Job Router Operations - Unassign Job
Unassign a job.
POST {endpoint}/routing/jobs/{jobId}/assignments/{assignmentId}:unassign?api-version=2023-11-01URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
|
assignment
|
path | True |
string |
Id of a job assignment. |
|
endpoint
|
path | True |
string |
Uri of your Communication resource |
|
job
|
path | True |
string |
Id of a job. |
|
api-version
|
query | True |
string |
The API version to use for this operation. |
Request Body
| Name | Type | Description |
|---|---|---|
| suspendMatching |
boolean |
If SuspendMatching is true, then a job is not queued for re-matching with a worker. |
Responses
| Name | Type | Description |
|---|---|---|
| 200 OK |
The request has succeeded. |
|
| Other Status Codes |
An unexpected error response. Headers x-ms-error-code: string |
Examples
Un-assign a job
Sample request
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
}
Sample response
{
"jobId": "8780b28c-7079-4de1-9143-4d369289e958",
"unassignmentCount": 1
}Definitions
| Name | Description |
|---|---|
|
Azure. |
The error object. |
|
Azure. |
A response containing error details. |
|
Azure. |
An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses. |
|
Unassign |
Request payload for unassigning a job. |
|
Unassign |
Response payload after a job has been successfully unassigned. |
Azure.Core.Foundations.Error
The error object.
| Name | Type | Description |
|---|---|---|
| code |
string |
One of a server-defined set of error codes. |
| details |
An array of details about specific errors that led to this reported error. |
|
| innererror |
An object containing more specific information than the current object about the error. |
|
| message |
string |
A human-readable representation of the error. |
| target |
string |
The target of the error. |
Azure.Core.Foundations.ErrorResponse
A response containing error details.
| Name | Type | Description |
|---|---|---|
| error |
The error object. |
Azure.Core.Foundations.InnerError
An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
| Name | Type | Description |
|---|---|---|
| code |
string |
One of a server-defined set of error codes. |
| innererror |
Inner error. |
UnassignJobOptions
Request payload for unassigning a job.
| Name | Type | Description |
|---|---|---|
| suspendMatching |
boolean |
If SuspendMatching is true, then a job is not queued for re-matching with a worker. |
UnassignJobResult
Response payload after a job has been successfully unassigned.
| Name | Type | Description |
|---|---|---|
| jobId |
string |
Id of an unassigned job. |
| unassignmentCount |
integer |
The number of times a job is unassigned. At a maximum 3. |