다음을 통해 공유


Items - Get Item Definition

지정된 항목 정의를 반환합니다.
이 API는 다양한 항목 유형에 대해 지원되며, 항목 정의 개요에서 지원되는 항목 유형 및 해당 정의 구조에 대한 정보를 찾습니다. 항목의 정의를 받으면 민감도 레이블이 정의의 일부가 아닙니다.

이 API는 LRO(장기 실행 작업)지원합니다.

권한

호출자에게 항목에 대한 읽기 및 쓰기 권한이 있어야 합니다.

필요한 위임된 범위

항목 API의 경우 다음 범위 유형을 사용합니다.

  • 제네릭 범위: Item.ReadWrite.All
  • 특정 범위: itemType. ReadWrite.All(예: Notebook.ReadWrite.All)

범위에 대한 자세한 내용은 범위 문서를 참조하세요.

제한점

이 API는 호출자가 민감도 레이블을 삭제할 수 있는 사용 권한이 없는 한 보호된 민감도 레이블이 있는 항목에 대해 차단됩니다.

Microsoft Entra 지원 식별자

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

아이덴티티 지원
사용자
서비스 주체관리 ID 호출의 항목 유형이 지원되는 경우 호출하는 항목 유형에 대한 해당 API를 확인하여 호출이 지원되는지 확인합니다. 예를 들어 의미 체계 모델이 지원됩니다.

인터페이스

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items/{itemId}/getDefinition
POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items/{itemId}/getDefinition?format={format}

URI 매개 변수

Name In(다음 안에) 필수 형식 Description
itemId
path True

string (uuid)

항목 ID입니다.

workspaceId
path True

string (uuid)

작업 영역 ID입니다.

format
query

string

항목 정의의 형식입니다.

응답

Name 형식 Description
200 OK

ItemDefinitionResponse

요청이 성공적으로 완료되었습니다.

202 Accepted

요청이 수락되었습니다. 정의 검색이 진행 중입니다.

헤더

  • Location: string
  • x-ms-operation-id: string
  • Retry-After: integer
Other Status Codes

ErrorResponse

일반적인 오류 코드:

  • OperationNotSupportedForItem - 요청된 항목에 대해 지원되지 않는 작업입니다.

예제

Get an item definition example

샘플 요청

POST https://api.fabric.microsoft.com/v1/workspaces/6e335e92-a2a2-4b5a-970a-bd6a89fbb765/items/cfafbeb1-8037-4d0c-896e-a46fb27ff229/getDefinition

샘플 응답

{
  "definition": {
    "parts": [
      {
        "path": "report.json",
        "payload": "QmFzZTY0U3RyaW5n",
        "payloadType": "InlineBase64"
      },
      {
        "path": "definition.pbir",
        "payload": "QW5vdGhlckJhc2U2NFN0cmluZw",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
        "payloadType": "InlineBase64"
      }
    ]
  }
}
Location: https://api.fabric.microsoft.com/v1/operations/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
x-ms-operation-id: 431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
Retry-After: 30

정의

Name Description
ErrorRelatedResource

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

ErrorResponse

오류 응답입니다.

ErrorResponseDetails

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

ItemDefinition

항목 정의 개체입니다.

ItemDefinitionPart

항목 정의 파트 개체입니다.

ItemDefinitionResponse

항목 공용 정의 응답입니다.

PayloadType

정의 파트 페이로드의 형식입니다. 추가 페이로드 유형은 시간이 지남에 따라 추가될 수 있습니다.

ErrorRelatedResource

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

Name 형식 Description
resourceId

string

오류와 관련된 리소스 ID입니다.

resourceType

string

오류와 관련된 리소스의 형식입니다.

ErrorResponse

오류 응답입니다.

Name 형식 Description
errorCode

string

오류 조건에 대한 정보를 제공하여 서비스와 사용자 간의 표준화된 통신을 허용하는 특정 식별자입니다.

message

string

사용자가 읽을 수 있는 오류 표현입니다.

moreDetails

ErrorResponseDetails[]

추가 오류 세부 정보 목록입니다.

relatedResource

ErrorRelatedResource

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

requestId

string

오류와 연결된 요청의 ID입니다.

ErrorResponseDetails

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

Name 형식 Description
errorCode

string

오류 조건에 대한 정보를 제공하여 서비스와 사용자 간의 표준화된 통신을 허용하는 특정 식별자입니다.

message

string

사용자가 읽을 수 있는 오류 표현입니다.

relatedResource

ErrorRelatedResource

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

ItemDefinition

항목 정의 개체입니다.

Name 형식 Description
format

string

항목 정의의 형식입니다.

parts

ItemDefinitionPart[]

정의 부분 목록입니다.

ItemDefinitionPart

항목 정의 파트 개체입니다.

Name 형식 Description
path

string

항목 파트 경로입니다.

payload

string

항목 부분 페이로드입니다.

payloadType

PayloadType

페이로드 형식입니다.

ItemDefinitionResponse

항목 공용 정의 응답입니다.

Name 형식 Description
definition

ItemDefinition

항목 정의 개체입니다.

PayloadType

정의 파트 페이로드의 형식입니다. 추가 페이로드 유형은 시간이 지남에 따라 추가될 수 있습니다.

Description
InlineBase64

인라인 베이스 64.