v1

latestOpenAPI 3.1.02026-07-26474165.4 KB
Job

Update Job

Administrators, impersonating a service user, can use this call to update a specified job.

put/job/{jobId}/update

Path parameters

jobIdstring required

The Id of the job you want to update.

Request body

jobTypestring required

The type of job (Caching).

intervalUnitstring required

A string representing the time interval (Hour/Day/Week/Month).

intervalValueinteger required

An integer that represents how many of the selected frequency unit the job should wait before running again.

logVerbosityinteger required

An enum indicating the level of log verbosity (1-5).

enabledboolean

A Boolean value indicating whether the job is enabled. The default value is true.

definedNextRunstring date-time

An optional DateTime value that can be used to set the initial start time for the job.

Example request

{
  "params": {
    "autoTruncateStrings": "false"
  }
}

Response

OK

jobTypestring required

The type of job (Caching).

idstring required

The job's Id.

namestring required

The job's name.

enabledboolean required

A Boolean value indicating whether the job is enabled.

createdstring date-time required

The date and time the job was created.

lastModifiedstring date-time required

The date and time the job was last modified.

nextRunTimestring date-time required

The date and time the job is scheduled to be run next.

intervalUnitstring required

A string representing the interval unit for the job (Hour/Day/Week/Month).

intervalValueinteger required

An integer that represents how many of the selected interval unit the job should wait before running again.

logVerbosityinteger required

A number indicating the level of log verbosity (1-5).

Example response

{
  "params": {
    "autoTruncateStrings": "false"
  }
}