openapi: 3.2.0 info: version: 3.0.0 title: Opal API (⚠️ WIP) Workflow Assignments API license: name: Opal API License url: https://www.workwithopal.com/api-license description: "The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “NOT RECOMMENDED”, “MAY”, and “OPTIONAL” in this document are to be interpreted as described in [BCP 14](https://tools.ietf.org/html/bcp14) [[RFC2119](https://tools.ietf.org/html/rfc2119)] [[RFC8174](https://tools.ietf.org/html/rfc8174)] when, and only when, they appear in all capitals, as shown here.\n\n# Other API Versions\n\nThe [v2 API](/api/documentation/v2) is more complete than the v3 API. Currently, if a resource has endpoints in both the v2 API and the v3 API you **SHOULD** use the v2 API endpoints. At some point in the future we will recommend the v3 API instead.\n\n*Note:* Endpoints will be added to the v3 API as needed, and we will continue to support all v2 API endpoints in the “JSON:API” and “Other” categories, even if we add an equivalent v3 API endpoint.\n\n# Key differences between v2 and v3 APIs\n\n## Resource Identifiers\n\nThe v3 API uses a different format for primary resource identifiers than the v2 API. Responses from v3 API endpoints include the resource’s v2 API id in the `attributes.legacy_id` field, in case you need to use both API versions. (v2 API resource identifiers are generally integers, but v2 API endpoints **MAY** use a different format.)\n\n*Note:* These are opaque strings, and you **MUST NOT** rely on the structure. Currently newly-created resources have a UUIDv4 identifier, but this behavior **MAY** change at any time. Existing identifiers will not be affected.\n\n# Documentation Organization\n\nv3 API endpoints are categorized by stability:\n\n1. Stable\n2. Unstable\n3. Proposed\n4. Experimental\n\nAll v3 API endpoints are [JSON:API](https://jsonapi.org)-compliant ([specification](https://jsonapi.org/format/)) and can be used with any [JSON:API-compliant client](https://jsonapi.org/implementations/).\n\nYour requests **MUST** set the `Accept` HTTP header to `application/vnd.api+json`. The server response’s `Content-Type` HTTP header will also be `application/vnd.api+json`.\n\n## Unstable Endpoints\n\n*Note:* This generally refers resources in the “Unstable” category, but includes endpoints with a summary that’s prefixed by `[UNSTABLE]`. These `[UNSTABLE]` endpoints may be part of a “Stable” resource.\n\nThe data structure and behavior of “Unstable” endpoints are not guaranteed, and we **MAY** change them at any time. You **MUST NOT** use these endpoints for production features, but **MAY** use them as a preview of upcoming features, and we welcome feedback.\n\n## Proposed Endpoints\n\n“Proposed” endpoints **MUST NOT** be used (they’re not yet implemented), and we **MAY** change or remove them at any time. We publish them at our discretion to share our plans and encourage internal feedback. We also welcome your feedback.\n\n# Design Principles\n\n## Breaking Changes\n\nWe **MAY** expand the data for “Stable” resources, but will not change or remove existing attributes or relationships for these resources. These expansions should not require any changes to your code.\n\nWe provide no guarantees for “Unstable,” \"Experimental,\" or “Proposed” endpoints.\n\n## Firehose Rule\n\nBy default endpoints include all the relevant data that’s accessible to the authenticated user. Clients **MAY** specify filters, ordering, pagination, sparse fields, and other limiting mechanisms to pare down the desired data.\n\n*Note:* Existing endpoints **MAY NOT** follow this maximalist approach, but new endpoints will, and we **MAY** enhance existing endpoints.\n\n## Obscurity\n\nIn order to provide customers with as much privacy as possible, many API calls that fail authorization will return `404 Not Found` rather than `403 Forbidden`. Do not design frontends around the expectation that a `404 Not Found` status code means a resource would not be returned given different authentication credentials.\n\n# Authentication Strategies\n## OAuth 2.0\nOpal uses OAuth 2.0 (https://oauth.net/2) to authenticate users and grant access to protected resources. After registering your application as an OAuth client, you must get permission from each user before accessing their account.\n\nThe main steps are:\n\n1. Register your application\n2. Direct the user to Opal, to authorize your application\n3. Opal confirm's user identity, and asks the user to grant your application permissions\n4. Opal issues tokens your application can use to access the user's Opal resources\n5. Your application can begin making requests to the Opal API on behalf of the user\n\n### Roles\n#### Client\nThe 3rd-party application accessing the API on behalf of the User.\n\n#### API\nAPI endpoints used to interact with a User's resources in Opal.\n\n#### User\nThe person authorizing the Client to access to their Opal account.\n\n### Registering your application\nApplication registration is currently a manual process.\n\nTo begin, you will need to provide the following information to the Opal integrations team:\n\n- Application name\n- Logo URI\n- Redirect URI\n\nIn return, expect to receive:\n\n- Client ID\n - public\n- Application secret\n - keep this private\n - keep this written down someplace safe. Opal cannot retrieve this for you if it is lost.\n\n### Authorization\nFor a Client to make API requests on behalf of Users, the User must first give consent.\nHere is an overview of the consent flow:\n\n1. Direct the User to grant access in Opal\n\n```\nhttps://login.ouropal.com/oauth2/auth?grant_type=authorization_code&scope=offline_access&response_type=code&client_id={client_id}&state={state}&redirect_uri={url_encoded_redirect}\n```\n\nParameters:\n- `client_id`: Provided by Opal.\n- `grant_type`: Set the value to authorization_code to receive a code string that can be exchanged for an access token.\n- `redirect_uri`: Defined by Client. After authentication, the user will be directed to this location.\n- `response_type`: The value code should be set for refresh tokens to be issued.\n- `scope`: The value offline_access must be present if you wish to use refresh tokens.\n- `state`: Defined by the Client. A unique value used to validate the response.\n\n\n2. If logged out, User is directed to log in to Opal\n\n3. User is redirected to consent page (if the User has not already given consent)\n\n```\nhttps://login.ouropal.com/oauth2/consent?consent_challenge=abc123\n```\n\n4. If the User grants permission, User is sent to the specified `redirect_uri`\n\n```\nhttps://example.com/defined-by-client?code=Mu9z2DndN7TfXSLaf99O8ReqqXqMabXhSqP5e0jlx_Q.naLKbko-GyfPJRGYcWyclxU0sBGwygPy05OSFww0XZ8&scope=offline_access&state={state}\n```\n\nParameters:\n- `code`: The Client may use this to get an access token.\n- `scope`: API permissions granted to the Client by the User.\n- `state`: The validation string provided by the Client in step 1.\n\nIf the User declines the consent prompt, User will be sent to the same `redirect_uri`, but with an error parameter :\n\n```\nhttps://example.com/defined-by-client?error=consent+request+denied&state={state}\n```\n\nParameters:\n- `error`: A brief description of the issue.\n- `state`: The validation string provided by the Client in step 1.\n\n### Retrieving Access Token\nYou must make a POST request to the token endpoint to get an access token, before the code expires:\n\n```\ncurl -X POST \\\n https://login.ouropal.com/oauth2/token \\\n -H 'Content-Type: application/x-www-form-urlencoded' \\\n -d 'code={code}&client_id={client_id}&redirect_uri={url_encoded_redirect}&client_secret={client_secret}&grant_type=authorization_code'\n```\n\nParameters:\n- `code`\n- `client_id`: Client ID provided by Opal.\n- `client_secret`: Client secret provided by Opal.\n- `grant_type`: Set value to authorization_code .\n- `redirect_uri`: Optional.\n\nIf successful, a JSON-formatted response body will contain the access_token and refresh_token:\n\n```json\n{\n \"access_token\":\"ABC123\",\n \"token_type\":\"bearer\",\n \"expires_in\":3600,\n \"refresh_token\":\"DEF456\",\n \"scope\":\"offline_access\"\n}\n```\n\n### Refreshing an Access Token\nOnce the access_token expires, you may generate a new one at the same token endpoint, but with different parameters.\nNote that in this request, a \"refresh_token\" parameter is used instead of \"code\", and the \"grant_type\" value is now \"refresh_token\" instead of \"authorization_code\".\n\n```\ncurl -X POST \\\n https://login.ouropal.com/oauth2/token \\\n -H 'Content-Type: application/x-www-form-urlencoded' \\\n -d 'refresh_token={refresh_token}&client_id={client_id}&redirect_uri={url_encoded_redirect}&client_secret={secret}&grant_type=refresh_token'\n```\n\nParameters:\n- `client_id`: Client ID provided by Opal.\n- `client_secret`: Client secret provided by Opal.\n- `grant_type`: Set value to refresh_token .\n- `redirect_uri`: Optional.\n- `refresh_token`: Refresh token value\n\n### Making Authenticated Requests\n\nSet an authorization header in your requests, specifying your access token as documented here: https://tools.ietf.org/html/rfc6750#section-2.1.\n\n**NOTE** that the `Authorization` header supercedes the `Session-Token` header described in the documentation for many endpoints. Specifying an `Authorization` header means you do not need to specify a `Session-Token` header.\n\n```\nAuthorization: Bearer ACCESS_TOKEN\n```\n\nFor example:\n```\n GET /resource HTTP/1.1\n Host: server.example.com\n Authorization: Bearer mF_9.B5f-4.1JqM\n```\n\n### Client Revoke/Rolling OAuth secrets\nClient secrets must be kept secret and not exposed outside of the token retrieval requests. If a secret has been potentially compromised, please notify Opal as soon as possible and let us know the OAuth client id associated with the secret. We will roll/update the secret, which will invalidate all existing access and refresh tokens. Invalidating tokens will cause users to need to reauthenticate, but consent should be remembered.\n" servers: - url: https://login.ouropal.com tags: - name: Workflow Assignments paths: /v3/workflow_assignments/{workflow_assignment_id}: get: tags: - Workflow Assignments operationId: ReadWorkflowAssignmentV3 summary: Get a Workflow Assignment security: - oauth2: - offline_access - api_key: [] parameters: - name: workflow_assignment_id in: path required: true description: The ID of the workflow assignment schema: type: string format: uuid - name: include in: query required: false description: 'A comma separated value of related resource objects on the workflow assignment to include. Note that user resources are not available as includes on this endpoint; the client must make subsequent API requests `api/v1/users` to request additional information on related users. ' schema: type: array items: type: string enum: - stage - stage.workflow - stage.workflow.context - responses style: form explode: false responses: '200': description: Workflow Assignment successfully retrieved content: application/json: schema: type: object required: - data properties: data: title: workflow_assignment type: object required: - id - type - attributes - relationships additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - workflow_assignment relationships: type: object required: - created_by_user - assigned_user - stage - responses additionalProperties: false properties: created_by_user: title: User type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - user assigned_user: title: User type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - user stage: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - workflow_stage responses: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - workflow_response attributes: type: object required: - assignment_type - created_at - metadata - position - updated_at additionalProperties: false properties: assignment_type: type: string enum: - approval - task - circuit_breaker created_at: type: string format: date-time readOnly: true metadata: type: - object - 'null' anyOf: - type: - object - 'null' title: Approval Workflow Assignment Metadata additionalProperties: false properties: title: type: string description: The title of the workflow_assignment. Will default to "Approval". - type: object title: Task/Circuit Breaker Workflow Assignment Metadata additionalProperties: false properties: title: type: string description: The title of the workflow_assignment. Will default to "Task" or "Pause". is_starred: type: boolean position: type: integer description: 'The sequential position (starting at 1) of the workflow_assignment within its workflow_stage. ' readOnly: true updated_at: type: string format: date-time readOnly: true included: type: array items: oneOf: - title: workflow_response type: object required: - id - type - attributes - relationships additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - workflow_response attributes: type: object additionalProperties: false required: - created_at - details - updated_at properties: created_at: type: string format: date-time description: An ISO8601 date-time. readOnly: true details: type: - object - 'null' oneOf: - type: - object - 'null' title: Approval Workflow Response Details additionalProperties: false required: - approved properties: approved: type: string enum: - approved - declined reasoning: type: - string - 'null' - type: object title: Task/Circuit Breaker Workflow Response Details additionalProperties: false required: - complete properties: complete: type: boolean - type: object title: Rewind Workflow Response Details additionalProperties: false required: - rewind properties: rewind: type: boolean updated_at: type: string format: date-time description: An ISO8601 date-time. readOnly: true relationships: type: object required: - assignment - created_by_user additionalProperties: false properties: assignment: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - workflow_assignment created_by_user: title: User type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - user - title: workflow_stage type: object required: - id - type - attributes - relationships additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - workflow_stage attributes: type: object required: - activated_at - created_at - due_date - metadata - position - stage_type - status - updated_at additionalProperties: false properties: activated_at: type: - string - 'null' format: date-time readOnly: true description: 'An ISO8601 date-time set to the time when this workflow_stage gained the `status` "active". Naturally, this field is `null` prior to the workflow_stage becoming active. It is also `null` _after_ a rollback if the rollback targets a workflow_stage earlier than the one currently active. ' created_at: type: string format: date-time readOnly: true description: An ISO8601 date-time. due_date: type: - string - 'null' format: date-time description: An ISO8601 date-time. metadata: type: - object - 'null' oneOf: - type: - object - 'null' title: Approval Workflow Stage Metadata additionalProperties: false required: - completion_rules properties: title: type: string description: The title of the workflow_stage. Will default to "Approval Phase" completion_rules: type: string enum: - all - one - type: object title: Task/Circuit Breaker Workflow Stage Metadata additionalProperties: false properties: title: type: string description: The title of the workflow_stage. Will default to "Task Phase" or "Pause" position: type: integer stage_type: type: string enum: - approval - task - circuit_breaker status: type: string enum: - active - complete - inactive updated_at: type: string format: date-time description: An ISO8601 date-time. relationships: type: object additionalProperties: false required: - assignments - workflow properties: assignments: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - workflow_assignment workflow: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - workflow - title: workflow type: object required: - id - attributes - relationships additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - workflow meta: type: object description: 'Optionally calculated workflow status metadata. **Not part of responses by default.** This is currently only available when requesting workflow resources from the `/workflows/v2/workflows` and `/workflows/v2/workflows/{id}` `GET` endpoints. You request that this metadata be included in responses with the `expose` query parameter like: `/workflows/v2/workflows?expose[workflow][meta]`. The "latest active stage" is either the stage that is currently active or it is the last stage of a completed workflow. ' required: - latest_active_stage - completed_stages - stage_type_count additionalProperties: false properties: latest_active_stage: oneOf: - title: Stage Status Metadata allOf: - required: - stage_type - resource_identifier properties: stage_type: type: string enum: - approval - task - circuit_breaker title: type: - string - 'null' description: The title of the stage. due_date: type: - string - 'null' format: date-time description: The due date of the stage if set. resource_identifier: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - workflow_stage - type: object description: The status metadata of a workflow_stage. required: - assignment_counts properties: assignment_counts: type: object description: 'Assignment counts broken down in three ways. First, the number of complete/incomplete assignments for all users (both approvals and tasks). Second, the number of complete/incomplete assignments for the current user (both approvals and tasks). Third, the number of declined approvals. In the first two cases, both approvals and tasks can be complete or incomplete where both approved and declined responses on an approval assignment count as completion. ' required: - all - current_user - declined additionalProperties: false properties: all: type: object required: - incomplete - complete additionalProperties: false properties: incomplete: type: integer minimum: 0 complete: type: integer minimum: 0 current_user: type: object required: - incomplete - complete additionalProperties: false properties: incomplete: type: integer minimum: 0 complete: type: integer minimum: 0 declined: type: integer minimum: 0 - title: 'null' type: - object - 'null' enum: - null completed_stages: type: integer minimum: 0 stage_type_count: type: object required: - approval - task - circuit_breaker additionalProperties: false properties: approval: type: integer minimum: 0 task: type: integer minimum: 0 circuit_breaker: type: integer minimum: 0 attributes: type: object required: - created_at - status - is_approved - updated_at additionalProperties: false properties: created_at: type: string format: date-time description: An ISO8601 date-time indicating when the workflow was created. readOnly: true status: type: string description: A string indicating the current status of the workflow. enum: - active - complete - inactive - paused readOnly: true is_approved: type: boolean description: 'Indicative of whether the latest approval workflow_stage has been completed. Workflows with only task workflow_stages will never result in `is_approved=true`. ' readOnly: true updated_at: type: string format: date-time description: 'An ISO8601 date-time indicating when the workflow was last updated. ' readOnly: true relationships: type: object additionalProperties: false required: - context - created_by_user - stages properties: context: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - workflow_context created_by_user: title: User type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - user stages: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - workflow_stage - title: workflow_context type: object additionalProperties: false required: - id - type - attributes - relationships properties: id: type: string format: uuid type: type: string enum: - workflow_context attributes: type: object additionalProperties: false required: - created_at - updated_at properties: created_at: type: string format: date-time description: An ISO8601 date-time. readOnly: true updated_at: type: string format: date-time description: An ISO8601 date-time. readOnly: true relationships: type: object additionalProperties: false required: - block - created_by_user - moment - workflow properties: block: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - block created_by_user: title: User type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - user moment: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - moment workflow: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - workflow examples: approval: value: data: id: 4ac02fc7-705c-467e-933e-8bf16fc3ebf1 type: workflow_assignment attributes: created_at: '2020-09-11T15:27:01.881-08:00' updated_at: '2020-09-11T15:27:01.881-08:00' assignment_type: approval position: 1 metadata: title: Approval relationships: created_by_user: data: id: ada0d59f-9f8c-4df3-ae9c-d6997ab48645 type: user stage: data: id: 186ad497-b8a7-43d6-bd95-cde8f9a02cdc type: workflow_stage assigned_user: data: id: ada0d59f-9f8c-4df3-ae9c-d6997ab48645 type: user responses: data: - id: 5d806729-5a08-4e31-8b8e-17bea992ec69 type: workflow_response task: value: data: id: 4ac02fc7-705c-467e-933e-8bf16fc3ebf1 type: workflow_assignment attributes: created_at: '2020-09-11T15:27:01.881-08:00' updated_at: '2020-09-11T15:27:01.881-08:00' assignment_type: task position: 1 metadata: title: Task is_starred: false relationships: created_by_user: data: id: ada0d59f-9f8c-4df3-ae9c-d6997ab48645 type: user stage: data: id: 186ad497-b8a7-43d6-bd95-cde8f9a02cdc type: workflow_stage assigned_user: data: id: ada0d59f-9f8c-4df3-ae9c-d6997ab48645 type: user responses: data: - id: 5d806729-5a08-4e31-8b8e-17bea992ec69 type: workflow_response circuit_breaker: value: data: id: 4ac02fc7-705c-467e-933e-8bf16fc3ebf1 type: workflow_assignment attributes: created_at: '2020-09-11T15:27:01.881-08:00' updated_at: '2020-09-11T15:27:01.881-08:00' assignment_type: circuit_breaker position: 1 metadata: title: Pause relationships: created_by_user: data: id: ada0d59f-9f8c-4df3-ae9c-d6997ab48645 type: user stage: data: id: 186ad497-b8a7-43d6-bd95-cde8f9a02cdc type: workflow_stage assigned_user: data: id: ada0d59f-9f8c-4df3-ae9c-d6997ab48645 type: user responses: data: - id: 5d806729-5a08-4e31-8b8e-17bea992ec69 type: workflow_response '400': description: Bad request content: application/json: schema: type: object required: - errors properties: errors: type: array items: type: object properties: status: type: string description: The http status code of the error response. title: type: string description: A short, human-readable summary of the error. detail: type: string description: A human-readable explanation of the error. code: type: string description: 'An system-readable error code to provide additional specificity for the error. ' required: - status '401': description: Unauthorized content: application/json: schema: type: object required: - errors properties: errors: type: array items: type: object properties: status: type: string description: The http status code of the error response. title: type: string description: A short, human-readable summary of the error. detail: type: string description: A human-readable explanation of the error. code: type: string description: 'An system-readable error code to provide additional specificity for the error. ' required: - status '404': description: Not found content: application/json: schema: type: object required: - errors properties: errors: type: array items: type: object properties: status: type: string description: The http status code of the error response. title: type: string description: A short, human-readable summary of the error. detail: type: string description: A human-readable explanation of the error. code: type: string description: 'An system-readable error code to provide additional specificity for the error. ' required: - status '422': description: Unprocessable entity content: application/json: schema: type: object required: - errors properties: errors: type: array items: type: object properties: status: type: string description: The http status code of the error response. title: type: string description: A short, human-readable summary of the error. detail: type: string description: A human-readable explanation of the error. code: type: string description: 'An system-readable error code to provide additional specificity for the error. ' required: - status patch: tags: - Workflow Assignments operationId: UpdateWorkflowAssignmentV3 summary: Update an workflow assignment by ID security: - oauth2: - offline_access - api_key: [] parameters: - name: workflow_assignment_id in: path required: true description: The ID of the workflow assignment schema: type: string format: uuid requestBody: content: application/json: schema: type: object required: - data properties: data: type: object required: - type - attributes - id properties: id: type: string format: uuid type: type: string enum: - workflow_assignment attributes: type: object properties: metadata: type: - object - 'null' properties: title: type: string is_starred: type: boolean relationships: type: object properties: assigned_user: title: User type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - user created_by_user: title: User type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - user stage: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - workflow_stage example: data: id: 586e3547-6798-419a-b5e6-39db937e1cbc type: workflow_assignment attributes: assigned_user_id: ada0d59f-9f8c-4df3-ae9c-d6997ab48645 responses: '200': description: An workflow assignment resource. content: application/json: schema: type: object required: - data properties: data: title: workflow_assignment type: object required: - id - type - attributes - relationships additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - workflow_assignment relationships: type: object required: - created_by_user - assigned_user - stage - responses additionalProperties: false properties: created_by_user: title: User type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - user assigned_user: title: User type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - user stage: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - workflow_stage responses: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - workflow_response attributes: type: object required: - assignment_type - created_at - metadata - position - updated_at additionalProperties: false properties: assignment_type: type: string enum: - approval - task - circuit_breaker created_at: type: string format: date-time readOnly: true metadata: type: - object - 'null' anyOf: - type: - object - 'null' title: Approval Workflow Assignment Metadata additionalProperties: false properties: title: type: string description: The title of the workflow_assignment. Will default to "Approval". - type: object title: Task/Circuit Breaker Workflow Assignment Metadata additionalProperties: false properties: title: type: string description: The title of the workflow_assignment. Will default to "Task" or "Pause". is_starred: type: boolean position: type: integer description: 'The sequential position (starting at 1) of the workflow_assignment within its workflow_stage. ' readOnly: true updated_at: type: string format: date-time readOnly: true included: type: array items: oneOf: - title: workflow_response type: object required: - id - type - attributes - relationships additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - workflow_response attributes: type: object additionalProperties: false required: - created_at - details - updated_at properties: created_at: type: string format: date-time description: An ISO8601 date-time. readOnly: true details: type: - object - 'null' oneOf: - type: - object - 'null' title: Approval Workflow Response Details additionalProperties: false required: - approved properties: approved: type: string enum: - approved - declined reasoning: type: - string - 'null' - type: object title: Task/Circuit Breaker Workflow Response Details additionalProperties: false required: - complete properties: complete: type: boolean - type: object title: Rewind Workflow Response Details additionalProperties: false required: - rewind properties: rewind: type: boolean updated_at: type: string format: date-time description: An ISO8601 date-time. readOnly: true relationships: type: object required: - assignment - created_by_user additionalProperties: false properties: assignment: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - workflow_assignment created_by_user: title: User type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - user - title: workflow_stage type: object required: - id - type - attributes - relationships additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - workflow_stage attributes: type: object required: - activated_at - created_at - due_date - metadata - position - stage_type - status - updated_at additionalProperties: false properties: activated_at: type: - string - 'null' format: date-time readOnly: true description: 'An ISO8601 date-time set to the time when this workflow_stage gained the `status` "active". Naturally, this field is `null` prior to the workflow_stage becoming active. It is also `null` _after_ a rollback if the rollback targets a workflow_stage earlier than the one currently active. ' created_at: type: string format: date-time readOnly: true description: An ISO8601 date-time. due_date: type: - string - 'null' format: date-time description: An ISO8601 date-time. metadata: type: - object - 'null' oneOf: - type: - object - 'null' title: Approval Workflow Stage Metadata additionalProperties: false required: - completion_rules properties: title: type: string description: The title of the workflow_stage. Will default to "Approval Phase" completion_rules: type: string enum: - all - one - type: object title: Task/Circuit Breaker Workflow Stage Metadata additionalProperties: false properties: title: type: string description: The title of the workflow_stage. Will default to "Task Phase" or "Pause" position: type: integer stage_type: type: string enum: - approval - task - circuit_breaker status: type: string enum: - active - complete - inactive updated_at: type: string format: date-time description: An ISO8601 date-time. relationships: type: object additionalProperties: false required: - assignments - workflow properties: assignments: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - workflow_assignment workflow: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - workflow - title: workflow type: object required: - id - attributes - relationships additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - workflow meta: type: object description: 'Optionally calculated workflow status metadata. **Not part of responses by default.** This is currently only available when requesting workflow resources from the `/workflows/v2/workflows` and `/workflows/v2/workflows/{id}` `GET` endpoints. You request that this metadata be included in responses with the `expose` query parameter like: `/workflows/v2/workflows?expose[workflow][meta]`. The "latest active stage" is either the stage that is currently active or it is the last stage of a completed workflow. ' required: - latest_active_stage - completed_stages - stage_type_count additionalProperties: false properties: latest_active_stage: oneOf: - title: Stage Status Metadata allOf: - required: - stage_type - resource_identifier properties: stage_type: type: string enum: - approval - task - circuit_breaker title: type: - string - 'null' description: The title of the stage. due_date: type: - string - 'null' format: date-time description: The due date of the stage if set. resource_identifier: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - workflow_stage - type: object description: The status metadata of a workflow_stage. required: - assignment_counts properties: assignment_counts: type: object description: 'Assignment counts broken down in three ways. First, the number of complete/incomplete assignments for all users (both approvals and tasks). Second, the number of complete/incomplete assignments for the current user (both approvals and tasks). Third, the number of declined approvals. In the first two cases, both approvals and tasks can be complete or incomplete where both approved and declined responses on an approval assignment count as completion. ' required: - all - current_user - declined additionalProperties: false properties: all: type: object required: - incomplete - complete additionalProperties: false properties: incomplete: type: integer minimum: 0 complete: type: integer minimum: 0 current_user: type: object required: - incomplete - complete additionalProperties: false properties: incomplete: type: integer minimum: 0 complete: type: integer minimum: 0 declined: type: integer minimum: 0 - title: 'null' type: - object - 'null' enum: - null completed_stages: type: integer minimum: 0 stage_type_count: type: object required: - approval - task - circuit_breaker additionalProperties: false properties: approval: type: integer minimum: 0 task: type: integer minimum: 0 circuit_breaker: type: integer minimum: 0 attributes: type: object required: - created_at - status - is_approved - updated_at additionalProperties: false properties: created_at: type: string format: date-time description: An ISO8601 date-time indicating when the workflow was created. readOnly: true status: type: string description: A string indicating the current status of the workflow. enum: - active - complete - inactive - paused readOnly: true is_approved: type: boolean description: 'Indicative of whether the latest approval workflow_stage has been completed. Workflows with only task workflow_stages will never result in `is_approved=true`. ' readOnly: true updated_at: type: string format: date-time description: 'An ISO8601 date-time indicating when the workflow was last updated. ' readOnly: true relationships: type: object additionalProperties: false required: - context - created_by_user - stages properties: context: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - workflow_context created_by_user: title: User type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - user stages: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - workflow_stage - title: workflow_context type: object additionalProperties: false required: - id - type - attributes - relationships properties: id: type: string format: uuid type: type: string enum: - workflow_context attributes: type: object additionalProperties: false required: - created_at - updated_at properties: created_at: type: string format: date-time description: An ISO8601 date-time. readOnly: true updated_at: type: string format: date-time description: An ISO8601 date-time. readOnly: true relationships: type: object additionalProperties: false required: - block - created_by_user - moment - workflow properties: block: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - block created_by_user: title: User type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - user moment: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - moment workflow: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - workflow examples: approval: value: data: id: 4ac02fc7-705c-467e-933e-8bf16fc3ebf1 type: workflow_assignment attributes: created_at: '2020-09-11T15:27:01.881-08:00' updated_at: '2020-09-11T15:27:01.881-08:00' assignment_type: approval position: 1 metadata: title: Approval relationships: created_by_user: data: id: ada0d59f-9f8c-4df3-ae9c-d6997ab48645 type: user stage: data: id: 186ad497-b8a7-43d6-bd95-cde8f9a02cdc type: workflow_stage assigned_user: data: id: ada0d59f-9f8c-4df3-ae9c-d6997ab48645 type: user responses: data: - id: 5d806729-5a08-4e31-8b8e-17bea992ec69 type: workflow_response task: value: data: id: 4ac02fc7-705c-467e-933e-8bf16fc3ebf1 type: workflow_assignment attributes: created_at: '2020-09-11T15:27:01.881-08:00' updated_at: '2020-09-11T15:27:01.881-08:00' assignment_type: task position: 1 metadata: title: Task is_starred: false relationships: created_by_user: data: id: ada0d59f-9f8c-4df3-ae9c-d6997ab48645 type: user stage: data: id: 186ad497-b8a7-43d6-bd95-cde8f9a02cdc type: workflow_stage assigned_user: data: id: ada0d59f-9f8c-4df3-ae9c-d6997ab48645 type: user responses: data: - id: 5d806729-5a08-4e31-8b8e-17bea992ec69 type: workflow_response circuit_breaker: value: data: id: 4ac02fc7-705c-467e-933e-8bf16fc3ebf1 type: workflow_assignment attributes: created_at: '2020-09-11T15:27:01.881-08:00' updated_at: '2020-09-11T15:27:01.881-08:00' assignment_type: circuit_breaker position: 1 metadata: title: Pause relationships: created_by_user: data: id: ada0d59f-9f8c-4df3-ae9c-d6997ab48645 type: user stage: data: id: 186ad497-b8a7-43d6-bd95-cde8f9a02cdc type: workflow_stage assigned_user: data: id: ada0d59f-9f8c-4df3-ae9c-d6997ab48645 type: user responses: data: - id: 5d806729-5a08-4e31-8b8e-17bea992ec69 type: workflow_response '400': description: Bad request content: application/json: schema: type: object required: - errors properties: errors: type: array items: type: object properties: status: type: string description: The http status code of the error response. title: type: string description: A short, human-readable summary of the error. detail: type: string description: A human-readable explanation of the error. code: type: string description: 'An system-readable error code to provide additional specificity for the error. ' required: - status '401': description: Unauthorized content: application/json: schema: type: object required: - errors properties: errors: type: array items: type: object properties: status: type: string description: The http status code of the error response. title: type: string description: A short, human-readable summary of the error. detail: type: string description: A human-readable explanation of the error. code: type: string description: 'An system-readable error code to provide additional specificity for the error. ' required: - status '403': description: Forbidden content: application/json: schema: type: object required: - errors properties: errors: type: array items: type: object properties: status: type: string description: The http status code of the error response. title: type: string description: A short, human-readable summary of the error. detail: type: string description: A human-readable explanation of the error. code: type: string description: 'An system-readable error code to provide additional specificity for the error. ' required: - status '404': description: Not found content: application/json: schema: type: object required: - errors properties: errors: type: array items: type: object properties: status: type: string description: The http status code of the error response. title: type: string description: A short, human-readable summary of the error. detail: type: string description: A human-readable explanation of the error. code: type: string description: 'An system-readable error code to provide additional specificity for the error. ' required: - status '409': description: Conflict content: application/json: schema: type: object required: - errors properties: errors: type: array items: type: object properties: status: type: string description: The http status code of the error response. title: type: string description: A short, human-readable summary of the error. detail: type: string description: A human-readable explanation of the error. code: type: string description: 'An system-readable error code to provide additional specificity for the error. ' required: - status '422': description: Unprocessable entity content: application/json: schema: type: object required: - errors properties: errors: type: array items: type: object properties: status: type: string description: The http status code of the error response. title: type: string description: A short, human-readable summary of the error. detail: type: string description: A human-readable explanation of the error. code: type: string description: 'An system-readable error code to provide additional specificity for the error. ' required: - status delete: tags: - Workflow Assignments operationId: DeleteWorkflowAssignmentV3 summary: Delete an Workflow Assignment security: - oauth2: - offline_access - api_key: [] parameters: - name: workflow_assignment_id in: path required: true description: The ID of the workflow assignment schema: type: string format: uuid responses: '204': description: Workflow Assignment successfully deleted '400': description: Bad request content: application/json: schema: type: object required: - errors properties: errors: type: array items: type: object properties: status: type: string description: The http status code of the error response. title: type: string description: A short, human-readable summary of the error. detail: type: string description: A human-readable explanation of the error. code: type: string description: 'An system-readable error code to provide additional specificity for the error. ' required: - status '401': description: Unauthorized content: application/json: schema: type: object required: - errors properties: errors: type: array items: type: object properties: status: type: string description: The http status code of the error response. title: type: string description: A short, human-readable summary of the error. detail: type: string description: A human-readable explanation of the error. code: type: string description: 'An system-readable error code to provide additional specificity for the error. ' required: - status '404': description: Not found content: application/json: schema: type: object required: - errors properties: errors: type: array items: type: object properties: status: type: string description: The http status code of the error response. title: type: string description: A short, human-readable summary of the error. detail: type: string description: A human-readable explanation of the error. code: type: string description: 'An system-readable error code to provide additional specificity for the error. ' required: - status /v3/workflow_assignments: get: tags: - Workflow Assignments operationId: ReadAssignmentsV3 summary: Get a collection of workflow_assignments description: 'Get workflow_assignments to which the authenticated user has access. These are not necessarily workflow_assignments assigned to the requesting user; if you wish to get workflow_assignments that are assigned to the user making the API request, pass the `assigned_user_id` filter set to the current user''s ID. ' security: - oauth2: - offline_access - api_key: [] parameters: - name: filter in: query description: Filter the resulting workflow assignments. required: false schema: type: object properties: activated_at: allOf: - type: object properties: eq: type: string description: 'Equal to filter. If no other filter is specified, `eq` will be assumed. ' gt: type: string description: Greater than filter gteq: type: string description: Greater than or equal to filter lt: type: string description: Less than filter lteq: type: string description: Less than or equal to filter - format: date-time - description: 'Filter workflow assignments by when the stage transitioned to an "active" status. Uses syntax `filter[activated_at][gt]=2020-01-01T00:00:00-07:00`. You can filter to a particular day by omitting the `gt`/`lt`/etc.: `filter[activated_at]=2020-01-01`. ' assigned_user_id: type: array items: type: string format: uuid description: The ID(s) of the users to which workflow assignments are given. assignment_type: type: array items: type: string enum: - approval - task - circuit_breaker - none description: The types of workflow assignments to retrieve. workspace_id: type: array description: 'The IDs of the workspaces to which results should be filtered. Comma separated list of IDs. If included, will only fetch resources associated with these workspaces. If not included, will return resources associated with all workspaces that the user belongs to. For example, `filter[workspace_id]=798ac6d9-b3fc-4155-88ee-237f43f3404b` will fetch all resources associated with workspace `798ac6d9-b3fc-4155-88ee-237f43f3404b`, while `filter[workspace_id]=798ac6d9-b3fc-4155-88ee-237f43f3404b,d79e513e-9246-454e-80bf-8268bc39cd6e,f2b19a4a-ba0c-49be-8aa7-a1bf68a4a4ed` will fetch any resources associated with workspaces `798ac6d9-b3fc-4155-88ee-237f43f3404b`, `d79e513e-9246-454e-80bf-8268bc39cd6e`, or `f2b19a4a-ba0c-49be-8aa7-a1bf68a4a4ed`. ' items: type: string format: uuid created_at: allOf: - type: object properties: eq: type: string description: 'Equal to filter. If no other filter is specified, `eq` will be assumed. ' gt: type: string description: Greater than filter gteq: type: string description: Greater than or equal to filter lt: type: string description: Less than filter lteq: type: string description: Less than or equal to filter - format: date-time - description: 'Filter workflow assignments by when they were created. Uses syntax `filter[created_at][gt]=2020-01-01T00:00:00-07:00`. You can filter to a particular day by omitting the `gt`/`lt`/etc.: `filter[created_at]=2020-01-01`. ' created_by_user_id: type: array items: type: string format: uuid description: The ID(s) of the users that created the workflow assignment. due_date: allOf: - type: object properties: eq: type: string description: 'Equal to filter. If no other filter is specified, `eq` will be assumed. ' gt: type: string description: Greater than filter gteq: type: string description: Greater than or equal to filter lt: type: string description: Less than filter lteq: type: string description: Less than or equal to filter - format: date-time - description: 'Filter workflow assignments by when they are due. Uses syntax `filter[due_date][gt]=2020-01-01T00:00:00-07:00` You can filter to a particular day by omitting the `gt`/`lt`/etc.: `filter[due_date]=2020-01-01`. You can filter to only workflow assignments without a set due date by ommiting the `gt`/`lt`/etc. and filtering for null: `filter[due_date]=null`. Workflow Assignment due date is based on the stage containing the workflow assignment. See Stage resource metadata. ' status: type: array items: type: string enum: - complete - incomplete description: 'The status of the workflow assignment. This is dictated by the responses (if any) to this workflow assignment. Note that an incomplete workflow assignment _can_ exist within a completed stage if the criteria for completing the stage was met without all workflow assignments in the stage having been completed. ' stage_status: type: array items: type: string enum: - inactive - active - complete description: 'The status of the stage containing this workflow assignment. Note that an incomplete workflow assignment _can_ exist within a completed stage if the criteria for completing the stage was met without all workflow assignments in the stage having been completed. ' style: deepObject explode: true - name: include in: query required: false description: 'A comma separated value of related resource objects on the workflow assignment to include. Note that user resources are not available as includes on this endpoint; the client must make subsequent API requests `api/v1/users` to request additional information on related users. ' schema: type: array items: type: string enum: - stage - stage.workflow - stage.workflow.context - responses style: form explode: false - name: sort in: query required: false description: 'A comma separated value specifying how a collection in the response body should be sorted, where each value is an attribute of the workflow assignment. If no sort order is provided, resources will be default sorted by created_at, ascending. When specifying multiple values, each value in the sequence determines the ordering precedence. Lastly, each workflow assignment in the collection will appear in ascending order, unless any of the enumerated values are prefixed with a minus "-" sign, in which case each workflow assignment will appear in descending order for the specified values. Workflow Assignment due date is based on the stage containing the workflow assignment. See Stage resource metadata. ' schema: type: string enum: - activated_at - assigned_user_id - created_at - created_by_user_id - due_date - position - updated_at - name: page description: Specify an offset and limit for pagination in: query required: false schema: type: object properties: limit: type: integer default: 50 offset: type: integer style: deepObject explode: true responses: '200': description: An array of workflow_assignments. content: application/json: schema: type: object required: - data - meta properties: data: type: array items: title: workflow_assignment type: object required: - id - type - attributes - relationships additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - workflow_assignment relationships: type: object required: - created_by_user - assigned_user - stage - responses additionalProperties: false properties: created_by_user: title: User type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - user assigned_user: title: User type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - user stage: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - workflow_stage responses: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - workflow_response attributes: type: object required: - assignment_type - created_at - metadata - position - updated_at additionalProperties: false properties: assignment_type: type: string enum: - approval - task - circuit_breaker created_at: type: string format: date-time readOnly: true metadata: type: - object - 'null' anyOf: - type: - object - 'null' title: Approval Workflow Assignment Metadata additionalProperties: false properties: title: type: string description: The title of the workflow_assignment. Will default to "Approval". - type: object title: Task/Circuit Breaker Workflow Assignment Metadata additionalProperties: false properties: title: type: string description: The title of the workflow_assignment. Will default to "Task" or "Pause". is_starred: type: boolean position: type: integer description: 'The sequential position (starting at 1) of the workflow_assignment within its workflow_stage. ' readOnly: true updated_at: type: string format: date-time readOnly: true included: type: array items: oneOf: - title: workflow_response type: object required: - id - type - attributes - relationships additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - workflow_response attributes: type: object additionalProperties: false required: - created_at - details - updated_at properties: created_at: type: string format: date-time description: An ISO8601 date-time. readOnly: true details: type: - object - 'null' oneOf: - type: - object - 'null' title: Approval Workflow Response Details additionalProperties: false required: - approved properties: approved: type: string enum: - approved - declined reasoning: type: - string - 'null' - type: object title: Task/Circuit Breaker Workflow Response Details additionalProperties: false required: - complete properties: complete: type: boolean - type: object title: Rewind Workflow Response Details additionalProperties: false required: - rewind properties: rewind: type: boolean updated_at: type: string format: date-time description: An ISO8601 date-time. readOnly: true relationships: type: object required: - assignment - created_by_user additionalProperties: false properties: assignment: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - workflow_assignment created_by_user: title: User type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - user - title: workflow_stage type: object required: - id - type - attributes - relationships additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - workflow_stage attributes: type: object required: - activated_at - created_at - due_date - metadata - position - stage_type - status - updated_at additionalProperties: false properties: activated_at: type: - string - 'null' format: date-time readOnly: true description: 'An ISO8601 date-time set to the time when this workflow_stage gained the `status` "active". Naturally, this field is `null` prior to the workflow_stage becoming active. It is also `null` _after_ a rollback if the rollback targets a workflow_stage earlier than the one currently active. ' created_at: type: string format: date-time readOnly: true description: An ISO8601 date-time. due_date: type: - string - 'null' format: date-time description: An ISO8601 date-time. metadata: type: - object - 'null' oneOf: - type: - object - 'null' title: Approval Workflow Stage Metadata additionalProperties: false required: - completion_rules properties: title: type: string description: The title of the workflow_stage. Will default to "Approval Phase" completion_rules: type: string enum: - all - one - type: object title: Task/Circuit Breaker Workflow Stage Metadata additionalProperties: false properties: title: type: string description: The title of the workflow_stage. Will default to "Task Phase" or "Pause" position: type: integer stage_type: type: string enum: - approval - task - circuit_breaker status: type: string enum: - active - complete - inactive updated_at: type: string format: date-time description: An ISO8601 date-time. relationships: type: object additionalProperties: false required: - assignments - workflow properties: assignments: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - workflow_assignment workflow: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - workflow - title: workflow type: object required: - id - attributes - relationships additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - workflow meta: type: object description: 'Optionally calculated workflow status metadata. **Not part of responses by default.** This is currently only available when requesting workflow resources from the `/workflows/v2/workflows` and `/workflows/v2/workflows/{id}` `GET` endpoints. You request that this metadata be included in responses with the `expose` query parameter like: `/workflows/v2/workflows?expose[workflow][meta]`. The "latest active stage" is either the stage that is currently active or it is the last stage of a completed workflow. ' required: - latest_active_stage - completed_stages - stage_type_count additionalProperties: false properties: latest_active_stage: oneOf: - title: Stage Status Metadata allOf: - required: - stage_type - resource_identifier properties: stage_type: type: string enum: - approval - task - circuit_breaker title: type: - string - 'null' description: The title of the stage. due_date: type: - string - 'null' format: date-time description: The due date of the stage if set. resource_identifier: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - workflow_stage - type: object description: The status metadata of a workflow_stage. required: - assignment_counts properties: assignment_counts: type: object description: 'Assignment counts broken down in three ways. First, the number of complete/incomplete assignments for all users (both approvals and tasks). Second, the number of complete/incomplete assignments for the current user (both approvals and tasks). Third, the number of declined approvals. In the first two cases, both approvals and tasks can be complete or incomplete where both approved and declined responses on an approval assignment count as completion. ' required: - all - current_user - declined additionalProperties: false properties: all: type: object required: - incomplete - complete additionalProperties: false properties: incomplete: type: integer minimum: 0 complete: type: integer minimum: 0 current_user: type: object required: - incomplete - complete additionalProperties: false properties: incomplete: type: integer minimum: 0 complete: type: integer minimum: 0 declined: type: integer minimum: 0 - title: 'null' type: - object - 'null' enum: - null completed_stages: type: integer minimum: 0 stage_type_count: type: object required: - approval - task - circuit_breaker additionalProperties: false properties: approval: type: integer minimum: 0 task: type: integer minimum: 0 circuit_breaker: type: integer minimum: 0 attributes: type: object required: - created_at - status - is_approved - updated_at additionalProperties: false properties: created_at: type: string format: date-time description: An ISO8601 date-time indicating when the workflow was created. readOnly: true status: type: string description: A string indicating the current status of the workflow. enum: - active - complete - inactive - paused readOnly: true is_approved: type: boolean description: 'Indicative of whether the latest approval workflow_stage has been completed. Workflows with only task workflow_stages will never result in `is_approved=true`. ' readOnly: true updated_at: type: string format: date-time description: 'An ISO8601 date-time indicating when the workflow was last updated. ' readOnly: true relationships: type: object additionalProperties: false required: - context - created_by_user - stages properties: context: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - workflow_context created_by_user: title: User type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - user stages: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - workflow_stage - title: workflow_context type: object additionalProperties: false required: - id - type - attributes - relationships properties: id: type: string format: uuid type: type: string enum: - workflow_context attributes: type: object additionalProperties: false required: - created_at - updated_at properties: created_at: type: string format: date-time description: An ISO8601 date-time. readOnly: true updated_at: type: string format: date-time description: An ISO8601 date-time. readOnly: true relationships: type: object additionalProperties: false required: - block - created_by_user - moment - workflow properties: block: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - block created_by_user: title: User type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - user moment: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - moment workflow: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - workflow meta: allOf: - type: object required: - total - page - resource_type properties: resource_type: type: string total: type: integer page: type: object required: - limit - offset properties: limit: type: integer offset: type: integer - type: object required: - filtered_out_by_due_date properties: filtered_out_by_due_date: description: 'The number of workflow_assignments that were filtered out of the responses due to the `due_date` filter. Note that this number applies across all pages. ' type: integer minimum: 0 example: data: - id: 4ac02fc7-705c-467e-933e-8bf16fc3ebf1 type: workflow_assignment attributes: created_at: '2020-09-11T15:27:01.881-08:00' updated_at: '2020-09-11T15:27:01.881-08:00' assignment_type: observer metadata: null position: 1 relationships: created_by_user: data: id: ada0d59f-9f8c-4df3-ae9c-d6997ab48645 type: user stage: data: id: 186ad497-b8a7-43d6-bd95-cde8f9a02cdc type: workflow_stage assigned_user: data: id: ada0d59f-9f8c-4df3-ae9c-d6997ab48645 type: user responses: data: - id: 5d806729-5a08-4e31-8b8e-17bea992ec69 type: workflow_response '400': description: Bad request content: application/json: schema: type: object required: - errors properties: errors: type: array items: type: object properties: status: type: string description: The http status code of the error response. title: type: string description: A short, human-readable summary of the error. detail: type: string description: A human-readable explanation of the error. code: type: string description: 'An system-readable error code to provide additional specificity for the error. ' required: - status '401': description: Unauthorized content: application/json: schema: type: object required: - errors properties: errors: type: array items: type: object properties: status: type: string description: The http status code of the error response. title: type: string description: A short, human-readable summary of the error. detail: type: string description: A human-readable explanation of the error. code: type: string description: 'An system-readable error code to provide additional specificity for the error. ' required: - status '404': description: Not found content: application/json: schema: type: object required: - errors properties: errors: type: array items: type: object properties: status: type: string description: The http status code of the error response. title: type: string description: A short, human-readable summary of the error. detail: type: string description: A human-readable explanation of the error. code: type: string description: 'An system-readable error code to provide additional specificity for the error. ' required: - status post: tags: - Workflow Assignments operationId: CreateWorkflowAssignmentV3 summary: Create an workflow_assignment security: - oauth2: - offline_access - api_key: [] requestBody: content: application/json: schema: type: object required: - data properties: data: type: object required: - type - attributes - relationships properties: type: type: string enum: - workflow_assignment attributes: type: object required: - assignment_type properties: metadata: type: - object - 'null' properties: title: type: string assignment_type: type: string enum: - approval - task - circuit_breaker relationships: type: object required: - stage - assigned_user properties: stage: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - workflow_stage assigned_user: title: User type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - user example: data: type: workflow_assignment attributes: assignment_type: approval metadata: title: Do the thing plz relationships: assigned_user: data: id: ada0d59f-9f8c-4df3-ae9c-d6997ab48645 type: user stage: data: id: 186ad497-b8a7-43d6-bd95-cde8f9a02cdc type: workflow_stage responses: '201': description: Workflow Assignment created content: application/json: schema: type: object required: - data properties: data: title: workflow_assignment type: object required: - id - type - attributes - relationships additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - workflow_assignment relationships: type: object required: - created_by_user - assigned_user - stage - responses additionalProperties: false properties: created_by_user: title: User type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - user assigned_user: title: User type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - user stage: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - workflow_stage responses: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - workflow_response attributes: type: object required: - assignment_type - created_at - metadata - position - updated_at additionalProperties: false properties: assignment_type: type: string enum: - approval - task - circuit_breaker created_at: type: string format: date-time readOnly: true metadata: type: - object - 'null' anyOf: - type: - object - 'null' title: Approval Workflow Assignment Metadata additionalProperties: false properties: title: type: string description: The title of the workflow_assignment. Will default to "Approval". - type: object title: Task/Circuit Breaker Workflow Assignment Metadata additionalProperties: false properties: title: type: string description: The title of the workflow_assignment. Will default to "Task" or "Pause". is_starred: type: boolean position: type: integer description: 'The sequential position (starting at 1) of the workflow_assignment within its workflow_stage. ' readOnly: true updated_at: type: string format: date-time readOnly: true included: type: array items: oneOf: - title: workflow_response type: object required: - id - type - attributes - relationships additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - workflow_response attributes: type: object additionalProperties: false required: - created_at - details - updated_at properties: created_at: type: string format: date-time description: An ISO8601 date-time. readOnly: true details: type: - object - 'null' oneOf: - type: - object - 'null' title: Approval Workflow Response Details additionalProperties: false required: - approved properties: approved: type: string enum: - approved - declined reasoning: type: - string - 'null' - type: object title: Task/Circuit Breaker Workflow Response Details additionalProperties: false required: - complete properties: complete: type: boolean - type: object title: Rewind Workflow Response Details additionalProperties: false required: - rewind properties: rewind: type: boolean updated_at: type: string format: date-time description: An ISO8601 date-time. readOnly: true relationships: type: object required: - assignment - created_by_user additionalProperties: false properties: assignment: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - workflow_assignment created_by_user: title: User type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - user - title: workflow_stage type: object required: - id - type - attributes - relationships additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - workflow_stage attributes: type: object required: - activated_at - created_at - due_date - metadata - position - stage_type - status - updated_at additionalProperties: false properties: activated_at: type: - string - 'null' format: date-time readOnly: true description: 'An ISO8601 date-time set to the time when this workflow_stage gained the `status` "active". Naturally, this field is `null` prior to the workflow_stage becoming active. It is also `null` _after_ a rollback if the rollback targets a workflow_stage earlier than the one currently active. ' created_at: type: string format: date-time readOnly: true description: An ISO8601 date-time. due_date: type: - string - 'null' format: date-time description: An ISO8601 date-time. metadata: type: - object - 'null' oneOf: - type: - object - 'null' title: Approval Workflow Stage Metadata additionalProperties: false required: - completion_rules properties: title: type: string description: The title of the workflow_stage. Will default to "Approval Phase" completion_rules: type: string enum: - all - one - type: object title: Task/Circuit Breaker Workflow Stage Metadata additionalProperties: false properties: title: type: string description: The title of the workflow_stage. Will default to "Task Phase" or "Pause" position: type: integer stage_type: type: string enum: - approval - task - circuit_breaker status: type: string enum: - active - complete - inactive updated_at: type: string format: date-time description: An ISO8601 date-time. relationships: type: object additionalProperties: false required: - assignments - workflow properties: assignments: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - workflow_assignment workflow: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - workflow - title: workflow type: object required: - id - attributes - relationships additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - workflow meta: type: object description: 'Optionally calculated workflow status metadata. **Not part of responses by default.** This is currently only available when requesting workflow resources from the `/workflows/v2/workflows` and `/workflows/v2/workflows/{id}` `GET` endpoints. You request that this metadata be included in responses with the `expose` query parameter like: `/workflows/v2/workflows?expose[workflow][meta]`. The "latest active stage" is either the stage that is currently active or it is the last stage of a completed workflow. ' required: - latest_active_stage - completed_stages - stage_type_count additionalProperties: false properties: latest_active_stage: oneOf: - title: Stage Status Metadata allOf: - required: - stage_type - resource_identifier properties: stage_type: type: string enum: - approval - task - circuit_breaker title: type: - string - 'null' description: The title of the stage. due_date: type: - string - 'null' format: date-time description: The due date of the stage if set. resource_identifier: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - workflow_stage - type: object description: The status metadata of a workflow_stage. required: - assignment_counts properties: assignment_counts: type: object description: 'Assignment counts broken down in three ways. First, the number of complete/incomplete assignments for all users (both approvals and tasks). Second, the number of complete/incomplete assignments for the current user (both approvals and tasks). Third, the number of declined approvals. In the first two cases, both approvals and tasks can be complete or incomplete where both approved and declined responses on an approval assignment count as completion. ' required: - all - current_user - declined additionalProperties: false properties: all: type: object required: - incomplete - complete additionalProperties: false properties: incomplete: type: integer minimum: 0 complete: type: integer minimum: 0 current_user: type: object required: - incomplete - complete additionalProperties: false properties: incomplete: type: integer minimum: 0 complete: type: integer minimum: 0 declined: type: integer minimum: 0 - title: 'null' type: - object - 'null' enum: - null completed_stages: type: integer minimum: 0 stage_type_count: type: object required: - approval - task - circuit_breaker additionalProperties: false properties: approval: type: integer minimum: 0 task: type: integer minimum: 0 circuit_breaker: type: integer minimum: 0 attributes: type: object required: - created_at - status - is_approved - updated_at additionalProperties: false properties: created_at: type: string format: date-time description: An ISO8601 date-time indicating when the workflow was created. readOnly: true status: type: string description: A string indicating the current status of the workflow. enum: - active - complete - inactive - paused readOnly: true is_approved: type: boolean description: 'Indicative of whether the latest approval workflow_stage has been completed. Workflows with only task workflow_stages will never result in `is_approved=true`. ' readOnly: true updated_at: type: string format: date-time description: 'An ISO8601 date-time indicating when the workflow was last updated. ' readOnly: true relationships: type: object additionalProperties: false required: - context - created_by_user - stages properties: context: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - workflow_context created_by_user: title: User type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - user stages: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - workflow_stage - title: workflow_context type: object additionalProperties: false required: - id - type - attributes - relationships properties: id: type: string format: uuid type: type: string enum: - workflow_context attributes: type: object additionalProperties: false required: - created_at - updated_at properties: created_at: type: string format: date-time description: An ISO8601 date-time. readOnly: true updated_at: type: string format: date-time description: An ISO8601 date-time. readOnly: true relationships: type: object additionalProperties: false required: - block - created_by_user - moment - workflow properties: block: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - block created_by_user: title: User type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - user moment: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - moment workflow: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - workflow examples: approval: value: data: id: 4ac02fc7-705c-467e-933e-8bf16fc3ebf1 type: workflow_assignment attributes: created_at: '2020-09-11T15:27:01.881-08:00' updated_at: '2020-09-11T15:27:01.881-08:00' assignment_type: approval position: 1 metadata: title: Approval relationships: created_by_user: data: id: ada0d59f-9f8c-4df3-ae9c-d6997ab48645 type: user stage: data: id: 186ad497-b8a7-43d6-bd95-cde8f9a02cdc type: workflow_stage assigned_user: data: id: ada0d59f-9f8c-4df3-ae9c-d6997ab48645 type: user responses: data: - id: 5d806729-5a08-4e31-8b8e-17bea992ec69 type: workflow_response task: value: data: id: 4ac02fc7-705c-467e-933e-8bf16fc3ebf1 type: workflow_assignment attributes: created_at: '2020-09-11T15:27:01.881-08:00' updated_at: '2020-09-11T15:27:01.881-08:00' assignment_type: task position: 1 metadata: title: Task is_starred: false relationships: created_by_user: data: id: ada0d59f-9f8c-4df3-ae9c-d6997ab48645 type: user stage: data: id: 186ad497-b8a7-43d6-bd95-cde8f9a02cdc type: workflow_stage assigned_user: data: id: ada0d59f-9f8c-4df3-ae9c-d6997ab48645 type: user responses: data: - id: 5d806729-5a08-4e31-8b8e-17bea992ec69 type: workflow_response circuit_breaker: value: data: id: 4ac02fc7-705c-467e-933e-8bf16fc3ebf1 type: workflow_assignment attributes: created_at: '2020-09-11T15:27:01.881-08:00' updated_at: '2020-09-11T15:27:01.881-08:00' assignment_type: circuit_breaker position: 1 metadata: title: Pause relationships: created_by_user: data: id: ada0d59f-9f8c-4df3-ae9c-d6997ab48645 type: user stage: data: id: 186ad497-b8a7-43d6-bd95-cde8f9a02cdc type: workflow_stage assigned_user: data: id: ada0d59f-9f8c-4df3-ae9c-d6997ab48645 type: user responses: data: - id: 5d806729-5a08-4e31-8b8e-17bea992ec69 type: workflow_response '400': description: Bad request content: application/json: schema: type: object required: - errors properties: errors: type: array items: type: object properties: status: type: string description: The http status code of the error response. title: type: string description: A short, human-readable summary of the error. detail: type: string description: A human-readable explanation of the error. code: type: string description: 'An system-readable error code to provide additional specificity for the error. ' required: - status '401': description: Unauthorized content: application/json: schema: type: object required: - errors properties: errors: type: array items: type: object properties: status: type: string description: The http status code of the error response. title: type: string description: A short, human-readable summary of the error. detail: type: string description: A human-readable explanation of the error. code: type: string description: 'An system-readable error code to provide additional specificity for the error. ' required: - status '404': description: Not found content: application/json: schema: type: object required: - errors properties: errors: type: array items: type: object properties: status: type: string description: The http status code of the error response. title: type: string description: A short, human-readable summary of the error. detail: type: string description: A human-readable explanation of the error. code: type: string description: 'An system-readable error code to provide additional specificity for the error. ' required: - status components: securitySchemes: oauth2: type: oauth2 description: 'This API uses OAuth 2.0 with the authorization code grant flow. You can find more detailed authentication instructions in the [Authentication Strategies](/api/documentation#section/Authentication-Strategies/OAuth-2.0) section. ' flows: authorizationCode: authorizationUrl: /oauth2/auth tokenUrl: /oauth2/token scopes: offline_access: Include this scope if you wish to receive a refresh token anonymous_oauth: type: oauth2 description: 'The OAuth 2.0 client credentials flow is used for secure server-server requests when Opal does not need to associate a request with a particular Opal user. These anonymous requests are instead authorized based on the OAuth scope. ' flows: clientCredentials: tokenUrl: /oauth/token scopes: write:onboarding: Include this scope if you wish to make API requests to onboard new Opals. api_key: type: apiKey description: '(Deprecated) This API also supports authentication via an API or session token set in the request headers. ' in: header name: Session-Token presentation_share_cookie: type: apiKey description: 'A cookie set and read by the Monolith service that authorizes a non-opal user to view a presentation and the resources within it. Other services can rely on this cookie by asking Monolith to authenticate it. ' in: cookie name: share_token x-tagGroups: - name: Stable tags: - Board Collaborators - Board Objects - Boards - Content Schedules - Moment Schedules - Moments - Onboarding - name: ⚠️ Unstable tags: - Block Connectors - Board Columns - Board Duplication - Board Standard Columns - Channels - Custom Field Options - Custom Field Types - Custom Fields - Moment Assignees - Moment Custom Fields - Planning Status - Rich Text Documents - User Groups - Users - Workspaces - name: ℹ️ Proposed tags: - Bulk Operations - Gem Chats - Gem Files - Moment Duplication - Presentation Themes - Workflows - Workflow Contexts - Workflow Stages - Workflow Assignments - Workflow Responses - name: ⚛️ Experimental tags: - Blocks - Block Custom Field Values - Block Duplication - Board User Settings - Categories - Category Types - Charts - Content - Custom Field Colors - Filter Sets - Key Dates - View Columns - View Standard Columns - Views - View Colors - Stories - name: Additional Resources tags: - secondary_resources