Partilhar via

Item Lifecycle - Create Item

Serviço:
Workload Development
Versão da API:
v1

Chamado pelo Microsoft Fabric para criar um novo item.
Após a criação do item, o Fabric executa validações básicas, cria o item em um estado de provisionamento e chama essa API para notificar a carga de trabalho. Espera-se que a carga de trabalho execute as validações necessárias, armazene os metadados do item, aloque os recursos necessários e atualize o cache de metadados do item de malha com relações de item e ETag.

Esta API deve aceitar a autenticação SubjectAndApp.

Permissões

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

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

Parâmetros do URI

Name Em Necessário Tipo Description
itemId
 path True

string (uuid)

O ID do item.
itemType
 path True

string

O tipo de item.
workspaceId
 path True

string (uuid)

O ID do espaço de trabalho.

Cabeçalho do Pedido

Name Necessário Tipo Description
ActivityId True

string

Um ID exclusivo para correlacionar a solicitação com seu sistema quando um usuário interage com sua carga de trabalho.
RequestId True

string

Um ID exclusivo globalmente que ajuda o Fabric a correlacionar sua solicitação com nossos registros. 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 contexto de usuário e chame outros serviços. Este cabeçalho tem o seguinte formato: SubjectAndAppToken1.0 subjectToken="delegated token", appToken="S2S token".
x-ms-client-tenant-id True

string

O ID do locatário do cliente que faz a solicitação.

Corpo do Pedido

Name Necessário Tipo Description
displayName True

string

maxLength: 256

O nome de exibição do item. Não pode exceder 256 caracteres.
creationPayload

object

Criação de carga útil específica para a carga de trabalho e tipo de item. Passado pelo editor de itens ou como parâmetro da API de automação de malha.
description

string

A descrição do item.

Respostas

Name Tipo Description
200 OK

Criado com sucesso.
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

Create item example

Pedido de amostra

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

{
  "displayName": "Forecast 1",
  "description": "The 1st forecast item",
  "creationPayload": {
    "algorithm": "ExponentialSmoothing"
  }
}

Resposta da amostra

Código de estado:
200

Definições

Name Description
CreateItemRequest

Crie conteúdo de solicitação de item.
ErrorExtendedInformation

As informações de erro estendidas.
ErrorResponse

A resposta de erro.
ErrorSource

A origem do erro.
NameValuePair

Um par nome-valor.

CreateItemRequest

Object

Crie conteúdo de solicitação de item.

Name Tipo Description
creationPayload

object

Criação de carga útil específica para a carga de trabalho e tipo de item. Passado pelo editor de itens ou como parâmetro da API de automação de malha.
description

string

A descrição do item.
displayName

string

maxLength: 256

O nome de exibição do item. Não pode exceder 256 caracteres.

ErrorExtendedInformation

Object

As informações de erro estendidas.

Name Tipo Description
additionalParameters

NameValuePair[]

Uma lista de parâmetros adicionais específicos para o 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

Object

A resposta de erro.

Name 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

NameValuePair

Object

Um par nome-valor.

Name Tipo Description
name

string

O nome.
value

string

O valor.