Partilhar via

Items - Get Item Definition

Serviço:
Core
Versão da API:
v1

Retorna a definição de item especificada.
Esta API é suportada para vários tipos de itens, localize os tipos de itens suportados e informações sobre a sua estrutura de definição em Visão geral da definição de item. Quando você obtém a definição de um item, o rótulo de sensibilidade não faz parte da definição.

Esta API suporta operações de longa duração (LRO).

Permissões

O chamador deve ter permissões de leitura e gravação para o item.

Escopos delegados necessários

Para APIs de item, use estes tipos de escopo:

  • Escopo genérico: Item.ReadWrite.All
  • Âmbito específico: itemType. ReadWrite.All (por exemplo: Notebook.ReadWrite.All)

para obter mais informações sobre escopos, consulte o artigo Escopos.

Limitações

Essa API é bloqueada para um item com um rótulo de sensibilidade protegido, a menos que o chamador tenha os direitos de uso para excluir o rótulo de sensibilidade.

Identidades suportadas pelo Entra da Microsoft

Esta API suporta as identidades do Microsoft listadas nesta secção.

Identidade Apoio
Utilizador Sim
Entidade de serviço e identidades geridas Quando o tipo de item na chamada é suportado. Verifique a API correspondente para o tipo de item que você está chamando para ver se sua chamada é suportada. Por exemplo, modelos semânticos são suportados.

Interfaz

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

Parâmetros do URI

Name Em Necessário Tipo Description
itemId
 path True

string (uuid)

O ID do item.
workspaceId
 path True

string (uuid)

O ID do espaço de trabalho.
format
 query

string

O formato da definição do item.

Respostas

Name Tipo Description
200 OK

ItemDefinitionResponse

Pedido concluído com sucesso.
202 Accepted

Pedido aceite. Está em curso a recuperação da definição.

Cabeçalhos

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

ErrorResponse

Códigos de erro comuns:

  • OperationNotSupportedForItem - Operação não suportada para o item solicitado.

Exemplos

Get an item definition example

Pedido de amostra

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

Resposta da amostra

Código de estado:
200 
{
  "definition": {
    "parts": [
      {
        "path": "report.json",
        "payload": "QmFzZTY0U3RyaW5n",
        "payloadType": "InlineBase64"
      },
      {
        "path": "definition.pbir",
        "payload": "QW5vdGhlckJhc2U2NFN0cmluZw",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
        "payloadType": "InlineBase64"
      }
    ]
  }
}
Código de estado:
202 
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

Definições

Name Description
ErrorRelatedResource

O objeto de detalhes do recurso relacionado ao erro.
ErrorResponse

A resposta de erro.
ErrorResponseDetails

Os detalhes da resposta de erro.
ItemDefinition

Um objeto de definição de item.
ItemDefinitionPart

Um objeto de parte de definição de item.
ItemDefinitionResponse

Resposta de definição pública do item.
PayloadType

O tipo de carga útil da peça de definição. Ao longo do tempo, podem ser adicionados tipos de carga útil adicionais.

ErrorRelatedResource

Object

O objeto de detalhes do recurso relacionado ao erro.

Name Tipo Description
resourceId

string

A ID do recurso envolvida no erro.
resourceType

string

O tipo de recurso envolvido no erro.

ErrorResponse

Object

A resposta de erro.

Name Tipo Description
errorCode

string

Um identificador específico que fornece informações sobre uma condição de erro, permitindo uma comunicação padronizada entre nosso serviço e seus usuários.
message

string

Uma representação legível por humanos do erro.
moreDetails

ErrorResponseDetails[]

Lista de detalhes de erro adicionais.
relatedResource

ErrorRelatedResource

Os detalhes do recurso relacionados ao erro.
requestId

string

ID da solicitação associada ao erro.

ErrorResponseDetails

Object

Os detalhes da resposta de erro.

Name Tipo Description
errorCode

string

Um identificador específico que fornece informações sobre uma condição de erro, permitindo uma comunicação padronizada entre nosso serviço e seus usuários.
message

string

Uma representação legível por humanos do erro.
relatedResource

ErrorRelatedResource

Os detalhes do recurso relacionados ao erro.

ItemDefinition

Object

Um objeto de definição de item.

Name Tipo Description
format

string

O formato da definição do item.
parts

ItemDefinitionPart[]

Uma lista de partes de definição.

ItemDefinitionPart

Object

Um objeto de parte de definição de item.

Name Tipo Description
path

string

O caminho da parte do item.
payload

string

A carga útil da parte do item.
payloadType

PayloadType

O tipo de carga útil.

ItemDefinitionResponse

Object

Resposta de definição pública do item.

Name Tipo Description
definition

ItemDefinition

Um objeto de definição de item.

PayloadType

Enumeração

O tipo de carga útil da peça de definição. Ao longo do tempo, podem ser adicionados tipos de carga útil adicionais.

Valor Description
InlineBase64

Base em linha 64.