Create Job

Administrators, impersonating a service user, can use this call to create a new job.

POST https://cloud.cdata.com/api/job/create

Create Job

cURL

curl --request POST \
  --url https://cloud.cdata.com/api/job/create

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

Payload Parameters

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 · required

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

logVerbosity · integer · required

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

enabled · boolean

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

definedNextRun · string

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

params · object · required

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

For cache jobs:

• timeCheckColumn: string
• autoTruncateStrings: string
• sourceConnectionName: string
• sourceName: string
• sourceSchema: string
• sourceTable: string

For scheduled queries:

• name: string
• query: string
• destinationWriteScheme: string
• destinationConnectionName: string
• destinationSchema: string
• destinationTable: string

Responses

200

HTTP 200 OK

Show Response body

jobs · array of objects · required

id · string · required

The job’s Id.

name · string · required

The job’s name.

enabled · boolean · required

A Boolean value indicating whether the job is enabled.

created · string · required

The date and time the job was created.

lastModified · string · required

The date and time the job was last modified.

nextRunTime · string · required

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

intervalUnit · string · required

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

intervalValue · integer · required

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

logVerbosity · integer · required

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

lastRun · object

The last run metrics for the job, including the date and time, duration, status, rows affected, and next run time.

params · object

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

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