部署の作成

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

部署を作成します。

リクエスト

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

メソッド	URI
POST	/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) 部署の識別用区切り文字

リクエストボディ

リクエストボディの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`name`	String	Required	部署名
`i18nNames`	Object	Optional	部署の多言語名
`i18nNames.{locale}`	String	Optional	言語ごとの部署名 `"言語コード": "値"`形式で入力サポートする言語コード: `ko_KR` \| `ja_JP` \| `en_US` <例> `"ko_KR": "마케팅팀"`、`"en_US": "Marketing Team"`
`sortOrd`	Number	Required	照会の表示順序
`uprDeptExternalKey`	String	Optional	上位部署の外部キーデフォルト: 最上位部署部署リストの照会を参照

リクエスト例

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

curl --location --request POST 'https://ncloudmcc.apigw.ntruss.com/ncloudmcc/v1/companies/2b64fc1e-****-****-****-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' \
--data '{
    "name": "マーケティングチーム",
    "i18nNames": {
        "ko_KR": "마케팅팀",
        "en_US": "Marketing Team"
    },
    "sortOrd": 1,
    "uprDeptExternalKey": "hg-mkt"
}'

レスポンス

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

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

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

レスポンス例

レスポンス成功時、201 Createdと表示され、部署が作成されます。