콘텐츠로 이동

생성



POST /api/v1/objc_cfg/create

개요

리소스 카탈로그 표시 및 보고 필드 설정을 생성합니다.

호출 전 및 사용 단계

이 API는 API Key에 infrastructure.setManage 권한이 있어야 합니다.

생성 시 실제로는 templateInfo.main[0].class/source.key에서 유형/분류를 가져오며 첫 번째 항목만 처리합니다. 외부 sourceType은 필수로 선언되어 있지만 컨트롤러는 이 값으로 생성 유형을 결정하지 않으므로 반드시 두 위치가 일치해야 합니다. 기존에 동일한 유형과 동일한 이름의 설정이 있으면 중복 오류가 발생하며, 이전 주석의 "존재하면 덮어쓰기" 방식이 아닙니다. 업데이트하려면 수정을 사용하십시오.

생성 시 최종 fields에는 name이 반드시 포함되어야 하며 중복되어서는 안 되고, 외부 fields가 템플릿을 덮어씁니다. 선택 사항으로 선언되어 있더라도 외부 또는 템플릿에 유효한 배열을 제공해야 합니다. 실제로 필드를 제출하면 다운스트림 보고 필터가 동기화되며, 필수 필드가 누락된 데이터는 폐기될 수 있으므로 변경 전에 수집 측과 먼저 확인하십시오. object 유형 생성도 제출 후 custom_object 필터 동기화를 호출하므로 동일한 이름의 사용자 정의 객체 카탈로그 보고 필터에 영향을 줄 수 있습니다. 수정 시 fields를 전달해도 동일하게 처리되고 동기화됩니다. 시스템 object를 생성하기 전에 동일한 이름의 custom_object 및 해당 필수 필드를 확인해야 하며, 시스템 object에서 표시만 수정할 때는 fields(템플릿 내 fields 포함)를 제출하지 마십시오.

템플릿이 비어 있지 않은 main을 제공할 때 source.name을 누락하면 별칭이 비워질 수 있고, groups/fills를 누락하면 []로 설정됩니다. filters/columns/views를 생략하면 수정 전 값이 유지되고, []는 비웁니다. 아이콘 설정은 전체 단위로 저장됩니다. 템플릿 groupCfg.name으로 그룹 생성을 시도할 수 있지만, 동일한 이름의 그룹이 이미 있는 경우 호환 분기에서 500이 발생할 수 있으므로 이 워크스페이스의 objcGroupUUID를 명시적으로 채우는 것을 권장합니다. 빈 문자열은 그룹 없음을 명확히 합니다.

먼저 로컬 설정을 제출한 후 다운스트림 필터를 동기화합니다. 동기화에 실패하면 500을 반환할 수 있지만 로컬에는 이미 저장된 상태이므로, 먼저 목록/내보내기로 검증한 뒤 재시도하십시오. 성공 응답은 설정 엔터티이며 블랙리스트나 전체 템플릿이 아닙니다. 이 페이지에서는 수집이 보고되었는지/페이지가 렌더링되었는지 확인하지 않습니다.

요청 헤더

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

Body 요청 파라미터

파라미터명 유형 필수 설명
fields[*] json 권장 형식은 객체이며 비즈니스는 name을 읽습니다. 항목별 유형 검증은 하지 않으며, 잘못된 형태는 정돈된 비즈니스 오류 대신 500이 될 수 있습니다. 표시 확장 필드를 포함할 수 있으나 서버는 그 소비 효과를 일괄 검증하지 않습니다.
예시: {"name": "name", "alias": "资源名称"}
획득 또는 입력 방법: 실제 보고 필드 정의 1건입니다.
fields[*].name string 비어 있지 않아야 하며 ^[a-zA-Z]+[0-9a-zA-Z_]+$와 일치해야 합니다. 영문자로 시작하고 이후 숫자/영문자/_가 오며 최소 2자입니다. 동일 배열 내에서 중복될 수 없고, 점/중국어/단일 문자는 지원하지 않습니다.
예시: name
획득 또는 입력 방법: 필드명을 보고 키와 정확히 일치시키고 최소한 name을 포함합니다.
fields[*].alias string 선택적 표시 확장 항목으로 서버에서 일괄 강제 검증하지 않습니다. 생략해도 name 키의 필수성에는 영향이 없습니다.
예시: 资源名称
획득 또는 입력 방법: 고객이 선택한 필드 표시 별칭 또는 원래 내보내기 값입니다.
templateInfo.title string 선택 사항이며 현재 생성/수정 시 이 입력은 저장되지 않습니다. 로컬 설정 내보내기의 title은 alias/name으로 합성되며, 이 값을 수정해도 분류명, 별칭 또는 내보내기 제목은 변경되지 않습니다.
예시: 示例资源目录
획득 또는 입력 방법: 원래 내보낸 템플릿의 제목입니다.
templateInfo.summary string 선택 사항이며 현재 생성/수정 시 리소스 카탈로그 엔터티 설명으로 저장되지 않습니다. 200 응답만 보고 저장되었다고 판단하지 마십시오.
예시:
획득 또는 입력 방법: 원래 내보낸 템플릿의 요약입니다.
templateInfo.iconSet json 생성 시 기본값은 {}입니다. 수정 시 생략하면 유지되고 {}는 비웁니다. 동적 객체는 템플릿/UI에서 소비되며 아이콘 URL의 유효성을 일괄 검증하지 않습니다.
예시: {}
획득 또는 입력 방법: 원래 내보낸 아이콘 설정 또는 비즈니스에서 선택한 유효한 아이콘 정보입니다.
templateInfo.iconSet.icon string 선택적 예시 키이며 임의의 모든 열거 값을 지원하는 것은 아닙니다. 실제 UI 아이콘에 맞게 선택하십시오.
예시: database
획득 또는 입력 방법: 기존 템플릿에서 지원하는 아이콘 식별자입니다.
templateInfo.iconSet.url string 선택 사항이며 서버는 이 지점에서 요청을 보내 검증하지 않습니다. 자격 증명 URL을 넣지 마십시오.
예시: https://example.com/resource-icon.svg
획득 또는 입력 방법: 고객이 접근할 수 있는 유효한 아이콘 리소스 URL입니다.
templateInfo.main array 생성 시 비즈니스상 최소 1개 항목이 필요합니다. 첫 번째 항목만 적용되며 여러 분류를 일괄 생성하지 않습니다. 수정 시 제공하지 않으면 대부분의 표시 필드가 유지되지만, 제공한 경우 기본 초기화 동작을 확인해야 합니다.
예시: [{}]
획득 또는 입력 방법: 내보낸 템플릿의 main 배열을 전체 백업합니다.
templateInfo.main[*] json 인덱스 0만 소비되므로 1개 항목만 두는 것을 권장합니다.
예시: {}
획득 또는 입력 방법: 단일 리소스 카탈로그 템플릿입니다.
templateInfo.main[*].class string 생성 시 실제 소스 유형이며 생략하면 기본값은 custom_object입니다. 공개 동적 템플릿은 열거 검증을 일괄 수행하지 않으므로 다른 값은 저장 실패로 500이 될 수 있습니다. 수정 시 이 값은 무시되고 실제 유형은 외부 sourceType을 사용합니다.
예시: custom_object
획득 또는 입력 방법: 외부 sourceType 및 실제 데이터 유형과 일치시킵니다.
templateInfo.main[*].source json 생성 시 유효한 객체가 필수이며, 수정 시에는 source.name만 별칭으로 읽고 경로 분류 코드는 변경하지 않습니다. 구 시스템 템플릿의 문자열 source를 그대로 채우지 말고 먼저 객체로 변환하십시오.
예시: {"key": "example_resources", "name": "示例资源目录"}
획득 또는 입력 방법: 원래 보고 class 코드 및 표시하려는 별칭을 가져옵니다.
templateInfo.main[*].source.key string 생성 시 비즈니스상 비어 있지 않은 문자열이 필요하며 앞뒤 공백은 제거됩니다. 이름 저장 컬럼은 256이며 공개적으로 해당 길이를 일괄 선언하지 않으므로 256자를 넘지 않도록 권장합니다. 수정 시 이 값으로 이름을 변경할 수 없으며 경로의 objc_name으로만 위치를 찾습니다.
예시: example_resources
획득 또는 입력 방법: 객체 보고 class와 완전히 일치하는 분류명입니다.
templateInfo.main[*].source.name string 생성 시 기본값은 빈 문자열입니다. 수정 시 비어 있지 않은 main을 제공하면서 source.name을 누락하면 별칭이 유지되는 것이 아니라 비워집니다. 컬럼은 256이므로 길이를 제어하는 것을 권장합니다.
예시: 示例资源目录
획득 또는 입력 방법: 고객이 선택한 표시 별칭으로, 원래 템플릿/목록의 alias에서 가져옵니다.
templateInfo.main[*].groupCfg json 외부 objcGroupUUID가 생략되면 name으로 그룹을 찾거나 생성하려 시도하며, {}는 그룹 없음을 의미합니다. 현재 동일한 이름의 그룹이 이미 있는 경우 호환 분기에서 500이 될 수 있으므로 안정적인 작업을 위해 기존 UUID를 명시적으로 채우는 것을 권장합니다.
예시: {}
획득 또는 입력 방법: 내보내기의 비즈니스 그룹 정보를 가져오거나, objcGroupUUID를 명시적으로 우선 사용합니다.
templateInfo.main[*].groupCfg.name string 선택 사항이며 공백은 제거됩니다. 기본값은 그룹 없음입니다. 단순한 표시 정보가 아니라 새 그룹 생성을 시도합니다. 기존 그룹이 있으면 외부 UUID를 우선 사용하십시오.
예시: 业务分组
획득 또는 입력 방법: 기존 그룹명 또는 고객이 생성할 그룹명에서 가져옵니다.
templateInfo.main[*].fields array 외부 fields와 동일한 구조입니다. 외부 fields가 있으면 이 값을 덮어씁니다. 생성 시 최종적으로 name이 반드시 포함되어야 합니다. 수정 시 두 위치 모두 생략하면 기존 대상은 유지되고, 대상이 없으면 fields=[]로 보완 생성되며 name을 검증하지 않고 다운스트림 동기화도 하지 않습니다.
예시: [{"name": "name"}]
획득 또는 입력 방법: 실제 보고에 반드시 포함되는 필드 또는 내보낸 main[0].fields입니다.
templateInfo.main[*].fields[*] json 권장 형식은 객체입니다.
예시: {"name": "name", "alias": "名称"}
획득 또는 입력 방법: 단일 필드 정의로 외부 fields와 동일합니다.
templateInfo.main[*].fields[*].name string 규칙은 fields[*].name과 동일하며 최종적으로 name이 포함되어야 하고 중복 이름이 없어야 합니다.
예시: name
획득 또는 입력 방법: 보고 필드 키입니다.
templateInfo.main[*].fields[*].alias string 선택 사항이며 name을 대체하지 않습니다.
예시: 名称
획득 또는 입력 방법: 해당 필드의 표시 별칭입니다.
templateInfo.main[*].filters array 생성 시 기본값은 []입니다. 수정 시 템플릿에 이 필드가 없으면 유지되고, []는 비우며, 비어 있지 않으면 전체를 교체합니다.
예시: [{"key": "env"}]
획득 또는 입력 방법: 원래 템플릿의 빠른 필터 설정으로, 필드는 실제 객체 데이터에서 가져옵니다.
templateInfo.main[*].filters[*] json 동적 표시 객체이며 서버는 저장만 하고 쿼리를 실행해 검증하지 않습니다.
예시: {"key": "env"}
획득 또는 입력 방법: 단일 빠른 필터 항목입니다.
templateInfo.main[*].filters[*].key string 비어 있지 않은 실제 키를 권장하며 제목을 넣지 마십시오.
예시: env
획득 또는 입력 방법: 실제 객체 속성 필드명입니다.
templateInfo.main[*].groups array 동적 표시 배열입니다. 생성 시 기본값은 []이며, 수정 시 비어 있지 않은 main을 주면서 groups를 생략해도 []로 비워집니다. 카탈로그 비즈니스 그룹 objcGroupUUID와 동일하지 않습니다.
예시: []
획득 또는 입력 방법: 원래 내보낸 그룹 표시 설정에서 보존합니다.
templateInfo.main[*].groups[*] JSON 원본 템플릿대로 완전히 보존되며 구조/열거에 대한 일괄 강제 검증은 없습니다.
예시: env
획득 또는 입력 방법: 기존 UI 설정에서 지원하는 그룹 항목입니다.
templateInfo.main[*].fills array 동적 배열입니다. 생성 시 기본값은 []이며, 수정 시 비어 있지 않은 main을 제공하면서 fills를 생략하면 []로 비워집니다. 서버 측 필수 하위 구조에 대한 일괄 규정은 없습니다.
예시: []
획득 또는 입력 방법: 원래 내보낸 채움 표시 설정에서 보존합니다.
templateInfo.main[*].fills[*] JSON 원래 소비 구조대로 보존하며 기본 규칙을 임의로 구성하지 않습니다.
예시: {}
획득 또는 입력 방법: 기존 UI 템플릿에서 실제로 사용하는 채움 설정 항목입니다.
templateInfo.main[*].table json 선택적 객체입니다. 생성 시 기본값은 빈 설정이며, 수정 시 하위 필드를 주지 않으면 해당 값이 유지됩니다.
예시: {}
획득 또는 입력 방법: 원래 템플릿의 목록 및 상세 표시 설정에서 복사합니다.
templateInfo.main[*].table.columns array 생성 시 기본값은 []입니다. 수정 시 생략하면 유지되고 []는 비웁니다. fields 수집 필터와는 다릅니다.
예시: [{"key": "name"}]
획득 또는 입력 방법: 목록에 표시할 실제 객체 필드입니다.
templateInfo.main[*].table.columns[*] json 동적 컬럼 객체이며 추가 표시 속성을 일괄 검증하지 않습니다.
예시: {"key": "name"}
획득 또는 입력 방법: 단일 목록 표시 컬럼입니다.
templateInfo.main[*].table.columns[*].key string 컬럼을 지정하는 필드이며 별칭/제목이 아닙니다.
예시: name
획득 또는 입력 방법: 실제 보고 필드명입니다.
templateInfo.main[*].table.detail json 선택적 객체이며 실제 views는 table.detail.views에 있어야 합니다. main.detail.views가 아닙니다.
예시: {}
획득 또는 입력 방법: 원래 템플릿의 상세 페이지 설정입니다.
templateInfo.main[*].table.detail.views array 생성 시 기본값은 []이며, 수정 시 생략하면 유지되고 []는 비웁니다. UI 소비 방식대로 저장하며 현재 API는 페이지/뷰의 존재 여부나 권한을 검증하지 않습니다.
예시: []
획득 또는 입력 방법: 원래 리소스 카탈로그 Tab 설정 또는 내장 페이지/내장 뷰 이름에서 가져옵니다.
templateInfo.main[*].table.detail.views[*] json 원래 표시 프로토콜이며 서버는 보관만 하고 즉시 렌더링하거나 페이지를 테스트하지 않습니다.
예시: {"viewType": "component", "viewName": "base", "title": "详情", "required": false, "keys": {}, "timerange": "default"}
획득 또는 입력 방법: 단일 상세 Tab 설정입니다.
templateInfo.main[*].table.detail.views[*].title string 선택적 표시 텍스트입니다.
예시: 详情
획득 또는 입력 방법: 호출자가 지정하는 Tab 표시 제목입니다.
templateInfo.main[*].table.detail.views[*].viewType string camelCase viewType을 사용합니다. 구 설명의 view_type은 여기서 자동 변환되지 않습니다.
예시: component
획득 또는 입력 방법: 실제로 지원되는 내장 페이지 component 또는 내장 뷰 dashboard입니다.
templateInfo.main[*].table.detail.views[*].viewName string 임의의 외부 사이트 URL이나 대시보드 UUID를 이름 대신 넣을 수 없습니다. 저장 시 존재를 검증하지 않으며 표시 가능 여부도 보장하지 않습니다.
예시: base
획득 또는 입력 방법: component는 지원되는 내장 페이지의 상대 경로를, dashboard는 기존 내장 뷰 이름을 사용합니다.
templateInfo.main[*].table.detail.views[*].required boolean 표시 규약상 false는 기본 표시, true는 keys 매칭으로 결정됩니다. 문자열 "false"가 아닌 실제 JSON 불리언을 사용하십시오. 이 API는 매칭을 즉시 검증하지 않습니다.
예시: false
획득 또는 입력 방법: keys 매칭 시에만 Tab을 표시하는 UI 옵션 여부입니다.
templateInfo.main[*].table.detail.views[*].keys json required=true와 연동되며, 필드 키 매핑에서 "*"는 해당 필드의 존재를 요구하고 구체 값은 동등 조건 조합을 의미합니다. {}는 UI 기본값을 따르며 API 인가로 작동하지 않습니다.
예시: {}
획득 또는 입력 방법: 표시할 객체의 데이터 필드 및 값 조건입니다.
templateInfo.main[*].table.detail.views[*].keys.필드명 JSON 기존 데이터 값을 사용하거나 존재 표시 *를 사용할 수 있으며 실제 UI 매칭 기능에 맞게 사용하십시오.
예시: *
획득 또는 입력 방법: 실제 객체 속성 키/매칭 값입니다.
templateInfo.main[*].table.detail.views[*].timerange string 또는 문자열 배열 표시 규약상 default는 플랫폼 시간 위젯을 따릅니다(15m로 고정되지 않음). 15m/1h/1d 또는 [이전 오프셋, 이후 오프셋] 예: [5m,30m]으로 데이터 time과 연동할 수 있습니다. 저장 시 표현식을 검증하거나 쿼리를 실행하지 않습니다.
예시: default
획득 또는 입력 방법: 상세 연관 쿼리 요구에 따라 시간 범위를 선택합니다.
templateInfo.main[*].table.detail.views[*].timerange[*] string m/h/d 단위를 사용하며 밀리초 단위의 timeRange Query와 다릅니다.
예시: 15m
획득 또는 입력 방법: 두 요소 오프셋 배열의 이전/이후 기간입니다.
fields array 선언은 선택 사항이지만 생성/수정 시 전달할 경우 비즈니스상 name이 포함되어야 하며 중복되어서는 안 됩니다. 외부 fields는 템플릿의 동일 이름 설정보다 우선합니다. 수정 시 두 위치 모두 생략하면 대상이 이미 존재할 때는 필드가 유지되고, 대상이 없으면 fields=[]로 보완 생성되며 name을 검증하지 않고 다운스트림 필터도 동기화하지 않습니다. 템플릿이 제공되면 템플릿을 사용합니다. 명시적 []는 name 누락으로 거부됩니다. 필드는 다운스트림 보고 필터 규칙에 동기화되며, 이러한 필수 필드가 누락된 데이터는 폐기될 수 있으므로 수집 측과 먼저 확인하십시오.
null 허용: False
예시: [{"name": "name", "alias": "资源名称"}]
획득 또는 입력 방법: 실제 보고에 반드시 포함되는 필드명을 가져오고, 내보낸 main[0].fields를 백업한 후 조정합니다.
objcGroupUUID string 선택 사항이며, 생성/수정 시 명시적 빈 문자열은 그룹을 비웁니다. 생략하면 템플릿 groupCfg.name을 시도하고 이름이 없으면 빈 문자열이 되며, 수정 시 원래 그룹이 유지되는 것은 아닙니다. 비어 있지 않으면 이 워크스페이스에 해당 그룹이 존재해야 합니다. 목록은 이 필드를 선언하고 있지만 현재 구현에서는 이를 기준으로 필터링하지 않으므로 결과를 좁히는 용도로 의존하지 마십시오.
빈 문자열 허용: True
null 허용: False
최대 길이: 64
예시:
획득 또는 입력 방법: 현재 워크스페이스의 리소스 카탈로그 그룹 관리 또는 목록 항목의 objcGroupUUID에서 objcg_ 식별자를 가져옵니다.
sourceType string Y 공개적으로 필수이며 object/custom_object만 가능합니다. 내부 함수를 공유하는 *_history는 지원하지 않습니다. 생성 시 실제로는 templateInfo.main[0].class를 사용하므로 반드시 이 필드와 일치해야 합니다. 수정/읽기에서는 설정 유형을 선택하는 데 사용됩니다. 삭제는 공개적으로 custom_object만 가능하며 컨트롤러가 이 유형으로 고정됩니다.
null 허용: False
선택 가능 값: ['object', 'custom_object']
예시: custom_object
획득 또는 입력 방법: 시스템 객체는 object, 사용자 정의 리소스 객체는 custom_object를 선택하며 실제 보고 데이터 소스를 따릅니다.
templateInfo json 동적 템플릿 객체입니다. 생성 시 유효하고 비어 있지 않은 main이 필요하며 첫 항목에 source.key가 포함되어야 합니다(외부에서 비즈니스상 필수로 선언되지 않았지만 생략하면 500이 될 수 있음). main[0]만 소비하고 이후 항목은 무시합니다. 수정 시 생략/{}로 대부분의 설정을 유지할 수 있지만 그룹은 이 페이지의 별도 규칙에 따라 처리됩니다.
null 허용: False
예시: {}
획득 또는 입력 방법: 리소스 카탈로그 내보내기의 content 설정 객체를 기반으로 우선 사용하고, 통합 응답 전체를 그대로 채우지 마십시오.

파라미터 추가 설명

템플릿 설정은 templateInfo.main[0]을 사용하며, 테이블 상세 경로는 table.detail.views이고 필드명은 viewType입니다. 파라미터 표에 항목별로 정리되어 있습니다. 템플릿 동적 표시 정보는 저장 시 페이지 렌더링이나 쿼리 검증을 수행하지 않습니다.

요청 예시

curl --request POST 'https://openapi.guance.com/api/v1/objc_cfg/create' \
  -H 'DF-API-KEY: <DF-API-KEY>' \
  -H 'Content-Type: application/json' \
  --data-raw '{"sourceType":"custom_object","objcGroupUUID":"","fields":[{"name":"name","alias":"资源名称"}],"templateInfo":{"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":{}}}'

응답

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

필드 유형 설명
content.id integer 또는 null 로컬 설정 레코드 번호이며, 신규 생성 제출 전 구성된 응답에서는 null일 수 있습니다.
content.uuid string 로컬 objc_ 설정 UUID이며 분류명이 아닙니다.
content.workspaceUUID string 소속 워크스페이스입니다.
content.sourceType string object/custom_object.
content.name string 실제 분류 코드입니다.
content.alias string 표시 별칭입니다.
content.objcGroupUUID string 비즈니스 그룹 UUID이며 그룹이 없으면 빈 문자열입니다.
content.dashboardBindSet array 이전 바인딩 데이터이며 이 진입점에서는 해당 구조를 별도로 파싱/업데이트하지 않습니다.
content.dashboardBindSet[] JSON 원래 저장된 동적 바인딩 항목입니다.
content.fields 객체 배열 보고 시 반드시 포함해야 하는 필드 정의입니다.
content.fields[].name string 실제 보고 필드명이며 name이 반드시 포함되고 중복되지 않아야 하며 필드 명명 규칙을 따릅니다.
content.fields[].alias string 선택적 표시 별칭입니다.
content.extend object 실제로 저장된 표시 설정입니다.
content.extend.iconSet object 또는 null 아이콘 동적 설정이며 이전 데이터/내보내기에서는 null일 수 있습니다.
content.extend.iconSet.icon string 조건부 아이콘 식별자입니다.
content.extend.iconSet.url string 조건부 아이콘 URL입니다.
content.extend.filters 객체 배열 빠른 필터 항목입니다.
content.extend.filters[].key string 필터 필드입니다.
content.extend.groups array 동적 표시 그룹입니다.
content.extend.groups[] JSON 단일 동적 그룹 항목입니다.
content.extend.fills array 동적 채움 설정입니다.
content.extend.fills[] JSON 단일 동적 채움 항목입니다.
content.extend.columns 객체 배열 목록 표시 컬럼입니다.
content.extend.columns[].key string 단일 컬럼 필드 키입니다.
content.extend.tableDetailViews 객체 배열 또는 object 상세 Tab이며 템플릿이 구성되지 않은 분기에서는 {}일 수 있습니다.
content.extend.tableDetailViews[].title string Tab 제목입니다.
content.extend.tableDetailViews[].viewType string component/dashboard.
content.extend.tableDetailViews[].viewName string 내장 페이지 경로 또는 내장 뷰 이름입니다.
content.extend.tableDetailViews[].required boolean keys에 따라 표시 여부를 결정하는지 여부입니다.
content.extend.tableDetailViews[].keys object 동적 매칭 필드/값입니다.
content.extend.tableDetailViews[].keys.필드명 JSON 매칭 값/존재 표시 *.
content.extend.tableDetailViews[].timerange string 또는 문자열 배열 default/상대 기간/이전·이후 오프셋 배열입니다.
content.extend.tableDetailViews[].timerange[] string 단일 이전/이후 오프셋 기간입니다.
content.status integer 정상 0, 삭제 3입니다.
content.creator string 생성 주체입니다.
content.updator string 업데이트 주체입니다.
content.createAt integer 생성 Unix 초입니다.
content.updateAt integer 또는 number 업데이트 Unix 초이며 이전 데이터는 소수 값을 허용할 수 있습니다.
content.deleteAt integer 삭제되지 않음은 -1입니다.
content.declaration object 공통 선언입니다.
{
  "code": 200,
  "content": {
    "id": null,
    "uuid": "objc_example",
    "workspaceUUID": "wksp_example",
    "sourceType": "custom_object",
    "name": "example_resources",
    "alias": "示例资源目录",
    "objcGroupUUID": "",
    "dashboardBindSet": [],
    "fields": [
      {
        "name": "name",
        "alias": "资源名称"
      }
    ],
    "extend": {
      "iconSet": {},
      "columns": [
        {
          "key": "name"
        }
      ],
      "filters": [
        {
          "key": "env"
        }
      ],
      "groups": [],
      "fills": [],
      "tableDetailViews": []
    },
    "status": 0,
    "creator": "wsak_example",
    "updator": "wsak_example",
    "createAt": 1785427200,
    "updateAt": 1785427200,
    "deleteAt": -1,
    "declaration": {}
  },
  "errorCode": "",
  "message": "",
  "success": true,
  "traceId": "TRACE-EXAMPLE"
}

오류 응답

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

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

HTTP 상태 errorCode 트리거 조건 메시지 또는 응답 설명 처리 방법
406 ft.ParameterValidationFailed 요청 필드가 누락되었거나 필드 값이 선언된 검증 조건을 위반함 파라미터 파싱 실패 파라미터 위치, 필드명, 유형, 값을 확인하십시오.
400 ft.RequestJsonFormatError 요청 JSON 구문이 유효하지 않음 요청 JSON 형식 오류 content.reason, line, column에 따라 JSON을 수정하십시오.
400 ft.JsonFormatError Body 최상위가 JSON 객체가 아님 일부 json 파일 형식 오류 이 페이지의 필드를 포함한 객체를 제출하십시오.
400 ft.InvalidFieldName 최종 fields의 특정 필드명이 정규식과 일치하지 않음 잘못된 필드명(영문자로 시작하고 영문자와 밑줄로만 구성) 영문자로 시작하고 최소 2자인 영문자/숫자/_ 이름을 사용하고, 문자열이 아닌 객체를 제출하십시오.
400 ft.MissingFiledName 최종 fields에 name 필드가 누락됨(생성 시 모든 필드를 생략하거나 []를 전달한 경우 포함) name 필드가 반드시 포함되어야 합니다 name과 실제 보고에 반드시 포함되는 모든 필드를 유지하고, 수정 전에 전체 정의를 백업하십시오.
400 ft.UnsupportRepeatfield fields에 중복 이름이 존재함 중복 필드가 있을 수 없습니다 필드는 name 기준으로 중복을 제거하며 별칭이 다르다고 다른 필드로 보지 않습니다.
406 ft.InvalidObjcSetClassName 분류명이 비어 있거나 형식이 유효하지 않음 객체 분류명 {}이(가) 유효하지 않습니다 기존 분류 목록에서 name을 가져오고, 생성 시 templateInfo.main[0].source.key가 비어 있지 않아야 하며 앞뒤 공백을 피하십시오.
404 ft.NotFoundObjcGroupObj 명시적으로 비어 있지 않은 objcGroupUUID가 현재 워크스페이스의 삭제되지 않은 그룹에 없음 지정한 리소스 클래스 그룹을 찾을 수 없습니다 실제 그룹 UUID를 사용하고, 그룹을 비우려면 빈 문자열을 명시하십시오.
500 ft.InternalServerError 동적 템플릿/필드 요소 형태, 저장 길이, 기존 그룹 호환 분기 또는 제출 후 필터 동기화 실패 내부 오류 먼저 목록/내보내기를 읽어 설정 및 다운스트림 필터 상태를 확인하십시오. 이미 저장되었을 수 있으므로 무작정 다시 생성하지 마십시오. 기존 그룹은 UUID를 명시적으로 채우십시오.
406 ft.InvalidObjcSetClassNameAlreadyExists 동일 워크스페이스, 동일 sourceType에 삭제되지 않은 동일 이름 설정이 이미 존재함 생성 실패, 리소스 클래스 「{}」이(가) 이미 존재합니다 수정 API를 호출하고 중복 생성으로 덮어쓰지 마십시오.

문서 평가

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