組織
- 印刷する
- PDF
組織
- 印刷する
- PDF
記事の要約
この要約は役に立ちましたか?
ご意見ありがとうございます
説明
顧客社の組織情報をWORKBOXで設定するためのAPIです。
追加API
組織情報を追加する。
リクエストURL
POST https://workbox.apigw.ntruss.com/workbox/workbox/openapi/v1/organization/company/{companyId}/dept/{externalKey}
リクエストヘッダ
| ヘッダ名 | 説明 |
|---|---|
| x-ncp-apigw-timestamp | 1970年1月1日 00:00:00 協定世界時(UTC)からの経過時間をミリセカンド(Millisecond)で表し、 API Gatewayサーバとの時間差が5分以上の場合は無効なリクエストとしてみなす。 x-ncp-apigw-timestamp:{Timestamp} |
| x-ncp-apigw-api-key | APIGWで発行されたキーの値x-ncp-apigw-api-key:{API Gateway API Key} |
| x-ncp-iam-access-key | Naverクラウドプラットフォームポータルで発行されたAccess Key IDの値x-ncp-iam-access-key:{Account Access Key} |
| x-ncp-apigw-signature-v1 | Access Key ID値とSecret Keyで暗号化した署名x-ncp-apigw-signature-v1:{API Gateway Signature} |
| Content-Type | Request body content typeをapplication/jsonに指定Content-Type: application/json |
リクエストPathパラメータ
| パラメータ | タイプ | サイズ | 必須 | 説明 |
|---|---|---|---|---|
| companyId | String | 36 | Y | 連携キー(CompanyId) Developers > 基本設定 > 連携キー |
| externalKey | String | 36 | Y | 部署外部キー |
リクエストBodyパラメータ
| パラメータ | タイプ | サイズ | 必須 | 説明 |
|---|---|---|---|---|
| name | String | 100 | Y | 部署名 |
| i18nNames | Map | N | 部署多国語名Map<Locale, String> i18nNames | |
| sortOrd | String | 1 | Y | 部署表示順番 |
| uprDeptExternalKey | String | 50 | Y | 上位部署外部キー(最上位組織である場合のみ #) |
リクエスト例示
POST https://workbox.apigw.ntruss.com/workbox/workbox/openapi/v1/organization/company/578c7009-bdad-4493-9835-72302cf988c6/dept/0000002
POST /openapi/v1/organization/company/578c7009-bdad-4493-9835-72302cf988c6/dept/0000002
HOST: workbox.apigw.ntruss.com
Content-Type: application/json
x-ncp-apigw-timestamp: 1505290625682
x-ncp-apigw-api-key: DUxjP4HYTP8V7khBkgywdDHQjKuaYWGrppHKpvdv
x-ncp-iam-access-key: D78BB444D6D3C84CA38A
x-ncp-apigw-signature-v1: WTPItrmMIfLUk/UyUIyoQbA/z5hq9o3G8eQMolUzTEo=
{
"sortOrd": 1,
"uprDeptExternalKey" : "00001",
"name": "運営管理チーム",
"i18nNames": {
"ko_KR": "운영관리팀",
"en_US": "Operation Management Team"
}
}
レスポンス例示
HTTP/1.1 201 OK
Server: nginx
Date: Wed, 12 Sep 2018 10:18:11 GMT
Content-Type: application/json;charset=utf-8
Transfer-Encoding: chunked
Connection: keep-alive
Access-Control-Allow-Origin: *
x-ncp-trace-id: 68d1o68pm4cr63gc3169gm4p34
{
"sortOrd": 1,
"uprDeptExternalKey" : "00001",
"name": "運営管理チーム",
"i18nNames": {
"ko_KR": "운영관리팀",
"en_US": "Operation Management Team"
}
}
修正API
組織情報を修正する。
リクエストURL
PUT https://workbox.apigw.ntruss.com/workbox/workbox/openapi/v1/organization/company/{companyId}/dept/{externalKey}
リクエストヘッダ
| ヘッダ名 | 説明 |
|---|---|
| x-ncp-apigw-timestamp | 1970年1月1日 00:00:00 協定世界時(UTC)からの経過時間をミリセカンド(Millisecond)で表し、 API Gatewayサーバとの時間差が5分以上の場合は無効なリクエストとしてみなす。 x-ncp-apigw-timestamp:{Timestamp} |
| x-ncp-apigw-api-key | APIGWで発行されたキーの値 x-ncp-apigw-api-key:{API Gateway API Key} |
| x-ncp-iam-access-key | Naverクラウドプラットフォームポータルで発行されたAccess Key IDの値 x-ncp-iam-access-key:{Account Access Key} |
| x-ncp-apigw-signature-v1 | Access Key ID値とSecret Keyで暗号化した署名 x-ncp-apigw-signature-v1:{API Gateway Signature} |
| Content-Type | Request body content typeをapplication/jsonに指定 Content-Type: application/json |
リクエストPathパラメータ
| パラメータ | タイプ | サイズ | 必須 | 説明 |
|---|---|---|---|---|
| companyId | String | 36 | Y | 連携キー(CompanyId) Developers > 基本設定 > 連携キー |
| externalKey | String | 36 | Y | 部署外部キー |
リクエストBodyパラメータ
| パラメータ | タイプ | サイズ | 必須 | 説明 |
|---|---|---|---|---|
| name | String | 100 | Y | 部署名 |
| i18nNames | Map | N | 部署多国語名Map<Locale, String> i18nNames | |
| sortOrd | String | 1 | Y | 部署表示順番 |
| uprDeptExternalKey | String | 50 | Y | 上位部署外部キー(最上位組織である場合のみ #) |
リクエスト例示
POST https://workbox.apigw.ntruss.com/workbox/workbox/openapi/v1/organization/company/578c7009-bdad-4493-9835-72302cf988c6/dept/0000002
POST /openapi/v1/organization/company/578c7009-bdad-4493-9835-72302cf988c6/dept/0000002
HOST: workbox.apigw.ntruss.com
Content-Type: application/json
x-ncp-apigw-timestamp: 1505290625682
x-ncp-apigw-api-key: DUxjP4HYTP8V7khBkgywdDHQjKuaYWGrppHKpvdv
x-ncp-iam-access-key: D78BB444D6D3C84CA38A
x-ncp-apigw-signature-v1: WTPItrmMIfLUk/UyUIyoQbA/z5hq9o3G8eQMolUzTEo=
{
"sortOrd": 1,
"uprDeptExternalKey" : "00001",
"name": "運営管理チーム",
"i18nNames": {
"ko_KR": "운영관리팀",
"en_US": "Operation Management Team"
}
}
レスポンス例示
HTTP/1.1 200 OK
Server: nginx
Date: Wed, 12 Sep 2018 10:18:11 GMT
Content-Type: application/json;charset=utf-8
Transfer-Encoding: chunked
Connection: keep-alive
Access-Control-Allow-Origin: *
x-ncp-trace-id: 68d1o68pm4cr63gc3169gm4p34
{
"sortOrd": 1,
"uprDeptExternalKey" : "00001",
"name": "運営管理チーム",
"i18nNames": {
"ko_KR": "운영관리팀",
"en_US": "Operation Management Team"
}
}
削除API
組織情報を削除する。
リクエストURL
DELETE https://workbox.apigw.ntruss.com/workbox/workbox/openapi/v1/organization/company/{companyId}/dept/{externalKey}
リクエストヘッダ
| ヘッダ名 | 説明 |
|---|---|
| x-ncp-apigw-timestamp | 1970年1月1日 00:00:00 協定世界時(UTC)からの経過時間をミリセカンド(Millisecond)で表し、 API Gatewayサーバとの時間差が5分以上の場合は無効なリクエストとしてみなす。 x-ncp-apigw-timestamp:{Timestamp} |
| x-ncp-apigw-api-key | APIGWで発行されたキーの値 x-ncp-apigw-api-key:{API Gateway API Key} |
| x-ncp-iam-access-key | Naverクラウドプラットフォームポータルで発行されたAccess Key IDの値 x-ncp-iam-access-key:{Account Access Key} |
| x-ncp-apigw-signature-v1 | Access Key ID値とSecret Keyで暗号化した署名 x-ncp-apigw-signature-v1:{API Gateway Signature} |
| Content-Type | Request body content typeをapplication/jsonに指定 Content-Type: application/json |
リクエストPathパラメータ
| パラメータ | タイプ | サイズ | 必須 | 説明 |
|---|---|---|---|---|
| companyId | String | 36 | Y | 連携キー(CompanyId) Developers > 基本設定 > 連携キー |
| externalKey | String | 36 | Y | 部署外部キー |
レスポンス
HTTPステータスコードでリターンされ、Body情報で伝達する。
| HTTPステータスコード | レスポンスメッセージ | 説明 |
|---|---|---|
| 200 | OK | 一般的なリクエスト成功 |
| 201 | Created | リソース作成成功に対するレスポンスコード |
| 400 | Bad Request | 一般的なリクエスト失敗に使用(大体、サーバが理解できない形式のリクエストの場合にレスポンスするため使用) |
| 500 | Internal Server Error | 一般的なサーバエラーに対するレスポンスコード、4XX代のエラーコードがクライアント側のエラーを表示するために使われるのであれば、 5XX代のエラーコードはサーバ側のエラーを表示するために使われます。 |
この記事は役に立ちましたか?