部署の照会

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

部署の詳細情報を照会します。

リクエスト

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

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

リクエストヘッダ

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

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

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

フィールド	タイプ	必須の有無	説明
`companyId`	String	Required	連携キーコンソールで確認: Media Connect Center > Developers > 基本設定 > 連携キー
`externalKey`	String	Required	部署の外部キー(External Key) 部署リストの照会を参照

リクエスト例

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

curl --location --request GET 'https://ncloudmcc.apigw.ntruss.com/ncloudmcc/v1/companies/2b64fc1e-6e9c-40dc-8b40-991bcaada5ef/depts/hg-tw-md' \
--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'

レスポンス

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

レスポンスボディ

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

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

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

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

レスポンス例

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

{
    "dept": {
        "uprDeptExternalKey": "",
        "name": "マニュアル開発チーム",
        "i18nNames": {
            "ko_KR": "매뉴얼개발팀",
            "en_US": "Manual Development Team"
        },
        "sortOrd": 1,
        "externalKey": "hg-tw-md"
    }
}