콘텐츠로 이동

조회



GET /api/v1/field_cfg/{field_uuid}/get

개요

현재 워크스페이스의 유효한 필드 구성 한 건에 저장된 값을 읽습니다.

호출 전 준비 및 사용 단계

대상 워크스페이스의 API Key를 사용합니다. 이 구성은 기존 필드에 표시 별칭, 설명, 단위, 분류를 추가하며, 수집 필드를 생성하거나 실제 데이터 유형을 변경하거나 과거 데이터를 백필하지 않습니다. 필드 소스가 같고 이름의 대소문자까지 완전히 동일한 사용자 정의 구성은 중복될 수 없으며, 소스가 다르면 같은 이름을 사용할 수 있습니다.

먼저 필드 목록에서 sysField=0인 uuid를 가져온 후 상세를 호출합니다. 이 API는 현재 워크스페이스 UUID와 status=0 조건으로만 읽으며, 시스템 워크스페이스의 내장 필드를 병합하지 않습니다. 상세는 저장된 호환 필드와 다국어 매핑을 그대로 반환하며, 목록처럼 요청 언어에 따라 alias/desc를 재작성하지 않습니다. creatorInfo/updatorInfo는 추가하지 않습니다.

경로 파라미터

파라미터명 유형 필수 설명
field_uuid string Y 현재 워크스페이스의 유효한 필드 구성 UUID입니다. 내장 구성은 일반적으로 시스템 워크스페이스에 속하므로, 목록에서 보인다고 해서 현재 워크스페이스에서 상세를 읽을 수 있는 것은 아닙니다.
예시: field_example
가져오기 또는 입력 방법: 필드 목록에서 sysField=0인 대상 행의 uuid를 읽으며, 필드 이름은 사용하지 않습니다.

요청 헤더

파라미터명 유형 필수 설명
DF-API-KEY string Y 워크스페이스의 OpenAPI 인증 자격 증명입니다.
예시: <DF-API-KEY>
가져오기 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 해당 작업 권한이 있는 OpenAPI Key를 가져옵니다.

파라미터 추가 설명

구성 상세를 반환하며, 해당 필드의 비즈니스 데이터를 읽는 것이 아닙니다.

요청 예시

curl --get 'https://openapi.guance.com/api/v1/field_cfg/field_example/get' \
  -H 'DF-API-KEY: <DF-API-KEY>'

응답

HTTP 200, application/json입니다. 아래 예시는 바로 읽을 수 있는 주요 필드를 보여줍니다.

필드 유형 설명
content.id integer 레코드 번호이며 API 주소 지정에는 사용되지 않습니다.
content.workspaceUUID string 구성이 속한 워크스페이스입니다. 내장 구성은 시스템 워크스페이스에 속합니다.
content.status integer 레코드 상태이며 정상은 0, 소프트 삭제는 3입니다. 본 상세는 유효하고 현재 워크스페이스에 속한 레코드만 반환합니다.
content.deleteAt integer 삭제 시간(Unix 초)이며, 삭제되지 않은 경우 -1입니다.
content.declaration object 현재 호출 워크스페이스의 공용 선언입니다.
content.uuid string 필드 구성 UUID이며, 이후 작업에서 이 값을 사용합니다. 실제 필드 이름이 아닙니다.
content.name string 실제 필드 이름이며 대소문자를 구분합니다.
content.alias string 별칭입니다. 목록에서는 요청 언어에 따라 표시하고, 상세/생성/수정에서는 호환 필드 값을 유지합니다.
content.aliasEn string 호환용 영문 별칭이며, 중국어로 대체될 수 있습니다.
content.aliasI18n object 또는 null 과거에 저장된 다국어 매핑을 그대로 반환합니다. null, {} 또는 일부 언어 키만 포함할 수 있으며, 목록의 6개 언어 정규화를 수행하지 않습니다.
content.desc string 설명입니다. 목록에서는 요청 언어에 따라 표시하고, 그 외 응답에서는 호환 필드 값을 사용합니다.
content.descEn string 호환용 영문 설명이며, 중국어로 대체될 수 있습니다.
content.descI18n object 또는 null 과거에 저장된 다국어 매핑을 그대로 반환합니다. null, {} 또는 일부 언어 키만 포함할 수 있으며, 목록의 6개 언어 정규화를 수행하지 않습니다.
content.fieldType string 구성된 데이터 유형이며, 실제 수집 필드 유형을 변경하지 않습니다. 과거 내장 레코드는 새 Body 외의 값을 가질 수 있습니다.
content.fieldSource string 적용 소스이며, 빈 문자열은 공용 구성을 의미합니다.
content.unit string 표시 단위입니다. fieldType=string인 경우 저장 시 강제로 비어 있습니다.
content.sysField integer 1은 내장, 0은 사용자 정의입니다. 내장 구성은 이 API로 수정/삭제할 수 없습니다.
content.category string system 시스템 필드, business 비즈니스 필드, other 기타이며, 오래된 레코드는 비어 있을 수 있습니다.
content.creator string 생성 주체이며 API Key 또는 시스템 주체일 수 있습니다.
content.updator string 수정 주체이며, 아직 수정되지 않은 경우 빈 문자열입니다.
content.createAt integer 생성 시간(Unix 초)입니다.
content.updateAt integer 수정 시간(Unix 초)이며, 아직 수정되지 않은 경우 -1일 수 있습니다.
content.aliasI18n.zh string zh 언어의 원본 별칭이며, 제공되지 않은 경우 일반적으로 비어 있습니다. 목록 표시 시 언어에 따라 대체됩니다. 상세는 저장 값을 그대로 반환하며 이 키는 생략될 수 있으므로, 먼저 상위 객체와 키의 존재 여부를 확인해야 합니다.
content.aliasI18n.en string en 언어의 원본 별칭이며, 제공되지 않은 경우 일반적으로 비어 있습니다. 목록 표시 시 언어에 따라 대체됩니다. 상세는 저장 값을 그대로 반환하며 이 키는 생략될 수 있으므로, 먼저 상위 객체와 키의 존재 여부를 확인해야 합니다.
content.aliasI18n.zh-hant string zh-hant 언어의 원본 별칭이며, 제공되지 않은 경우 일반적으로 비어 있습니다. 목록 표시 시 언어에 따라 대체됩니다. 상세는 저장 값을 그대로 반환하며 이 키는 생략될 수 있으므로, 먼저 상위 객체와 키의 존재 여부를 확인해야 합니다.
content.aliasI18n.id string id 언어의 원본 별칭이며, 제공되지 않은 경우 일반적으로 비어 있습니다. 목록 표시 시 언어에 따라 대체됩니다. 상세는 저장 값을 그대로 반환하며 이 키는 생략될 수 있으므로, 먼저 상위 객체와 키의 존재 여부를 확인해야 합니다.
content.aliasI18n.ja string ja 언어의 원본 별칭이며, 제공되지 않은 경우 일반적으로 비어 있습니다. 목록 표시 시 언어에 따라 대체됩니다. 상세는 저장 값을 그대로 반환하며 이 키는 생략될 수 있으므로, 먼저 상위 객체와 키의 존재 여부를 확인해야 합니다.
content.aliasI18n.ko string ko 언어의 원본 별칭이며, 제공되지 않은 경우 일반적으로 비어 있습니다. 목록 표시 시 언어에 따라 대체됩니다. 상세는 저장 값을 그대로 반환하며 이 키는 생략될 수 있으므로, 먼저 상위 객체와 키의 존재 여부를 확인해야 합니다.
content.descI18n.zh string zh 언어의 원본 설명이며, 제공되지 않은 경우 일반적으로 비어 있습니다. 목록 표시 시 언어에 따라 대체됩니다. 상세는 저장 값을 그대로 반환하며 이 키는 생략될 수 있으므로, 먼저 상위 객체와 키의 존재 여부를 확인해야 합니다.
content.descI18n.en string en 언어의 원본 설명이며, 제공되지 않은 경우 일반적으로 비어 있습니다. 목록 표시 시 언어에 따라 대체됩니다. 상세는 저장 값을 그대로 반환하며 이 키는 생략될 수 있으므로, 먼저 상위 객체와 키의 존재 여부를 확인해야 합니다.
content.descI18n.zh-hant string zh-hant 언어의 원본 설명이며, 제공되지 않은 경우 일반적으로 비어 있습니다. 목록 표시 시 언어에 따라 대체됩니다. 상세는 저장 값을 그대로 반환하며 이 키는 생략될 수 있으므로, 먼저 상위 객체와 키의 존재 여부를 확인해야 합니다.
content.descI18n.id string id 언어의 원본 설명이며, 제공되지 않은 경우 일반적으로 비어 있습니다. 목록 표시 시 언어에 따라 대체됩니다. 상세는 저장 값을 그대로 반환하며 이 키는 생략될 수 있으므로, 먼저 상위 객체와 키의 존재 여부를 확인해야 합니다.
content.descI18n.ja string ja 언어의 원본 설명이며, 제공되지 않은 경우 일반적으로 비어 있습니다. 목록 표시 시 언어에 따라 대체됩니다. 상세는 저장 값을 그대로 반환하며 이 키는 생략될 수 있으므로, 먼저 상위 객체와 키의 존재 여부를 확인해야 합니다.
content.descI18n.ko string ko 언어의 원본 설명이며, 제공되지 않은 경우 일반적으로 비어 있습니다. 목록 표시 시 언어에 따라 대체됩니다. 상세는 저장 값을 그대로 반환하며 이 키는 생략될 수 있으므로, 먼저 상위 객체와 키의 존재 여부를 확인해야 합니다.
{
  "code": 200,
  "content": {
    "id": 10,
    "uuid": "field_example",
    "workspaceUUID": "wksp_example",
    "name": "host",
    "alias": "主机",
    "aliasEn": "Host",
    "aliasI18n": {
      "zh": "主机",
      "en": "Host",
      "zh-hant": "主機",
      "id": "",
      "ja": "",
      "ko": ""
    },
    "desc": "主机名称",
    "descEn": "Host name",
    "descI18n": {
      "zh": "主机名称",
      "en": "Host name",
      "zh-hant": "主機名稱",
      "id": "",
      "ja": "",
      "ko": ""
    },
    "fieldType": "string",
    "fieldSource": "logging",
    "category": "business",
    "unit": "",
    "sysField": 0,
    "status": 0,
    "creator": "wsak_example",
    "updator": "",
    "createAt": 1785427200,
    "updateAt": -1,
    "deleteAt": -1,
    "declaration": {}
  },
  "errorCode": "",
  "message": "",
  "success": true,
  "traceId": "TRACE-EXAMPLE"
}

오류 응답

인증, 속도 제한 및 공용 요청 오류는 공용 오류 정의를 참고합니다.

HTTP 상태 errorCode 발생 조건 메시지 또는 응답 설명 처리 방법
400 ft.FieldNotFound UUID가 현재 워크스페이스에 속하지 않거나, 레코드가 없거나 삭제됨 지정된 필드를 찾을 수 없음 현재 워크스페이스 필드 목록에서 사용자 정의 구성 UUID를 가져옵니다. 시스템 워크스페이스 UUID로는 작업할 수 없습니다.
500 ft.InternalServerError 조회 또는 응답 포맷팅 실패 내부 오류 traceId를 보관한 후 재시도합니다. 계속 실패하면 관리자에게 문의합니다.

문서 평가

이 페이지가 도움이 되었나요?