Sign in
latestSwagger 2.02026-07-13120150263.9 KB

565d8813cbd3

Create or update a scheduled job

Create or update a scheduled job by ID.

put/scheduledJobs/{scheduledJobId}

Path parameters

scheduledJobIdstring required

Unique ID of the scheduled job.

Query parameters

api-versionstring required

The version of the API being called.

Request body

etagstring

ETag used to prevent conflict in scheduled job updates.

idstring

Unique ID of the scheduled job.

displayNamestring

Display name of the scheduled job.

descriptionstring

Detailed description of the scheduled job.

groupstring required

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

organizationsstring[]

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

enabledboolean

Whether the scheduled job is enabled.

completedboolean

Whether the scheduled job has completed.

Response

Success

etagstring

ETag used to prevent conflict in scheduled job updates.

idstring

Unique ID of the scheduled job.

displayNamestring

Display name of the scheduled job.

descriptionstring

Detailed description of the scheduled job.

groupstring required

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

organizationsstring[]

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

enabledboolean

Whether the scheduled job is enabled.

completedboolean

Whether the scheduled job has completed.