Organization v1
- Print
- PDF
Organization v1
- Print
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
Description
Sets department information for your company in WORKPLACE.
Addition API
Adds department information.
Request URL
POST https://workplace.apigw.ntruss.com/organization/apigw/v1/company/{companyId}/dept/{externalKey}
Request headers
| Header | Description |
|---|---|
| x-ncp-apigw-timestamp | Shows the time elapsed since January 1, 1970 00:00:00 UTC. If the time differs from that of the API Gateway server by 5 minutes or more, the request is considered invalid. x-ncp-apigw-timestamp:{Timestamp} |
| x-ncp-apigw-api-key | Key issued by APIGWx-ncp-apigw-api-key:{API Gateway API Key} |
| x-ncp-iam-access-key | This is the Access Key ID value issued by the NAVER CLOUD PLATFORM portal.x-ncp-iam-access-key:{Account Access Key} |
| x-ncp-apigw-signature-v1 | This is the signature encrypted with the Access Key ID value and Secret Key.x-ncp-apigw-signature-v1:{API Gateway Signature} |
| Content-Type | Request body content type is specified as application/jsonContent-Type: application/json |
Request path parameters
| Parameter | Type | Size | Required | Description |
|---|---|---|---|---|
| companyId | String | 36 | Y | API key (CompanyId) Developers > Basic Settings > API Key |
| externalKey | String | 36 | Y | Department external key |
Request body parameters
| Parameter | Type | Size | Required | Description |
|---|---|---|---|---|
| name | String | 100 | Y | Department Name |
| i18nNames | Map | N | Department Name in multiple languages Map<Locale, String> i18nNames | |
| uprDeptExternalKey | String | 50 | Y | Parent department’s external key (enter # only for the top level) |
| deptbsExternalKey | String | 36 | N | Department head’s external key |
| dispOrd | String | 1 | Y | Display order of departments |
Request Example
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"
}
}
Response Example
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"
}
}
Edit API
Edits department information.
Request URL
PUT https://workplace.apigw.ntruss.com/organization/apigw/v1/company/{companyId}/dept/{externalKey}
Request headers
| Header | Description |
|---|---|
| x-ncp-apigw-timestamp | Shows the time elapsed since January 1, 1970 00:00:00 UTC. If the time differs from that of the API Gateway server by 5 minutes or more, the request is considered invalid. x-ncp-apigw-timestamp:{Timestamp} |
| x-ncp-apigw-api-key | Key issued by APIGWx-ncp-apigw-api-key:{API Gateway API Key} |
| x-ncp-iam-access-key | This is the Access Key ID value issued by the NAVER CLOUD PLATFORM portal.x-ncp-iam-access-key:{Account Access Key} |
| x-ncp-apigw-signature-v1 | This is the signature encrypted with the Access Key ID value and Secret Key.x-ncp-apigw-signature-v1:{API Gateway Signature} |
| Content-Type | Request body content type is specified as application/jsonContent-Type: application/json |
Request path parameters
| Parameter | Type | Size | Required | Description |
|---|---|---|---|---|
| companyId | String | 36 | Y | API key (CompanyId) Developers > Basic Settings > API Key |
| externalKey | String | 36 | Y | 부서 외부키 |
Request body parameters
| Parameter | Type | Size | Required | Description |
|---|---|---|---|---|
| name | String | 100 | Y | Department Name |
| i18nNames | Map | N | Department Name in multiple languagesMap<Locale, String> i18nNames | |
| uprDeptExternalKey | String | 50 | Y | Parent department’s external key (enter # only for the top level) |
| deptbsExternalKey | String | 36 | N | Department head’s external key |
| dispOrd | String | 1 | Y | Display order of departments |
Request Example
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"
}
}
Response Example
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"
}
}
Delete API
Deletes department information.
Request URL
DELETE https://workplace.apigw.ntruss.com/organization/apigw/v1/company/{companyId}/dept/{externalKey}
Request headers
| Header | Description |
|---|---|
| x-ncp-apigw-timestamp | Shows the time elapsed since January 1, 1970 00:00:00 UTC. If the time differs from that of the API Gateway server by 5 minutes or more, the request is considered invalid. x-ncp-apigw-timestamp:{Timestamp} |
| x-ncp-apigw-api-key | Key issued by APIGWx-ncp-apigw-api-key:{API Gateway API Key} |
| x-ncp-iam-access-key | This is the Access Key ID value issued by the NAVER CLOUD PLATFORM portal.x-ncp-iam-access-key:{Account Access Key} |
| x-ncp-apigw-signature-v1 | This is the signature encrypted with the Access Key ID value and Secret Key.x-ncp-apigw-signature-v1:{API Gateway Signature} |
| Content-Type | Request body content type is specified as application/jsonContent-Type: application/json |
Request path parameters
| Parameter | Type | Size | Required | Description |
|---|---|---|---|---|
| companyId | String | 36 | Y | API key (CompanyId) Developers > Basic Settings > API Key |
| externalKey | String | 36 | Y | Department external key |
Response
Returned as HTTP status code in the response body.
| HTTP status code | Response message | Description |
|---|---|---|
| 200 | OK | Success |
| 201 | Created | Resource successfully created |
| 400 | Bad Request | Failure (usually used to respond to a request format that the server cannot understand.) |
| 500 | Internal Server Error | General server error. Where 4xx error codes represent client-side errors, 5xx error codes represent server-side errors. |
Was this article helpful?