Compartilhar via

Job Router Operations - Close Job

  • Referência
Serviço:
Communication
Versão da API:
2023-11-01

Fecha um trabalho concluído.

POST {endpoint}/routing/jobs/{jobId}/assignments/{assignmentId}:close?api-version=2023-11-01

Parâmetros de URI

Nome Em Obrigatório Tipo Description
assignmentId
 path True

string

ID de uma tarefa de trabalho.
endpoint
 path True

string

URI do recurso de Comunicação
jobId
 path True

string

Id de um trabalho.
api-version
 query True

string

A versão da API a ser usada para esta operação.

Corpo da solicitação

Nome Tipo Description
closeAt

string

Se não for fornecida, a capacidade de trabalho será liberada imediatamente junto com uma notificação JobClosedEvent. Se fornecido, a capacidade de trabalho é liberada junto com uma notificação JobClosedEvent em um momento futuro em UTC.
dispositionCode

string

Indica o resultado de um trabalho, preencha esse campo com seus próprios valores personalizados.
note

string

Uma observação que será acrescentada à coleção Notes de um trabalho com o carimbo de data/hora atual.

Respostas

Nome Tipo Description
200 OK

object

A solicitação foi bem-sucedida.
Other Status Codes

Azure.Core.Foundations.ErrorResponse

Uma resposta de erro inesperada.

Cabeçalhos

x-ms-error-code: string

Exemplos

Closes a completed job

Solicitação de exemplo

POST https://contoso.westus.communications.azure.com/routing/jobs/8780b28c-7079-4de1-9143-4d369289e958/assignments/1d5896f3-8b54-40be-82d3-910323f5e2af:close?api-version=2023-11-01

{
  "dispositionCode": "JobCompleted.",
  "note": "Closing job"
}

Resposta de exemplo

Código de status:
200 
{}

Definições

Nome Description
Azure.Core.Foundations.Error

O objeto de erro.
Azure.Core.Foundations.ErrorResponse

Uma resposta que contém detalhes do erro.
Azure.Core.Foundations.InnerError

Um objeto que contém informações mais específicas sobre o erro. De acordo com as diretrizes da API do Microsoft One – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
CloseJobOptions

Solicitar conteúdo para trabalhos de fechamento

Azure.Core.Foundations.Error

O objeto de erro.

Nome Tipo Description
code

string

Um de um conjunto definido pelo servidor de códigos de erro.
details

Azure.Core.Foundations.Error[]

Uma matriz de detalhes sobre erros específicos que levaram a esse erro relatado.
innererror

Azure.Core.Foundations.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 do erro.
target

string

O destino do erro.

Azure.Core.Foundations.ErrorResponse

Uma resposta que contém detalhes do erro.

Nome Tipo Description
error

Azure.Core.Foundations.Error

O objeto de erro.

Azure.Core.Foundations.InnerError

Um objeto que contém informações mais específicas sobre o erro. De acordo com as diretrizes da API do Microsoft One – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nome Tipo Description
code

string

Um de um conjunto definido pelo servidor de códigos de erro.
innererror

Azure.Core.Foundations.InnerError

Erro interno.

CloseJobOptions

Solicitar conteúdo para trabalhos de fechamento

Nome Tipo Description
closeAt

string

Se não for fornecida, a capacidade de trabalho será liberada imediatamente junto com uma notificação JobClosedEvent. Se fornecido, a capacidade de trabalho é liberada junto com uma notificação JobClosedEvent em um momento futuro em UTC.
dispositionCode

string

Indica o resultado de um trabalho, preencha esse campo com seus próprios valores personalizados.
note

string

Uma observação que será acrescentada à coleção Notes de um trabalho com o carimbo de data/hora atual.