Job Router Operations - Unassign Job

Servicio:

Communication

Versión de la API:

2023-11-01

Anula la asignación de un trabajo.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
assignmentId	path	True	string	Identificador de una asignación de trabajo.
endpoint	path	True	string	Uri del recurso de comunicación
jobId	path	True	string	Identificador de un trabajo.
api-version	query	True	string	Versión de API que se usará para la operación.

Cuerpo de la solicitud

Nombre	Tipo	Description
suspendMatching	boolean	Si SuspendMatching es true, no se pone en cola un trabajo para volver a coincidir con un trabajo.

Respuestas

Nombre	Tipo	Description
200 OK	UnassignJobResult	La solicitud se ha realizado correctamente.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Una respuesta de error inesperada. Encabezados x-ms-error-code: string

Ejemplos

Un-assign a job

Solicitud de ejemplo

HTTP

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

{
  "suspendMatching": false
}

Respuesta de muestra

status code:

200

{
  "jobId": "8780b28c-7079-4de1-9143-4d369289e958",
  "unassignmentCount": 1
}

Definiciones

Nombre	Description
Azure.Core.Foundations.Error	Objeto de error.
Azure.Core.Foundations.ErrorResponse	Respuesta que contiene los detalles del error.
Azure.Core.Foundations.InnerError	Objeto que contiene información más específica sobre el error. Según las directrices de la API de Microsoft One: https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
UnassignJobOptions	Solicitud de carga para cancelar la asignación de un trabajo.
UnassignJobResult	Carga de respuesta después de que un trabajo se haya anulado correctamente la asignación.

Azure.Core.Foundations.Error

Objeto de error.

Nombre	Tipo	Description
code	string	Uno de un conjunto definido por el servidor de códigos de error.
details	Azure.Core.Foundations.Error[]	Matriz de detalles sobre errores específicos que llevaron a este error notificado.
innererror	Azure.Core.Foundations.InnerError	Objeto que contiene información más específica que el objeto actual sobre el error.
message	string	Representación legible del error.
target	string	Destino del error.

Azure.Core.Foundations.ErrorResponse

Respuesta que contiene los detalles del error.

Nombre	Tipo	Description
error	Azure.Core.Foundations.Error	Objeto de error.

Azure.Core.Foundations.InnerError

Objeto que contiene información más específica sobre el error. Según las directrices de la API de Microsoft One: https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nombre	Tipo	Description
code	string	Uno de un conjunto definido por el servidor de códigos de error.
innererror	Azure.Core.Foundations.InnerError	Error interno.

UnassignJobOptions

Solicitud de carga para cancelar la asignación de un trabajo.

Nombre	Tipo	Description
suspendMatching	boolean	Si SuspendMatching es true, no se pone en cola un trabajo para volver a coincidir con un trabajo.

UnassignJobResult

Carga de respuesta después de que un trabajo se haya anulado correctamente la asignación.

Nombre	Tipo	Description
jobId	string	Identificador de un trabajo sin asignar.
unassignmentCount	integer	Número de veces que se anula la asignación de un trabajo. Como máximo 3.