콘텐츠로 이동

내보내기



GET /api/v1/objc_cfg/{objc_name}/export

개요

단일 리소스 카탈로그 구성을 JSON 템플릿으로 내보냅니다.

호출 전 및 사용 단계

라우트 권한은 routine.defaultAccess, anonymous.shared, anonymous.snapshotShared 중 하나를 충족해야 합니다. 이 API는 객체 데이터 조회를 수행하지 않으므로 이번 내보내기를 위해 infrastructure.Query를 추가로 신청할 필요가 없습니다.

GET은 JSON content 구성을 반환하며 CSV/파일 스트림/비동기 다운로드가 아닙니다. 템플릿 객체는 templateInfo에 사용하고 통합 응답 전체를 그대로 다시 채워 넣지 마십시오. 현재 워크스페이스 구성을 우선 사용하고, 없으면 워크스페이스 언어에 따라 사이트 템플릿으로 대체합니다. 현재 어느 쪽도 일치하지 않으면 요청한 분류명으로 합성된 최소 템플릿을 반환할 수 있으며, 404가 보장되지 않고 원래 분류에 데이터가 있다고 보장하지도 않습니다.

로컬 구성은 groupCfg.name을 내보내며, 다른 워크스페이스로 가져올 때는 먼저 그룹 UUID를 명확히 해야 이름 호환 오류를 피할 수 있습니다. 시스템 템플릿은 추가 메타데이터와 여러 main 항목을 유지할 수 있습니다. 업로드된 사용자 정의 시스템 템플릿의 source는 여전히 레거시 문자열/배열일 수 있으므로, 다시 채우기 전에 key(및 선택적 name)를 포함한 객체로 변환하고 동적 필드를 항목별로 확인하십시오. 공개 생성/수정은 첫 번째 항목만 사용합니다. 이 페이지는 읽기 전용이며 삭제 또는 보고 필드 동기화를 수행하지 않습니다.

라우트 파라미터

파라미터 이름 유형 필수 설명
objc_name string Y 삭제 시 Body 필수; 경로 내보내기/수정은 동일한 분류명을 사용하며, 이름은 보고하는 class와 일치하게 유지하고 경로를 URL 인코딩합니다. 별칭은 표시만 제어하며 대상 이름으로 사용되지 않습니다.
예: example_resources
가져오기 또는 입력 방법: 리소스 카탈로그 목록content[].name에서 분류 코드를 가져오며, objc_ 구성 UUID 또는 alias가 아닙니다.

요청 헤더

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

Query 요청 파라미터

파라미터 이름 유형 필수 설명
sourceType string Y 공개 시 필수이며 object/custom_object만 지원합니다. 공유 내부 함수의 *_history는 지원하지 않습니다. 생성 시 실제로 templateInfo.main[0].class를 사용하므로 반드시 이 필드와 일치해야 합니다. 수정/읽기에서는 구성 유형을 선택하는 데 사용됩니다. 공개 삭제는 custom_object만 가능하며 컨트롤러가 이 유형으로 고정합니다.
null 허용: False
선택 가능 값: ['object', 'custom_object']
예: custom_object
가져오기 또는 입력 방법: 시스템 객체는 object, 사용자 정의 리소스 객체는 custom_object를 선택하며, 실제 보고 데이터 소스를 사용합니다.

요청 예시

curl --get 'https://openapi.guance.com/api/v1/objc_cfg/example_resources/export' \
  -H 'DF-API-KEY: <DF-API-KEY>' \
  --data-urlencode sourceType=custom_object

응답

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

필드 유형 설명
content.main 객체 배열 생성/수정 시 다시 채울 수 있는 템플릿 배열입니다. 로컬 합성은 보통 단일 항목이며, 시스템 템플릿은 원본 배열을 유지할 수 있습니다.
content.main[].class string object/custom_object 데이터 유형입니다.
content.main[].source object 또는 string 또는 array 분류 위치 지정 및 표시 이름입니다. 로컬 구성은 객체로 합성되며, 업로드된 사용자 정의 시스템 템플릿은 레거시 문자열/배열을 유지할 수 있으므로 다시 채우기 전에 key를 포함한 객체로 정규화하십시오.
content.main[].source.key string source가 객체일 때의 실제 분류명입니다. 레거시 문자열/배열 분기에서는 생략될 수 있습니다.
content.main[].source.name string source가 객체일 때의 조건부 별칭입니다. 로컬 합성에서 구성되지 않은 경우 분류명으로 대체되며, 레거시 템플릿에서는 생략될 수 있습니다.
content.main[].기타 템플릿 필드 JSON 사용자 정의 업로드 시스템 템플릿은 동적 확장 필드와 원본 구조를 유지할 수 있습니다. 이 페이지의 생성/수정에서 사용하는 필드만 다시 채우며, 인식되지 않은 필드를 저장되었거나 검증된 것으로 간주하지 않습니다.
content.main[].groupCfg object 비즈니스 그룹 내보내기 구성이며, 그룹이 없으면 {}입니다.
content.main[].groupCfg.name string 그룹이 있을 때의 이름이며 UUID가 아닙니다.
content.main[].fields 객체 배열 필드 정의입니다.
content.main[].fields[].name string 실제 보고 필드 이름입니다. name은 필수이며 중복될 수 없고, 필드 명명 규칙을 따릅니다.
content.main[].fields[].alias string 선택적 표시 별칭입니다.
content.main[].filters 객체 배열 빠른 필터입니다.
content.main[].filters[].key string 필터 필드입니다.
content.main[].groups array 동적 표시 그룹입니다.
content.main[].groups[] JSON 원본 동적 그룹 항목입니다.
content.main[].fills array 동적 채우기 구성입니다.
content.main[].fills[] JSON 원본 동적 채우기 항목입니다.
content.main[].table object 목록/상세 보기입니다.
content.main[].table.columns 객체 배열 목록 열입니다.
content.main[].table.columns[].key string 열 필드입니다.
content.main[].table.detail object 상세 구성입니다.
content.main[].table.detail.views 객체 배열 탭 구성입니다.
content.title string 별칭/분류명이며, 시스템 템플릿은 원본 값을 사용합니다.
content.summary string 로컬 합성 시 빈 문자열이며, 시스템 템플릿은 원본 값을 사용합니다.
content.iconSet object 또는 null 아이콘입니다. 사용 가능한 값이 없으면 null일 수 있습니다.
content.iconSet.icon string 조건부 아이콘 식별자입니다.
content.iconSet.url string 조건부 아이콘 리소스 URL입니다.
content.declaration object 외부 공통 선언입니다. templateInfo에 다시 채울 때 통합 래퍼는 포함하지 않습니다.
content.main[].table.detail.views[].title string 탭 제목입니다.
content.main[].table.detail.views[].viewType string component/dashboard입니다.
content.main[].table.detail.views[].viewName string 내장 페이지 경로 또는 내장 뷰 이름입니다.
content.main[].table.detail.views[].required boolean keys에 따라 표시 여부를 결정합니다.
content.main[].table.detail.views[].keys object 동적으로 일치시킬 필드/값입니다.
content.main[].table.detail.views[].keys.필드명 JSON 일치 값/존재 표시 *입니다.
content.main[].table.detail.views[].timerange string 또는 문자열 배열 default/상대 기간/전후 오프셋 배열입니다.
content.main[].table.detail.views[].timerange[] string 단일 전/후 오프셋 기간입니다.
{
  "code": 200,
  "content": {
    "main": [
      {
        "class": "custom_object",
        "source": {
          "key": "example_resources",
          "name": "示例资源目录"
        },
        "groupCfg": {},
        "fields": [
          {
            "name": "name",
            "alias": "资源名称"
          }
        ],
        "filters": [
          {
            "key": "env"
          }
        ],
        "groups": [],
        "fills": [],
        "table": {
          "columns": [
            {
              "key": "name"
            }
          ],
          "detail": {
            "views": []
          }
        }
      }
    ],
    "title": "示例资源目录",
    "summary": "",
    "iconSet": {},
    "declaration": {}
  },
  "errorCode": "",
  "message": "",
  "success": true,
  "traceId": "TRACE-EXAMPLE"
}

오류 응답

인증, 속도 제한 및 공통 요청 오류는 공통 오류 정의를 참조하십시오.

현재 API Key 워크스페이스의 구성만 수정/내보내기할 수 있습니다. 목록은 권한이 부여된 대상 워크스페이스에 대해 카운트할 수 있지만, 표시 구성은 여전히 현재 워크스페이스입니다. 인터페이스에는 freeEdition 버전 선언이 있으며, 공통 OpenAPI 인증은 이 라우트에서 해당 버전 검사를 수행하지 않으므로 버전 자체를 고정 403으로 작성하지 않습니다. 업스트림 4xx 조회는 실제 Kodo/권한 매핑에 따릅니다. 일반 5xx는 최종적으로 500 ft.InternalServerError가 됩니다.

HTTP 상태 errorCode 트리거 조건 메시지 또는 응답 설명 처리 방법
406 ft.ParameterValidationFailed 요청 필드가 누락되었거나 필드 값이 선언된 검증 조건을 위반했습니다. 파라미터 파싱 실패 파라미터 위치, 필드 이름, 유형 및 값을 확인하십시오.
404 ft.NotFoundObjcGroupObj 로컬 구성에서 참조하는 비즈니스 그룹이 더 이상 존재하지 않습니다. 지정한 리소스 분류 그룹을 찾을 수 없습니다. 해당 카탈로그의 그룹 연관 관계를 확인하고 수정한 후 다시 내보내십시오. 카탈로그 자체를 찾지 못한 경우 이 오류가 반드시 발생하는 것은 아닙니다.
500 ft.InternalServerError 단일 카탈로그 구성, 시스템 템플릿 또는 연관 그룹 읽기 및 내보내기 형식 지정 중 처리되지 않은 예외가 발생했습니다. 내부 오류 해당 분류의 이전 구성, 템플릿 구조 및 그룹 연관 관계를 확인하고 traceId를 보존한 후 제한적으로 재시도하십시오. 이 페이지는 읽기 전용이며 이번 구성 쓰기를 수행하지 않습니다.

문서 평가

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