> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cloud.cdata.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List Jobs

> Administrators, impersonating a service user, can request a list of jobs for a sub-account.



## OpenAPI

````yaml en/API/REST-API-Embedded.yaml GET /job/list
openapi: 3.1.0
info:
  title: CData Connect AI REST API Embedded
  version: v1
servers:
  - url: https://cloud.cdata.com/api
    description: Production base URL
security:
  - BearerAuth: []
paths:
  /job/list:
    get:
      tags:
        - Job
      summary: List Jobs
      description: >
        Administrators, impersonating a service user, can request a list of jobs
        for a sub-account.
      operationId: listJobs
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobListResult'
              example:
                jobs:
                  - jobType: Caching
                    id: a1b2c3d4-5678-90ab-cdef-1234567890ab
                    name: OData1 Categories
                    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: ModifiedDate
                      autoTruncateStrings: 'false'
                      sourceConnection: 36b2c04f-70f4-44a1-876a-29e42237ee63
                      sourceConnectionName: OData1
                      sourceName: OData1
                      sourceSchema: OData
                      sourceTable: Categories
                      replicateStartDate: '2024-01-01T00:00:00Z'
                      replicateInterval: 180
                      mergeKeys:
                        - colName: Id
                          colType: varchar
                          isPrimaryKey: true
                        - colName: WorkspaceId
                          colType: varchar
                          isPrimaryKey: true
      servers:
        - url: https://cloud.cdata.com/api
          description: Production base URL for job endpoints
components:
  schemas:
    JobListResult:
      type: object
      properties:
        jobs:
          type: array
          items:
            $ref: '#/components/schemas/JobInfo'
          nullable: true
      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
    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'
        replicateStartDate:
          type: string
          format: date-time
          nullable: true
          description: >
            The minimum date from which to start replicating data. Records with
            a date before this value are excluded from the cache population. For
            incremental jobs, this value also serves as the fallback start point
            when no prior sync status exists. Leave empty to replicate all
            available records.
          example: '2024-01-01T00:00:00Z'
        replicateInterval:
          type: integer
          format: int32
          nullable: true
          description: >
            The numeric size of the lookback window for each incremental refresh
            batch. Incremental runs retrieve source records changed within this
            window, allowing an interrupted run to resume without re-pulling the
            full history. The unit is Days. Defaults to 180 when not specified.
            Applies only when `timeCheckColumn` is set.
          example: 180
        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.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.