Job Router Operations - Close Job

  • Başvuru
Hizmet:
Communication
API Sürümü:
2023-11-01

Tamamlanmış bir işi kapatır.

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

URI Parametreleri

Name İçinde Gerekli Tür Description
assignmentId
 path True

string

İş atamasının kimliği.
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
closeAt

string

Sağlanmazsa, çalışan kapasitesi bir JobClosedEvent bildirimiyle birlikte hemen serbest bırakılır. Sağlanırsa çalışan kapasitesi, UTC'de gelecek bir zamanda bir JobClosedEvent bildirimiyle birlikte yayımlanır.
dispositionCode

string

Bir işin sonucunu gösterir ve bu alanı kendi özel değerlerinizle doldurun.
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

Closes a completed job

Örnek isteği

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

Ö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.
CloseJobOptions

İşlerin kapatılması için yük isteme

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.

CloseJobOptions

İşlerin kapatılması için yük isteme

Name Tür Description
closeAt

string

Sağlanmazsa, çalışan kapasitesi bir JobClosedEvent bildirimiyle birlikte hemen serbest bırakılır. Sağlanırsa çalışan kapasitesi, UTC'de gelecek bir zamanda bir JobClosedEvent bildirimiyle birlikte yayımlanır.
dispositionCode

string

Bir işin sonucunu gösterir ve bu alanı kendi özel değerlerinizle doldurun.
note

string

Geçerli zaman damgasıyla bir işin Notes koleksiyonuna eklenecek not.