Item Lifecycle - Get Item Payload

Serviço:

Workload Development

Versão da API:

v1

Chamado por Microsoft Fabric para recuperar o conteúdo da carga de trabalho de um item.
Quando o editor <de itens iframe> solicita um item, o Fabric executa validações básicas e chama essa API para recuperar o conteúdo da carga de trabalho.

Essa API aceita a autenticação SubjectAndApp.

Permissões

As permissões são verificadas por Microsoft Fabric.

GET https://workload.contoso.com/workload-api-path-placeholder/workspaces/{workspaceId}/items/{itemType}/{itemId}/payload

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
itemId	path	True	string (uuid)	A ID do item.
itemType	path	True	string	O tipo de item.
workspaceId	path	True	string (uuid)	O identificador do espaço de trabalho.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
ActivityId	True	string	Uma ID exclusiva para correlacionar a solicitação com seu sistema quando um usuário interage com sua carga de trabalho.
RequestId	True	string	Uma ID global exclusiva que ajuda o Fabric a correlacionar sua solicitação com nossos logs. Forneça essa ID ao relatar um problema.
Authorization	True	string	Um cabeçalho de autorização de token duplo que permite que a carga de trabalho valide a origem da solicitação, forneça o contexto do usuário e chame outros serviços. Esse cabeçalho tem o seguinte formato: SubjectAndAppToken1.0 subjectToken="delegated token", appToken="S2S token".
x-ms-client-tenant-id	True	string	A ID do locatário do cliente que está fazendo a solicitação.

Respostas

Nome	Tipo	Description
200 OK	GetItemPayloadResponse	Concluído com êxito.
Other Status Codes	ErrorResponse	Para condições de erro, a carga de trabalho deve retornar um código de status de erro HTTP apropriado (4xx, 5xx) com informações detalhadas de erro no corpo da resposta.

Exemplos

Get item content example

Solicitação de exemplo

HTTP

GET https://workload.contoso.com/workload-api-path-placeholder/workspaces/e5ef604d-e14f-4a59-9133-75d5a0cb9334/items/Contoso.FinanceAnalytics.Forecast/b14cb7e7-d346-4751-9cfd-8c2767d53111/payload

Resposta de exemplo

Código de status:

200

{
  "itemPayload": {
    "algorithm": "ExponentialSmoothing"
  }
}

Definições

Nome	Description
ErrorExtendedInformation	As informações de erro estendidas.
ErrorResponse	A resposta de erro.
ErrorSource	A origem do erro.
GetItemPayloadResponse	O conteúdo do item para o editor de itens.
NameValuePair	Um par nome-valor.

ErrorExtendedInformation

Objeto

As informações de erro estendidas.

Nome	Tipo	Description
additionalParameters	NameValuePair[]	Uma lista de parâmetros adicionais específicos ao erro.
errorCode	string	O código de erro.
message	string	A mensagem de erro.
messageParameters	string[]	Uma lista de parâmetros para formatar uma mensagem localizada.

ErrorResponse

Objeto

A resposta de erro.

Nome	Tipo	Description
errorCode	string	O código de erro.
isPermanent	boolean	Indica se o erro é permanente ou se a operação pode ser repetida.
message	string	A mensagem de erro.
messageParameters	string[]	Uma lista de parâmetros para formatar uma mensagem localizada.
moreDetails	ErrorExtendedInformation[]	Uma lista de detalhes de erro adicionais.
source	ErrorSource	A origem do erro.

ErrorSource

Enumeração

A origem do erro.

Valor	Description
System
User
External

GetItemPayloadResponse

Objeto

O conteúdo do item para o editor de itens.

Nome	Tipo	Description
itemPayload	object	Conteúdo específico para a carga de trabalho e o tipo de item.

NameValuePair

Objeto

Um par nome-valor.

Nome	Tipo	Description
name	string	O nome.
value	string	O valor .