연결의 파일 가져오기 목록(List File Imports) (V2)

지정한 Connection에 정의된 파일 가져오기 중 호출자가 볼 권한이 있는 항목만 조회합니다. 목록에 없다는 이유만으로 작업이 존재하지 않는다고 단정하지 않습니다.

첫 요청에는 pageToken을 넣지 않습니다. 다음 페이지가 있으면 응답의 nextPageToken을 다음 요청의 쿼리 매개변수 pageToken으로 전달합니다.

HTTP 요청

GET /api/v2/connectivity/connections/{connectionRid}/fileImports

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

경로 매개변수

이름	자료형	필수 여부	의미와 조건	예시 값
`connectionRid`	`string`	필수	소스라고도 부르는 Connection의 RID입니다.	`ri.magritte..source.c078b71b-92f9-41b6-b0df-3760f411120b`

쿼리 매개변수

이름	자료형	필수 여부	의미와 조건	예시 값
`pageSize`	`integer`	선택	요청할 페이지 크기입니다.
`pageToken`	`string`	선택	페이지 조회를 시작할 위치입니다. 첫 요청에서는 생략하고, 다음 요청에서는 직전 응답의 `nextPageToken`을 `pageToken`으로 전달합니다.

요청 본문

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

응답

응답 형식은 ListFileImportsResponse입니다.

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

`data`의 구조

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

이름	자료형	필수 여부	의미와 조건	예시 값
`rid`	`string`	필수	배치 동기화라고도 부르는 FileImport의 RID입니다.	`ri.magritte..extract.27bb4f2b-63b8-44b8-a579-4e2bd65ba158`
`connectionRid`	`string`	필수	이 파일 가져오기가 사용하는 Connection, 즉 소스의 RID입니다.	`ri.magritte..source.c078b71b-92f9-41b6-b0df-3760f411120b`
`datasetRid`	`string`	필수	출력 데이터셋의 RID입니다. 파일 가져오기를 생성한 뒤에는 바꿀 수 없습니다.	`ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da`
`branchName`	`string`	선택	수집한 데이터를 담을 출력 데이터셋 브랜치입니다. 대부분의 플랫폼 인스턴스에서는 기본값이 `master`입니다. 파일 가져오기를 생성한 뒤에는 바꿀 수 없습니다.	`master`
`displayName`	`string`	필수		`My file import`
`fileImportFilters`	`list<FileImportFilter>`	선택	가져올 파일을 제한하는 필터 목록입니다. 지정한 순서대로 적용하며 순서에 따라 가져오기 성능이 달라질 수 있습니다.
`importMode`	`enum`	필수	원시 파일을 읽고 출력 데이터셋에 반영하는 방식입니다. `SNAPSHOT`은 이번 실행의 파일만으로 새 데이터셋 상태를 구성합니다. `APPEND`는 이전 실행의 데이터에 새 파일을 추가합니다. `UPDATE`는 파일 이름을 기준으로 기존 파일을 교체합니다. 허용값: `SNAPSHOT`, `APPEND`, `UPDATE`.	`SNAPSHOT`
`subfolder`	`string`	선택	외부 시스템에서 가져올 하위 폴더입니다. 생략하면 외부 시스템의 루트 폴더를 사용합니다.	`subfolder1/subfolder2`

`fileImportFilters`의 구조

파일 가져오기 필터의 9가지 유형은 type 필드로 구분합니다. 배열 순서대로 원천 파일에 적용하며 customFilter는 조회 전용입니다.

가상 파일 가져오기 목록의 응답 예시입니다.

{
  "data": [
    {
      "datasetRid": "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da",
      "importMode": "SNAPSHOT",
      "displayName": "My file import",
      "connectionRid": "ri.magritte..source.c078b71b-92f9-41b6-b0df-3760f411120b",
      "branchName": "master",
      "subfolder": "subfolder1/subfolder2",
      "rid": "ri.magritte..extract.27bb4f2b-63b8-44b8-a579-4e2bd65ba158",
      "fileImportFilters": [
        {
          "type": "pathMatchesFilter",
          "regex": "subfolder1/subfolder2/.*"
        }
      ]
    }
  ],
  "nextPageToken": "v1.QnVpbGQgdGhlIEZ1dHVyZTogaHR0cHM6Ly93d3cucGFsYW50aXIuY29tL2NhcmVlcnMvP2xldmVyLXNvdXJjZSU1YiU1ZD1BUElEb2NzI29wZW4tcG9zaXRpb25z"
}

개별 오류

오류 이름	오류 코드	HTTP	의미와 조건	추가 매개변수
`ConnectionNotFound`	`NOT_FOUND`	404	지정한 연결을 찾을 수 없습니다.	`connectionRid`

요청 예제

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

cURL

curl \
	-H "Authorization: Bearer ${FOUNDRY_TOKEN}" \
	"https://${FOUNDRY_HOST}/api/v2/connectivity/connections/ri.magritte..source.c078b71b-92f9-41b6-b0df-3760f411120b/fileImports"

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/connectivity/connections/ri.magritte..source.c078b71b-92f9-41b6-b0df-3760f411120b/fileImports'.format(HOSTNAME), headers=headers)
print(response)

Java

Apache HttpClient 4.5 API와 try-with-resources를 사용합니다. 클래스 이름에 맞는 ListFileImportsExample.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 ListFileImportsExample {
    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/connectivity/connections/ri.magritte..source.c078b71b-92f9-41b6-b0df-3760f411120b/fileImports");
            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/connectivity/connections/ri.magritte..source.c078b71b-92f9-41b6-b0df-3760f411120b/fileImports`, {
    method: 'GET',
    headers: {
        'Authorization': `Bearer ${TOKEN}`,
    }
}).then((response) => {
    console.log(response)
});

PowerShell

$ErrorActionPreference = 'Stop'
$TOKEN = $env:FOUNDRY_TOKEN
$HOSTNAME = $env:FOUNDRY_HOST

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

$response = Invoke-WebRequest -Uri "https://$HOSTNAME/api/v2/connectivity/connections/ri.magritte..source.c078b71b-92f9-41b6-b0df-3760f411120b/fileImports" `
	-Headers $headers

$response.content

Keyboard shortcuts

팔란티어 플랫폼 한국어 해설