서식 상세 조회 v2
- 인쇄
- PDF
서식 상세 조회 v2
- 인쇄
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
설명
고객사에서 서식 생성기로 직접 생성한 서식 중 특정 서식의 상세 정보를 조회합니다.
요청 헤더 공통
| Header | Description |
|---|---|
| x-ncp-apigw-timestamp | - 1970년 1월 1일 00:00:00 협정 세계시(UTC)부터의 경과 시간을 밀리초(Millisecond)로 나타낸 것 - API Gateway 서버와 시간 차가 5분 이상 나는 경우 유효하지 않은 요청으로 간주 |
| x-ncp-iam-access-key | - 네이버 클라우드 플랫폼 포털 또는 Sub Account에서 발급받은 Access Key ID |
| x-ncp-apigw-signature-v2 | - 위 예제의 Body를 Access Key ID와 맵핑되는 Secret Key로 암호화한 서명 - HMAC 암호화 알고리즘은 HmacSHA256 사용 |
서식생성기 서식 조회 API
서식의 구성 정보를 조회합니다.
요청 URL
GET https://workplace.apigw.ntruss.com/workflow/apigw/v2/company/{companyId}/fg/{dfmId}
요청 헤더
| Header | Description |
|---|---|
| x-ncp-apigw-timestamp | - 1970년 1월 1일 00:00:00 협정 세계시(UTC)부터의 경과 시간을 밀리초(Millisecond)로 나타낸 것 - API Gateway 서버와 시간 차가 5분 이상 나는 경우 유효하지 않은 요청으로 간주 |
| x-ncp-iam-access-key | - 네이버 클라우드 플랫폼 포털 또는 Sub Account에서 발급받은 Access Key ID |
| x-ncp-apigw-signature-v2 | - 위 예제의 Body를 Access Key ID와 맵핑되는 Secret Key로 암호화한 서명 - HMAC 암호화 알고리즘은 HmacSHA256 사용 |
요청 Path 파라미터
| 파라미터 | 타입 | 크기 | 필수 여부 | 설명 |
|---|---|---|---|---|
| companyId | String | 36 | Y | 연동키(CompanyId) Developers > 기본 설정 > 연동키 |
| dfmId | String | 36 | Y | 서식ID |
요청 예시
GET https://workplace.apigw.ntruss.com/workflow/apigw/v2/company/187d83ad-4038-45b6-8e7c-59eca16fdc46/fg/61d6850b-99d6-45fe-a166-d5c38e45f272
GET /workflow/apigw/v2/company/187d83ad-4038-45b6-8e7c-59eca16fdc46/fg/61d6850b-99d6-45fe-a166-d5c38e45f272
HOST: workplace.apigw.ntruss.com
Content-Type: application/json
x-ncp-apigw-timestamp: 1505290625682
x-ncp-iam-access-key: D78BB444D6D3C84CA38A
x-ncp-apigw-signature-v2: WTPItrmMIfLUk/UyUIyoQbA/z5hq9o3G8eQMolUzTEo=
응답 예시
HTTP/1.1 200 OK
Server: nginx
Date: Wed, 12 Sep 2020 01:18:11 GMT
Content-Type: application/json;charset=utf-8
Transfer-Encoding: chunked
Connection: keep-alive
Access-Control-Allow-Origin: *
x-ncp-trace-id: 68d1o68pm4cr63gc3169gm4p34
{
"category": "c45b70b9-96b3-11eb-affc-0050568509e9",
"dfm_nm": {
"ko_KR": "",
"en_US": "",
"ja_JP": "",
"default_val": "일일보고서"
},
"save_time": "2021.06.02 18:15:57",
"items": [
{
"compCode": "CP_TEXT",
"compName": "텍스트",
"uuid": "0b1db6ba-1d0e-3b15-b09f-b573d0c4d791",
"attrItem": {
"compCode": "CP_COMMON",
"compConfigCode": "001",
"compConfigName": "이름",
"attrType": "ATextField",
"attrCode": "",
"attrValue": {
"ko_KR": "",
"en_US": "",
"ja_JP": "",
"default_val": "사업장"
}
}
},
{
"compCode": "CP_TEXT",
"compName": "텍스트",
"uuid": "8782fe52-df59-b86c-be9a-e41c0dbfa291",
"attrItem": {
"compCode": "CP_COMMON",
"compConfigCode": "001",
"compConfigName": "이름",
"attrType": "ATextField",
"attrCode": "",
"attrValue": {
"ko_KR": "",
"en_US": "",
"ja_JP": "",
"default_val": "건물"
}
}
},
{
"compCode": "CP_EDITOR",
"compName": "스마트 에디터",
"uuid": "d03c038f-3f05-12e7-adeb-8380e8778d22",
"attrItem": {
"compCode": "CP_COMMON",
"compConfigCode": "001",
"compConfigName": "이름",
"attrType": "ATextField",
"attrCode": "",
"attrValue": {
"ko_KR": "",
"en_US": "",
"ja_JP": "",
"default_val": "내용"
}
}
},
{
"compCode": "CP_HIDDEN_TEXT",
"compName": "히든 텍스트",
"uuid": "32976b48-0234-0046-e13d-87f0fd678d7f",
"attrItem": {
"compCode": "CP_COMMON",
"compConfigCode": "001",
"compConfigName": "이름",
"attrType": "ATextField",
"attrCode": "",
"attrValue": {
"ko_KR": "",
"en_US": "",
"ja_JP": "",
"default_val": "히든 텍스트"
}
}
}
]
}
서식생성기 서식 상세조회 API
서식의 구성 정보를 상세히 조회합니다.
서식을 구성하는 컴포넌트별 속성값이 모두 제공됩니다.
요청 URL
GET https://workplace.apigw.ntruss.com/workflow/apigw/v2/company/{companyId}/fg/{dfmId}?detail=true
요청 헤더
| Header | Description |
|---|---|
| x-ncp-apigw-timestamp | - 1970년 1월 1일 00:00:00 협정 세계시(UTC)부터의 경과 시간을 밀리초(Millisecond)로 나타낸 것 - API Gateway 서버와 시간 차가 5분 이상 나는 경우 유효하지 않은 요청으로 간주 |
| x-ncp-iam-access-key | - 네이버 클라우드 플랫폼 포털 또는 Sub Account에서 발급받은 Access Key ID |
| x-ncp-apigw-signature-v2 | - 위 예제의 Body를 Access Key ID와 맵핑되는 Secret Key로 암호화한 서명 - HMAC 암호화 알고리즘은 HmacSHA256 사용 |
요청 Path 파라미터
| 파라미터 | 타입 | 크기 | 필수 여부 | 설명 |
|---|---|---|---|---|
| companyId | String | 36 | Y | 연동키(CompanyId) Developers > 기본 설정 > 연동키 |
| dfmId | String | 36 | Y | 서식ID |
요청 파라미터
| 파라미터 | 타입 | 크기 | 필수 여부 | 설명 |
|---|---|---|---|---|
| detail | String | 36 | N | 상세 옵션 포함여부 (true) |
요청 예시
GET https://workplace.apigw.ntruss.com/workflow/apigw/v2/company/187d83ad-4038-45b6-8e7c-59eca16fdc46/fg/61d6850b-99d6-45fe-a166-d5c38e45f272?detail=true
GET /workflow/apigw/v2/company/187d83ad-4038-45b6-8e7c-59eca16fdc46/fg/61d6850b-99d6-45fe-a166-d5c38e45f272
HOST: workplace.apigw.ntruss.com
Content-Type: application/json
x-ncp-apigw-timestamp: 1505290625682
x-ncp-iam-access-key: D78BB444D6D3C84CA38A
x-ncp-apigw-signature-v2: WTPItrmMIfLUk/UyUIyoQbA/z5hq9o3G8eQMolUzTEo=
응답 예시
HTTP/1.1 200 OK
Server: nginx
Date: Wed, 12 Sep 2020 01:18:11 GMT
Content-Type: application/json;charset=utf-8
Transfer-Encoding: chunked
Connection: keep-alive
Access-Control-Allow-Origin: *
x-ncp-trace-id: 68d1o68pm4cr63gc3169gm4p34
{
"category": "a022520d-9bfb-11eb-9964-c64a936ef062",
"dfm_nm": {
"ko_KR": "",
"en_US": "",
"ja_JP": "",
"zh_CN": "",
"zh_TW": "",
"default_val": "일일보고서"
},
"save_time": "2021.05.26 12:06:59",
"items": [
{
"compLevelType": "BASIC",
"compCode": "CP_TEXT",
"compName": "텍스트",
"icon": "menu-thumb1",
"lang": "ko_KR",
"status": "USE",
"orderNum": "0",
"attrItems": [
{
"compCode": "CP_COMMON",
"compConfigCode": "001",
"compConfigName": "이름",
"attrType": "ATextField",
"attrCode": "",
"attrCodeItem": [],
"lang": "ko_KR",
"status": "USE",
"orderNum": "1",
"attrValue": {
"ko_KR": "",
"en_US": "",
"ja_JP": "",
"zh_CN": "",
"zh_TW": "",
"default_val": "시스템"
},
"uniqKey": 1621998048090
},
{
"compCode": "CP_COMMON",
"compConfigCode": "002",
"compConfigName": "설명",
"attrType": "ATextField",
"attrCode": "",
"attrCodeItem": [],
"lang": "ko_KR",
"status": "USE",
"orderNum": "2",
"attrValue": {
"ko_KR": "",
"en_US": "",
"ja_JP": "",
"zh_CN": "",
"zh_TW": "",
"default_val": null
},
"uniqKey": 1621998048090
},
{
"compCode": "CP_COMMON",
"compConfigCode": "003",
"compConfigName": "필수 항목으로 표시",
"attrType": "CheckBox",
"attrCode": "",
"attrCodeItem": [],
"lang": "ko_KR",
"status": "USE",
"orderNum": "3",
"attrValue": {
"value": ""
},
"uniqKey": 1621998048090
},
{
"compCode": "CP_COMMON",
"compConfigCode": "004",
"compConfigName": "사용자 지정 ID",
"attrType": "TextField",
"attrCode": "",
"attrCodeItem": [],
"lang": "ko_KR",
"status": "USE",
"orderNum": "4",
"attrValue": {
"value": "custom-uuid-001"
},
"uniqKey": 1643361787020
},
{
"compCode": "CP_TEXT",
"compConfigCode": "003",
"compConfigName": "최대 입력 글자수 설정",
"attrType": "Radio",
"attrCode": "CD039",
"attrCodeItem": [
{
"code": "001",
"value": "안함"
},
{
"code": "002",
"value": "관리자 설정"
}
],
"lang": "ko_KR",
"status": "USE",
"orderNum": "1",
"attrValue": [
{
"code": "001",
"value": "Y"
},
{
"code": "002",
"value": ""
}
],
"uniqKey": 1621998048090
},
{
"compCode": "CP_TEXT",
"compConfigCode": "001",
"compConfigName": "최대 입력 글자수",
"attrType": "NumberField",
"attrCode": "",
"attrCodeItem": [],
"lang": "ko_KR",
"status": "USE",
"orderNum": "2",
"attrValue": {
"value": ""
},
"uniqKey": 1621998048090
},
{
"compCode": "CP_TEXT",
"compConfigCode": "002",
"compConfigName": "입력 허용 값",
"attrType": "MultiCheckBox",
"attrCode": "CD001",
"attrCodeItem": [
{
"code": "001",
"value": "문자"
},
{
"code": "002",
"value": "숫자"
},
{
"code": "003",
"value": "특수기호"
}
],
"lang": "ko_KR",
"status": "USE",
"orderNum": "3",
"attrValue": [
{
"code": "001",
"value": "Y"
},
{
"code": "002",
"value": "Y"
},
{
"code": "003",
"value": "Y"
}
],
"uniqKey": 1621998048090
}
],
"uniqKey": 4,
"uuid": "ece162d7-058f-1368-bd85-36e7f66e4c41"
},
{
"compLevelType": "BASIC",
"compCode": "CP_EDITOR",
"compName": "스마트 에디터",
"icon": "menu-thumb16",
"lang": "ko_KR",
"status": "USE",
"orderNum": "1",
"attrItems": [
{
"compCode": "CP_COMMON",
"compConfigCode": "001",
"compConfigName": "이름",
"attrType": "ATextField",
"attrCode": "",
"attrCodeItem": [],
"lang": "ko_KR",
"status": "USE",
"orderNum": "1",
"attrValue": {
"ko_KR": "",
"en_US": "",
"ja_JP": "",
"zh_CN": "",
"zh_TW": "",
"default_val": "내용"
},
"uniqKey": 1621998069749
},
{
"compCode": "CP_COMMON",
"compConfigCode": "002",
"compConfigName": "설명",
"attrType": "ATextField",
"attrCode": "",
"attrCodeItem": [],
"lang": "ko_KR",
"status": "USE",
"orderNum": "2",
"attrValue": {
"ko_KR": "",
"en_US": "",
"ja_JP": "",
"zh_CN": "",
"zh_TW": "",
"default_val": null
},
"uniqKey": 1621998069750
},
{
"compCode": "CP_COMMON",
"compConfigCode": "003",
"compConfigName": "필수 항목으로 표시",
"attrType": "CheckBox",
"attrCode": "",
"attrCodeItem": [],
"lang": "ko_KR",
"status": "USE",
"orderNum": "3",
"attrValue": {
"value": ""
},
"uniqKey": 1621998069750
},
{
"compCode": "CP_COMMON",
"compConfigCode": "004",
"compConfigName": "사용자 지정 ID",
"attrType": "TextField",
"attrCode": "",
"attrCodeItem": [],
"lang": "ko_KR",
"status": "USE",
"orderNum": "4",
"attrValue": {
"value": ""
},
"uniqKey": 1643361787020
}
],
"uniqKey": 6,
"uuid": "f9d07675-fe21-b457-39a5-510ebef3c2fe"
},
{
"compLevelType": "BASIC",
"compCode": "CP_HIDDEN_TEXT",
"compName": "히든 텍스트",
"icon": "menu-thumb15",
"lang": "ko_KR",
"status": "USE",
"orderNum": "2",
"attrItems": [
{
"compCode": "CP_COMMON",
"compConfigCode": "001",
"compConfigName": "이름",
"attrType": "ATextField",
"attrCode": "",
"attrCodeItem": [],
"lang": "ko_KR",
"status": "USE",
"orderNum": "1",
"attrValue": {
"ko_KR": "",
"en_US": "",
"ja_JP": "",
"zh_CN": "",
"zh_TW": "",
"default_val": "히든 텍스트"
},
"uniqKey": 1621998383378
},
{
"compCode": "CP_COMMON",
"compConfigCode": "002",
"compConfigName": "설명",
"attrType": "ATextField",
"attrCode": "",
"attrCodeItem": [],
"lang": "ko_KR",
"status": "USE",
"orderNum": "2",
"attrValue": {
"ko_KR": "",
"en_US": "",
"ja_JP": "",
"zh_CN": "",
"zh_TW": "",
"default_val": null
},
"uniqKey": 1621998383378
},
{
"compCode": "CP_COMMON",
"compConfigCode": "003",
"compConfigName": "필수 항목으로 표시",
"attrType": "CheckBox",
"attrCode": "",
"attrCodeItem": [],
"lang": "ko_KR",
"status": "USE",
"orderNum": "3",
"attrValue": {
"value": ""
},
"uniqKey": 1621998383378
},
{
"compCode": "CP_COMMON",
"compConfigCode": "004",
"compConfigName": "사용자 지정 ID",
"attrType": "TextField",
"attrCode": "",
"attrCodeItem": [],
"lang": "ko_KR",
"status": "USE",
"orderNum": "4",
"attrValue": {
"value": ""
},
"uniqKey": 1643361787020
},
{
"compCode": "CP_HIDDEN_TEXT",
"compConfigCode": "001",
"compConfigName": "저장 시 출력 텍스트 설정",
"attrType": "Radio",
"attrCode": "CD017",
"attrCodeItem": [
{
"code": "001",
"value": "문서 저장 시간"
},
{
"code": "002",
"value": "직접 입력"
}
],
"lang": "ko_KR",
"status": "USE",
"orderNum": "1",
"attrValue": [
{
"code": "001",
"value": "N"
},
{
"code": "002",
"value": "Y"
}
],
"uniqKey": 1621998383378
},
{
"compCode": "CP_HIDDEN_TEXT",
"compConfigCode": "002",
"compConfigName": "저장 시 출력 텍스트",
"attrType": "TextField",
"attrCode": "",
"attrCodeItem": [],
"lang": "ko_KR",
"status": "USE",
"orderNum": "2",
"attrValue": {
"value": "API 입력"
},
"uniqKey": 1621998383378
},
{
"compCode": "CP_HIDDEN_TEXT",
"compConfigCode": "003",
"compConfigName": "작성자 부서/이름 노출",
"attrType": "CheckBox",
"attrCode": "",
"attrCodeItem": [],
"lang": "ko_KR",
"status": "USE",
"orderNum": "3",
"attrValue": {
"value": "N"
},
"uniqKey": 1621998383378
},
{
"compCode": "CP_HIDDEN_TEXT",
"compConfigCode": "004",
"compConfigName": "API 연동",
"attrType": "CheckBox",
"attrCode": "",
"attrCodeItem": [],
"lang": "ko_KR",
"status": "USE",
"orderNum": "4",
"attrValue": {
"value": "Y"
},
"uniqKey": 1621998383378
}
],
"uniqKey": 8,
"uuid": "7a030aeb-1f59-3edc-4418-2fa85c6e2ecc"
}
]
}
응답
HTTP 상태 코드로 리턴되고, Body 정보로 전달한다.
| HTTP 상태 코드 | 응답메시지 | 설명 |
|---|---|---|
| 200 | OK | 일반적인 요청 성공 |
| 201 | Created | 리소스 생성 성공에 대한 응답 코드 |
| 400 | Bad Request | 일반적인 요청 실패에 사용 |
| 500 | Internal Server Error | - 일반적인 서버 오류에 대한 응답 코드 - 4XX대의 오류 코드가 클라이언트 측 오류를 나타내기 위해 사용 - 5XX대의 오류 코드는 서버 측 오류를 나타내기 위해 사용 |
응답 예시
{
"status": 400,
"code": -4001,
"errors": [],
"message": "This is a duplicate login ID"
}
지원하는 언어 코드
| locale 코드 | 설명 |
|---|---|
| ko_KR | 한국어 |
| ja_JP | 일본어 |
| zh_CN | 중국어(간체) |
| zh_TW | 중국어(번체) |
| en_US | 영어 |
이 문서가 도움이 되었습니까?