Create a workflow session​
Create a workflow session
Query Parameters
- run boolean
Will run the created/updated workflow session if successful
Example: true
- application/json
Request Body required
workflow_session object
workflow_id uuidThe workflow id
requester_id uuidThe requester id
requester_type stringPossible values: [
User
,NeprofileUser
,NeaccessUser
]The requester type
profile_id uuidThe profile this workflow session will be working with. Only Applicable for Update workflows
profile_ids uuid[]The profiles this workflow session will be working with. Only Applicable for Batch workflows
attributes object
The attributes
property name*
string
- 200
- 400
- 500
Expected response to a valid request
- application/json
- Schema
- Example (from schema)
Schema
workflow_session object
id uuidThe id
uid stringPossible values:
>= 32 characters
and<= 32 characters
The uid
workflow_id uuidThe workflow id
requester_id uuidthe requester id
requester_type stringPossible values: [
User
,NeprofileUser
,NeaccessUser
]The requester type
profile_id uuidThe profile this workflow session will be working with. Only Applicable for Update workflows
profile_ids uuid[]The profiles this workflow session will be working with. Only Applicable for Batch workflows
status stringPossible values: [
api_request_sent
,approved
,assigned
,attempting_to_start_workflow
,AUTH-STATUS1
,AUTH-STATUS2
,AUTH-STATUS3
,AUTH-STATUS4
,AUTH-STATUS5
,AUTH-STATUS6
,AUTH-STATUS7
,AUTH-STATUS8
,AUTH-STATUS9
,auto_assigned
,batch_completed
,checking_for_duplicates
,closed
,completed
,courion_add
,courion_extend
,courion_terminate
,courion_update
,duplicates_resolved
,failed
,fulfilled
,invitation_sent
,ldap_provided
,new
,non_employee_created
,non_employee_updated
,notified
,pending_approval
,pending_assignment
,pending_courion_add
,pending_courion_extend
,pending_courion_terminate
,pending_courion_update
,pending_creation
,pending_fulfillment
,pending_ldap
,pending_notification
,pending_profile_select
,pending_request
,pending_review
,pending_status_change
,pending_stored_procedure
,pending_trigger
,pending_update
,processing
,profile_check_complete
,profiles_selected
,rejected
,requested
,reviewed
,soap_request_sent
,started_workflow
,status_changed
,stored_procedure
,un_assigned
,waiting_on_workflow
,workflow_changed
]The status
attributes object
The attributes
property name*
string
{
"workflow_session": {
"id": "db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e",
"uid": "db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e",
"workflow_id": "db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e",
"requester_id": "db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e",
"requester_type": "User",
"profile_id": "db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e",
"profile_ids": [
"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e",
"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9t"
],
"status": "completed",
"attributes": {
"text_attribute_uid": "static text",
"date_attribute_uid": "01/15/2020",
"profile_select_attribute_uid": "Profile Name",
"multiple_profile_select_attribute_uid": "Profile Name,Second Profile Name,Third Profile Name",
"contributor_select_attribute_uid": "User Name",
"multiple_contributor_select_attribute_uid": "User Name,Second User Name,Third User Name"
}
}
}
Bad Request - unable to complete.
- application/json
- Schema
- Example (from schema)
Schema
- MOD1
- MOD2
- error
- error
- errors
{
"error": "Invalid JSON syntax. Please check your syntax and try again."
}
Internal Server Error - returned on unhandled exceptions.
- application/json
- Schema
- Example (from schema)
Schema
- error
A message describing the error
{
"error": "Sorry something went wrong"
}