Linkage code v2

Article Summary

Share feedback

Thanks for sharing your feedback!

Description

This is the API to use linkage code 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

List APIs

Retrieve the linkage code list.

Request URL

GET https://workplace.apigw.ntruss.com/workflow/apigw/v2/company/{companyId}/interlocking-code/codes

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

Request path parameter

Parameter	Type	Size	Requirement status	Description
companyId	String	36	Y	Linkage key (CompanyId) `Developers > Basic settings > Linkage key`

Request example

GET https://workplace.apigw.ntruss.com/workflow/apigw/v2/company/c1798784-9a47-4751-ab9f-b9629825ab93/interlocking-code/codes

GET /workflow/apigw/v2/company/c1798784-9a47-4751-ab9f-b9629825ab93/interlocking-code/codes
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=

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

[
  {
    "codeIndex": 1,
    "codeKey": "vegetables",
    "codeName": {
      "defaultMessage": "Vegetable",
      "messages": {
        "zh_CN": "蔬菜",
        "ja_JP": "野菜",
        "ko_KR": "채소",
        "zh_TW": "蔬菜",
        "en_US": "vegetables"
      }
    },
    "items": []
  },
  {
    "codeIndex": 2,
    "codeKey": "fruits",
    "codeName": {
      "defaultMessage": "Fruit",
      "messages": {
        "zh_CN": "水果",
        "ja_JP": "果物",
        "ko_KR": "과일",
        "zh_TW": "水果",
        "en_US": "fruits"
      }
    },
    "items": []
  }
]

Linkage code information and item list

Retrieve the linkage code information and item list.

Request URL

GET https://workplace.apigw.ntruss.com/workflow/apigw/v2/company/{companyId}/interlocking-code/codes/{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

Request example

GET https://workplace.apigw.ntruss.com/workflow/apigw/v2/company/c1798784-9a47-4751-ab9f-b9629825ab93/interlocking-code/codes/vegetables

GET /workflow/apigw/v2/company/c1798784-9a47-4751-ab9f-b9629825ab93/interlocking-code/codes/vegetables
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=

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

{
    "codeIndex": 1,
    "codeKey": "vegetables",
    "codeName": {
      "defaultMessage": "Vegetable",
      "messages": {
        "zh_CN": "蔬菜",
        "ja_JP": "野菜",
        "ko_KR": "채소",
        "zh_TW": "蔬菜",
        "en_US": "vegetables"
      }
    },
  "items": [
    {
      "itemId": "1",
      "itemValue": {
        "defaultMessage": "Carrot",
        "messages": {
           "zh_CN": "胡萝卜",
           "ja_JP": "ニンジン",
           "ko_KR": "채소",
           "zh_TW": "胡蘿蔔",
           "en_US": "carrot"
        }
      }
    },
    {
      "itemId": "2",
      "itemValue": {
        "defaultMessage": "Onion",
        "messages": {
           "zh_CN": "洋葱",
           "ja_JP": "タマネギ",
           "ko_KR": "양파",
           "zh_TW": "洋蔥",
           "en_US": "onion"
        }
      }
    },
    {
      "itemId": "3",
      "itemValue": {
        "defaultMessage": "Garlic",
        "messages": {
           "zh_CN": "大蒜",
           "ja_JP": "ニンニク",
           "ko_KR": "마늘",
           "zh_TW": "大蒜",
           "en_US": "garlic"
        }
      }
    },
    {
      "itemId": "4",
      "itemValue": {
        "defaultMessage": "Lettuce",
        "messages": {
           "zh_CN": "生菜",
           "ja_JP": "レタス",
           "ko_KR": "상추",
           "zh_TW": "生菜",
           "en_US": "lettuce"
        }
      }
    },
  ]
}

Save linkage code

Save the linkage code.

Request URL

POST https://workplace.apigw.ntruss.com/workflow/apigw/v2/company/{companyId}/interlocking-code/codes

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`

Request body parameter

Parameter	Type	Size	Requirement status	Description
codeKey	String	30	Y	Linkage code key
codeName	i18nName		Y	Multiple language value of code name

i18nName Type

Parameter	Type	Size	Requirement status	Description
defaultMessage	String	30	Y	Default value of linkage code name
messages	Map		N	Multiple language of linkage code name`Map<Locale, String> i18nName`

Request example

POST https://workplace.apigw.ntruss.com/workflow/apigw/v2/company/c1798784-9a47-4751-ab9f-b9629825ab93/interlocking-code/codes

POST /workflow/apigw/v2/company/c1798784-9a47-4751-ab9f-b9629825ab93/interlocking-code/codes
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=
{
  "codeKey": "fishes",
  "codeName": {
    "defaultMessage": "Fish",
    "messages": {
      "ko_KR": "물고기",
      "ja_JP": "魚",
      "zh_CN": "鱼儿",
      "zh_TW": "魚兒",
      "en_US": "fishes"
    }
  }
}

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

{
  "codeIndex": 3,
  "codeKey": "fishes",
  "codeName": {
    "defaultMessage": "Fish",
    "messages": {
      "ko_KR": "물고기",
      "ja_JP": "魚",
      "zh_CN": "鱼儿",
      "zh_TW": "魚兒",
      "en_US": "fishes"
    }
  },
  "items": []
}

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?

What's Next

Linkage code item v2

Table of contents

Description
Request header common
List APIs
Linkage code information and item list
Save linkage code
Response
Language codes supported