Compartir a través de

Job Router Operations - Cancel Job

  • Referencia
Servicio:
Communication
Versión de la API:
2023-11-01

Envía la solicitud para cancelar un trabajo existente por identificador al proporcionar el motivo de cancelación de forma gratuita.

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

Parámetros de identificador URI

Nombre En Requerido Tipo Description
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 la API que se va a usar para esta operación.

Cuerpo de la solicitud

Nombre Tipo Description
dispositionCode

string

Indica el resultado de un trabajo, rellene este campo con sus propios valores personalizados. Si no se proporciona, se establece el valor predeterminado de "Canceled".
note

string

Nota que se anexará a la colección Notes de un trabajo con la marca de tiempo actual.

Respuestas

Nombre Tipo Description
200 OK

object

La solicitud se ha realizado correctamente.
Other Status Codes

Azure.Core.Foundations.ErrorResponse

Una respuesta de error inesperada.

Encabezados

x-ms-error-code: string

Seguridad

AadOauth2Auth

Flujo de OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: accessCode
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize
Dirección URL del token: https://login.microsoftonline.com/common/oauth2/token

Ámbitos

Nombre Description
https://communication.azure.com/.default

Ejemplos

Cancels a job
Submits request to cancel an existing job

Cancels a job

Solicitud de ejemplo

POST https://contoso.westus.communications.azure.com/routing/jobs/8780b28c-7079-4de1-9143-4d369289e958:cancel?api-version=2023-11-01

{}

Respuesta de muestra

status code:
200 
{}

Submits request to cancel an existing job

Solicitud de ejemplo

POST https://contoso.westus.communications.azure.com/routing/jobs/8780b28c-7079-4de1-9143-4d369289e958:cancel?api-version=2023-11-01

Respuesta de muestra

status code:
200 
{}

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

Solicitar carga para cancelar un trabajo.

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.

CancelJobOptions

Solicitar carga para cancelar un trabajo.

Nombre Tipo Description
dispositionCode

string

Indica el resultado de un trabajo, rellene este campo con sus propios valores personalizados. Si no se proporciona, se establece el valor predeterminado de "Canceled".
note

string

Nota que se anexará a la colección Notes de un trabajo con la marca de tiempo actual.