Items - Execute Query (beta)

서비스:: GraphModel

API 버전:: v1

지정된 그래프 모델에서 쿼리를 실행합니다.

비고

GraphModel 항목은 현재 미리 보기로 제공됩니다(자세한 정보). 이 API는 베타 릴리스의 일부이며 평가 및 개발 목적으로만 제공됩니다. 피드백에 따라 변경 될 수 있으며 프로덕션 사용에는 권장되지 않습니다. 이 API를 호출할 때 호출자는 쿼리 매개 변수 true 의 값으로 지정 beta 해야 합니다.preview 쿼리 매개 변수는 .로 대체beta되었습니다. 이전 버전과의 호환성을 preview 위해 계속 지원되며 )와 동일하게 beta동작합니다.

이 API는 페이지 매김지원합니다.

Permissions

호출자에게 는 뷰어 작업 영역 역할이 있어야 합니다.

필요한 위임된 범위

Workspace.Read.All 또는 Workspace.ReadWrite.All

지원되는 ID Microsoft Entra

이 API는 이 섹션에 나열된 Microsoft ID 지원합니다.

아이덴티티	Support
사용자	Yes
서비스 주체 및 관리 ID	Yes

인터페이스

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/graphModels/{graphModelId}/executeQuery?beta={beta}

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
graphModelId	path	True	string (uuid)	GraphModel ID입니다.
workspaceId	path	True	string (uuid)	작업 영역 ID입니다.
beta	query	True	boolean	현재 베타 버전인 이 API에 액세스하려면 `true` 이 필수 매개 변수를 설정해야 합니다.

요청 본문

Name	필수	형식	Description
query	True	string	쿼리 문자열입니다.

응답

Name 형식 Description

200 OK

Name	형식	Description
200 OK	file	쿼리 실행이 성공적으로 완료되었습니다. 결과는 JSON 형식입니다. 데이터를 읽는 방법은 MSFT GQL API 를 참조하세요.
429 Too Many Requests	ErrorResponse	서비스 속도 제한을 초과했습니다. 서버는 클라이언트가 `Retry-After` 추가 요청을 보내기 전에 대기해야 하는 시간을 초 단위로 나타내는 헤더를 반환합니다. 헤더 Retry-After: integer
Other Status Codes	ErrorResponse	일반적인 오류 코드: OperationNotSupportedForItem - 요청된 항목에 대해 지원되지 않는 작업입니다. CorruptedPayload - 제공된 페이로드가 손상되었습니다.

file

쿼리 실행이 성공적으로 완료되었습니다. 결과는 JSON 형식입니다. 데이터를 읽는 방법은 MSFT GQL API 를 참조하세요.

429 Too Many Requests

ErrorResponse

서비스 속도 제한을 초과했습니다. 서버는 클라이언트가 Retry-After 추가 요청을 보내기 전에 대기해야 하는 시간을 초 단위로 나타내는 헤더를 반환합니다.

헤더

Retry-After: integer

Other Status Codes

ErrorResponse

일반적인 오류 코드:

OperationNotSupportedForItem - 요청된 항목에 대해 지원되지 않는 작업입니다.
CorruptedPayload - 제공된 페이로드가 손상되었습니다.

예제

Execute a graph query example

샘플 요청

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/graphModels/5b218778-e7a5-4d73-8187-f10824047715/executeQuery?beta=True

{
  "query": "MATCH (node_station:`station`) RETURN TO_JSON_STRING(node_station) AS `station` LIMIT 10;"
}

샘플 응답

상태 코드:: 200

{
  "status": {
    "code": "00000",
    "description": "note: successful completion",
    "diagnostics": {
      "OPERATION": "query",
      "OPERATION_CODE": "0",
      "CURRENT_SCHEMA": "/"
    }
  },
  "result": {
    "kind": "TABLE",
    "columns": [
      {
        "name": "station",
        "gqlType": "STRING",
        "jsonType": "string"
      }
    ],
    "data": [
      {
        "station": "{\"labels\":[\"station\"],\"oid\":\"1688849860263937\",\"properties\":{\"stationFrom\":\"Holborn\",\"stationTo\":\"Chancery_Lane\"}}"
      },
      {
        "station": "{\"labels\":[\"station\"],\"oid\":\"1688849860263938\",\"properties\":{\"stationFrom\":\"Chancery_Lane\",\"stationTo\":\"St_Paul's\"}}"
      },
      {
        "station": "{\"labels\":[\"station\"],\"oid\":\"1688849860263939\",\"properties\":{\"stationFrom\":\"Hyde_Park_Corner\",\"stationTo\":\"Green_Park\"}}"
      },
      {
        "station": "{\"labels\":[\"station\"],\"oid\":\"1688849860263940\",\"properties\":{\"stationFrom\":\"Holborn\",\"stationTo\":\"Russel_Square\"}}"
      },
      {
        "station": "{\"labels\":[\"station\"],\"oid\":\"1688849860263941\",\"properties\":{\"stationFrom\":\"Euston\",\"stationTo\":\"Warren_Street\"}}"
      },
      {
        "station": "{\"labels\":[\"station\"],\"oid\":\"1688849860263942\",\"properties\":{\"stationFrom\":\"Victoria\",\"stationTo\":\"Pimlico\"}}"
      },
      {
        "station": "{\"labels\":[\"station\"],\"oid\":\"1688849860263943\",\"properties\":{\"stationFrom\":\"London_Bridge\",\"stationTo\":\"Monument\"}}"
      },
      {
        "station": "{\"labels\":[\"station\"],\"oid\":\"1688849860263944\",\"properties\":{\"stationFrom\":\"Moorgate\",\"stationTo\":\"Old_Street\"}}"
      },
      {
        "station": "{\"labels\":[\"station\"],\"oid\":\"1688849860263945\",\"properties\":{\"stationFrom\":\"South_Kensington\",\"stationTo\":\"Sloane_Square\"}}"
      },
      {
        "station": "{\"labels\":[\"station\"],\"oid\":\"1688849860263946\",\"properties\":{\"stationFrom\":\"Victoria\",\"stationTo\":\"St_James's_Park\"}}"
      }
    ]
  }
}

정의

Name	Description
ErrorRelatedResource	오류 관련 리소스 세부 정보 개체입니다.
ErrorResponse	오류 응답입니다.
ErrorResponseDetails	오류 응답 세부 정보입니다.
ExecuteQueryRequest	쿼리 요청 페이로드를 실행합니다.

ErrorRelatedResource

Object

오류 관련 리소스 세부 정보 개체입니다.

Name	형식	Description
resourceId	string	오류와 관련된 리소스 ID입니다.
resourceType	string	오류와 관련된 리소스의 형식입니다.

ErrorResponse

Object

오류 응답입니다.

Name	형식	Description
errorCode	string	오류 조건에 대한 정보를 제공하여 서비스와 사용자 간의 표준화된 통신을 허용하는 특정 식별자입니다.
message	string	사용자가 읽을 수 있는 오류 표현입니다.
moreDetails	ErrorResponseDetails[]	추가 오류 세부 정보 목록입니다.
relatedResource	ErrorRelatedResource	오류 관련 리소스 세부 정보입니다.
requestId	string (uuid)	오류와 연결된 요청의 ID입니다.

ErrorResponseDetails

Object

오류 응답 세부 정보입니다.

Name	형식	Description
errorCode	string	오류 조건에 대한 정보를 제공하여 서비스와 사용자 간의 표준화된 통신을 허용하는 특정 식별자입니다.
message	string	사용자가 읽을 수 있는 오류 표현입니다.
relatedResource	ErrorRelatedResource	오류 관련 리소스 세부 정보입니다.

ExecuteQueryRequest

Object

쿼리 요청 페이로드를 실행합니다.

Name	형식	Description
query	string	쿼리 문자열입니다.

다음을 통해 공유

Items - Execute Query (beta)

Permissions

필요한 위임된 범위

지원되는 ID Microsoft Entra

인터페이스

URI 매개 변수

요청 본문

응답

예제

Execute a graph query example

샘플 요청

샘플 응답

정의

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

ExecuteQueryRequest