GET/workflow/document-forms

申請フォーマットのリストを取得する。

Authorization

oauth2

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

Scope

workflow
workflow.read

HTTP Request

GEThttps://www.worksapis.com/v1.0/workflow/document-forms

Query Parameters

ParameterTypeDescription
count integer 

取得数


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

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


example : JlIBsfJogXpzDGY8OscZziqZpYqCAu3RbZbaFzBb1od6lWQtSdPUd2FIdCuaGgu8DA== 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Response

HTTP 200

OK

PropertyTypeDescription
documentForms array (DocumentForm) 
 
responseMetaData object (responseMetaData) 

レスポンスのメタデータ

 

DocumentForm

PropertyTypeDescription
categoryId integer 

カテゴリー ID


required 
documentFormId string 

申請フォーマット ID


required 
documentFormName string 

申請フォーマット名

 
i18nNames array (I18nName) 

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

 
enabled boolean 

申請フォーマットの有効フラグ

 
useFormDesigner 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  "documentForms": [3    {4      "categoryId": 10000001,5      "documentFormId": "16d11974-7351-4cc9-9eec-52322ff286ee",6      "documentFormName": "計画書",7      "i18nNames": [8        {9          "name": "計画書",10          "language": "ja_JP"11        }12      ],13      "enabled": true,14      "useFormDesigner": true15    }16  ],17  "responseMetaData": {18    "nextCursor": "JlIBsfJogXpzDGY8OscZziqZpYqCAu3RbZbaFzBb1od6lWQtSdPUd2FIdCuaGgu8DA=="19  }20}