Partilhar via


Models - DigitalTwinModels List

Obtém metadados de modelo e, opcionalmente, definições de modelo. Códigos de estado:

  • 200 OK
  • 400 Pedido Incorreto
    • InvalidArgument – o ID do modelo é inválido.
    • LimitExceeded - Foi atingido o número máximo de IDs de modelo permitidos em "dependenciesFor".
  • 404 Não Encontrado
    • ModelNotFound - O modelo não foi encontrado.
GET https://digitaltwins-hostname/models?api-version=2023-10-31
GET https://digitaltwins-hostname/models?dependenciesFor={dependenciesFor}&includeModelDefinition={includeModelDefinition}&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.

dependenciesFor
query

string[]

Se especificado, devolve apenas o conjunto dos modelos especificados juntamente com as respetivas dependências. Se for omitido, todos os modelos são obtidos.

includeModelDefinition
query

boolean

Quando verdadeiro, a definição do modelo será devolvida como parte do resultado.

Cabeçalho do Pedido

Name Necessário Tipo Description
max-items-per-page

integer

O número máximo de itens a obter por pedido. O servidor pode optar por devolver menos do que o número pedido.

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.

Respostas

Name Tipo Description
200 OK

PagedDigitalTwinsModelDataCollection

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

List models
List models (include dependencies and definitions)

List models

Sample Request

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

Sample Response

{
  "value": [
    {
      "id": "dtmi:com:example:Sample;1",
      "uploadTime": "2022-02-28T00:30:00.1234567Z",
      "decommissioned": false
    },
    {
      "id": "dtmi:com:example:SampleDeviceModel;1",
      "displayName": {
        "en": "My Device Model"
      },
      "uploadTime": "2022-02-27T00:30:00.1234567Z",
      "decommissioned": false
    },
    {
      "id": "dtmi:com:example:AnotherSample;1",
      "displayName": {
        "en": "My Sample"
      },
      "uploadTime": "2022-02-26T00:30:00.1234567Z",
      "decommissioned": false
    }
  ],
  "nextLink": "url-to-next-page"
}

List models (include dependencies and definitions)

Sample Request

GET https://digitaltwins-hostname/models?dependenciesFor=dtmi:com:example:SampleDeviceModel;1&includeModelDefinition=True&api-version=2023-10-31

Sample Response

{
  "value": [
    {
      "id": "dtmi:com:example:Sample;1",
      "uploadTime": "2022-02-28T00:30:00.1234567Z",
      "decommissioned": false,
      "model": {
        "@id": "dtmi:com:example:Sample;1",
        "@type": "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"
      }
    },
    {
      "id": "dtmi:com:example:SampleDeviceModel;1",
      "displayName": {
        "en": "My Device Model"
      },
      "uploadTime": "2022-02-28T00:30:00.1234567Z",
      "decommissioned": false,
      "model": {
        "@id": "dtmi:com:example:SampleDeviceModel;1",
        "@type": "Interface",
        "displayName": "My Device Model",
        "contents": [
          {
            "@type": "Component",
            "name": "Sample",
            "schema": "dtmi:com:example:Sample;1"
          }
        ],
        "@context": "dtmi:dtdl:context;2"
      }
    }
  ],
  "nextLink": "url-to-next-page"
}

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 indicada pelo erro que contém.

PagedDigitalTwinsModelDataCollection

Uma coleção de objetos DigitalTwinsModelData.

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 subestado para o código de erro HTTP.

details

Error[]

Detalhes internos do erro.

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 indicada 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.

PagedDigitalTwinsModelDataCollection

Uma coleção de objetos DigitalTwinsModelData.

Name Tipo Description
nextLink

string

Um URI para obter a página seguinte de objetos.

value

DigitalTwinsModelData[]

Os objetos DigitalTwinsModelData.