Classic/VPC環境で利用できます。
役職の詳細情報を照会します。
リクエスト
リクエスト形式を説明します。リクエスト形式は次の通りです。
| メソッド | URI |
|---|---|
| GET | /ncloudmcc/v1/companies/{companyId}/job-grades/{externalKey} |
リクエストヘッダ
Media Connect Center APIで共通して使用されるヘッダの詳細は、Media Connect Centerのリクエストヘッダをご参照ください。
リクエストパスパラメータ
リクエストパスパラメータの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
companyId |
String | Required | 連携キー
|
externalKey |
String | Required | 役職の外部キー(External Key)
|
リクエスト例
リクエストのサンプルコードは次の通りです。
curl --location --request GET 'https://ncloudmcc.apigw.ntruss.com/ncloudmcc/v1/companies/2b64fc1e-6e9c-40dc-8b40-991bcaada5ef/job-grades/hg-grade-1' \
--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'
レスポンス
レスポンス形式を説明します。
レスポンスボディ
レスポンスボディの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
jobGrade |
Object | - | 役職の情報 |
jobGrade.name |
String | - | 役職名 |
jobGrade.i18nNames |
Object | - | 役職の多言語名 |
jobGrade.i18nNames.{locale} |
String | - | 言語ごとの役職名
|
jobGrade.sortOrd |
Number | - | 照会の表示順序 |
jobGrade.externalKey |
String | - | 役職の外部キー(External Key) |
レスポンスステータスコード
Media Connect Center APIで共通して使用されるレスポンスステータスコードの詳細は、Media Connect Centerのレスポンスステータスコードをご参照ください。
レスポンス例
レスポンスのサンプルコードは次の通りです。
{
"jobGrade": {
"name": "スーパーバイザー",
"i18nNames": {
"ko_KR": "수퍼바이저",
"en_US": "Supervisor"
},
"sortOrd": 1,
"externalKey": "hg-grade-1"
}
}