Items - Update Item Definition

Serviço:

Core

Versão da API:

v1

Substitui a definição para o item especificado.
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. A atualização da definição do item não afeta seu rótulo de sensibilidade.

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 artigo Escopos.

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}/updateDefinition

Com parâmetros opcionais:

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

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.
updateMetadata	query		boolean	Quando definido como true e o arquivo .platform é fornecido como parte da definição, os metadados do item são atualizados usando os metadados no arquivo .platform

Corpo do Pedido

Name	Necessário	Tipo	Description
definition	True	ItemDefinition	Um objeto de definição de item.

Respostas

Name	Tipo	Description
200 OK		Pedido concluído com sucesso.
202 Accepted		Pedido aceite. A definição de atualização está em andamento. 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. CorruptedPayload - A carga fornecida está corrompida.

Exemplos

Update an item definition example

Pedido de amostra

HTTP

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

{
  "definition": {
    "parts": [
      {
        "path": "report.json",
        "payload": "QmFzZTY0U3RyaW5n",
        "payloadType": "InlineBase64"
      },
      {
        "path": "definition.pbir",
        "payload": "QW5vdGhlckJhc2U2NFN0cmluZw",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
        "payloadType": "InlineBase64"
      }
    ]
  }
}

Resposta da amostra

Código de estado:

200

Código de estado:

202

Location: https://api.fabric.microsoft.com/v1/operations/427f6c34-b64e-4ee4-8ea5-b533c0e203ef
x-ms-operation-id: 427f6c34-b64e-4ee4-8ea5-b533c0e203ef
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.
PayloadType	O tipo de carga útil da peça de definição. Ao longo do tempo, podem ser adicionados tipos de carga útil adicionais.
UpdateItemDefinitionRequest	Atualize a carga útil da solicitação de definição de item.

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.

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.

UpdateItemDefinitionRequest

Object

Atualize a carga útil da solicitação de definição de item.

Name	Tipo	Description
definition	ItemDefinition	Um objeto de definição de item.