Kaynak: İşlem
Bu kaynak, bir ağ API çağrısının sonucu olan uzun süreli bir işlemi temsil eder.
JSON gösterimi |
---|
{ "name": string, "metadata": { "@type": string, field1: ..., ... }, "done": boolean, // Union field |
Alanlar | |
---|---|
name |
Sunucu tarafından atanan ad; yalnızca başlangıçta döndürdüğü hizmetin içinde benzersizdir. Varsayılan HTTP eşlemesini kullanıyorsanız |
metadata |
İşlem Rastgele tür alanlarını içeren bir nesne. Ek alan ( |
done |
Değer |
Birlik alanı result . İşlem sonucu. Bu, error veya geçerli bir response olabilir. done = false ise ne error ne de response ayarlanmadı. done = true ise error veya response tam olarak ayarlanabilir. Bazı hizmetler sonucu sağlamayabilir. result aşağıdakilerden yalnızca biri olabilir: |
|
error |
İşlem |
response |
İşlem Rastgele tür alanlarını içeren bir nesne. Ek alan ( |
Durum
Status
türü, REST API'leri ve TBS API'leri dahil olmak üzere farklı programlama ortamları için uygun olan bir mantıksal hata modelini tanımlar. gTB tarafından kullanılır. Her Status
mesajı üç hata verisinden oluşur: hata kodu, hata mesajı ve hata ayrıntıları.
Bu hata modeli ve nasıl çalışılacağı hakkında daha fazla bilgiye API Tasarım Kılavuzu'ndan ulaşabilirsiniz.
JSON gösterimi |
---|
{ "code": integer, "message": string, "details": [ { "@type": string, field1: ..., ... } ] } |
Alanlar | |
---|---|
code |
|
message |
Geliştiriciye yönelik hata mesajı (İngilizce olmalıdır). Kullanıcıya yönelik hata mesajlarının yerelleştirilip |
details[] |
Hata ayrıntılarını içeren iletilerin listesi. API'lerin kullanması gereken yaygın bir mesaj türü grubu vardır. Rastgele tür alanlarını içeren bir nesne. Ek alan ( |
Yöntemler |
|
---|---|
|
Uzun süreli bir işlemin en son durumunu alır. |