체크포인트 기록 조회(Get Record) (V2)

기록 RID로 체크포인트 통과 기록 하나를 조회합니다. 작업을 수행한 사용자와 적용 범위, 기록 시각, 대상 스냅샷 및 사용자가 제출한 통과 근거를 확인할 수 있습니다.

이 엔드포인트는 미리보기 기능이며 언제든 변경되거나 제거될 수 있습니다. 사용하려면 preview=true를 지정합니다.

HTTP 요청

GET /api/v2/checkpoints/records/{recordRid}

작업 식별자는 v2.getRecord입니다. OAuth2로 호출하는 타사 애플리케이션에는 api:checkpoints-read 권한 범위가 필요합니다. 각 요청에 Authorization: Bearer <접근 토큰>을 전달합니다.

경로 매개변수

쿼리 매개변수

요청 본문

요청 본문을 사용하지 않습니다.

응답

응답은 Record입니다. 이름과 경로 같은 문자열은 개인정보 보호를 위해 값이 가려질 수 있으므로, 일반 문자열이 아닌 value와 redactionType을 가진 객체로 처리합니다.

Record의 필드, 통과 근거 4가지와 체크포인트 유형 84개는 기록 자료형을 따릅니다. 대상 스냅샷의 19가지 분기는 대상 자료형에 정의되어 있습니다.

가상 Contour 내보내기 체크포인트 기록의 응답 예시입니다.

{
  "projectRid": "ri.compass.main.folder.d4e5f6a7-b8c9-0123-defa-234567890123",
  "delegateUserId": "0d1fe74e-2b70-4a93-9b1a-80070637788b",
  "configRid": "ri.checkpoints.main.config.b2c3d4e5-f6a7-8901-bcde-f12345678901",
  "organizationRid": "ri.multipass..organization.e5f6a7b8-c9d0-1234-efab-345678901234",
  "checkpointedItems": [
    {
      "type": "checkpointedResource",
      "rid": "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da",
      "resourceType": "DATASET",
      "compassPath": {
        "value": "/My Project/My Dataset"
      },
      "orgMarkings": []
    }
  ],
  "rid": "ri.checkpoints.main.checkpoint.a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "type": "CONTOUR_EXPORT",
  "actingUser": {
    "userId": "f05f8da4-b84c-4fca-9c77-8af0b13d11de",
    "username": {
      "value": "admin"
    }
  },
  "createdAt": "2023-11-14T09:30:00.000Z",
  "approvalsMetadata": {
    "approvalsTaskId": "e3f4a5b6-c7d8-9012-efab-123456789012",
    "approvalsSubtaskIds": [
      "f4a5b6c7-d8e9-0123-fabc-234567890123"
    ]
  },
  "scope": "USER_SCOPED",
  "interactionRid": "ri.checkpoints.main.checkpointable-interaction.c3d4e5f6-a7b8-9012-cdef-123456789012",
  "namespaceRid": "ri.compass.main.folder.f6a7b8c9-d0e1-2345-fabc-456789012345",
  "justification": {
    "type": "acknowledgementJustification",
    "prompt": "I acknowledge this action",
    "title": "Export Confirmation"
  }
}

개별 오류

요청 예제

FOUNDRY_HOST에는 https://를 제외한 Foundry 호스트를, FOUNDRY_TOKEN에는 유효한 토큰을 환경 변수로 제공합니다. 예시 식별자와 매개변수 값은 실제 작업 대상에 맞게 바꿉니다.

cURL

curl \
	-H "Authorization: Bearer ${FOUNDRY_TOKEN}" \
	"https://${FOUNDRY_HOST}/api/v2/checkpoints/records/ri.checkpoints.main.checkpoint.a1b2c3d4-e5f6-7890-abcd-ef1234567890?preview=true"

Python

Requests 라이브러리가 설치된 Python 환경에서 사용합니다.

import os
import requests

HOSTNAME = os.environ["FOUNDRY_HOST"]
TOKEN = os.environ["FOUNDRY_TOKEN"]
headers = {
    "authorization": "Bearer {}".format(TOKEN)
}

response = requests.get('https://{}/api/v2/checkpoints/records/ri.checkpoints.main.checkpoint.a1b2c3d4-e5f6-7890-abcd-ef1234567890?preview=true'.format(HOSTNAME), headers=headers)
print(response)

Java

Apache HttpClient 4.5 API와 try-with-resources를 사용합니다. 클래스 이름에 맞는 GetRecordExample.java 파일에서 사용합니다.

import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClientBuilder;

public class GetRecordExample {
    public static void main(String[] args) throws Exception {
        String HOSTNAME = System.getenv("FOUNDRY_HOST");
        String TOKEN = System.getenv("FOUNDRY_TOKEN");

        try (CloseableHttpClient httpClient = HttpClientBuilder.create().build()) {
            HttpGet request = new HttpGet("https://" + HOSTNAME + "/api/v2/checkpoints/records/ri.checkpoints.main.checkpoint.a1b2c3d4-e5f6-7890-abcd-ef1234567890?preview=true");
            request.addHeader("authorization", String.format("Bearer %s", TOKEN));
            try (CloseableHttpResponse response = httpClient.execute(request)) {
                System.out.println(response);
            }
        }
    }
}

JavaScript

fetch를 제공하는 Node.js 환경에서 사용합니다. 서비스 사용자 토큰을 브라우저로 전달하지 않습니다.

const HOSTNAME = process.env.FOUNDRY_HOST;
const TOKEN = process.env.FOUNDRY_TOKEN;

fetch(`https://${HOSTNAME}/api/v2/checkpoints/records/ri.checkpoints.main.checkpoint.a1b2c3d4-e5f6-7890-abcd-ef1234567890?preview=true`, {
    method: 'GET',
    headers: {
        'Authorization': `Bearer ${TOKEN}`,
    }
}).then((response) => {
    console.log(response)
});

PowerShell

$TOKEN = $env:FOUNDRY_TOKEN
$HOSTNAME = $env:FOUNDRY_HOST

$headers = @{
    "authorization" = "Bearer $TOKEN"
}

$response = Invoke-WebRequest -Uri "https://$HOSTNAME/api/v2/checkpoints/records/ri.checkpoints.main.checkpoint.a1b2c3d4-e5f6-7890-abcd-ef1234567890?preview=true" `
	-Headers $headers

$response.content