Create a request

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

Creates a request from the invoking user as the change suggester on the catalog object.

Recipes

🦉

Create Workflow Requests in Bulk

Open Recipe

🚧
Type must be lowercase
When making a CREATE request using this API, the type property must be in lowercase.

Responses

Response body

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

state_info

string

An optional state information string of Workflow execution.

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.

context

input

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

object

Workflow resource.

integer

ID of Workflow.

title

string

required

Unique title of Workflow.

type

string

required

Workflow type.

change_request add_request

state

string

Workflow state.

PUBLISHED UNPUBLISHED CLEANING DELETED ERROR

state_info

string

An optional state information string of Workflow.

status

string

A human-understandable Workflow state.

PUBLISHED UNPUBLISHED WORKING DELETED FAILED

rule

required

steps

array of objects

required

Review steps of Workflow.

steps*

object

number

ID of Workflow step.

settings

object

required

Step settings

reviewers

array of objects

required

length ≥ 1

Collection of Workflow step reviewers.

reviewers*

object

rtype_name

string

required

Type of reviewer.

user groupprofile people_set

rid

number

required

ID of reviewer.

ordinal

number

required

≥ 1

Ordinal value of step.

next_step

number | null

ID of subsequent step to start with of the Workflow.

start_step

number

ID of step to start with for the workflow.

is_reviewer

boolean

If the invoking user is a reviewer, in any step, of Workflow.

can_bypass

boolean

If the invoking user can bypass the review flow of Workflow.

creator_id

number

ID of user who created the Workflow.

last_updator_id

number

ID of user who last modified the Workflow.

ts_created

date-time

Timestamp when the Workflow was created.

ts_updated

date-time

Timestamp when the Workflow was last updated.

step_executions

array of objects

Step executions of 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_id

integer

ID of Workflow step.

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.

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 POST \
2
     --url https://alation_domain/integration/v2/workflow_executions/ \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Choose an example:

application/json

🚧Type must be lowercase

201Successfully created

400Malformed Request

401Unauthorized bad/missing token

403Forbidden User cannot edit this resource

404The specified resource was not found

500Internal Server Error

🚧
Type must be lowercase