Jobs - DeleteJobs GetById

Service:

Azure Digital Twins

API Version:

2023-10-31

Recupera um trabalho de exclusão. Códigos de status:

• 200 OK
• 404 Não Encontrado
  • DeleteJobNotFound – O trabalho de exclusão não foi encontrado.

GET https://digitaltwins-hostname/jobs/deletions/{id}?api-version=2023-10-31

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
id	path	True	string	A ID do trabalho de exclusão. A ID é exclusiva dentro do serviço e diferencia maiúsculas de minúsculas.
api-version	query	True	string	A versão da API solicitada.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
traceparent		string	Identifica a solicitação em um sistema de rastreamento distribuído.
tracestate		string	Fornece informações de identificação de rastreamento específicas do fornecedor e é um complemento para o rastreamentoparente.

Respostas

Nome	Tipo	Description
200 OK	DeleteJob	Êxito
Other Status Codes	ErrorResponse	Resposta padrão. 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

Get an import job by id

Sample Request

HTTP

GET https://digitaltwins-hostname/jobs/deletions/deletejob1?api-version=2023-10-31

Sample Response

Status code:

200

{
  "id": "deletejob1",
  "createdDateTime": "2022-01-01T00:00:00.0000000+00:00",
  "finishedDateTime": "2022-01-01T00:01:00.0000000+00:00",
  "purgeDateTime": "2022-01-31T00:01:00.0000000+00:00",
  "status": "succeeded"
}

Definições

Nome	Description
delete-job-status	Status do trabalho.
DeleteJob	Um trabalho que contém uma referência às operações a serem executadas, resultados e metadados de execução.
Error	Definição de erro.
ErrorResponse	Resposta de erro.
InnerError	Uma descrição de erro mais específica do que foi fornecida pelo erro que contém.

delete-job-status

Status do trabalho.

Nome	Tipo	Description
failed	string
notstarted	string
running	string
succeeded	string

DeleteJob

Um trabalho que contém uma referência às operações a serem executadas, resultados e metadados de execução.

Nome	Tipo	Description
createdDateTime	string	Hora de início do trabalho. O carimbo de data/hora está no formato RFC3339: yyyy-MM-ddTHH:mm:ssZ.
error	Error	Detalhes dos erros que ocorreram na execução do trabalho de importação.
finishedDateTime	string	Hora de término do trabalho. O carimbo de data/hora está no formato RFC3339: yyyy-MM-ddTHH:mm:ssZ.
id	string	O identificador do trabalho de exclusão.
purgeDateTime	string	Hora em que o trabalho será limpo pelo serviço do sistema. O carimbo de data/hora está no formato RFC3339: yyyy-MM-ddTHH:mm:ssZ.
status	delete-job-status	Status do trabalho.

Error

Definição de erro.

Nome	Tipo	Description
code	string	Código de erro específico do serviço que serve como substatus para o código de erro HTTP.
details	Error[]	Detalhes do erro interno.
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 pelo homem do erro.

ErrorResponse

Resposta de erro.

Nome	Tipo	Description
error	Error	Os detalhes do erro.

InnerError

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

Nome	Tipo	Description
code	string	Um código de erro mais específico do que foi 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.