Jump to

• Request
• Response

List Workflows

get

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

Retrieves a list of workflows 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 workflows by name
• parentFolder: filters workflows by parent folder

The following examples demonstrate the supported query patterns:

• Retrieve all workflows for a project:

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

  /projects/{projectId}/workflows


• Retrieve all workflows for a project with specific fields:

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

  /projects/{projectId}/workflows?fields=name,workflowId,...


• Retrieve workflows for a project by name:

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

  /projects/{projectId}/workflows?name=your_workflow_name


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

  Retrieves workflows 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}/workflows?name=your_workflow_name&fields=name,workflowId,...


• Retrieve workflows for a project by parent folder:

  Retrieves workflows for the project with the given projectId that belong to the specified parentFolder. All default fields for these workflows will be included in the response.

  /projects/{projectId}/workflows?parentFolder=your_workflow_parentFolder


• Retrieve workflows for a project by parent folder with specific fields:

  Retrieves workflows for the project with the given projectId that belong to the specified parentFolder, and the response will only include the fields specified in the fields parameter.

  /projects/{projectId}/workflows?parentFolder=your_workflow_parentFolder&fields=name,workflowId,...

Request

Path Parameters

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

Query Parameters

• fields: string
  comma-separated list of fields to include in the response
• folder: string
  filters workflows by parent folder
• name: string
  filters workflows by name

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 workflows

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object WorkflowBaseDTO
  JSON that represents a workflow with basic information.

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

Nested Schema : WorkflowBaseDTO

Type: object

JSON that represents a workflow with basic information.

Show Source

• dateCreated: string (date-time)
• dateUpdated: string (date-time)
• description: string
• name(required): string
• parentFolder: string
• projectName: string
• workflowId: string

{
    "type":"object",
    "description":"JSON that represents a workflow with basic information.",
    "required":[
        "name"
    ],
    "properties":{
        "name":{
            "type":"string"
        },
        "workflowId":{
            "type":"string"
        },
        "dateCreated":{
            "type":"string",
            "format":"date-time"
        },
        "dateUpdated":{
            "type":"string",
            "format":"date-time"
        },
        "projectName":{
            "type":"string"
        },
        "parentFolder":{
            "type":"string"
        },
        "description":{
            "type":"string"
        }
    }
}

401 Response

Unauthorized

404 Response

Not Found

Back to Top