Get workflow sessions​
Get workflow sessions
Query Parameters
Allows for pagination and sorting.
Profile ID to filter by
Possible values: >= 32 characters
and <= 32 characters
Workflow session uid for filtering
Workflow ID for filtering
Requester ID for filtering
Possible values: [waiting on workflow
, identity proofing completed
, new
, closing
, pending request
, requested
, pending approval
, approved
, pending notification
, notified
, pending review
, reviewed
, pending trigger
, stored procedure
, pending status change
, status changed
, pending update
, non employee updated
, non employee created
, pending creation
, rejected
, pending assignment
, assigned
, default
, failed
, un assigned
, auto assigned
, ldap provided
, pending ldap
, pending fulfillment
, pending stored procedure
, pending courion add
, fulfilled
, pending courion update
, courion add
, pending courion_extend
, courion update
, pending courion terminate
, courion extend
, pending profile select
, courion terminate
, batch completed
, profiles selected
, answered questions
, pending questions
, attempting to start workflow
, started workflow
, profile check complete
, completed
, processing
, pending set attribute
, invitation sent
, action skipped
, api request sent
, attribute set
, disabled
, duplicates resolved
, soap request sent
, checking for duplicates
, pending identity proofing
, closed
, workflow changed
]
filter by workflow session status
Returns batching metadata in the response
- 200
- 400
- 500
Expected response to a valid request
Schema
- Array [
- ]
workflow_sessions 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
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
_metadata object
{
"workflow_sessions": [
{
"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"
}
}
],
"_metadata": {
"limit": 0,
"offset": 0,
"total": 0,
"next": "/endpoint?limit=10&offset=60",
"previous": "/endpoint?limit=10&offset=40"
}
}
Bad Request - unable to complete.
Schema
{}
Internal Server Error - returned on unhandled exceptions.
Schema
A message describing the error
{
"error": "Sorry something went wrong"
}