連携コード v2

説明

クライアントが使用する連携コード情報をWORKPLACEで使用するためのAPIです。

リクエストヘッダ共通

リストAPI

連携コードリストをインポートします。

リクエストURL

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

リクエストヘッダ共通

リクエストPathパラメータ

リクエスト例

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=

レスポンス例

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": "野菜",
      "messages": {
        "zh_CN": "蔬菜",
        "ja_JP": "野菜",
        "ko_KR": "채소",
        "zh_TW": "蔬菜",
        "en_US": "vegetables"
      }
    },
    "used": "Y",
    "items": []
  },
  {
    "codeIndex": 2,
    "codeKey": "fruits",
    "codeName": {
      "defaultMessage": "果物",
      "messages": {
        "zh_CN": "水果",
        "ja_JP": "果物",
        "ko_KR": "과일",
        "zh_TW": "水果",
        "en_US": "fruits"
      }
    },
    "used": "Y",
    "items": []
  }
]

連携コード情報とアイテムリスト

連携コード情報と関連したアイテムリストをインポートします。

リクエストURL

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

リクエストヘッダ

リクエストPathパラメータ

リクエスト例

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=

レスポンス例

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": "野菜",
      "messages": {
        "zh_CN": "蔬菜",
        "ja_JP": "野菜",
        "ko_KR": "채소",
        "zh_TW": "蔬菜",
        "en_US": "vegetables"
      }
    },
    "used": "Y",
  "items": [
    {
      "itemId": "1",
       "used": "Y",
      "itemValue": {
        "defaultMessage": "ニンジン",
        "messages": {
           "zh_CN": "胡萝卜",
           "ja_JP": "ニンジン",
           "ko_KR": "채소",
           "zh_TW": "胡蘿蔔",
           "en_US": "carrot"
        }
      }
    },
    {
      "itemId": "2",
       "used": "Y",
      "itemValue": {
        "defaultMessage": "玉ねぎ",
        "messages": {
           "zh_CN": "洋葱",
           "ja_JP": "タマネギ",
           "ko_KR": "양파",
           "zh_TW": "洋蔥",
           "en_US": "onion"
        }
      }
    },
    {
      "itemId": "3",
       "used": "Y",
      "itemValue": {
        "defaultMessage": "ニンニク",
        "messages": {
           "zh_CN": "大蒜",
           "ja_JP": "ニンニク",
           "ko_KR": "마늘",
           "zh_TW": "大蒜",
           "en_US": "garlic"
        }
      }
    },
    {
      "itemId": "4",
       "used": "Y",
      "itemValue": {
        "defaultMessage": "レタス",
        "messages": {
           "zh_CN": "生菜",
           "ja_JP": "レタス",
           "ko_KR": "상추",
           "zh_TW": "生菜",
           "en_US": "lettuce"
        }
      }
    },
  ]
}

連携コード保存

連携コードを保存します。

リクエストURL

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

リクエストヘッダ

リクエストPathパラメータ

リクエストBodyパラメータ

i18nName Type

リクエスト例

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",
  "used": "Y",
  "codeName": {
    "defaultMessage": "魚",
    "messages": {
      "ko_KR": "물고기",
      "ja_JP": "魚",
      "zh_CN": "鱼儿",
      "zh_TW": "魚兒",
      "en_US": "fishes"
    }
  }
}

レスポンス例

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",
    "used": "Y",
  "codeName": {
    "defaultMessage": "魚",
    "messages": {
      "ko_KR": "물고기",
      "ja_JP": "魚",
      "zh_CN": "鱼儿",
      "zh_TW": "魚兒",
      "en_US": "fishes"
    }
  },
  "items": []
}

レスポンス

HTTPステータスコードでリターンされ、Body情報として伝達する。

レスポンス例

{
    "status": 400,
    "code": -4001,
    "errors": [],
    "message": "This is a duplicate login ID"
}

サポートしている言語コード