Create an update workflow
POST/workflows/update_workflows
Create an update workflow
Request
- application/json
Body
required
workflow
object
The profile type the workflow effects.
Possible values: [Enabled
, Disabled
]
Whether or not the workflow is enabled or disabled.
The uid of the workflow.
Name of the workflow
The status of the profiles the workflow will effect.
Responses
- 200
- 400
- 500
Expected response to a valid request
- application/json
- Schema
- Example (from schema)
Schema
workflow
object
The objects ID.
Possible values: >= 32 characters
and <= 32 characters
The objects UID.
The workflow id.
The requester's id.
Possible values: [User
, NeprofileUser
, NeaccessUser
]
The requester type.
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
]
The status of the workflow session.
attributes
object
The attributes asscoiated with the workflow session.
{
"workflow": {
"id": "33f072dd-13b4-41e1-8ea0-16f2a59b57c8",
"uid": "wsUid",
"workflow_id": "33f072dd-13b4-41e1-8ea0-16f2a59b57c8",
"requester_id": "33f072dd-13b4-41e1-8ea0-16f2a59b57c8",
"requester_type": "User",
"profile_id": "33f072dd-13b4-41e1-8ea0-16f2a59b57c8",
"profile_ids": "59ed1cb6-9977-4965-9bfe-f2bcc242523e, 89ed1cb6-9977-4965-9bfe-f2bcc242523e",
"status": "completed",
"attributes": {
"text_attribute_uid": "static text",
"date_attribute_uid": "01/15/2020",
"profile_select_attribute_uid": "Profile Name",
"profile_search_attribute_uid": "Profile Name",
"multiple_profile_search_attribute_uid": "Profile Name,Second Profile Name,Third Profile Name",
"multiple_profile_select_attribute_uid": "Profile Name,Second Profile Name,Third Profile Name",
"contributor_select_attribute_uid": "User Name ([email protected])",
"contributor_search_attribute_uid": "User Name ([email protected])",
"multiple_contributor_search_attribute_uid": "User Name ([email protected]),Second User Name ([email protected]),Third User Name ([email protected])",
"owner_select_attribute_uid": "User Name ([email protected])",
"owner_search_attribute_uid": "User Name ([email protected])",
"dropdown_attribute_uid": "yes, no",
"tags_attribute_uid": "yes, no",
"checkbox_attribute_uid": "yes, no",
"text_area_uid": "static text",
"radio_attribute_uid": "yes, no"
}
}
}
Bad Request - unable to complete.
- application/json
- Schema
- Example (from schema)
Schema
- InvalidJson
- ValidationErrors
oneOf
{}
Internal Server Error - returned on unhandled exceptions.
- application/json
- Schema
- Example (from schema)
Schema
A message describing the error
{
"error": "Sorry something went wrong"
}