役職リストの照会

Classic/VPC環境で利用できます。

役職リストを照会します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド	URI
GET	/ncloudmcc/v1/companies/{companyId}/job-grades

リクエストヘッダ

Media Connect Center APIで共通して使用されるヘッダの詳細は、Media Connect Centerのリクエストヘッダをご参照ください。

リクエストパスパラメータ

リクエストパスパラメータの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`companyId`	String	Required	連携キーコンソールで確認: Media Connect Center > Developers > 基本設定 > 連携キー

リクエストクエリパラメータ

リクエストクエリパラメータの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`limit`	Number	Optional	照会データの最大項目数デフォルト: 10
`offset`	Number	Optional	照会データのスタート位置デフォルト: 0

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request GET 'https://ncloudmcc.apigw.ntruss.com/ncloudmcc/v1/companies/2b64fc1e-6e9c-40dc-8b40-991bcaada5ef/job-grades' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'x-ncp-region_code: KR' \
--header 'Content-Type: application/json'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`page`	Object	-	ページ情報
`page.count`	Number	-	レスポンス結果数
`page.offset`	Number	-	照会データのスタート位置
`page.limit`	Number	-	照会データの最大項目数
`page.total`	Number	-	レスポンス総数
`jobGrades`	Array	-	役職リスト: jobGrades

`jobGrades`

jobGradesの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`name`	String	-	役職名
`i18nNames`	Object	-	役職の多言語名
`i18nNames.{locale}`	String	-	言語ごとの役職名 `"言語コード": "値"`形式韓国語、英語、日本語のうち登録された値を表示
`sortOrd`	Number	-	照会の表示順序
`externalKey`	String	-	役職の外部キー(External Key)

レスポンスステータスコード

Media Connect Center APIで共通して使用されるレスポンスステータスコードの詳細は、Media Connect Centerのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
    "page": {
        "count": 6,
        "offset": 0,
        "limit": 10,
        "total": 6
    },
    "jobGrades": [
        {
            "name": "代表取締役",
            "i18nNames": {
                "ko_KR": "대표이사",
                "en_US": "CEO",
                "ja_JP": "代表取締役"
            },
            "sortOrd": 1,
            "externalKey": ""
        },
        {
            "name": "スーパーバイザー",
            "i18nNames": {
                "ko_KR": "수퍼바이저",
                "en_US": "Supervisor"
            },
            "sortOrd": 1,
            "externalKey": "hg-grade-1"
        },
        {
            "name": "部長",
            "i18nNames": {
                "ko_KR": "부장",
                "en_US": "Director",
                "ja_JP": "部長"
            },
            "sortOrd": 2,
            "externalKey": ""
        },
        {
            "name": "課長",
            "i18nNames": {
                "ko_KR": "과장",
                "en_US": "Manager",
                "ja_JP": "課長"
            },
            "sortOrd": 3,
            "externalKey": ""
        },
        {
            "name": "代理",
            "i18nNames": {
                "ko_KR": "대리",
                "en_US": "Deputy",
                "ja_JP": "代理"
            },
            "sortOrd": 4,
            "externalKey": ""
        },
        {
            "name": "社員",
            "i18nNames": {
                "ko_KR": "사원",
                "en_US": "Employee",
                "ja_JP": "社員"
            },
            "sortOrd": 5,
            "externalKey": ""
        }
    ]
}