Jobs - Get

Služba:

IoT Central

Verze rozhraní API:

2022-07-31

Získání úlohy podle ID
Získejte podrobnosti o spuštěné nebo dokončené úloze podle ID úlohy.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
baseDomain	path	True	string	Základní doména pro všechny požadavky služby Azure IoT Central.
jobId	path	True	string maxLength: 255 pattern: ^[a-zA-Z0-9_-]*$	Jedinečné ID úlohy.
subdomain	path	True	string	Subdoména aplikace.
api-version	query	True	string	Verze volaného rozhraní API.

Odpovědi

Name	Typ	Description
200 OK	Job	Úspěch
Other Status Codes	Error	Odpověď na chybu přijatá ze služby IoT Central Hlavičky x-ms-error-code: string

Zabezpečení

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

Get a job by ID

Ukázkový požadavek

HTTP

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

Ukázková odpověď

Stavový kód:

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

Definice

Name	Description
CloudPropertyJobData	Data úlohy cloudové vlastnosti.
CommandJobData	Definice dat úlohy příkazu.
DeviceTemplateMigrationJobData	Definice dat úlohy migrace šablony zařízení.
Error	Definice chyby odpovědi.
ErrorDetails	Podrobné informace o chybě.
Job	Definice úlohy.
JobBatch	Definice dávky úlohy.
JobBatchType	Určuje, jestli se dávkování provádí na zadaném počtu zařízení, nebo procento celkového počtu zařízení.
JobCancellationThreshold	Definice prahové hodnoty zrušení úlohy.
JobCancellationThresholdType	Určuje, jestli je prahová hodnota zrušení na zadaný počet zařízení, nebo procento celkového počtu zařízení.
JobProgress	souhrn průběhu naplánované úlohy.
PropertyJobData	Definice dat úlohy vlastnosti.

CloudPropertyJobData

Objekt

Data úlohy cloudové vlastnosti.

Name	Typ	Description
path	string	Cesta k cílové funkci v rámci šablony zařízení.
target	string minLength: 1	Šablona zařízení, která definuje cílovou funkci pro úlohu.
type	string: cloudProperty	Typ dat úlohy
value	AnyValue	Hodnota použitá k aktualizaci cílové schopnosti( pokud existuje).

CommandJobData

Objekt

Definice dat úlohy příkazu.

Name	Typ	Description
path	string	Cesta k cílové funkci v rámci šablony zařízení.
target	string minLength: 1	Šablona zařízení, která definuje cílovou funkci pro úlohu.
type	string: command	Typ dat úlohy
value	AnyValue	Hodnota použitá k aktualizaci cílové schopnosti( pokud existuje).

DeviceTemplateMigrationJobData

Objekt

Definice dat úlohy migrace šablony zařízení.

Name	Typ	Description
template	string minLength: 1	Šablona cílového zařízení, do které se budou migrovat zařízení.
type	string: deviceTemplateMigration	Typ dat úlohy

Error

Objekt

Definice chyby odpovědi.

Name	Typ	Description
error	ErrorDetails	Podrobnosti o chybě pro aktuální požadavek

ErrorDetails

Objekt

Podrobné informace o chybě.

Name	Typ	Description
code	string	Kód chyby
message	string	Podrobnosti o chybové zprávě
requestId	string	ID korelace pro aktuální požadavek
time	string (date-time-rfc1123)	Čas, kdy se žádost o chybu nezdařila.

Job

Objekt

Definice úlohy.

Name	Typ	Description
batch	JobBatch	Konfigurace dávkování pro úlohu.
cancellationThreshold	JobCancellationThreshold	Prahová hodnota zrušení pro úlohu.
data	JobData[]: CloudPropertyJobData[] CommandJobData[] DeviceTemplateMigrationJobData[] PropertyJobData[]	Možnosti, které úloha aktualizuje, a hodnoty, se kterými se aktualizují.
description	string	Podrobný popis úlohy
displayName	string	Zobrazovaný název úlohy.
end	string (date-time)	Koncový čas úlohy
group	string	ID skupiny zařízení, na které se má úloha spustit.
id	string	Jedinečné ID úlohy.
organizations	string[]	Seznam organizací této úlohy, dnes se podporuje jenom jedna organizace, brzy bude podporováno více organizací.
progress	JobProgress	Statistika průběhu úlohy
scheduledJobId	string	ID definice naplánované úlohy, která vytvořila tuto úlohu.
start	string (date-time)	Čas zahájení úlohy
status	string	Určuje, jestli se úloha spouští, spouští atd.

JobBatch

Objekt

Definice dávky úlohy.

Name	Typ	Description
type	JobBatchType	Určuje, jestli se dávkování provádí na zadaném počtu zařízení, nebo procento celkového počtu zařízení.
value	number	Počet nebo procento zařízení, na kterých se dávkování provádí.

JobBatchType

Výčet

Určuje, jestli se dávkování provádí na zadaném počtu zařízení, nebo procento celkového počtu zařízení.

Hodnota	Description
number	Dávkování úloh na základě počtu zařízení
percentage	Procento dávkového dávkování celkového použitého zařízení

JobCancellationThreshold

Objekt

Definice prahové hodnoty zrušení úlohy.

Name	Typ	Description
batch	boolean	Určuje, jestli prahová hodnota zrušení platí pro každou dávku nebo pro celkovou úlohu.
type	JobCancellationThresholdType	Určuje, jestli je prahová hodnota zrušení na zadaný počet zařízení, nebo procento celkového počtu zařízení.
value	number	Počet nebo procento zařízení, na kterých se použije prahová hodnota zrušení.

JobCancellationThresholdType

Výčet

Určuje, jestli je prahová hodnota zrušení na zadaný počet zařízení, nebo procento celkového počtu zařízení.

Hodnota	Description
number	Prahová hodnota zrušení úlohy na základě zadaného počtu zařízení
percentage	Prahová hodnota zrušení úlohy na základě procenta celkového počtu zařízení.

JobProgress

Objekt

souhrn průběhu naplánované úlohy.

Name	Typ	Description
completed	integer (int32)	Počet entit, pro které se úloha dokončila.
failed	integer (int32)	Počet entit, u kterých úloha selhala.
pending	integer (int32)	Počet entit, pro které úloha ještě není spuštěná.
total	integer (int32)	Celkový počet entit, na které úloha cílí.

PropertyJobData

Objekt

Definice dat úlohy vlastnosti.

Name	Typ	Description
path	string	Cesta k cílové funkci v rámci šablony zařízení.
target	string minLength: 1	Šablona zařízení, která definuje cílovou funkci pro úlohu.
type	string: property	Typ dat úlohy
value	AnyValue	Hodnota použitá k aktualizaci cílové schopnosti( pokud existuje).