Jump to

• Request
• Response

List Schedules

get

[host-url]/dt-rest/v2/projects/{projectId}/schedules

Retrieves a list of schedules for a specific project. 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 dataflow ID

The following examples demonstrate the supported query patterns:

• Retrieve all schedules for a project:

  Retrieves all schedules for the project with the given projectId. All default fields for these schedules will be included in the response.

  /projects/{projectId}/schedules


• Retrieve all schedules for a project with specific fields:

  Retrieves all schedules for the project with the given projectId, and the response will only include the fields specified in the fields parameter.

  /projects/{projectId}/schedules?fields=name,scheduleId,...


• Retrieves all schedules for a project by name:

  Retrieves schedules for the project with the given projectId that match the specified name. All default fields for these schedules will be included in the response.

  /projects/{projectId}/schedules?name=your_schedule_name


• Retrieve schedules for a project by name with specific fields:

  Retrieves schedules for the project with the given projectId that match the specified name, and the response will only include the fields specified in the fields parameter.

  /projects/{projectId}/schedules?name=your_schedule_name&fields=name,scheduleId,...


• Retrieves all schedules for a project by status:

  Retrieves schedules for the project with the given projectId that match the specified status. All default fields for these schedules will be included in the response.

  /projects/{projectId}/schedules?status=your_schedule_status


• Retrieve schedules for a project by status with specific fields:

  Retrieves schedules for the project with the given projectId that match the specified name, and the response will only include the fields specified in the fields parameter.

  /projects/{projectId}/schedules?status=your_schedule_status&fields=name,scheduleId,...


• Retrieves all schedules for the workflow associated with a specific project:

  Retrieves all schedules for the workflow that match the project with the given projectId that match specified workflowId. All default fields for these schedules will be included in the response.

  /projects/{projectId}/schedules?workflowId=your_workflowId


• Retrieves all schedules for the workflow associated with a specific project with fields:

  Retrieves all schedules for the workflow that match the project with the given projectId that match the specified workflowId, and the response will only include the fields specified in the fields parameter.

  /projects/{projectId}/schedules?workflowId=your_workflowId&fields=name,scheduleId,...


• Retrieves all schedules for the dataflow associated with a specific project:

  Retrieves all schedules for the dataflow that match the project with the given projectId that match specified dataflowId. All default fields for these schedules will be included in the response.

  /projects/{projectId}/schedules?dataflowId=your_dataFlowId


• Retrieves all schedules for the dataflow associated with a specific project with fields:

  Retrieves all schedules for the dataflow that match the project with the given projectId that match the specified dataflowId, and the response will only include the fields specified in the fields parameter.

  /projects/{projectId}/schedules?dataflowId=your_dataFlowId&fields=name,scheduleId,...

Request

Path Parameters

• projectId(required): string
  ID of the project for which to retrieve schedules

Query Parameters

• dataFlowId: string
  filters schedules by dataflow ID
• 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