GET/business-support/approval/document-forms/{documentFormId}

특정 결재 서식을 조회한다.

Authorization

oauth2

OAuth 2.0 인증.
자세한 인증 방식은 인가·인증을 참고한다.

Scope

businessSupport.approval
businessSupport.approval.read

HTTP Request

GEThttps://www.worksapis.com/v1.0/business-support/approval/document-forms/{documentFormId}

Path Parameters

ParameterTypeDescription
documentFormId string 

결재 서식 코드


required 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Response

HTTP 200

OK

PropertyTypeDescription
categoryId integer 

카테고리 ID

 
documentFormId string 

결재 서식 코드

 
documentFormName string 

결재 서식명

 
i18nNames array (i18nName) 

다국어 목록 정보.
Admin > 기본환경 > 회사 정보 > 다국어 설정에서 지정된 항목의 다국어만 표시된다.

 
enabled boolean 

결재 서식 사용 여부

 
useFormDesigner boolean 

회사 생성 결재 서식 여부

 
components array (Component) 

회사 생성 결재 서식이면 컴포넌트 정보가 전달된다.

 

i18nName

PropertyTypeDescription
name string 

다국어 이름


required
minLength : 1
maxLength : 100 
language string 

다국어 언어 코드


required
Allowed values : ko_KR, en_US, ja_JP, 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": "ko_KR"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}