GET/workflow/document-forms/{documentFormId}

申請フォーマットを取得する

Authorization

oauth2

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

Scope

workflow
workflow.read

HTTP Request

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

Path Parameters

ParameterTypeDescription
documentFormId string 

申請フォーマット ID


required 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Response

HTTP 200

OK

PropertyTypeDescription
categoryId integer 

カテゴリー ID

 
documentFormId string 

申請フォーマット ID

 
documentFormName string 

申請フォーマット名

 
i18nNames array (I18nName) 

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

 
enabled boolean 

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

 
useFormDesigner boolean 

フォーマットエディタによる編集

 
components array (Component) 

コンポーネント情報

 

I18nName

PropertyTypeDescription
name string 

多国語表示名


required
minLength : 1
maxLength : 100 
language string 

多国語言語コード


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

Component

PropertyTypeDescription
componentType string 

コンポーネントの属性を参照する。


required 
componentName string 

コンポーネント名


required 
componentId string 

コンポーネント ID


required 
componentCustomId string 

コンポーネントのカスタム ID

 
componentLabel string 

コンポーネント ラベル

 
attributes array (ComponentAttribute) 

コンポーネントの属性を参照する。

 

ComponentAttribute

PropertyTypeDescription
attributeType string 

属性の種類


required 
attributeId string 

属性 ID


required 
attributeName string 

属性の名前

 
attributeValue object 

属性の値

 

Response Example

example

1{2  "categoryId": 10000001,3  "documentFormId": "16d11974-7351-4cc9-9eec-52322ff286ee",4  "documentFormName": "計画書",5  "i18nNames": [6    {7      "name": "計画書",8      "language": "ja_JP"9    }10  ],11  "enabled": true,12  "useFormDesigner": true,13  "components": [14    {15      "componentType": "CP_TEXT",16      "componentName": "一行テキスト",17      "componentId": "f230ab03-59a3-0050-e7f5-3fd20d30d711",18      "componentCustomId": "custom_001",19      "componentLabel": "名前",20      "attributes": [21        {22          "attributeType": "CP_COMMON",23          "attributeId": "001",24          "attributeName": "名前",25          "attributeValue": {26            "value": "価格"27          }28        },29        {30          "attributeType": "CP_COMMON",31          "attributeId": "002",32          "attributeName": "説明",33          "attributeValue": {34            "value": "商品の価格を入力してください。"35          }36        },37        {38          "attributeType": "CP_COMMON",39          "attributeId": "003",40          "attributeName": "必須項目に設定",41          "attributeValue": {42            "value": "Y"43          }44        },45        {46          "attributeType": "CP_COMMON",47          "attributeId": "004",48          "attributeName": "カスタムID",49          "attributeValue": {50            "value": "custom_001"51          }52        },53        {54          "attributeType": "CP_TEXT",55          "attributeId": "001",56          "attributeName": "最大文字数",57          "attributeValue": {58            "value": "10"59          }60        },61        {62          "attributeType": "CP_TEXT",63          "attributeId": "002",64          "attributeName": "入力できる値",65          "attributeValue": {66            "items": [67              {68                "itemId": "001",69                "itemName": "文字"70              }71            ]72          }73        },74        {75          "attributeType": "CP_TEXT",76          "attributeId": "003",77          "attributeName": "最大文字数の設定",78          "attributeValue": {79            "items": [80              {81                "itemId": "002",82                "itemName": "設定"83              }84            ]85          }86        }87      ]88    }89  ]90}