Keyboard shortcuts

Press ← or → to navigate between chapters

Press ? to show this help

Press Esc to hide this help

체크포인트 대상 스냅샷

Record.checkpointedItems의 각 항목은 type으로 구분하는 CheckpointedItem입니다. 19가지 분기는 체크포인트 시점에 기록한 리소스, 객체 집합, 주체 등의 정보를 담습니다. 아래 RID 필드는 문자열 리소스 식별자입니다.

문자열을 담는 username, name, compassPath 객체의 value는 개인정보 보호를 위해 없을 수 있습니다. 함께 제공되는 redactionType을 확인하고 가려진 원래 값을 추정하지 않습니다.

분기 checkpointedIssue

체크포인트에 기록한 이슈입니다.

이름자료형필수 여부의미와 조건예시 값
typeenum필수분기를 구분하는 type 값입니다. 허용값: checkpointedIssue.checkpointedIssue
issueRidstring필수

분기 checkpointedJob

체크포인트에 기록한 빌드 작업입니다.

이름자료형필수 여부의미와 조건예시 값
typeenum필수분기를 구분하는 type 값입니다. 허용값: checkpointedJob.checkpointedJob
jobRidstring필수

분기 checkpointedSchedule

체크포인트에 기록한 일정입니다.

이름자료형필수 여부의미와 조건예시 값
typeenum필수분기를 구분하는 type 값입니다. 허용값: checkpointedSchedule.checkpointedSchedule
scheduleRidstring필수

분기 checkpointedResource

체크포인트에 기록한 Foundry 리소스입니다.

이름자료형필수 여부의미와 조건예시 값
typeenum필수분기를 구분하는 type 값입니다. 허용값: checkpointedResource.checkpointedResource
ridstring필수
resourceTypeenum필수기록한 리소스의 유형입니다. 리소스 유형의 값을 사용합니다.DATASET
nameobject선택개인정보 보호를 위해 값이 가려질 수 있는 문자열 객체입니다.응답 예시 참조
projectRidstring선택체크포인트 적용 범위인 프로젝트의 식별자입니다.ri.compass.main.folder.d4e5f6a7-b8c9-0123-defa-234567890123
namespaceRidstring선택체크포인트와 연결된 네임스페이스의 식별자입니다.ri.compass.main.folder.f6a7b8c9-d0e1-2345-fabc-456789012345
compassPathobject필수개인정보 보호를 위해 값이 가려질 수 있는 문자열 객체입니다.응답 예시 참조
orgMarkingslist<string>선택

name의 구조

이름자료형필수 여부의미와 조건예시 값
valuestring선택
redactionTypeenum선택문자열 값이 가려진 이유를 나타냅니다. 허용값: USER_REDACTED, RESOURCE_REDACTED.USER_REDACTED

compassPath의 구조

이름자료형필수 여부의미와 조건예시 값
valuestring선택
redactionTypeenum선택문자열 값이 가려진 이유를 나타냅니다. 허용값: USER_REDACTED, RESOURCE_REDACTED.USER_REDACTED

분기 checkpointedJobSpecification

체크포인트에 기록한 작업 명세입니다.

이름자료형필수 여부의미와 조건예시 값
typeenum필수분기를 구분하는 type 값입니다. 허용값: checkpointedJobSpecification.checkpointedJobSpecification
jobSpecRidstring필수

분기 checkpointedLanguageModel

체크포인트에 기록한 언어 모델입니다.

이름자료형필수 여부의미와 조건예시 값
typeenum필수분기를 구분하는 type 값입니다. 허용값: checkpointedLanguageModel.checkpointedLanguageModel
modelRidstring필수

분기 checkpointedGroup

체크포인트에 기록한 그룹입니다.

이름자료형필수 여부의미와 조건예시 값
typeenum필수분기를 구분하는 type 값입니다. 허용값: checkpointedGroup.checkpointedGroup
groupIdstring필수

분기 checkpointedUserIntakeSubmission

체크포인트에 기록한 사용자 접수 양식 제출입니다.

이름자료형필수 여부의미와 조건예시 값
typeenum필수분기를 구분하는 type 값입니다. 허용값: checkpointedUserIntakeSubmission.checkpointedUserIntakeSubmission
submissionRidstring필수

분기 checkpointedObjectSet

체크포인트에 기록한 객체 집합입니다.

이름자료형필수 여부의미와 조건예시 값
typeenum필수분기를 구분하는 type 값입니다. 허용값: checkpointedObjectSet.checkpointedObjectSet
versionedobject선택체크포인트에 기록한 버전이 있는 객체 집합입니다.응답 예시 참조
typesProxyobject선택체크포인트에 기록한 유형 프록시 객체 집합입니다.응답 예시 참조

versioned의 구조

이름자료형필수 여부의미와 조건예시 값
versionedObjectSetRidstring필수
objectSetVersionstring필수
objectTypeslist<CheckpointedOntologyWithObjectTypes>선택

objectTypes의 구조

배열 항목은 CheckpointedOntologyWithObjectTypes이며 자료형은 object입니다.

체크포인트에 기록한 온톨로지와 연결된 객체 유형입니다.

이름자료형필수 여부의미와 조건예시 값
ontologyobject필수체크포인트에 기록한 온톨로지 스냅샷입니다.응답 예시 참조
objectTypeRidslist<rid>선택
ontology의 구조
이름자료형필수 여부의미와 조건예시 값
ontologyRidstring필수
ontologyVersionstring필수
namespaceRidstring선택체크포인트와 연결된 네임스페이스의 식별자입니다.ri.compass.main.folder.f6a7b8c9-d0e1-2345-fabc-456789012345

typesProxy의 구조

이름자료형필수 여부의미와 조건예시 값
objectTypeslist<CheckpointedOntologyWithObjectTypes>선택

objectTypes의 구조

배열 항목은 CheckpointedOntologyWithObjectTypes이며 자료형은 object입니다.

체크포인트에 기록한 온톨로지와 연결된 객체 유형입니다.

이름자료형필수 여부의미와 조건예시 값
ontologyobject필수체크포인트에 기록한 온톨로지 스냅샷입니다.응답 예시 참조
objectTypeRidslist<rid>선택
ontology의 구조
이름자료형필수 여부의미와 조건예시 값
ontologyRidstring필수
ontologyVersionstring필수
namespaceRidstring선택체크포인트와 연결된 네임스페이스의 식별자입니다.ri.compass.main.folder.f6a7b8c9-d0e1-2345-fabc-456789012345

분기 checkpointedMarking

체크포인트에 기록한 보안 표지입니다.

이름자료형필수 여부의미와 조건예시 값
typeenum필수분기를 구분하는 type 값입니다. 허용값: checkpointedMarking.checkpointedMarking
markingIdstring필수

분기 checkpointedMarketplaceProduct

체크포인트에 기록한 Marketplace 상품입니다.

이름자료형필수 여부의미와 조건예시 값
typeenum필수분기를 구분하는 type 값입니다. 허용값: checkpointedMarketplaceProduct.checkpointedMarketplaceProduct
productIdstring필수

분기 checkpointedPeeringJob

체크포인트에 기록한 피어링 작업입니다.

이름자료형필수 여부의미와 조건예시 값
typeenum필수분기를 구분하는 type 값입니다. 허용값: checkpointedPeeringJob.checkpointedPeeringJob
jobIdstring필수피어링 작업의 식별자입니다.
relationshipRidstring필수피어링 관계의 리소스 식별자입니다.

분기 checkpointedRole

체크포인트에 기록한 역할입니다.

이름자료형필수 여부의미와 조건예시 값
typeenum필수분기를 구분하는 type 값입니다. 허용값: checkpointedRole.checkpointedRole
roleIdstring필수

분기 checkpointedIntervention

체크포인트에 기록한 Intervention입니다.

이름자료형필수 여부의미와 조건예시 값
typeenum필수분기를 구분하는 type 값입니다. 허용값: checkpointedIntervention.checkpointedIntervention
interventionRidstring필수

분기 checkpointedLanguageModelSession

체크포인트에 기록한 언어 모델 세션입니다.

이름자료형필수 여부의미와 조건예시 값
typeenum필수분기를 구분하는 type 값입니다. 허용값: checkpointedLanguageModelSession.checkpointedLanguageModelSession
sessionRidstring필수

분기 checkpointedToken

체크포인트에 기록한 인증 토큰입니다.

이름자료형필수 여부의미와 조건예시 값
typeenum필수분기를 구분하는 type 값입니다. 허용값: checkpointedToken.checkpointedToken
tokenIdstring필수
tokenTypeenum필수체크포인트에 기록한 토큰의 유형입니다. 허용값: USER_TOKEN.USER_TOKEN

분기 checkpointedUserIntakeFormInput

체크포인트에 기록한 사용자 접수 양식 입력입니다.

이름자료형필수 여부의미와 조건예시 값
typeenum필수분기를 구분하는 type 값입니다. 허용값: checkpointedUserIntakeFormInput.checkpointedUserIntakeFormInput
inputIdstring필수

분기 checkpointedPrincipal

체크포인트에 기록한 사용자 또는 그룹 주체입니다.

이름자료형필수 여부의미와 조건예시 값
typeenum필수분기를 구분하는 type 값입니다. 허용값: checkpointedPrincipal.checkpointedPrincipal
idstring필수
usernameobject필수개인정보 보호를 위해 값이 가려질 수 있는 문자열 객체입니다.응답 예시 참조
organizationRidstring선택체크포인트와 연결된 조직의 식별자입니다.ri.multipass..organization.e5f6a7b8-c9d0-1234-efab-345678901234
roleenum필수기록한 대상과 관련하여 이 주체가 맡았던 역할입니다. 허용값: SOURCE_SHARE_RECIPIENT, TARGET_GROUP, GROUP_MEMBER, MARKING_MEMBER, ROLE_GRANT_RECIPIENT, MFA_METHOD_RESET_TARGET, ISSUE_ASSIGNEE.GROUP_MEMBER

username의 구조

이름자료형필수 여부의미와 조건예시 값
valuestring선택
redactionTypeenum선택문자열 값이 가려진 이유를 나타냅니다. 허용값: USER_REDACTED, RESOURCE_REDACTED.USER_REDACTED

분기 checkpointedActionType

체크포인트에 기록한 온톨로지 액션 유형입니다.

이름자료형필수 여부의미와 조건예시 값
typeenum필수분기를 구분하는 type 값입니다. 허용값: checkpointedActionType.checkpointedActionType
actionTypeRidstring필수
ontologyobject필수체크포인트에 기록한 온톨로지 스냅샷입니다.응답 예시 참조

ontology의 구조

이름자료형필수 여부의미와 조건예시 값
ontologyRidstring필수
ontologyVersionstring필수
namespaceRidstring선택체크포인트와 연결된 네임스페이스의 식별자입니다.ri.compass.main.folder.f6a7b8c9-d0e1-2345-fabc-456789012345

객체 집합과 온톨로지 버전

checkpointedObjectSet의 versioned와 typesProxy는 각각 선택 필드입니다. versioned가 있으면 versionedObjectSetRid와 objectSetVersion이 필수입니다. 두 형태의 objectTypes 목록은 온톨로지 스냅샷과 객체 유형 RID를 묶습니다.

온톨로지 스냅샷에는 ontologyRid와 ontologyVersion이 필수이고 namespaceRid는 선택입니다. 객체 유형 목록의 값은 API 이름이 아니라 RID입니다. 액션 유형 스냅샷도 actionTypeRid와 해당 온톨로지 스냅샷을 함께 담습니다.

리소스 유형

checkpointedResource.resourceType은 다음 값을 사용합니다.

  • CONTOUR_ANALYSIS
  • CONTOUR_SOURCE_DATASET
  • DATA_CONNECTION_SYNC
  • DATA_CONNECTION_SOURCE
  • DATA_CONNECTION_SYNC_TARGET_DATASET
  • HUBBLE_OBJECT_TYPE
  • EXPORTED_RESOURCE
  • IMPORTED_RESOURCE
  • REPORT
  • CIPHER_CHANNEL
  • CIPHER_LICENSE
  • PARENT_RESOURCE
  • ATTACHMENT
  • SLATE_APPLICATION
  • NOTEPAD
  • DATASET
  • MEDIA_SET
  • CODE_REPOSITORY
  • CODE_WORKBOOK
  • CODE_WORKSPACE
  • TELEMETRY_CONTAINER
  • REFERENCED_RESOURCE
  • ROLE_GRANT_RESOURCE
  • PROJECT
  • STORE
  • THIRD_PARTY_APPLICATION
  • BUILDER_PIPELINE
  • MODEL
  • MODEL_VERSION
  • AGENT
  • WORKSHOP_MODULE
  • WALKTHROUGH
  • FLOW_CAPTURE
  • PEERING_CONNECTION

리소스 스냅샷 예시

가상 데이터셋을 기록한 항목입니다.

{
  "type": "checkpointedResource",
  "rid": "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da",
  "resourceType": "DATASET",
  "compassPath": {
    "value": "/My Project/My Dataset"
  },
  "orgMarkings": []
}