diff --git a/platform-api/api/overview.mdx b/platform-api/api/overview.mdx index 52a0852c..c3658de0 100644 --- a/platform-api/api/overview.mdx +++ b/platform-api/api/overview.mdx @@ -1395,7 +1395,7 @@ query parameters (for `curl` or Postman): - `workflow_id=`, replacing `` with the workflow's unique ID. To get this ID, see [List workflows](#list-workflows). -- `status=`, replacing `` with one of the following job statuses: `failed`, `finished`, or `running`. +- `status=`, replacing `` with one of the following job statuses: `completed`, `failed`, `im progress`, `scheduled`, and `stopped`. For `curl` or Postman, you can specify multiple query parameters as `?workflow_id=&status=`. diff --git a/platform-api/api/workflows.mdx b/platform-api/api/workflows.mdx index 032f36ef..4739889e 100644 --- a/platform-api/api/workflows.mdx +++ b/platform-api/api/workflows.mdx @@ -190,10 +190,17 @@ Replace the preceding placeholders as follows: - `` (_required_) - The ID of the target destination connector. To get the ID, use the `UnstructuredClient` object's `destinations.list_destinations` function (for the Python SDK) or the `GET` method to call the `/destinations` endpoint (for `curl` or Postman). [Learn more](/platform-api/api/overview#list-destination-connectors). -- `` (for the Python SDK) or `` (for `curl` or Postman) (_required_) - The workflow optimization type. [Learn more](/platform/partitioning). Available values include - `ADVANCED`, `BASIC`, `PLATINUM`, and `CUSTOM` (for the Python SDK) or - `advanced`, `basic`, `platinum`, and `custom` (for `curl` or Postman). +- `` (for the Python SDK) or `` (for `curl` or Postman) (_required_) - The workflow type. Available values include `CUSTOM` (for the Python SDK) and `custom` (for `curl` or Postman). + If `` is set to `CUSTOM` (for the Python SDK), or if `` is set to `custom` (for `curl` or Postman), you must add a `worfklow_nodes` array. For instructions, see [Custom workflow DAG nodes](#custom-workflow-dag-nodes). + + + The previously-available workflow optimization types `ADVANCED`, `BASIC`, and `PLATINUM` (for the Python SDK) and + `advanced`, `basic`, and `platinum` (for `curl` or Postman) are non-operational and planned to be fully removed in a future release. + + The ability to create an [automatic workflow](/platform/workflows#create-an-automatic-workflow) type is currently not available but is planned to be added in a future release. + + - `` - The repeating automatic run schedule, specified as a predefined phrase. The available predefined phrases are: - `every 15 minutes` (for `curl` or Postman): Every 15 minutes (cron expression: `*/15 * * * *`).