Partilhar via


Models - DigitalTwinModels Add

Carrega um ou mais modelos. Quando ocorre um erro, não são carregados modelos. Códigos de estado:

  • 201 Criado
  • 400 Pedido Incorreto
    • DTDLParserError – os modelos fornecidos não são DTDL válidos.
    • InvalidArgument - O ID do modelo é inválido.
    • LimitExceeded – o número máximo de IDs de modelo permitidos em "dependenciesFor" foi atingido.
    • ModelVersionNotSupported – a versão do DTDL utilizada não é suportada.
  • 409 Conflito
    • ModelAlreadyExists – o modelo fornecido já existe.
POST https://digitaltwins-hostname/models?api-version=2023-10-31

Parâmetros do URI

Name Em Necessário Tipo Description
api-version
query True

string

A versão da API pedida.

Cabeçalho do Pedido

Name Necessário Tipo Description
traceparent

string

Identifica o pedido num sistema de rastreio distribuído.

tracestate

string

Fornece informações de identificação de rastreio específicas do fornecedor e é um complemento para o traceparent.

Corpo do Pedido

Name Tipo Description
models

object[]

Uma matriz de modelos a adicionar.

Respostas

Name Tipo Description
201 Created

DigitalTwinsModelData[]

Com êxito

Other Status Codes

ErrorResponse

Resposta predefinida.

Headers

x-ms-error-code: string

Segurança

oauth2

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize?resource=0b07f429-9f4b-4714-9392-cc5e8e80c8b0

Exemplos

Add models

Sample Request

POST https://digitaltwins-hostname/models?api-version=2023-10-31

[
  {
    "@id": "dtmi:com:example:Sample;1",
    "@type": "Interface",
    "displayName": "Sample Interface",
    "contents": [
      {
        "@type": "Property",
        "name": "name",
        "displayName": "Sample instance name",
        "schema": "string"
      },
      {
        "@type": "Property",
        "name": "temp",
        "displayName": "Sample instance temperature",
        "schema": "integer"
      },
      {
        "@type": "Property",
        "name": "comfortIndex",
        "displayName": "Sample instance comfort index",
        "schema": "integer"
      }
    ],
    "@context": "dtmi:dtdl:context;2"
  }
]

Sample Response

[
  {
    "id": "dtmi:com:example:Sample;1",
    "displayName": {
      "en": "Sample Interface"
    },
    "uploadTime": "2022-02-28T00:30:00.1234567Z",
    "decommissioned": false
  }
]

Definições

Name Description
DigitalTwinsModelData

Uma definição de modelo e metadados para esse modelo.

Error

Definição de erro.

ErrorResponse

Resposta de erro.

InnerError

Uma descrição de erro mais específica do que a fornecida pelo erro que contém.

DigitalTwinsModelData

Uma definição de modelo e metadados para esse modelo.

Name Tipo Valor Predefinido Description
decommissioned

boolean

False

Indica se o modelo está desativado. Os modelos desativados não podem ser referenciados por duplos digitais recentemente criados.

description

object

Um mapa de idiomas que contém as descrições localizadas, conforme especificado na definição do modelo.

displayName

object

Um mapa de idiomas que contém os nomes a apresentar localizados, conforme especificado na definição do modelo.

id

string

O ID do modelo, conforme especificado na definição do modelo.

model

object

A definição do modelo.

uploadTime

string

A hora em que o modelo foi carregado para o serviço.

Error

Definição de erro.

Name Tipo Description
code

string

Código de erro específico do serviço que serve como o subtatus para o código de erro HTTP.

details

Error[]

Detalhes de erro internos.

innererror

InnerError

Um objeto que contém informações mais específicas do que o objeto atual sobre o erro.

message

string

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

ErrorResponse

Resposta de erro.

Name Tipo Description
error

Error

Os detalhes do erro.

InnerError

Uma descrição de erro mais específica do que a fornecida pelo erro que contém.

Name Tipo Description
code

string

Um código de erro mais específico do que o fornecido pelo erro que contém.

innererror

InnerError

Um objeto que contém informações mais específicas do que o objeto atual sobre o erro.