職責リストの照会

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

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

リクエスト

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

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

リクエストヘッダ

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-positions' \
--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	-	レスポンス総数
`jobPositions`	Array	-	職責リスト: jobPositions

`jobPositions`

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

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

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

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

レスポンス例

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

{
    "page": {
        "count": 5,
        "offset": 0,
        "limit": 10,
        "total": 5
    },
    "jobPositions": [
        {
            "name": "CEO",
            "i18nNames": {
                "ko_KR": "CEO",
                "en_US": "CEO",
                "ja_JP": "CEO"
            },
            "sortOrd": 1,
            "externalKey": "CEO"
        },
        {
            "name": "本部長",
            "i18nNames": {
                "ko_KR": "본부장",
                "en_US": "General Manager",
                "ja_JP": "本部長"
            },
            "sortOrd": 2,
            "externalKey": "GM"
        },
        {
            "name": "チーム長",
            "i18nNames": {
                "ko_KR": "팀장",
                "en_US": "Team Leader",
                "ja_JP": "チーム長"
            },
            "sortOrd": 3,
            "externalKey": "TL"
        },
        {
            "name": "チーム員",
            "i18nNames": {
                "ko_KR": "팀원",
                "en_US": "Team members",
                "ja_JP": "チーム員"
            },
            "sortOrd": 4,
            "externalKey": "TM"
        },
        {
            "name": "PM",
            "i18nNames": {
                "ko_KR": "프로젝트 매니저",
                "en_US": "Project Manager"
            },
            "sortOrd": 5,
            "externalKey": "hg-position-5"
        }
    ]
}