--- id: patch-workflow-session sidebar_label: Update a workflow session by id hide_title: true hide_table_of_contents: true api: {"operationId":"patchWorkflowSession","description":"Update a workflow session by id","tags":["workflow sessions"],"parameters":[{"name":"id","in":"path","description":"ID of the object to retrieve or update","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"run","in":"query","description":"Will run the created/updated workflow session if successful","required":false,"schema":{"type":"boolean","default":false}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"workflow_session":{"type":"object","properties":{"workflow_id":{"type":"string","format":"uuid"},"requester_id":{"type":"string","format":"uuid"},"requester_type":{"type":"string","enum":["User","NeprofileUser","NeaccessUser"]},"profile_id":{"type":"string","format":"uuid","description":"The profile this workflow session will be working with. Only Applicable for Update workflows"},"profile_ids":{"type":"array","items":{"type":"string","format":"uuid"},"description":"The profiles this workflow session will be working with. Only Applicable for Batch workflows"},"status":{"type":"string","enum":["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"],"example":"completed"},"attributes":{"type":"object","additionalProperties":{"type":"string"},"example":{"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"}}}}}}}}},"responses":{"200":{"description":"Expected response to a valid request","content":{"application/json":{"schema":{"type":"object","properties":{"workflow_session":{"type":"object","properties":{"id":{"type":"string","format":"uuid","readOnly":true},"uid":{"type":"string","minLength":32,"maxLength":32,"readOnly":true},"workflow_id":{"type":"string","format":"uuid"},"requester_id":{"type":"string","format":"uuid"},"requester_type":{"type":"string","enum":["User","NeprofileUser","NeaccessUser"]},"profile_id":{"type":"string","format":"uuid","description":"The profile this workflow session will be working with. Only Applicable for Update workflows"},"profile_ids":{"type":"array","items":{"type":"string","format":"uuid"},"description":"The profiles this workflow session will be working with. Only Applicable for Batch workflows"},"status":{"type":"string","enum":["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"],"example":"completed"},"attributes":{"type":"object","additionalProperties":{"type":"string"},"example":{"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"}}}}}}}}},"400":{"description":"Bad Request - unable to complete.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"error":{"example":"Invalid JSON syntax. Please check your syntax and try again."}}},{"type":"object","properties":{"error":{"example":"The failed to create/update"},"errors":{"example":{"attribute":"can't be blank"}}}}]}}}},"500":{"description":"Internal Server Error - returned on unhandled exceptions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"Sorry something went wrong"}}}}}}},"method":"patch","path":"/workflow_sessions/{id}","jsonRequestBodyExample":{"workflow_session":{"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"}}},"info":{"version":"1.0.0","title":"SecZetta Lifecycle API","description":"The Lifecycle API can be used to access and modify various resources in your environment.","license":{"name":"MIT"}},"postman":{"name":"Update a workflow session by id","description":{"content":"Update a workflow session by id","type":"text/plain"},"url":{"path":["workflow_sessions",":id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Will run the created/updated workflow session if successful","type":"text/plain"},"key":"run","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the object to retrieve or update","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} sidebar_class_name: "patch api-method" info_path: nerm/api/seczetta-lifecycle-api custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Update a workflow session by id' (patch-workflow-session)" --- import ApiTabs from "@theme/ApiTabs"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; import TabItem from "@theme/TabItem"; ## Update a workflow session by id Update a workflow session by id
Path Parameters
Query Parameters
Request Body required
    workflow_session object
    attributes object
  • property name* string
Expected response to a valid request
Schema
    workflow_session object
    = 32 characters` and `<= 32 characters`"} defaultValue={undefined}>
    attributes object
  • property name* string
Bad Request - unable to complete.
Schema
    oneOf
Internal Server Error - returned on unhandled exceptions.
Schema