Job Router Operations - Close Job

Service:

Communication

API-versie:

2023-11-01

Sluit een voltooide taak.

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

URI-parameters

Name	In	Vereist	Type	Description
assignmentId	path	True	string	Id van een taaktoewijzing.
endpoint	path	True	string	URI van uw communicatieresource
jobId	path	True	string	Id van een taak.
api-version	query	True	string	De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagbody

Name	Type	Description
closeAt	string	Als deze niet wordt opgegeven, wordt de capaciteit van de werkrol onmiddellijk vrijgegeven, samen met een JobClosedEvent-melding. Indien opgegeven, wordt de werkrolcapaciteit vrijgegeven samen met een JobClosedEvent-melding op een later tijdstip in UTC.
dispositionCode	string	Geeft het resultaat van een taak aan, vul dit veld in met uw eigen aangepaste waarden.
note	string	Een notitie die wordt toegevoegd aan de verzameling Notities van een taak met de huidige tijdstempel.

Antwoorden

Name	Type	Description
200 OK	object	De aanvraag is geslaagd.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Een onverwacht foutbericht. Kopteksten x-ms-error-code: string

Voorbeelden

Closes a completed job

Voorbeeldaanvraag

HTTP

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"
}

Voorbeeldrespons

Statuscode:

200

{}

Definities

Name	Description
Azure.Core.Foundations.Error	Het foutobject.
Azure.Core.Foundations.ErrorResponse	Een antwoord met foutdetails.
Azure.Core.Foundations.InnerError	Een object met specifiekere informatie over de fout. Volgens de Richtlijnen voor Microsoft One API: https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
CloseJobOptions	Nettolading aanvragen voor het sluiten van taken

Azure.Core.Foundations.Error

Het foutobject.

Name	Type	Description
code	string	Een van een door de server gedefinieerde set foutcodes.
details	Azure.Core.Foundations.Error[]	Een matrix met details over specifieke fouten die tot deze gerapporteerde fout hebben geleid.
innererror	Azure.Core.Foundations.InnerError	Een object met specifiekere informatie dan het huidige object over de fout.
message	string	Een door mensen leesbare weergave van de fout.
target	string	Het doel van de fout.

Azure.Core.Foundations.ErrorResponse

Een antwoord met foutdetails.

Name	Type	Description
error	Azure.Core.Foundations.Error	Het foutobject.

Azure.Core.Foundations.InnerError

Een object met specifiekere informatie over de fout. Volgens de Richtlijnen voor Microsoft One API: https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Type	Description
code	string	Een van een door de server gedefinieerde set foutcodes.
innererror	Azure.Core.Foundations.InnerError	Interne fout.

CloseJobOptions

Nettolading aanvragen voor het sluiten van taken

Name	Type	Description
closeAt	string	Als deze niet wordt opgegeven, wordt de capaciteit van de werkrol onmiddellijk vrijgegeven, samen met een JobClosedEvent-melding. Indien opgegeven, wordt de werkrolcapaciteit vrijgegeven samen met een JobClosedEvent-melding op een later tijdstip in UTC.
dispositionCode	string	Geeft het resultaat van een taak aan, vul dit veld in met uw eigen aangepaste waarden.
note	string	Een notitie die wordt toegevoegd aan de verzameling Notities van een taak met de huidige tijdstempel.