객체 집합 로드의 응답 메타데이터
객체 집합을 읽는 세 API는 반환하는 속성 이름과 메타데이터가 다릅니다.
| API | 반환하는 속성과 메타데이터 |
|---|---|
loadObjects | 객체 유형의 속성을 반환하며 __rid, __apiName, __primaryKey를 사용합니다. |
loadObjectsMultipleObjectTypes | 객체 유형 범위에서는 선택한 객체 속성을, 인터페이스 범위에서는 그 인터페이스를 구현하는 객체 속성을 반환합니다. 메타데이터에는 $ 접두사를 사용하며 인터페이스 매핑도 제공합니다. |
loadObjectsOrInterfaces | 요청한 집합에 인터페이스가 포함되어 있고 객체를 그 인터페이스로 볼 수 있으면 인터페이스 속성을, 그렇지 않으면 객체 유형 속성을 반환합니다. 한 결과 집합에 두 속성 표현을 섞을 수 없습니다. $rid, $primaryKey와 유형 정보를 사용합니다. |
totalCount는 모든 페이지의 전체 항목 수를 나타내는 long 정수입니다. 각 응답의 data는 현재 페이지의 객체입니다.
속성 보안 정보
loadObjects와 loadObjectsMultipleObjectTypes에서 loadPropertySecurities=true를 지정하면 속성값과 보안 정보의 인덱스를 함께 반환합니다. 속성값의 propertySecurityIndex는 응답의 propertySecurities를 참조합니다. Secured Property Value의 JSON 표현을 따릅니다. 이 기능은 실험적이며 아직 일반 제공 기능이 아닙니다.
배열 항목은 PropertySecurities이며 자료형은 object입니다.
속성값의 보안 결과를 OR로 결합한 집합입니다.
| 이름 | 자료형 | 필수 여부 | 의미와 조건 | 예시 값 |
|---|---|---|---|---|
disjunction | list<PropertySecurity> | 선택 |
disjunction의 구조
배열 항목은 PropertySecurity이며 자료형은 union<propertyMarkingSummary, unsupportedPolicy, errorComputingSecurity>입니다.
분기 propertyMarkingSummary
속성값에 적용되는 모든 보안 표지 조건입니다.
| 이름 | 자료형 | 필수 여부 | 의미와 조건 | 예시 값 |
|---|---|---|---|---|
type | enum | 필수 | 허용값: propertyMarkingSummary. | propertyMarkingSummary |
conjunctive | list<MarkingId> | 선택 | 접근하려면 목록의 모든 표지를 충족해야 합니다. | |
disjunctive | list<array> | 선택 | 바깥 목록은 AND, 각 안쪽 목록은 OR로 결합합니다. 각 안쪽 목록에서 하나 이상을 충족하고 바깥 목록의 모든 조건을 충족해야 합니다. | |
containerConjunctive | list<MarkingId> | 선택 | 속성값을 담은 컨테이너의 AND 표지 조건입니다. 예를 들어 데이터셋의 프로젝트에 적용되는 표지이며, 속성 자체의 표지와 달라도 모두 충족해야 합니다. | |
containerDisjunctive | list<array> | 선택 | 컨테이너의 표지는 속성 자체의 표지와 달라도 충족해야 합니다. 바깥 목록을 AND, 각 안쪽 목록을 OR로 결합하므로 모든 안쪽 목록에서 하나 이상을 충족해야 합니다. |
conjunctive의 구조
배열 항목은 MarkingId이며 자료형은 string입니다.
분류 또는 필수 보안 표지의 ID입니다.
disjunctive의 구조
배열 항목은 array이며 자료형은 list<MarkingId>입니다.
배열 항목은 MarkingId이며 자료형은 string입니다.
분류 또는 필수 보안 표지의 ID입니다.
containerConjunctive의 구조
배열 항목은 MarkingId이며 자료형은 string입니다.
분류 또는 필수 보안 표지의 ID입니다.
containerDisjunctive의 구조
배열 항목은 array이며 자료형은 list<MarkingId>입니다.
배열 항목은 MarkingId이며 자료형은 string입니다.
분류 또는 필수 보안 표지의 ID입니다.
분기 unsupportedPolicy
기반 제한 뷰가 속성 보안 정보를 지원하지 않습니다.
| 이름 | 자료형 | 필수 여부 | 의미와 조건 | 예시 값 |
|---|---|---|---|---|
type | enum | 필수 | 허용값: unsupportedPolicy. | unsupportedPolicy |
분기 errorComputingSecurity
서버가 속성의 보안 정보를 읽지 못했습니다.
| 이름 | 자료형 | 필수 여부 | 의미와 조건 | 예시 값 |
|---|---|---|---|---|
type | enum | 필수 | 허용값: errorComputingSecurity. | errorComputingSecurity |
conjunctive의 모든 표지를 충족해야 합니다. disjunctive는 각 안쪽 집합에서 하나 이상을 충족하고 모든 안쪽 집합을 만족해야 합니다. 컨테이너 표지는 데이터셋의 프로젝트 등에 적용되며 속성 자체의 표지와 달라도 함께 충족해야 합니다.
unsupportedPolicy는 기반 제한 뷰가 속성 보안 정보를 지원하지 않는다는 뜻이고, errorComputingSecurity는 보안 정보를 읽지 못했다는 뜻입니다. 어느 경우도 해당 값을 공개 데이터로 판단할 근거가 되지 않습니다.
평가에 사용한 객체 유형
객체 집합 전체를 평가하면서 참조한 구체적인 객체 유형의 API 이름입니다. 인터페이스 구현 유형, 링크 탐색과 파생 속성에서 사용한 유형도 포함하며 현재 페이지에 해당 객체가 없을 수 있습니다. 정보를 제공할 수 있을 때 첫 페이지에서만 반환합니다. 이 정보는 바뀔 수 있으므로 집합을 다시 불러올 때 갱신해야 합니다. 필드가 생략되면 의존 유형 정보를 사용할 수 없다는 뜻입니다.
| 이름 | 자료형 | 필수 여부 | 의미와 조건 | 예시 값 |
|---|---|---|---|---|
objectTypeApiNames | list<ObjectTypeApiName> | 선택 |
objectTypeApiNames의 구조
배열 항목은 ObjectTypeApiName이며 자료형은 string입니다.
카멜 표기법의 객체 유형 API 이름입니다. 실제 이름과 대소문자는 List Object Types 또는 Ontology Manager에서 확인합니다.
인터페이스와 객체 유형의 매핑
다중 객체 유형 로드는 인터페이스 API 이름, 구현 객체 유형 API 이름, 속성 매핑의 순서로 맵을 반환합니다. 기존 매핑은 공유 속성 유형(SPT)의 API 이름에서 객체의 로컬 속성 이름으로 연결합니다.
맵의 키는 InterfaceTypeApiName(string), 값은 InterfaceToObjectTypeMappings(map<ObjectTypeApiName, InterfaceToObjectTypeMapping>)입니다.
키: UpperCamelCase 형식의 인터페이스 API 이름입니다. List Interface Types 또는 Ontology Manager에서 확인합니다.
객체 유형별로 인터페이스 속성과 객체 속성의 대응을 담은 맵입니다.
맵의 키는 ObjectTypeApiName(string), 값은 InterfaceToObjectTypeMapping(map<SharedPropertyTypeApiName, PropertyApiName>)입니다.
키: 카멜 표기법의 객체 유형 API 이름입니다. 실제 이름과 대소문자는 List Object Types 또는 Ontology Manager에서 확인합니다.
인터페이스 속성에서 객체의 로컬 속성으로 대응하는 맵입니다.
맵의 키는 SharedPropertyTypeApiName(string), 값은 PropertyApiName(string)입니다.
키: lowerCamelCase 형식의 공유 속성 유형 API 이름입니다. List Shared Property Types 또는 Ontology Manager에서 확인합니다.
속성의 API 이름입니다. Get Object Type 또는 Ontology Manager에서 확인합니다.
V2 매핑의 마지막 키는 인터페이스 속성 API 이름이며 값은 그 속성의 구현 정의입니다. SPT API 이름과 인터페이스 속성 API 이름을 같은 식별자로 취급하지 않습니다.
맵의 키는 InterfaceTypeApiName(string), 값은 InterfaceToObjectTypeMappingsV2(map<ObjectTypeApiName, InterfaceToObjectTypeMappingV2>)입니다.
키: UpperCamelCase 형식의 인터페이스 API 이름입니다. List Interface Types 또는 Ontology Manager에서 확인합니다.
객체 유형별로 인터페이스 속성의 구현을 담은 맵입니다.
맵의 키는 ObjectTypeApiName(string), 값은 InterfaceToObjectTypeMappingV2(map<InterfacePropertyApiName, InterfacePropertyTypeImplementation>)입니다.
키: 카멜 표기법의 객체 유형 API 이름입니다. 실제 이름과 대소문자는 List Object Types 또는 Ontology Manager에서 확인합니다.
인터페이스 속성을 구현하는 방법을 담은 맵입니다.
맵의 키는 InterfacePropertyApiName(string), 값은 InterfacePropertyTypeImplementation(union<structFieldImplementation, structImplementation, localPropertyImplementation, reducedPropertyImplementation>)입니다.
키: lowerCamelCase 형식의 인터페이스 속성 API 이름입니다. List Interface Types의 allPropertiesV2 또는 Ontology Manager에서 확인합니다.
객체 유형이 인터페이스 속성을 구현하는 방식입니다.
네 가지 구현 분기와 축약 조건은 객체 유형의 인터페이스 구현을 따릅니다.
계산 사용량과 트랜잭션
loadObjects와 loadObjectsMultipleObjectTypes의 includeComputeUsage는 OSDK 애플리케이션 전용이며 운영 사용은 권장하지 않습니다. 반환되는 computeUsage의 단위는 compute-seconds입니다.
loadObjectsOrInterfaces의 응답에는 선택적으로 transactionId가 들어 있습니다. 이 엔드포인트에는 loadPropertySecurities와 includeComputeUsage 요청 필드가 없습니다.