CData

CData Job API

The Job API from CData — 7 operation(s) for job.

Documentation GitHub OpenAPI

Operations 7

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /job/list List a sub-account's jobs · List Jobs #

Ask an LLM

“Which caching jobs are set up for this sub-account?”

“How do I see all scheduled jobs while impersonating a service user?”

Tell an agent

List all jobs for this sub-account.

Show me every scheduled caching job we have.

GET /job/{jobId} Get the details of a job · Get Job #

Ask an LLM

“How do I check the schedule and settings of one specific job?”

“What details can I see for a single caching job?”

Tell an agent

Get the details of job {jobId}.

Show me the schedule and parameters configured on job {jobId}.

POST /job/create Create a scheduled caching job · Create Job #

Ask an LLM

“How do I schedule a caching job that runs every few hours?”

“Can I set the first run time for a new job instead of starting right away?”

Tell an agent

Create a {jobType} job that runs every {intervalValue} {intervalUnit} with log verbosity {logVerbosity} and parameters {params}.

Create a {jobType} job every {intervalValue} {intervalUnit}, verbosity {logVerbosity}, params {params}, with enabled set to {enabled}.

PUT /job/{jobId}/update Change an existing job's schedule or settings · Update Job #

Ask an LLM

“How do I change how often an existing caching job runs?”

“Can I pause an existing job by disabling it rather than deleting it?”

Tell an agent

Change job {jobId} to a {jobType} job every {intervalValue} {intervalUnit} with verbosity {logVerbosity} and params {params}.

Set existing job {jobId} enabled to {enabled}, keeping type {jobType}, every {intervalValue} {intervalUnit}, verbosity {logVerbosity}, params {params}.

DELETE /job/{jobId}/delete Delete a job · Delete Job #

Ask an LLM

“How do I permanently remove a caching job I no longer need?”

“Can I delete a scheduled job so it never runs again?”

Tell an agent destructive · confirm first

Delete job {jobId}.

Remove the scheduled job {jobId} for good.

POST /job/{jobId}/run Queue a job to run now · Run Job #

Ask an LLM

“Can I trigger a caching job immediately instead of waiting for its schedule?”

“How do I kick off a job run on demand?”

Tell an agent

Run job {jobId} now.

Put job {jobId} in the queue to run right away.

POST /job/{jobId}/stop Stop a running job · Stop Job #

Ask an LLM

“How do I halt a job that is currently running?”

“Can I cancel a caching job run that is taking too long?”

Tell an agent destructive · confirm first

Stop job {jobId}.

Halt the in-progress run of job {jobId}.

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/cdata:cdata-job-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: CData Connect AI REST API Embedded Job API
  version: v1
servers:
- url: https://cloud.cdata.com/api
  description: Production base URL
security:
- BearerAuth: []
tags:
- name: Job
paths:
  /job/list:
    get:
      summary: List Jobs
      tags:
      - Job
      operationId: listJobs
      description: Administrators, impersonating a service user, can request a list of jobs for a sub-account.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobListResult'
              example:
                jobs:
                - jobType: Caching
                  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
      servers:
      - url: https://cloud.cdata.com/api
        description: Production base URL for job endpoints
  /job/{jobId}:
    get:
      summary: Get Job
      tags:
      - Job
      operationId: getJob
      description: Retrieve the details for a specific job.
      parameters:
      - name: jobId
        in: path
        required: true
        schema:
          type: string
        description: The Id of the job you want to retrieve details from.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobInfo'
              example:
                jobType: Caching
                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
      servers:
      - url: https://cloud.cdata.com/api
        description: Production base URL for job endpoints
  /job/create:
    post:
      summary: Create Job
      tags:
      - Job
      operationId: createJob
      description: Administrators, impersonating a service user, can use this call to create a new job.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateJobRequest'
            example:
              jobType: Caching
              intervalUnit: Hour
              intervalValue: '1'
              logVerbosity: '1'
              enabled: 'true'
              params:
                timeCheckColumn: ''
                autoTruncateStrings: 'false'
                sourceConnection: 36b2c04f-70f4-44a1-876a-29e42237ee63
                sourceName: OData1
                sourceSchema: OData
                sourceTable: Categories
                mergeKeys:
                - colName: Id
                  colType: varchar
                  isPrimaryKey: true
                - colName: WorkspaceId
                  colType: varchar
                  isPrimaryKey: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobInfo'
              example:
                jobType: Caching
                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
      servers:
      - url: https://cloud.cdata.com/api
        description: Production base URL for job endpoints
  /job/{jobId}/update:
    put:
      summary: Update Job
      tags:
      - Job
      operationId: updateJob
      description: Administrators, impersonating a service user, can use this call to update a specified job.
      parameters:
      - name: jobId
        in: path
        required: true
        schema:
          type: string
        description: The Id of the job you want to update.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateJobRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobInfo'
              example:
                jobType: Caching
                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
      servers:
      - url: https://cloud.cdata.com/api
        description: Production base URL for job endpoints
  /job/{jobId}/delete:
    delete:
      summary: Delete Job
      tags:
      - Job
      operationId: deleteJob
      description: Administrators, impersonating a service user, can use this call to delete a specified job.
      parameters:
      - name: jobId
        in: path
        required: true
        schema:
          type: string
        description: The Id of the job you want to delete.
      responses:
        '200':
          description: OK
      servers:
      - url: https://cloud.cdata.com/api
        description: Production base URL for job endpoints
  /job/{jobId}/run:
    post:
      summary: Run Job
      tags:
      - Job
      operationId: runJob
      description: Administrators, impersonating a service user, can use this call to put the specified job in the queue to be run.
      parameters:
      - name: jobId
        in: path
        required: true
        schema:
          type: string
        description: The Id of the job you want to put in the queue to be run.
      responses:
        '200':
          description: OK
      servers:
      - url: https://cloud.cdata.com/api
        description: Production base URL for job endpoints
  /job/{jobId}/stop:
    post:
      summary: Stop Job
      tags:
      - Job
      operationId: stopJob
      description: Administrators, impersonating a service user, can use this call to stop the specified job.
      parameters:
      - name: jobId
        in: path
        required: true
        schema:
          type: string
        description: The Id of the job you want to stop.
      responses:
        '200':
          description: OK
      servers:
      - url: https://cloud.cdata.com/api
        description: Production base URL for job endpoints
components:
  schemas:
    UpdateJobRequest:
      type: object
      required:
      - jobType
      - intervalUnit
      - intervalValue
      - logVerbosity
      - params
      properties:
        jobType:
          type: string
          description: The type of job (Caching).
        intervalUnit:
          type: string
          description: A string representing the time interval (Hour/Day/Week/Month).
        intervalValue:
          type: integer
          format: int32
          description: An integer that represents how many of the selected frequency unit the job should wait before running again.
        logVerbosity:
          type: integer
          format: int32
          description: An enum indicating the level of log verbosity (1-5).
        enabled:
          type: boolean
          description: A Boolean value indicating whether the job is enabled. The default value is true.
        definedNextRun:
          type: string
          format: date-time
          description: An optional DateTime value that can be used to set the initial start time for the job.
        params:
          $ref: '#/components/schemas/JobParams'
          description: An object containing job-specific parameters.
      additionalProperties: false
    CreateJobRequest:
      type: object
      required:
      - jobType
      - intervalUnit
      - intervalValue
      - logVerbosity
      - params
      properties:
        jobType:
          type: string
          description: The type of job (Caching).
        intervalUnit:
          type: string
          description: A string representing the time interval (Hour/Day/Week/Month).
        intervalValue:
          type: integer
          format: int32
          description: An integer that represents how many of the selected frequency unit the job should wait before running again.
        logVerbosity:
          type: integer
          format: int32
          description: An enum indicating the level of log verbosity (1-5).
        enabled:
          type: boolean
          description: A Boolean value indicating whether the job is enabled. The default value is true.
        definedNextRun:
          type: string
          format: date-time
          description: An optional DateTime value that can be used to set the initial start time for the job.
        params:
          $ref: '#/components/schemas/JobParams'
          description: An object containing job-specific parameters.
      additionalProperties: false
    JobInfo:
      type: object
      required:
      - jobType
      - id
      - name
      - enabled
      - created
      - lastModified
      - nextRunTime
      - intervalUnit
      - intervalValue
      - logVerbosity
      properties:
        jobType:
          type: string
          description: The type of job (Caching).
        id:
          type: string
          description: The job's Id.
        name:
          type: string
          description: The job's name.
        enabled:
          type: boolean
          description: A Boolean value indicating whether the job is enabled.
        created:
          type: string
          format: date-time
          description: The date and time the job was created.
        lastModified:
          type: string
          format: date-time
          description: The date and time the job was last modified.
        nextRunTime:
          type: string
          format: date-time
          description: The date and time the job is scheduled to be run next.
        intervalUnit:
          type: string
          description: A string representing the interval unit for the job (Hour/Day/Week/Month).
        intervalValue:
          type: integer
          format: int32
          description: An integer that represents how many of the selected interval unit the job should wait before running again.
        logVerbosity:
          type: integer
          format: int32
          description: A number indicating the level of log verbosity (1-5).
        lastRun:
          $ref: '#/components/schemas/JobLastRun'
        params:
          $ref: '#/components/schemas/JobParams'
      additionalProperties: false
    JobLastRun:
      type: object
      description: The last run metrics for the job, including the date and time, duration, status, rows affected, and next run time.
      properties:
        dateTime:
          type: string
          format: date-time
          nullable: true
        duration:
          type: integer
          format: int64
          nullable: true
        status:
          type: string
          nullable: true
        rowsAffected:
          type: integer
          format: int64
          nullable: true
        nextRunTime:
          type: string
          format: date-time
          nullable: true
          description: The date and time the job is scheduled to be run next.
      additionalProperties: false
    JobListResult:
      type: object
      properties:
        jobs:
          type: array
          items:
            $ref: '#/components/schemas/JobInfo'
          nullable: true
      additionalProperties: false
    JobParams:
      type: object
      description: An object containing job parameters. Caching jobs use the fields below; other job types may include additional properties.
      properties:
        sourceConnection:
          type: string
          format: uuid
          description: The Id of the source connection.
        sourceConnectionName:
          type: string
          description: The name of the source connection. Returned in responses.
        sourceName:
          type: string
          description: The source driver name (for example, "Asana", "MailChimp").
        sourceSchema:
          type: string
          description: The schema in the source connection that contains the table being cached.
        sourceTable:
          type: string
          description: The name of the table in the source connection to cache.
        timeCheckColumn:
          type: string
          description: The column used to detect changes for incremental caching. Leave empty to refresh the full table.
        autoTruncateStrings:
          type: string
          description: Whether to truncate string values that exceed the destination column length. Accepted as a string by the API ("true" or "false").
          example: 'false'
        mergeKeys:
          type: array
          description: 'The columns used to match source rows against cached rows during a merge. Mark each column that is part of the primary key with `isPrimaryKey: true`; supplying more than one such entry defines a composite primary key.'
          items:
            $ref: '#/components/schemas/MergeKey'
      additionalProperties: true
    MergeKey:
      type: object
      properties:
        colName:
          type: string
          description: The name of the column.
        colType:
          type: string
          description: The column's data type (for example, "varchar").
        isPrimaryKey:
          type: boolean
          description: Whether the column is part of the primary key. Set `true` on multiple columns to define a composite primary key.
      additionalProperties: false
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: JWT token authentication. Include the token in the Authorization header as `Bearer {token}`. See [Authentication](/en/API/Authentication-Embedded) for more information on creating a token.

CData Job API

Operations 7

Documentation

Specifications

Schemas & Data

Other Resources

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification