Operate workflow step

put

https://api.seismic.com/workflow/v1/engagements/{engagementId}/workflows/{workflowId}/steps/{stepId}/operations/{operation}

Operate an engagement workflow step, supporting operations are Approve/Reject/Revoke/Claim/Unclaim. Reviewers approve or reject the active step with comments, can claim a step so other reviewers know they are handling it, and can unclaim it again; revoke reverses an earlier decision. When approving, the caller can choose the approver of the next step through selectedApprover.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

engagementId

string

required

Engagement Id (Required). Unique identifier of the engagement that owns the workflow step being operated on.

workflowId

string

required

Workflow Id (Required). Unique identifier of the running workflow that contains the step, as returned by the get workflow details operation.

stepId

string

required

Step Id (Required). Unique identifier of the workflow step to act on, matching the step id or workflowStepId returned by the read operations.

operation

string

required

approve|reject|revoke|claim|unclaim (Required). The reviewer action to perform on the workflow step.

Query Params

isForce

string

Defaults to true|false

For Approve and Reject operation, set to true to ignore the claim on the workflow step. Accepts the text values true or false.

Body Params

Reviewer comments and the optional selected approver for the next step. Send an empty object for claim, unclaim and revoke when no comments are needed.

comments

string

Required for approve|reject operations. Plain-text reviewer comments explaining the decision, shown to the submitter and other reviewers.

richComments

string

Required for approve|reject operations. it supports rich text in html code, rendered in place of the plain-text comments.

selectedApprover

object

Headers

string

enum

Defaults to application/json; charset=utf-8

Generated from available response content types

Allowed:

Responses

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

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