API 요청
Request Headers
| 헤더명 | 설명 | 필수여부 |
|---|---|---|
| Content-Type | API 요청에 대한 타입 | appliation/json |
| api-authorization-key | API 요청에 대한 키 | Y |
Request Parameters
| 요청 변수 | 설명 | 타입 | 필수여부 |
|---|---|---|---|
| equipKey | 장치에 대한 고유키 | number | N |
| codeKey | 장치 분류에 대한 키 | string | N |
| equipModelId | 장치에 대한 모델명 | string | N |
| createId | 최초등록자 | string | N |
Response: Success
| 필드 | 설명 | 타입 |
|---|---|---|
| DATA.RESULT | API 요청에 대한 결과 | boolean |
| DATA.DATA.EQUIP_KEY | 장치에 대한 고유키 | number |
| DATA.DATA.CODE_KEY | 장치 분류에 대한 고유 키 | number |
| DATA.DATA.EQUIP_TYPE | 장치 분류명 | string |
| DATA.DATA.EQUIP_NM | 장치 이름 | string |
| DATA.DATA.EQUIP_MODEL_ID | 장치 모델명 | string |
| DATA.DATA.EQUIP_MANU_ID | 장치 제조사 | string |
| DATA.DATA.PROP_VAL1 | 장치에 대한 1번 값 | array/string |
| DATA.DATA.PROP_VAL2 | 장치에 대한 2번 값 | array/string |
| DATA.DATA.PROP_VAL3 | 장치에 대한 3번 값 | array/string |
| DATA.DATA.PROP_VAL4 | 장치에 대한 4번 값 | array/string |
| DATA.DATA.PROP_VAL5 | 장치에 대한 5번 값 | array/string |
| DATA.DATA.PROP_VAL6 | 장치에 대한 6번 값 | array/string |
| DATA.DATA.PROP_VAL7 | 장치에 대한 7번 값 | array/string |
| DATA.DATA.PROP_VAL8 | 장치에 대한 8번 값 | array/string |
| DATA.DATA.PROP_VAL9 | 장치에 대한 9번 값 | array/string |
| DATA.DATA.PROP_VAL10 | 장치에 대한 10번 값 | array/string |
| DATA.DATA.OBJECT3D_DEFAULT_SET | 3D오브젝트 기본 세트 명 | string |
| DATA.DATA.MATERIAL_DEFAULT_SET | 메테리얼 기본 세트 명 | string |
| DATA.DATA.CREATE_ID | 최초등록자 | string |
| DATA.DATA.UPDATE_ID | 최종수정자 | string |
| DATA.DATA.CREATE_DT | 최초등록일시 | string |
| DATA.DATA.UPDATE_DT | 최종수정일시 | string |
| DATA.DATA.PROP_INFO.PROP_INFO_KEY | 장치 속성에 대한 고유 키 | number |
| DATA.DATA.PROP_INFO.CODE_KEY | 장치 분류에 대한 고유 키 | number |
| DATA.DATA.PROP_INFO.PROP_ORDER | 장치 분류 순서 | string |
| DATA.DATA.PROP_INFO.PROP_NAME | 장치 분류 명 | string |
| DATA.DATA.PROP_INFO.DATA_TYPE | 장치 분류 유형 | string |
| DATA.DATA.PROP_INFO.DATA_MIN_LENGTH | 장치 값에 대한 최소 길이 | number |
| DATA.DATA.PROP_INFO.DATA_MAX_LENGTH | 장치 값에 대한 최대 길이 | number |
| DATA.DATA.PROP_INFO.DATA_REQUIRED | 장치 값에 대한 필수 여부 | string |
| DATA.DATA.PROP_INFO.DATA_REGEX | 장치 값에 대한 정규식 BASE64 | string |
| DATA.DATA.PROP_INFO.DATA_REGEX_TAG | 장치 값에 대한 정규식 태그 | string |
| DATA.DATA.PROP_INFO.DATA_REF_OBJ | 장치 값에 대한 참조 대상 | string |
| DATA.DATA.PROP_INFO.DATA_REF_VAL | 장치 값에 대한 참조 값 | string |
| DATA.DATA.PROP_INFO.DATA_INFO_MESSAGE | 장치 값에 대한 규칙 설명 메시지 | string |
| DATA.DATA.PROP_INFO.USE_YN | 장치 속성에 대한 사용 여부 | string |
| DATA.DATA.PROP_INFO.CREATE_ID | 최초등록자 | string |
| DATA.DATA.PROP_INFO.UPDATE_ID | 최종수정자 | string |
| DATA.DATA.PROP_INFO.CREATE_DT | 최초등록일시 | string |
| DATA.DATA.PROP_INFO.UPDATE_DT | 최종수정일시 | string |
| DATA.DATA.FILE.ORIGINNAME | 장치와 관련된 파일 명 | string |
| DATA.DATA.FILE.NAME | 장치와 관련된 파일 세트명 | string |
| DATA.DATA.FILE.TYPE | 장치와 관련된 파일 세트 타입 | string |
| DATA.DATA.FILE.LINK | 장치와 관련된 파일 세트 다운로드 링크 | string |
Response: Fail
| 필드 | 설명 | 타입 |
|---|---|---|
| DATA.RESULT | API 요청에 대한 결과 | boolean |
| DATA.MESSAGE | 요청 실패에 대한 원인 메시지 | string |
오류 메시지 설명
| HTTP 상태 코드 | 메시지 | 설명 |
|---|---|---|
| 401 | API AUTHORIZATION KEY IS EMPTY | API 키를 포함하지 않고 요청함 |
| 403 | NOT ALLOWED TYPE CURRENT API KEY | 신청 시 사용 범위에 포함되지 않은 API를 호출하려 함 |
| 403 | NOT AUTHORIZED TO ACCESS API | 승인되지 않았거나 API 키 정보가 없음 |
| 500 | API SERVICE OCCURED ERROR. PLEASE TRY AGAIN. | API 서비스에서 오류 발생. 일정시간 뒤 재시도 필요 |
| 400 | INVALID PARAMETER | 필수 파라미터가 존재하지 않음 |
| 200 | NOT FOUND DATA | 존재하지 않은 데이터를 수정, 삭제하려 함 |
| 403 | PERMISSION DENIED | 본인이 등록하지 않은 데이터를 수정, 삭제하려함 |
| 200 | ACCOUNT INFORAMTION IS INVALID | 로그인 정보가 올바르지 않음 |
| 200 | DISABLED ACCOUNT | 활성되지 않은 계정 |