v8

latestSwagger 2.02026-07-13120150263.9 KB

Execute a new job

Create and execute a new job via its job definition.

put/jobs/{jobId}

Path parameters

jobIdstring required

Unique ID of the job.

Query parameters

api-versionstring required

The version of the API being called.

Request body

idstring

Unique ID of the job.

scheduledJobIdstring

Id of the scheduled job definition that created this job.

displayNamestring

Display name of the job.

descriptionstring

Detailed description of the job.

groupstring required

The ID of the device group on which to execute the job.

startstring date-time

The start time of the job

endstring date-time

The end time of the job

statusstring

Indicates whether the job is starting, running, etc.

organizationsstring[]

List of organizations of the job, only one organization is supported today, multiple organizations will be supported soon.

Response

Success

idstring

Unique ID of the job.

scheduledJobIdstring

Id of the scheduled job definition that created this job.

displayNamestring

Display name of the job.

descriptionstring

Detailed description of the job.

groupstring required

The ID of the device group on which to execute the job.

startstring date-time

The start time of the job

endstring date-time

The end time of the job

statusstring

Indicates whether the job is starting, running, etc.

organizationsstring[]

List of organizations of the job, only one organization is supported today, multiple organizations will be supported soon.