Update Job

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

PUT /job/{jobId}/update

Update Job

cURL

curl --request PUT \
  --url https://cloud.cdata.com/api/job/{jobId}/update \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "jobType": "<string>",
  "intervalUnit": "<string>",
  "intervalValue": 123,
  "logVerbosity": 123,
  "params": {},
  "enabled": true,
  "definedNextRun": "2023-11-07T05:31:56Z"
}
'

200

{
  "jobs": [
    {
      "id": "string",
      "name": "string",
      "enabled": true,
      "created": "2024-01-01T00:00:00Z",
      "lastModified": "2024-01-01T00:00:00Z",
      "nextRunTime": "2024-01-01T00:00:00Z",
      "intervalUnit": "Hour",
      "intervalValue": 1,
      "logVerbosity": 1,
      "lastRun": {
        "dateTime": "0001-01-01T00:00:00Z",
        "duration": 63894847975,
        "status": "JOB_QUEUED",
        "rowsAffected": 0,
        "nextRunTime": "0001-01-01T00:00:00Z"
      },
      "params": {
        "timeCheckColumn": "",
        "autoTruncateStrings": "false",
        "sourceConnection": "f6f3cfe6-72e2-4edb-914f-4409c01c1418",
        "sourceConnectionName": "MailChimp1",
        "sourceName": "MailChimp",
        "sourceSchema": "MailChimp",
        "sourceTable": "Conversations"
      }
    }
  ]
}

Authorizations

Authorization · string · header · required

JWT token authentication. Include the token in the Authorization header as Bearer {token}. See Authentication for more information on creating a token.

Path Parameters

jobId · string · required

The Id of the job you want to update.

Body

application/json

jobType · string · required

The type of job that the user wants to run (Caching or ScheduledQuery).

intervalUnit · string · required

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

intervalValue · integer<int32> · required

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

logVerbosity · integer<int32> · required

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

params · object · required

An object containing different job details depending on if the job is a cache job or a scheduled query.

enabled · boolean

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

definedNextRun · string<date-time>

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

Response

200 - application/json

OK

jobs · object[] | null

Show child attributes