部署リストの照会

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

部署リストを照会します。

リクエスト

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

メソッド	URI
GET	/ncloudmcc/v1/companies/{companyId}/depts

リクエストヘッダ

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/depts' \
--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	-	レスポンス総数
`depts`	Array	-	部署リスト: depts

`depts`

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

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

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

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

レスポンス例

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

{
    "page": {
        "count": 4,
        "offset": 0,
        "limit": 10,
        "total": 4
    },
    "depts": [
        {
            "uprDeptExternalKey": null,
            "name": "マニュアルコンテンツ開発株式会社",
            "i18nNames": {
                "ko_KR": "매뉴얼콘텐츠개발 주식회사"
            },
            "sortOrd": 1,
            "externalKey": ""
        },
        {
            "uprDeptExternalKey": null,
            "name": "コンテンツ開発グループ",
            "i18nNames": {},
            "sortOrd": 0,
            "externalKey": "hg-tw"
        },
        {
            "uprDeptExternalKey": "hg-tw",
            "name": "コンテンツ開発チーム",
            "i18nNames": {
                "ko_KR": "콘텐츠개발팀",
                "en_US": "Contents Dev. Team"
            },
            "sortOrd": 0,
            "externalKey": "hg-tw-cd"
        },
        {
            "uprDeptExternalKey": "hg-tw",
            "name": "マニュアル開発チーム",
            "i18nNames": {
                "ko_KR": "매뉴얼개발팀",
                "en_US": "Manual Dev. Team"
            },
            "sortOrd": 1,
            "externalKey": "hg-tw-md"
        }
    ]
}