Jump to

• Request
• Response

List Schedules

get

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

Retrieves a list of schedules. This method supports various query parameters to filter and customize the response:

• fields: specifies the fields to include in the response (comma-separated)
• name: filters schedules by name
• status: filters schedules by status
• workflowId: filters schedules by workflow ID
• dataFlowId: filters schedules by data flow ID

The following examples demonstrate the supported query patterns:

• Retrieve all schedules (no filters):

  Retrieves all available schedules without any filtering. All default fields for these schedules will be included in the response.

  /schedules


• Retrieve all schedules with specific fields:

  Retrieves all available schedules without any filtering, and the response will only include the fields specified in the fields parameter.

  /schedules?fields=name,scheduleId,...


• Retrieve a schedule by name:

  Retrieves a schedule that matches the given name. All default fields for this schedule will be included in the response.

  /schedules?name=your_schedule_name


• Retrieve a schedule by name with specific fields:

  Retrieves a schedule that matches the given name, and the response will only include the fields specified in the fields parameter.

  /schedules?name=your_schedule_name&fields=name,scheduleId,...


• Retrieve schedules by status:

  Retrieves all schedules that match the given status. All default fields for these schedules will be included in the response.

  /schedules?status=your_status


• Retrieve schedules by status with specific fields:

  Retrieves all schedules that match the given status, and the response will only include the fields specified in the fields parameter.

  /schedules?status=your_status&fields=name,scheduleId,...


• Retrieve schedules by workflow ID:

  Retrieves all schedules that are associated with the given workflowId. All default fields for these schedules will be included in the response.

  /schedules?workflowId=your_workflow_id


• Retrieve schedules by workflow ID with specific fields:

  Retrieves all schedules that are associated with the given workflowId, and the response will only include the fields specified in the fields parameter.

  /schedules?workflowId=your_workflow_id&fields=name,scheduleId,...


• Retrieve schedules by data flow ID:

  Retrieves all schedules that are associated with the given dataflowId. All default fields for these schedules will be included in the response.

  /schedules?dataFlowId=your_dataflow_id


• Retrieve schedules by data flow ID with specific fields:

  Retrieves all schedules that are associated with the given dataflowId, and the response will only include the fields specified in the fields parameter.

  /schedules?dataFlowId=your_dataflow_id&fields=name,scheduleId,...

Request

Query Parameters

• dataflowId: string
  QueryParam parameter dataflowId
• fields: string
  comma-separated list of fields to include in the response
• name: string
  filters schedules by name
• status: string
  filters schedules by status
• workflowId: string
  filters schedules by workflow ID

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

a response object containing the list of schedules

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object JobScheduleBaseDTO
  Represents a job schedule with basic information.

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

Nested Schema : JobScheduleBaseDTO

Type: object

Represents a job schedule with basic information.

Show Source

• activeEndDate: string
• activeFromDate: string
• designObjectId: string
• designObjectName: string
• designObjectType(required): string
• name(required): string
• scheduleId: string
• scheduleNumber: integer (int64)
• status(required): string

{
    "type":"object",
    "description":"Represents a job schedule with basic information.",
    "required":[
        "designObjectType",
        "name",
        "status"
    ],
    "properties":{
        "scheduleId":{
            "type":"string"
        },
        "scheduleNumber":{
            "type":"integer",
            "format":"int64"
        },
        "name":{
            "type":"string"
        },
        "designObjectType":{
            "type":"string"
        },
        "designObjectName":{
            "type":"string"
        },
        "designObjectId":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "activeFromDate":{
            "type":"string"
        },
        "activeEndDate":{
            "type":"string"
        }
    }
}

401 Response

Unauthorized

404 Response

Not Found

Back to Top