Keyboard shortcuts

Press ← or → to navigate between chapters

Press ? to show this help

Press Esc to hide this help

체크포인트 기록 검색(Search Records) (V2)

체크포인트 유형, 사용자, 생성 시각, 통과 근거와 대상 식별자 등의 조건으로 기록을 검색합니다. 본문의 where.filter에 조건을 넣습니다.

페이지 크기는 생략하면 100이고 생성 시각 정렬은 기본 DESC입니다. ASC는 오래된 기록부터 반환합니다. 첫 요청에서는 본문의 pageToken을 생략하며, 다음 요청에는 직전 응답의 nextPageToken 문자열을 그대로 넣습니다. 토큰을 JSON처럼 보인다는 이유로 별도 객체로 변환하지 않습니다.

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

HTTP 요청

POST /api/v2/checkpoints/records/search

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

경로 매개변수

지정할 경로 매개변수가 없습니다.

쿼리 매개변수

이름자료형필수 여부의미와 조건예시 값
previewboolean선택미리보기 기능 사용을 활성화합니다.true

요청 본문

본문 형식은 SearchRecordsRequest이며 필수입니다.

이름자료형필수 여부의미와 조건예시 값
whereobject필수체크포인트 기록의 검색 조건입니다.본문 예시 참조
pageTokenstring선택페이지 조회를 시작할 위치입니다. 첫 요청에서는 생략하고, 다음 요청에서는 직전 응답의 nextPageToken을 pageToken으로 전달합니다.
pageSizeinteger선택검색 페이지 크기입니다. 생략하면 기본값 100을 사용합니다.
sortDirectionenum선택기록 생성 시각의 정렬 방향입니다. 기본값 DESC는 최근 기록부터 반환합니다. 허용값: ASC, DESC.DESC

where의 구조

이름자료형필수 여부의미와 조건예시 값
filterSearchCheckpointRecordsFilter필수체크포인트 기록을 선택하는 필터입니다.본문 예시 참조
filter의 구조

8가지 필터와 대상 식별자 20가지 분기의 전체 필드 및 조건은 검색 필터를 따릅니다.

다음 본문의 식별자와 값은 가상 예시입니다.

{
  "sortDirection": "DESC",
  "pageSize": 100,
  "where": {
    "filter": {
      "type": "eq",
      "field": "checkpointType",
      "value": "CONTOUR_EXPORT"
    }
  },
  "pageToken": "v1.QnVpbGQgdGhlIEZ1dHVyZTogaHR0cHM6Ly93d3cucGFsYW50aXIuY29tL2NhcmVlcnMvP2xldmVyLXNvdXJjZSU1YiU1ZD1BUElEb2NzI29wZW4tcG9zaXRpb25z"
}

응답

응답 형식은 SearchCheckpointRecordsResponse입니다. data는 Record 목록이며 nextPageToken이 있으면 다음 페이지를 조회할 수 있습니다.

이름자료형필수 여부의미와 조건예시 값
datalist<Record>선택
nextPageTokenstring선택다음 페이지를 요청할 때 pageToken에 전달할 토큰입니다. 다음 토큰이 없으면 마지막 페이지입니다.

data의 구조

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

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

가상 Contour 내보내기 기록 검색의 응답 예시입니다.

{
  "data": [
    {
      "rid": "ri.checkpoints.main.checkpoint.a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "type": "CONTOUR_EXPORT",
      "scope": "USER_SCOPED",
      "actingUser": {
        "userId": "f05f8da4-b84c-4fca-9c77-8af0b13d11de",
        "username": {
          "value": "admin"
        }
      },
      "createdAt": "2023-11-14T09:30:00.000Z",
      "checkpointedItems": [
        {
          "type": "checkpointedResource",
          "rid": "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da",
          "resourceType": "DATASET",
          "compassPath": {
            "value": "/My Project/My Dataset"
          },
          "orgMarkings": []
        }
      ],
      "justification": {
        "type": "acknowledgementJustification",
        "prompt": "I acknowledge this action",
        "title": "Export Confirmation"
      }
    }
  ],
  "nextPageToken": "{\"token\":\"1771291126611\",\"recordRid\":\"ri.checkpoints.main.checkpoint.01932cec-a44d-41fc-8066-bfc15c1c4a4c\"}"
}

개별 오류

오류 이름오류 코드HTTP의미와 조건추가 매개변수
SearchRecordsPermissionDeniedPERMISSION_DENIED403체크포인트 기록을 검색할 수 없습니다.

요청 예제

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

예제는 다음 페이지를 요청하는 형태입니다. pageToken은 반드시 직전 응답의 실제 nextPageToken으로 바꿉니다. 처음 조회할 때는 이 필드를 본문에서 제거하고 같은 검색 조건을 사용합니다.

cURL

curl -X POST \
	-H "Content-type: application/json" \
	-H "Authorization: Bearer ${FOUNDRY_TOKEN}" \
	"https://${FOUNDRY_HOST}/api/v2/checkpoints/records/search?preview=true" \
	-d '{"sortDirection":"DESC","pageSize":100,"where":{"filter":{"type":"eq","field":"checkpointType","value":"CONTOUR_EXPORT"}},"pageToken":"v1.QnVpbGQgdGhlIEZ1dHVyZTogaHR0cHM6Ly93d3cucGFsYW50aXIuY29tL2NhcmVlcnMvP2xldmVyLXNvdXJjZSU1YiU1ZD1BUElEb2NzI29wZW4tcG9zaXRpb25z"}'

Python

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

import os
import requests

HOSTNAME = os.environ["FOUNDRY_HOST"]
TOKEN = os.environ["FOUNDRY_TOKEN"]
headers = {
    "content-type": "application/json",
    "authorization": "Bearer {}".format(TOKEN)
}
request_body = {
    "sortDirection": "DESC",
    "pageSize": 100,
    "where": {
        "filter": {
            "type": "eq",
            "field": "checkpointType",
            "value": "CONTOUR_EXPORT"
        }
    },
    "pageToken": "v1.QnVpbGQgdGhlIEZ1dHVyZTogaHR0cHM6Ly93d3cucGFsYW50aXIuY29tL2NhcmVlcnMvP2xldmVyLXNvdXJjZSU1YiU1ZD1BUElEb2NzI29wZW4tcG9zaXRpb25z"
}

response = requests.post('https://{}/api/v2/checkpoints/records/search?preview=true'.format(HOSTNAME), headers=headers, json=request_body)
print(response)

Java

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

import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClientBuilder;
import org.apache.http.entity.ContentType;
import org.apache.http.entity.StringEntity;

public class SearchRecordsExample {
    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()) {
            HttpPost request = new HttpPost("https://" + HOSTNAME + "/api/v2/checkpoints/records/search?preview=true");
            request.addHeader("content-type", "application/json");
            request.addHeader("authorization", String.format("Bearer %s", TOKEN));
            request.setEntity(new StringEntity("{\"sortDirection\":\"DESC\",\"pageSize\":100,\"where\":{\"filter\":{\"type\":\"eq\",\"field\":\"checkpointType\",\"value\":\"CONTOUR_EXPORT\"}},\"pageToken\":\"v1.QnVpbGQgdGhlIEZ1dHVyZTogaHR0cHM6Ly93d3cucGFsYW50aXIuY29tL2NhcmVlcnMvP2xldmVyLXNvdXJjZSU1YiU1ZD1BUElEb2NzI29wZW4tcG9zaXRpb25z\"}", ContentType.APPLICATION_JSON));
            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/search?preview=true`, {
    method: 'POST',
    headers: {
        'Content-Type': 'application/json',
        'Authorization': `Bearer ${TOKEN}`,
    },
    body: '{"sortDirection":"DESC","pageSize":100,"where":{"filter":{"type":"eq","field":"checkpointType","value":"CONTOUR_EXPORT"}},"pageToken":"v1.QnVpbGQgdGhlIEZ1dHVyZTogaHR0cHM6Ly93d3cucGFsYW50aXIuY29tL2NhcmVlcnMvP2xldmVyLXNvdXJjZSU1YiU1ZD1BUElEb2NzI29wZW4tcG9zaXRpb25z"}'
}).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/search?preview=true" `
	-Method Post `
	-Headers $headers `
	-ContentType application/json `
	-Body "{`"sortDirection`":`"DESC`",`"pageSize`":100,`"where`":{`"filter`":{`"type`":`"eq`",`"field`":`"checkpointType`",`"value`":`"CONTOUR_EXPORT`"}},`"pageToken`":`"v1.QnVpbGQgdGhlIEZ1dHVyZTogaHR0cHM6Ly93d3cucGFsYW50aXIuY29tL2NhcmVlcnMvP2xldmVyLXNvdXJjZSU1YiU1ZD1BUElEb2NzI29wZW4tcG9zaXRpb25z`"}"

$response.content