List requests

get {protocol}://{base-url}/integration/v2/workflow_executions/

List all requests. By default, this will return workflow execution representation; an optional values parameter can be supplied to return only the specified set of fields of the request.

Query Params

skip

integer

Defaults to 0

Specifies the number of items to be skipped in the response. Used together with Limit parameter to fetch paginated responses. This is automatically set in X-Next-Page response header if present.

limit

integer

≥ 1

Defaults to 100

Specifies the number of items to be fetched in one paginated response. Response may have a X-Next-Page URL parameter in the header to fetch next set of items or page.

type

string

Only Workflow executions with specified type will be returned.

state

json

Only Workflow executions with specified state will be returned.

status

string

Defaults to active

Only Workflow executions with specified status will be returned.

initiated_by

integer

ID of the user who has initiated the workflow execution.

otype

string

Only Workflow executions with specified otype will be returned.

Responses

Response body

array of objects

object

integer

ID of Workflow execution.

type

string

Workflow execution type.

CHANGE_REQUEST CREATE_REQUEST ASSOCIATE_REQUEST

state

string

Workflow execution state.

ENROLLED VERIFYING RUNNING REVIEW_COMPLETED CHANGE_COMMITTED COMMIT_FAILED ASSOCIATED ASSOCIATE_FAILED DELETING DELETED ABANDONED ERROR

status

string

A human-understandable Workflow execution state.

PENDING IN_PROGRESS APPROVED REJECTED DONE ERROR CLOSED

otype

string

Type name of object.

data schema table attribute glossary_term glossary_v3 policy business_policy policy_group

oid

number | null

ID of object.

field_id

number

ID of custom field.

collection_otype

string

Type name of collection object.

policy_group glossary_v3

collection_oid

number | null

ID of object.

step_executions

array of objects

Step executions performed by reviewer(s) or system on this workflow execution

step_executions

object

integer

ID of Workflow step execution.

type

string

Workflow step execution type.

CHANGE_REQUEST_REVIEW ADD_REQUEST_REVIEW

state

string

Workflow step execution state.

INITIATED ANALYZING RUNNING COMPLETED DELETED ERROR

status

string

A human-understandable Workflow step execution state.

PENDING IN_PROGRESS APPROVED REJECTED ERROR CLOSED

workflow_step

object

Workflow review step related information and settings.

workflow_execution

object

Short representation of Workflow execution resource.

workflow_stepexecutionactions

array of objects

Actions performed by reviewer(s) or system on this Workflow step execution.

workflow_stepexecutionactions

object

actor_id

number

ID of user who performed an action as a reveiwer on the Workflow step execution.

actor_type

string

Type of actor who performed an action on the Workflow step execution.

ts_updated

date-time

Timestamp when the action was taken on the Workflow step execution.

type

string

Workflow step execution action type. This represents the action type performed by the reviewer or system on the Workflow step execution.

APPROVE REJECT

comment

string

Comment provided by the reviewer or system along with the action taken on the Workflow step execution.

ts_started_at

date-time

Timestamp when the Workflow step execution was open for review.

ts_finished_at

date-time

Timestamp when the Workflow step execution was done with with review.

ts_created

date-time

Timestamp when the Workflow step execution was created.

ts_updated

date-time

Timestamp when the Workflow step execution was last updated.

url

string

URL of the Workflow step execution.

initiated_by

number

ID of user who initiated the request or suggestion, also known as Workflow execution.

root_execution_id

number

ID of parent Workflow execution, if any.

workflow_id

number

ID of Workflow of which this Workflow execution is based on.

ts_created

date-time

Timestamp when the Workflow execution was created.

ts_updated

date-time

Timestamp when the Workflow execution was last updated.

url

string

URL of the Workflow execution.

409

Conflict

410

Gone

422

Unprocessable entity

424

Failed dependency

429

Too many requests

Language

Credentials

Header

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://alation_domain/integration/v2/workflow_executions/?skip=0&limit=100&status=active' \
3
     --header 'accept: application/json'

Choose an example:

application/json

200List Requests

400Malformed Request

401Unauthorized bad/missing token

403Forbidden User cannot edit this resource

404The specified resource was not found

500Internal Server Error