Job Router Operations - Cancel Job

Hizmet:

Communication

API Sürümü:

2023-11-01

Serbest biçimli iptal nedeni sağlarken var olan bir işi kimlikle iptal etme isteği gönderir.

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
endpoint	path	True	string	İletişim kaynağınızın Uri'si
jobId	path	True	string	İşin kimliği.
api-version	query	True	string	Bu işlem için kullanılacak API sürümü.

İstek Gövdesi

Name	Tür	Description
dispositionCode	string	Bir işin sonucunu gösterir ve bu alanı kendi özel değerlerinizle doldurun. Sağlanmazsa, varsayılan "İptal Edildi" değeri ayarlanır.
note	string	Geçerli zaman damgasıyla bir işin Notes koleksiyonuna eklenecek not.

Yanıtlar

Name	Tür	Description
200 OK	object	İstek başarılı oldu.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Beklenmeyen bir hata yanıtı. Üst Bilgiler x-ms-error-code: string

Örnekler

Cancels a job

Submits request to cancel an existing job

Cancels a job

Örnek isteği

HTTP

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

{}

Örnek yanıt

Durum kodu:

200

{}

Submits request to cancel an existing job

Örnek isteği

HTTP

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

Örnek yanıt

Durum kodu:

200

{}

Tanımlar

Name	Description
Azure.Core.Foundations.Error	Hata nesnesi.
Azure.Core.Foundations.ErrorResponse	Hata ayrıntılarını içeren bir yanıt.
Azure.Core.Foundations.InnerError	Hata hakkında daha ayrıntılı bilgi içeren bir nesne. Microsoft One API yönergelerine göre - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
CancelJobOptions	bir işi iptal etme için istek yükü.

Azure.Core.Foundations.Error

Hata nesnesi.

Name	Tür	Description
code	string	Sunucu tanımlı hata kodları kümesinden biri.
details	Azure.Core.Foundations.Error[]	Bu bildirilen hataya yol açan belirli hatalarla ilgili bir dizi ayrıntı.
innererror	Azure.Core.Foundations.InnerError	Hatayla ilgili geçerli nesneden daha belirli bilgiler içeren bir nesne.
message	string	Hatanın insanlar tarafından okunabilir bir gösterimi.
target	string	Hatanın hedefi.

Azure.Core.Foundations.ErrorResponse

Hata ayrıntılarını içeren bir yanıt.

Name	Tür	Description
error	Azure.Core.Foundations.Error	Hata nesnesi.

Azure.Core.Foundations.InnerError

Hata hakkında daha ayrıntılı bilgi içeren bir nesne. Microsoft One API yönergelerine göre - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Tür	Description
code	string	Sunucu tanımlı hata kodları kümesinden biri.
innererror	Azure.Core.Foundations.InnerError	İç hata.

CancelJobOptions

bir işi iptal etme için istek yükü.

Name	Tür	Description
dispositionCode	string	Bir işin sonucunu gösterir ve bu alanı kendi özel değerlerinizle doldurun. Sağlanmazsa, varsayılan "İptal Edildi" değeri ayarlanır.
note	string	Geçerli zaman damgasıyla bir işin Notes koleksiyonuna eklenecek not.