Linkage code item v2
- Print
- PDF
Linkage code item v2
- Print
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
Description
This is the API to use linkage code item information used by the client in WORKPLACE.
Request header common
Header | Description |
---|---|
x-ncp-apigw-timestamp | * It indicates the time elapsed since January 1, 1970 00:00:00 UTC in milliseconds. * 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 the NAVER Cloud Platform portal or by Sub Account |
x-ncp-apigw-signature-v2 | * A signature that encrypts the body of the example above with the secret key mapped to the access key ID * HMAC encryption algorithm uses HmacSHA256 |
Save link code items
Save the linkage code items.
Request URL
POST https://workplace.apigw.ntruss.com/workflow/apigw/v2/company/{companyId}/interlocking-code/items/{codeKey}
Request header
Header | Description |
---|---|
x-ncp-apigw-timestamp | * It indicates the time elapsed since January 1, 1970 00:00:00 UTC in milliseconds. * 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 the NAVER Cloud Platform portal or by Sub Account |
x-ncp-apigw-signature-v2 | * A signature that encrypts the body of the example above with the secret key mapped to the access key ID * HMAC encryption algorithm uses HmacSHA256 |
Request path parameter
Parameter | Type | Size | Requirement status | Description |
---|---|---|---|---|
companyId | String | 36 | Y | Linkage key (CompanyId)Developers > Basic settings > Linkage key |
codeKey | String | 30 | Y | Linkage code key to save items |
Request body parameter
Parameter | Type | Size | Requirement status | Description |
---|---|---|---|---|
itemId | String | 30 | Y | Item ID |
itemValue | i18nName | Y | Item value |
i18nName Type
Parameter | Type | Size | Requirement status | Description |
---|---|---|---|---|
defaultMessage | String | 30 | Y | Default value of item name |
messages | Map | N | Multiple language of item nameMap<Locale, String> i18nName |
Request example
POST https://workplace.apigw.ntruss.com/workflow/apigw/v2/company/c1798784-9a47-4751-ab9f-b9629825ab93/interlocking-code/items/fishes
POST /workflow/apigw/v2/company/c1798784-9a47-4751-ab9f-b9629825ab93/interlocking-code/items/fishes
HOST: workplace.apigw.ntruss.com
Content-Type: application/json
x-ncp-apigw-timestamp: 1505290625682
x-ncp-iam-access-key: D78BB444D6D3C84CA38A
x-ncp-apigw-signature-v2: WTPItrmMIfLUk/UyUIyoQbA/z5hq9o3G8eQMolUzTEo=
{
"itemId": "tuna",
"itemValue": {
"defaultMessage": "Tuna",
"messages": {
"ko_KR": "참치",
"ja_JP": "参差",
"zh_CN": "金枪鱼",
"zh_TW": "金槍魚",
"en_US": "tuna"
}
}
}
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
Response
Returned as an HTTP status code in the response body.
HTTP status code | Response message | Description |
---|---|---|
200 | OK | General request made successfully |
201 | Created | Response code to the successful resource creation |
400 | Bad Request | Use for failed general request |
500 | Internal Server Error | - Response code to general server errors - 4XX error codes represent client-side errors - 5XX error codes represent server-side errors |
Response example
{
"status": 400,
"code": -4001,
"errors": [],
"message": "This is a duplicate login ID"
}
Language codes supported
Locale code | Description |
---|---|
ko_KR | Korean |
ja_JP | Japanese |
zh_CN | Chinese (Simplified) |
zh_TW | Chinese (Traditional) |
en_US | English |
Was this article helpful?