Create a workflow session
POST/workflow_sessions
Create a workflow session
Request
Query Parameters
Will run the created/updated workflow session if successful
- application/json
Body
required
workflow_session object
Possible values: [User
, NeprofileUser
, NeaccessUser
]
The profile this workflow session will be working with. Only Applicable for Update workflows
The profiles this workflow session will be working with. Only Applicable for Batch workflows
attributes object
Responses
- 200
- 400
- 500
Expected response to a valid request
- application/json
- Schema
- Example (from schema)
Schema
workflow_session object
Possible values: >= 32 characters
and <= 32 characters
Possible values: [User
, NeprofileUser
, NeaccessUser
]
The profile this workflow session will be working with. Only Applicable for Update workflows
The profiles this workflow session will be working with. Only Applicable for Batch workflows
Possible 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
]
attributes object
{
"workflow_session": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"uid": "string",
"workflow_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"requester_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"requester_type": "User",
"profile_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"profile_ids": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"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
- InvalidJson
- ValidationErrors
{}
Internal Server Error - returned on unhandled exceptions.
- application/json
- Schema
- Example (from schema)
Schema
A message describing the error
{
"error": "Sorry something went wrong"
}