Workflows
5 operations.
| Method | Endpoint | Description |
|---|---|---|
| POST | /api/v1/projects/{projectId}/environments/{environmentId}/workflows | Start a Workflow |
| GET | /api/v1/projects/{projectId}/environments/{environmentId}/workflows/{workflowRunId} | Get Workflow status |
| POST | /api/v1/projects/{projectId}/environments/{environmentId}/workflows/{workflowRunId}/cancel | Cancel a Workflow |
| POST | /api/v1/projects/{projectId}/environments/{environmentId}/workflows/{workflowRunId}/resolve-unknown | Resolve an unknown Workflow effect |
| POST | /api/v1/projects/{projectId}/environments/{environmentId}/workflows/{workflowRunId}/resume | Resume a paused Workflow |
Start a Workflow
POST/api/v1/projects/{projectId}/environments/{environmentId}/workflows
Admit a pinned operation Workflow and return its durable run.
Parameters
path
| Name | Type | Required | Description |
|---|---|---|---|
| projectId | string | required | Identifies the Project that owns the addressed resource. Applies to Start a Workflow. |
| environmentId | string | required | Identifies the Project environment addressed by the operation. Applies to Start a Workflow. |
Request body
required — Request body for: Start a Workflow.
application/json
| Name | Type | Required | Description |
|---|---|---|---|
| agentId | string | required | |
| definitionIdOrName | one of 2 types | required | |
| params | object | optional | |
| requestKey | string | optional | |
| actorUserId | string | optional |
Responses
| Status | Description | Body |
|---|---|---|
| 200 | Response for status 200 | application/json object
|
| 202 | Response for status 202 | application/json object
|
| 400 | Bad Request | application/json PublicApiError
|
| 401 | Authentication failed. Possible reasons: - Authorization header is not provided - Invalid API key - Session expired | application/json PublicApiError
|
| 403 | Access denied. The authenticated user does not have permission to perform this action. | application/json PublicApiError
|
| 404 | Resource not found. | application/json PublicApiError
|
| 409 | Request conflicts with current state of the resource, including safe deployment conflict classifications. | application/json PublicApiError
|
| 422 | Request validation failed. Check the request body, query parameters, or path parameters. | application/json PublicApiError
|
| 500 | The server could not complete the request. | application/json PublicApiError
|
Get Workflow status
GET/api/v1/projects/{projectId}/environments/{environmentId}/workflows/{workflowRunId}
Parameters
path
| Name | Type | Required | Description |
|---|---|---|---|
| projectId | string | required | Identifies the Project that owns the addressed resource. Applies to Get Workflow status. |
| environmentId | string | required | Identifies the Project environment addressed by the operation. Applies to Get Workflow status. |
| workflowRunId | string | required | Identifies the durable Workflow run being addressed. Applies to Get Workflow status. |
query
| Name | Type | Required | Description |
|---|---|---|---|
| actorUserId | string | optional | Selects the external actor whose personalized Workflow authorization is being checked. Applies to Get Workflow status. |
Responses
| Status | Description | Body |
|---|---|---|
| 200 | Response for status 200 | application/json object
|
| 400 | The request is malformed or cannot be processed. | application/json PublicApiError
|
| 401 | Authentication failed. Possible reasons: - Authorization header is not provided - Invalid API key - Session expired | application/json PublicApiError
|
| 403 | Access denied. The authenticated user does not have permission to perform this action. | application/json PublicApiError
|
| 404 | Resource not found. | application/json PublicApiError
|
| 422 | Request validation failed. Check the request body, query parameters, or path parameters. | application/json PublicApiError
|
| 500 | The server could not complete the request. | application/json PublicApiError
|
Cancel a Workflow
POST/api/v1/projects/{projectId}/environments/{environmentId}/workflows/{workflowRunId}/cancel
Parameters
path
| Name | Type | Required | Description |
|---|---|---|---|
| projectId | string | required | Identifies the Project that owns the addressed resource. Applies to Cancel a Workflow. |
| environmentId | string | required | Identifies the Project environment addressed by the operation. Applies to Cancel a Workflow. |
| workflowRunId | string | required | Identifies the durable Workflow run being addressed. Applies to Cancel a Workflow. |
query
| Name | Type | Required | Description |
|---|---|---|---|
| actorUserId | string | optional | Selects the external actor whose personalized Workflow authorization is being checked. Applies to Cancel a Workflow. |
Responses
| Status | Description | Body |
|---|---|---|
| 200 | Response for status 200 | application/json object
|
| 400 | The request is malformed or cannot be processed. | application/json PublicApiError
|
| 401 | Authentication failed. Possible reasons: - Authorization header is not provided - Invalid API key - Session expired | application/json PublicApiError
|
| 403 | Access denied. The authenticated user does not have permission to perform this action. | application/json PublicApiError
|
| 404 | Resource not found. | application/json PublicApiError
|
| 422 | Request validation failed. Check the request body, query parameters, or path parameters. | application/json PublicApiError
|
| 500 | The server could not complete the request. | application/json PublicApiError
|
Resolve an unknown Workflow effect
POST/api/v1/projects/{projectId}/environments/{environmentId}/workflows/{workflowRunId}/resolve-unknown
Parameters
path
| Name | Type | Required | Description |
|---|---|---|---|
| projectId | string | required | Identifies the Project that owns the addressed resource. Applies to Resolve an unknown Workflow effect. |
| environmentId | string | required | Identifies the Project environment addressed by the operation. Applies to Resolve an unknown Workflow effect. |
| workflowRunId | string | required | Identifies the durable Workflow run being addressed. Applies to Resolve an unknown Workflow effect. |
Request body
required — Request body for: Resolve an unknown Workflow effect.
application/json
| Name | Type | Required | Description |
|---|---|---|---|
| stepId | string | required | |
| outcome | one of 2 types | required |
Responses
| Status | Description | Body |
|---|---|---|
| 200 | Response for status 200 | application/json object
|
| 400 | Bad Request | application/json PublicApiError
|
| 401 | Authentication failed. Possible reasons: - Authorization header is not provided - Invalid API key - Session expired | application/json PublicApiError
|
| 403 | Access denied. The authenticated user does not have permission to perform this action. | application/json PublicApiError
|
| 404 | Resource not found. | application/json PublicApiError
|
| 409 | Request conflicts with current state of the resource, including safe deployment conflict classifications. | application/json PublicApiError
|
| 422 | Request validation failed. Check the request body, query parameters, or path parameters. | application/json PublicApiError
|
| 500 | The server could not complete the request. | application/json PublicApiError
|
Resume a paused Workflow
POST/api/v1/projects/{projectId}/environments/{environmentId}/workflows/{workflowRunId}/resume
Parameters
path
| Name | Type | Required | Description |
|---|---|---|---|
| projectId | string | required | Identifies the Project that owns the addressed resource. Applies to Resume a paused Workflow. |
| environmentId | string | required | Identifies the Project environment addressed by the operation. Applies to Resume a paused Workflow. |
| workflowRunId | string | required | Identifies the durable Workflow run being addressed. Applies to Resume a paused Workflow. |
query
| Name | Type | Required | Description |
|---|---|---|---|
| actorUserId | string | optional | Selects the external actor whose personalized Workflow authorization is being checked. Applies to Resume a paused Workflow. |
Responses
| Status | Description | Body |
|---|---|---|
| 200 | Response for status 200 | application/json object
|
| 400 | The request is malformed or cannot be processed. | application/json PublicApiError
|
| 401 | Authentication failed. Possible reasons: - Authorization header is not provided - Invalid API key - Session expired | application/json PublicApiError
|
| 403 | Access denied. The authenticated user does not have permission to perform this action. | application/json PublicApiError
|
| 404 | Resource not found. | application/json PublicApiError
|
| 409 | Request conflicts with current state of the resource, including safe deployment conflict classifications. | application/json PublicApiError
|
| 422 | Request validation failed. Check the request body, query parameters, or path parameters. | application/json PublicApiError
|
| 500 | The server could not complete the request. | application/json PublicApiError
|