GET/workflow/linkage-codes

申請フォーマットの入力値リストの一覧を取得する。
本 API の利用には、申請フォーマットの入力値リスト管理 メニューへのアクセス権限が必要となる。

Authorization

oauth2

Access Token を指定します。
指定の方法や Access Token の取得方法は 共通仕様 を参照してください。

Scope

workflow.read
workflow

HTTP Request

GEThttps://www.worksapis.com/v1.0/workflow/linkage-codes

Query Parameters

ParameterTypeDescription
count integer 

取得数


default : 100
minimum : 1
maximum : 200
format : int32 
cursor string 

リストのカーソル値 (URL エンコードする)

 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Response

HTTP 200

入力値リストリストのレスポンス

PropertyTypeDescription
linkageCodes array (LinkageCode) 

入力値リストの一覧

 
responseMetaData object (responseMetaData) 

レスポンスのメタデータ

 

LinkageCode

PropertyTypeDescription
domainId integer 

ドメイン ID


format : int32 
linkageCodeKey string 

入力値リストのリスト管理コード

 
linkageCodeName string 

入力値リストのコード名

 
i18nNames array (I18nName) 

多国語名リスト
[管理者画面 > 基本設定 > 会社情報 > 多国語設定] で指定された項目の多国語のみ表示される。

 
enabled boolean 

入力値リストの有効フラグ

 

I18nName

PropertyTypeDescription
name string 

多国語表示名


required
minLength : 1
maxLength : 100 
language string 

多国語言語コード


required
Allowed values : ja_JP, ko_KR, en_US, zh_CN, zh_TW 

responseMetaData

PropertyTypeDescription
nextCursor string 

次のリスト取得時に使用するカーソル値

 

Response Example

example

1{2  "linkageCodes": [3    {4      "domainId": 10000001,5      "linkageCodeKey": "vegetables",6      "linkageCodeName": "野菜",7      "i18nNames": [8        {9          "language": "ja_JP",10          "name": "野菜"11        },12        {13          "language": "en_US",14          "name": "vegetables"15        },16        {17          "language": "ko_KR",18          "name": "채소"19        }20      ],21      "enabled": true22    }23  ],24  "responseMetaData": {25    "nextCursor": "JlIBsfJogXpzDGY8OscZziqZpYqCAu3RbZbaFzBb1od6lWQtSdPUd2FIdCuaGgu8DA=="26  }27}

HTTP 404

Not Found