Set additional properties by employee
- Print
- PDF
Set additional properties by employee
- Print
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
Description
Sets additional properties for an employee.
Add additional properties
Adds additional properties of an employee.
Request URL
POST https://workplace.apigw.ntruss.com/organization/apigw/v1/company/{companyId}/addattrdata/employee/{externalKey}/attrkey/{attrExternalKey}
Request header
| Header | Description |
|---|---|
| x-ncp-apigw-timestamp | * This is the number of milliseconds that have elapsed since January 1, 1970 00:00:00 UTC. * If the time difference compared to the API Gateway server is more than 5 minutes, then the request is considered invalid. |
| x-ncp-iam-access-key | * Access Key ID issued on NAVER Cloud Platform portal or by Sub Account |
| x-ncp-apigw-signature-v2 | * A signature that encrypts the body of the example above with Secret Key mapped to the access key ID * HmacSHA256 is used as the HMAC encryption algorithm |
Request path parameters
| Parameter | Type | Length | Required | Description |
|---|---|---|---|---|
| companyId | String | 36 | Y | API key (CompanyId). Developers > Basic Settings > API Key |
| externalKey | String | 36 | Y | Employee’s external key |
| attrExternalKey | String | 36 | Y | Additional property’s external key |
Request body parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| fieldData | String | N | Additional property data. Pass the data through itemExternalKey if it is selective input type. |
Request example
POST https://workplace.apigw.ntruss.com/organization/apigw/v1/company/578c7009-bdad-4493-9835-72302cf988c6/addattrdata/employee/23f24be1-e100-4d9f-a242-ef0bd4ac8135/attrkey/e95b455e-4dee-4a74-ad3d-192d203e7650
POST /organization/apigw/v1/company/578c7009-bdad-4493-9835-72302cf988c6/addattrdata/employee/23f24be1-e100-4d9f-a242-ef0bd4ac8135/attrkey/e95b455e-4dee-4a74-ad3d-192d203e7650
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-v2: WTPItrmMIfLUk/UyUIyoQbA/z5hq9o3G8eQMolUzTEo=
{
"fieldData" : "7df0ef37-a451-49e7-8886-06a2e0e1d3a7"
}
or
{
"fieldData" : "test"
}
Response example
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
{
"fieldData" : "7df0ef37-a451-49e7-8886-06a2e0e1d3a7"
}
or
{
"fieldData" : "test"
}
Edit additional properties
Edits additional properties of an employee.
Request URL
PUT https://workplace.apigw.ntruss.com/organization/apigw/v1/company/addattrdata/employee/{externalKey}/attrkey/{attrExternalKey}
Request header
| Header | Description |
|---|---|
| x-ncp-apigw-timestamp | * This is the number of milliseconds that have elapsed since January 1, 1970 00:00:00 UTC. * If the time difference compared to the API Gateway server is more than 5 minutes, then the request is considered invalid. |
| x-ncp-iam-access-key | * Access Key ID issued on NAVER Cloud Platform portal or by Sub Account |
| x-ncp-apigw-signature-v2 | * A signature that encrypts the body of the example above with Secret Key mapped to the access key ID * HmacSHA256 is used as the HMAC encryption algorithm |
Request path parameters
| Parameter | Type | Length | Required | Description |
|---|---|---|---|---|
| companyId | String | 36 | Y | API key (CompanyId). Developers > Basic Settings > API Key |
| externalKey | String | 36 | Y | Employee’s external key |
| attrExternalKey | String | 36 | Y | Additional property’s external key |
Request body parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| fieldData | String | N | Additional property data. Pass the data through itemExternalKey if it is selective input type. |
Request example
POST https://workplace.apigw.ntruss.com/organization/apigw/v1/company/578c7009-bdad-4493-9835-72302cf988c6/addattrdata/employee/23f24be1-e100-4d9f-a242-ef0bd4ac8135/attrkey/e95b455e-4dee-4a74-ad3d-192d203e7650
POST /organization/apigw/v1/company/578c7009-bdad-4493-9835-72302cf988c6/addattrdata/employee/23f24be1-e100-4d9f-a242-ef0bd4ac8135/attrkey/e95b455e-4dee-4a74-ad3d-192d203e7650
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-v2:WTPItrmMIfLUk/UyUIyoQbA/z5hq9o3G8eQMolUzTEo=
{
"fieldData" : "7df0ef37-a451-49e7-8886-06a2e0e1d3a7"
}
or
{
"fieldData" : "test"
}
Response example
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
{
"fieldData" : "7df0ef37-a451-49e7-8886-06a2e0e1d3a7"
}
or
{
"fieldData" : "test"
}
Delete additional properties
Deletes additional properties of an employee.
Request URL
DELETE https://workplace.apigw.ntruss.com/organization/apigw/v1/company/addattrdata/employee/{externalKey}/attrkey/{attrExternalKey}
Request header
| Header | Description |
|---|---|
| x-ncp-apigw-timestamp | * This is the number of milliseconds that have elapsed since January 1, 1970 00:00:00 UTC. * If the time difference compared to the API Gateway server is more than 5 minutes, then the request is considered invalid. |
| x-ncp-iam-access-key | * Access Key ID issued on NAVER Cloud Platform portal or by Sub Account |
| x-ncp-apigw-signature-v2 | * A signature that encrypts the body of the example above with Secret Key mapped to the access key ID * HmacSHA256 is used as the HMAC encryption algorithm |
Request path parameters
| Parameter | Type | Length | Required | Description |
|---|---|---|---|---|
| companyId | String | 36 | Y | API key (CompanyId). Developers > Basic Settings > API Key |
| externalKey | String | 36 | Y | Employee’s external key |
| attrExternalKey | String | 36 | Y | Additional property’s external key |
Response
It returns an 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 (It is usually used to respond to the request format that the server cannot understand.) |
| 500 | Internal Server Error | General server error. Whereas 4xx error codes represent client-side errors, 5xx error codes represent server-side errors. |
Was this article helpful?