組織v1
- 印刷する
- PDF
組織v1
- 印刷する
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
説明
クライアントの組織情報をWORKPLACEに設定するためのAPIです。
追加API
組織情報を追加する。
リクエストURL
POST https://workplace.apigw.ntruss.com/organization/apigw/v1/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 | |
| uprDeptExternalKey | String | 50 | Y | 上位部署の外部キー(最上位組織の場合のみ#) |
| deptbsExternalKey | String | 36 | N | 部署長の外部キー |
| dispOrd | String | 1 | Y | 部署表示順序 |
リクエスト例
POST https://workplace.apigw.ntruss.com/organization/apigw/v1/company/578c7009-bdad-4493-9835-72302cf988c6/dept/0000002
POST /organization/apigw/v1/company/578c7009-bdad-4493-9835-72302cf988c6/dept/0000002
HOST:workplace.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=
{
"dispOrd":1,
"uprDeptExternalKey" :"00001",
"deptbsExternalKey" :"EX00001",
"name":"운영관리팀",
"i18nNames":{
"ko_KR":"운영관리팀",
"en_US":"Operation Management Team"
}
}
レスポンス例
HTTP/1.1 201 OK
Server:nginx
Date:Wed, 12 Sep 2020 01: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
{
"dispOrd":1,
"uprDeptExternalKey" :"00001",
"deptbsExternalKey" :"EX00001",
"name":"운영관리팀",
"i18nNames":{
"ko_KR":"운영관리팀",
"en_US":"Operation Management Team"
}
}
修正API
組織情報を修正する。
リクエストURL
PUT https://workplace.apigw.ntruss.com/organization/apigw/v1/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 | |
| uprDeptExternalKey | String | 50 | Y | 上位部署の外部キー(最上位組織の場合のみ#) |
| deptbsExternalKey | String | 36 | N | 部署長の外部キー |
| dispOrd | String | 1 | Y | 部署表示順序 |
リクエスト例
POST https://workplace.apigw.ntruss.com/organization/apigw/v1/company/578c7009-bdad-4493-9835-72302cf988c6/dept/0000002
POST /organization/apigw/v1/company/578c7009-bdad-4493-9835-72302cf988c6/dept/0000002
HOST:workplace.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=
{
"dispOrd":1,
"uprDeptExternalKey" :"00001",
"deptbsExternalKey" :"EX00001",
"name":"운영관리팀",
"i18nNames":{
"ko_KR":"운영관리팀",
"en_US":"Operation Management Team"
}
}
レスポンス例
HTTP/1.1 200 OK
Server:nginx
Date:Wed, 12 Sep 2020 01: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
{
"dispOrd":1,
"uprDeptExternalKey" :"00001",
"deptbsExternalKey" :"EX00001",
"name":"운영관리팀",
"i18nNames":{
"ko_KR":"운영관리팀",
"en_US":"Operation Management Team"
}
}
削除API
組織情報を削除する。
リクエストURL
DELETE https://workplace.apigw.ntruss.com/organization/apigw/v1/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台のエラーコードはサーバ側のエラーを示すために使用されます。 |
この記事は役に立ちましたか?