Jobs - Get

Hizmet:

IoT Central

API Sürümü:

2022-07-31

Kimliğine göre iş alma
İş kimliğine göre çalışan veya tamamlanan bir iş hakkındaki ayrıntıları alın.

GET https://{subdomain}.{baseDomain}/api/jobs/{jobId}?api-version=2022-07-31

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
baseDomain	path	True	string	Tüm Azure IoT Central hizmet istekleri için temel etki alanı.
jobId	path	True	string maxLength: 255 pattern: ^[a-zA-Z0-9_-]*$	İşin benzersiz kimliği.
subdomain	path	True	string	Uygulama alt etki alanı.
api-version	query	True	string	Çağrılan API'nin sürümü.

Yanıtlar

Name	Tür	Description
200 OK	Job	Başarı
Other Status Codes	Error	IoT Central Hizmetinden alınan bir hata yanıtı. Üst Bilgiler x-ms-error-code: string

Güvenlik

azure_auth

Azure Active Directory OAuth2 Akışı

Tür: oauth2
Akış: implicit
Yetkilendirme URL’si: https://login.microsoftonline.com/common/oauth2/authorize

Kapsamlar

Name	Description
user_impersonation	kullanıcı hesabınızın kimliğine bürünme

Örnekler

Get a job by ID

Örnek isteği

HTTP

GET https://appsubdomain.azureiotcentral.com/api/jobs/myJobId?api-version=2022-07-31

Örnek yanıt

Durum kodu:

200

{
  "id": "myJobId",
  "displayName": "My Job",
  "group": "475cad48-b7ff-4a09-b51e-1a9021385453",
  "data": [
    {
      "type": "property",
      "target": "urn:1dgygpt7t:modelDefinition:02uwtefvdy",
      "path": "componentName.propertyName",
      "value": "updated value"
    }
  ],
  "status": "running"
}

Tanımlar

Name	Description
CloudPropertyJobData	Bulut özelliği iş verileri.
CommandJobData	Komut işi veri tanımı.
DeviceTemplateMigrationJobData	Cihaz şablonu geçiş işi veri tanımı.
Error	Yanıt hatası tanımı.
ErrorDetails	Hatanın ayrıntılı bilgileri.
Job	İş tanımı.
JobBatch	İş toplu iş tanımı.
JobBatchType	Toplu işlem işleminin belirtilen sayıda cihazda mı yoksa toplam cihazların yüzdesinde mi yapıldığı.
JobCancellationThreshold	İş iptal eşiği tanımı.
JobCancellationThresholdType	İptal eşiğinin belirtilen sayıda cihaz başına mı yoksa toplam cihaz yüzdesine göre mi olduğu.
JobProgress	zamanlanmış işin ilerleme özeti.
PropertyJobData	Özellik işi veri tanımı.

CloudPropertyJobData

Object

Bulut özelliği iş verileri.

Name	Tür	Description
path	string	Cihaz şablonundaki hedef özelliğin yolu.
target	string minLength: 1	İş için hedef özelliği tanımlayan cihaz şablonu.
type	string: cloudProperty	İş verilerinin türü.
value	AnyValue	Varsa hedef özelliği güncelleştirmek için kullanılan değer.

CommandJobData

Object

Komut işi veri tanımı.

Name	Tür	Description
path	string	Cihaz şablonundaki hedef özelliğin yolu.
target	string minLength: 1	İş için hedef özelliği tanımlayan cihaz şablonu.
type	string: command	İş verilerinin türü.
value	AnyValue	Varsa hedef özelliği güncelleştirmek için kullanılan değer.

DeviceTemplateMigrationJobData

Object

Cihaz şablonu geçiş işi veri tanımı.

Name	Tür	Description
template	string minLength: 1	Cihazların geçirileceği hedef cihaz şablonu.
type	string: deviceTemplateMigration	İş verilerinin türü.

Error

Object

Yanıt hatası tanımı.

Name	Tür	Description
error	ErrorDetails	Geçerli istek için hata ayrıntıları.

ErrorDetails

Object

Hatanın ayrıntılı bilgileri.

Name	Tür	Description
code	string	Hata kodu.
message	string	Hata iletisi ayrıntıları.
requestId	string	Geçerli istek için bağıntı kimliği.
time	string (date-time-rfc1123)	Hata isteğinin başarısız olduğu zaman.

Job

Object

İş tanımı.

Name	Tür	Description
batch	JobBatch	İşin toplu iş yapılandırması.
cancellationThreshold	JobCancellationThreshold	İşin iptal eşiği.
data	JobData[]: CloudPropertyJobData[] CommandJobData[] DeviceTemplateMigrationJobData[] PropertyJobData[]	İş tarafından güncelleştirilen özellikler ve güncelleştirilmekte oldukları değerler.
description	string	İşin ayrıntılı açıklaması.
displayName	string	İşin görünen adı.
end	string (date-time)	İşin bitiş saati
group	string	İşin yürütüldiği cihaz grubunun kimliği.
id	string	İşin benzersiz kimliği.
organizations	string[]	İşin kuruluşlarının listesi, bugün yalnızca bir kuruluş destekleniyor, yakında birden çok kuruluş desteklenecek.
progress	JobProgress	İşin ilerleme istatistikleri.
scheduledJobId	string	Bu işi oluşturan zamanlanmış iş tanımının kimliği.
start	string (date-time)	İşin başlangıç saati
status	string	İşin başlatılıp başlatılmadığını, çalıştığını vb. gösterir.

JobBatch

Object

İş toplu iş tanımı.

Name	Tür	Description
type	JobBatchType	Toplu işlem işleminin belirtilen sayıda cihazda mı yoksa toplam cihazların yüzdesinde mi yapıldığı.
value	number	Toplu işlem yapılan cihazların sayısı veya yüzdesi.

JobBatchType

Listeleme

Toplu işlem işleminin belirtilen sayıda cihazda mı yoksa toplam cihazların yüzdesinde mi yapıldığı.

Değer	Description
number	Cihaz sayısına göre toplu iş oluşturma.
percentage	Uygulanan toplam cihazların iş toplu iş yüzdesi.

JobCancellationThreshold

Object

İş iptal eşiği tanımı.

Name	Tür	Description
batch	boolean	İptal eşiğinin toplu iş başına mı yoksa genel işe mi uygulanacağı.
type	JobCancellationThresholdType	İptal eşiğinin belirtilen sayıda cihaz başına mı yoksa toplam cihaz yüzdesine göre mi olduğu.
value	number	İptal eşiğinin uygulandığı cihazların sayısı veya yüzdesi.

JobCancellationThresholdType

Listeleme

İptal eşiğinin belirtilen sayıda cihaz başına mı yoksa toplam cihaz yüzdesine göre mi olduğu.

Değer	Description
number	Belirtilen cihaz sayısına göre iş iptal eşiği.
percentage	Toplam cihaz yüzdesine göre iş iptal eşiği.

JobProgress

Object

zamanlanmış işin ilerleme özeti.

Name	Tür	Description
completed	integer (int32)	İşin tamamlandığı varlık sayısı.
failed	integer (int32)	İşin başarısız olduğu varlık sayısı.
pending	integer (int32)	İşin henüz çalışmadığı varlık sayısı.
total	integer (int32)	İş tarafından hedeflenen varlıkların toplam sayısı.

PropertyJobData

Object

Özellik işi veri tanımı.

Name	Tür	Description
path	string	Cihaz şablonundaki hedef özelliğin yolu.
target	string minLength: 1	İş için hedef özelliği tanımlayan cihaz şablonu.
type	string: property	İş verilerinin türü.
value	AnyValue	Varsa hedef özelliği güncelleştirmek için kullanılan değer.