Jump to

• Request
• Response

List Jobs

post

[host-url]/dt-rest/v2/jobs

Retrieves a list of all jobs matching the specified search criteria, returning only minimal information. The filtering criteria is provided in the request body. The filtering logic is as follows:

• Job Name: If jobName is provided, the response will contain the job with this name.
• Status: If status is provided, the response will contain jobs that match the status.
• Date Range:
  • If both fromDate and toDate are provided, jobs that match the range will be returned in the response.
  • If only fromDate is provided, jobs past this date will be returned.
  • If only toDate is provided, jobs before this date will be returned.
  • Supported formats: "yyyy-MM-dd'T'HH:mm:ss.SSSX, "yyyy-MM-dd'T'HH:mm:ss.SSS", "EEE, dd MMM yyyy HH:mm:ss zzz", "yyyy-MM-dd"
  • The default timezone for fromDate and toDate is UTC.
  • To use a different timezone, the date string must be formatted to include the timezone offset.
    E.g. Wed, 10 Sep 2025 07:29:30 GMT+5:30
• Max Results: If maxResults is provided, it limits the number of jobs retrieved. Otherwise, all are retrieved.

The fields available for filtering include: status (array of strings), fromDate (date-time), toDate (date-time), maxResults (integer), and jobName (string).

Request

Query Parameters

• limit: integer(int32)
  The maximum number of items per page.
• page: integer(int32)
  The current page number.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

JSON for job search criteria with parameters used to retrieve job information. All filtering parameters are optional.

Show Source

• fromDate: string (date-time)
• jobName: string
• maxResults: integer (int32)
• status: string
  Allowed Values: [ "WAITING", "ERROR", "RUNNING", "DONE", "WARNING", "QUEUED", "NOT_STARTED", "PREPARING", "VALID", "INVALID" ]

  Enumerates the possible statuses of a job.

  • Waiting: The Job is waiting to be executed.
  • Error: The Job terminated due to an error.
  • Running: The Job is being executed.
  • Done: The Job executed successfully.
  • Warning: The Job completed successfully but errors have been detected during the data quality check.
  • Queued: The Job is waiting for an agent to be available for its execution.
  • Not started: The Job has not started.
  • Preparing: The Job is preparing to be executed.
  • Valid: The Job is valid to be executed.
  • Invalid: The Job is not valid to be executed.
• toDate: string (date-time)

{
    "type":"object",
    "description":"JSON for job search criteria with parameters used to retrieve job information. All filtering parameters are optional.",
    "properties":{
        "status":{
            "$ref":"#/components/schemas/JobStatus"
        },
        "fromDate":{
            "type":"string",
            "format":"date-time"
        },
        "toDate":{
            "type":"string",
            "format":"date-time"
        },
        "maxResults":{
            "type":"integer",
            "format":"int32"
        },
        "jobName":{
            "type":"string"
        }
    },
    "example":{
        "status":"WAITING",
        "fromDate":"2025-11-12T17:30:45.948821Z",
        "toDate":"2025-11-12T17:30:45.948840Z",
        "maxResults":123,
        "jobName":"jobName_example"
    }
}

Example:

{
    "status":"WAITING",
    "fromDate":"2025-11-12T17:30:45.948821Z",
    "toDate":"2025-11-12T17:30:45.948840Z",
    "maxResults":123,
    "jobName":"jobName_example"
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

A JSON object containing the paginated list of jobs.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object RuntimeJobBaseDTO
  Represents a job during runtime.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/RuntimeJobBaseDTO"
    }
}

Nested Schema : RuntimeJobBaseDTO

Type: object

Represents a job during runtime.

Show Source

• endDate: string (date-time)
• jobId: string
• jobName(required): string
• jobNumber: integer (int64)
• startDate: string (date-time)
• status: string
  Allowed Values: [ "WAITING", "ERROR", "RUNNING", "DONE", "WARNING", "QUEUED", "NOT_STARTED", "PREPARING", "VALID", "INVALID" ]

  Enumerates the possible statuses of a job.

  • Waiting: The Job is waiting to be executed.
  • Error: The Job terminated due to an error.
  • Running: The Job is being executed.
  • Done: The Job executed successfully.
  • Warning: The Job completed successfully but errors have been detected during the data quality check.
  • Queued: The Job is waiting for an agent to be available for its execution.
  • Not started: The Job has not started.
  • Preparing: The Job is preparing to be executed.
  • Valid: The Job is valid to be executed.
  • Invalid: The Job is not valid to be executed.

{
    "type":"object",
    "description":"Represents a job during runtime.",
    "required":[
        "jobName"
    ],
    "properties":{
        "status":{
            "$ref":"#/components/schemas/JobStatus"
        },
        "jobName":{
            "type":"string"
        },
        "jobNumber":{
            "type":"integer",
            "format":"int64"
        },
        "jobId":{
            "type":"string"
        },
        "startDate":{
            "type":"string",
            "format":"date-time"
        },
        "endDate":{
            "type":"string",
            "format":"date-time"
        }
    }
}

401 Response

Unauthorized

Back to Top