GET/workflow/categories

権限に応じたカテゴリーのリストを取得する。

Authorization

oauth2

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

Scope

workflow
workflow.read

HTTP Request

GEThttps://www.worksapis.com/v1.0/workflow/categories

Query Parameters

ParameterTypeDescription
count integer 

取得数


default : 20
minimum : 1
maximum : 40
example : 40
format : int32 
cursor string 

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


example : JlIBsfJogXpzDGY8OscZziqZpYqCAu3RbZbaFzBb1od6lWQtSdPUd2FIdCuaGgu8DA== 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Response

HTTP 200

OK

PropertyTypeDescription
categories array (object) 
 
responseMetaData object (responseMetaData) 

レスポンスのメタデータ

 

object

PropertyTypeDescription
categoryId integer 

カテゴリー ID


required
format : int64 
categoryName string 

カテゴリー名


required 
i18nNames array (I18nName) 

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

 

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  "categories": [3    {4      "categoryId": 112,5      "categoryName": "総務",6      "i18nNames": [7        {8          "name": "総務",9          "language": "ja_JP"10        }11      ]12    }13  ],14  "responseMetaData": {15    "nextCursor": "JlIBsfJogXpzDGY8OscZziqZpYqCAu3RbZbaFzBb1od6lWQtSdPUd2FIdCuaGgu8DA=="16  }17}

HTTP 403

Forbidden