Jump to

• Request
• Response

Retrieve Workflow

get

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

Retrieves a workflow by its ID.

Request

Path Parameters

• workflowId(required): string
  the ID of the workflow to retrieve

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

a workflow object, wrapped in a Response object

Body ()

Root 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