RID로 쿼리 함수 조회(Get By RID) (V2)

함수 RID와 선택적인 버전으로 Query 메타데이터를 조회합니다. 버전을 생략하면 최신 버전을 가져오며 includePrerelease의 기본값은 false입니다. 사전 릴리스를 후보에 포함하려면 버전을 생략하고 이 값을 true로 지정합니다.

이 경로의 입력에는 latestVersionResolution이 없습니다. API 이름 조회의 게시 시각 선택 옵션과 구분합니다.

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

HTTP 요청

GET /api/v2/functions/queries/getByRid

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

경로 매개변수

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

쿼리 매개변수

요청 본문

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

응답

응답 형식은 Query입니다.

parameters의 구조

맵의 키는 ParameterId(string), 값은 Parameter(object)입니다.

키: 액션이나 쿼리 입력에 사용하는 매개변수의 고유 ID입니다. 매개변수는 Ontology Manager에서 확인하고 관리할 수 있습니다.

쿼리 매개변수의 설명과 자료형 및 필수 여부입니다.

dataType의 구조

22가지 분기와 중첩 필드, 집계 및 유형 참조의 조건은 QueryDataType을 따릅니다.

output의 구조

22가지 분기와 중첩 필드, 집계 및 유형 참조의 조건은 QueryDataType을 따릅니다.

typeReferences의 구조

맵의 키는 TypeReferenceIdentifier(string), 값은 QueryDataType(union<date, struct, set, void, string, double, integer, threeDimensionalAggregation, union, float, geoshape, long, boolean, unsupported, attachment, mediaReference, null, array, twoDimensionalAggregation, valueTypeReference, typeReference, timestamp>)입니다.

키: 현재 Query의 typeReferences 맵에서 자료형 정의를 찾을 식별자입니다.

쿼리 매개변수와 출력의 자료형을 구분합니다.

22가지 분기와 중첩 필드, 집계 및 유형 참조의 조건은 QueryDataType을 따릅니다.

가상 가격 쿼리 함수의 응답 예시입니다.

{
  "output": {
    "type": "double"
  },
  "apiName": "myQueryFunction",
  "displayName": "My Entity",
  "rid": "ri.function-registry.main.function.8cb2d957-f0e6-4e0c-81de-e701bd54b18c",
  "typeReferences": {
    "MyTypeReference": {
      "type": "integer"
    }
  },
  "parameters": {
    "price": {
      "dataType": {
        "type": "double"
      },
      "required": true
    }
  },
  "version": "1.2.3"
}

개별 오류

요청 예제

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

cURL

curl \
	-H "Authorization: Bearer ${FOUNDRY_TOKEN}" \
	"https://${FOUNDRY_HOST}/api/v2/functions/queries/getByRid?rid=ri.function-registry.main.function.8cb2d957-f0e6-4e0c-81de-e701bd54b18c&version=1.2.3&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/functions/queries/getByRid?rid=ri.function-registry.main.function.8cb2d957-f0e6-4e0c-81de-e701bd54b18c&version=1.2.3&preview=true'.format(HOSTNAME), headers=headers)
print(response)

Java

Apache HttpClient 4.5 API와 try-with-resources를 사용합니다. 클래스 이름에 맞는 GetByRidExample.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 GetByRidExample {
    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/functions/queries/getByRid?rid=ri.function-registry.main.function.8cb2d957-f0e6-4e0c-81de-e701bd54b18c&version=1.2.3&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/functions/queries/getByRid?rid=ri.function-registry.main.function.8cb2d957-f0e6-4e0c-81de-e701bd54b18c&version=1.2.3&preview=true`, {
    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/functions/queries/getByRid?rid=ri.function-registry.main.function.8cb2d957-f0e6-4e0c-81de-e701bd54b18c&version=1.2.3&preview=true" `
	-Headers $headers

$response.content