Get list of workflows

post

https://api.seismic.com/workflow/v1/engagements/pendingApprovals

Pull the metadata for a list of engagement approval workflows. The request body lets the caller choose which fields to return, filter the list with conditions, search by keyword, sort the results, page through them with offset and limit, and scope the list to workflows where the calling user is the submitter or a reviewer. For example, a reviewer can list every engagement workflow that is currently waiting on their approval.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Query criteria that control which pending approval workflows are returned, in what order, and which page of results.

fields

string

An array of different field names in EngagementId,EngagementTitle,EngagementType,inside_contents,WorkflowId,WorkflowStatus,WorkflowName,ActiveStepOrder,MaxStepOrder,Submitter,WorkflowStepId,SubmitToActiveStep,SubmitToWorkflow,Reviewers,SelectedReviewers,ClaimedUser. By default it is null to return all field values.

sorts

array of objects

An array of key + sortOrder pairs. By default the result is sorted by SubmitToActiveStep DESC.

sorts

pagination

object

Offset and limit that select which page of matching workflows is returned in the response.

conditions

array of objects

An array of filters, each made of a key, an operator and a value, applied together to narrow the list.

conditions

string

Keyword to be searched in EngagementType,EngagementTitle,WorkflowStatus,WorkflowName,Submitter,Reviewers,ClaimedUser. Matching is applied in addition to any conditions supplied.

role

string

enum

Scopes the list to workflows the calling user submitted (Submitter) or workflows the calling user must review (Reviewer).

Allowed:

Headers

string

enum

Defaults to application/json; charset=utf-8

Generated from available response content types

Allowed:

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json; charset=utf-8

application/json

200OK

400Bad Request. The request body or path values are invalid, or the referenced engagement, workflow or step cannot be found.

401Unauthorized. The Authorization header is missing, or the JWT bearer token is invalid or expired.

403Forbidden. The token is valid but does not grant the scopes required by this operation, or the user is not permitted to act on the resource.

429Too Many Requests. The per-client rate limit has been exceeded; wait before retrying the request.