Endpoints to manage workflow templates.
Visual Investigator Workflow
2024.12 - v4
The SAS Visual Investigator Workflow API enable users to execute and manage workflows created within SAS Visual Investigator. The SAS Visual Investigator workflows are based on an open-source engine that complies with the Business Process Model and Notation (BPMN) 2.0 standard. It supports industry standards for visual representation and behavior, and it provides support for established workflow patterns. SAS Visual Investigator workflows are efficient and scalable, and integrate with other standard business process implementations.
head
Returns the headers for the workflow definitions.Get the headers for the workflow definitions
get
Retrieves a list of the latest workflow definitions. The returned items are of type application/vnd.sas.investigation.workflow.workflow+json.Get a list of workflow definitions
head
Returns the headers for all versions of the workflow definitionsGet the headers for all versions of the workflow definitions
get
Retrieves a list of all versions of the workflow definitions. The returned items are of type application/vnd.sas.investigation.workflow.workflow+json.Get a list of all versions of the workflow definitions
head
Returns the headers for the specified workflow definitionGet the headers for the specified workflow definition
get
Retrieves the details for the specified workflow definition.Get the details for the specified workflow definition
delete
Deletes a workflow definition.Delete a workflow definition
put
Updates an existing workflow definition. When a workflow is updated, a new version of the workflow definition is created. This ensures that existing processes working tasks against the previous versions of this workflow have access to the data needed and can continue. A workflow is not versioned if the updated properties are shared by all workflow versions (label, description, enabled, and useForAutoStart).Update an existing workflow definition
delete
Deletes all workflow definitions for an entity.Delete all workflow definitions for an entity
delete
Deletes all workflow revisions by workflow name.Delete all workflow revisions by workflow name
head
Returns the headers for a specified workflow definitionGet the headers for a specified workflow definition
get
Retrieves details for a specified workflow definition.Get details for a specified workflow definition
post
Starts a process instance of a workflow definition.Start a workflow process
post
Starts a workflow definition process instance.Start a workflow definition process instance
Endpoints manage workflow processes.
head
Returns the headers for a list of workflow processesGet the headers for a list of workflow processes
get
Retrieves a list of workflow processes. The returned items are of type application/vnd.sas.investigation.workflow.process+json.Get a list of workflow processes
delete
Stops and deletes all workflow processes.Stop and delete all workflow processes
head
Returns the headers for a list of active workflow processes.Get the headers for a list of active workflow processes
get
Retrieves a list of active workflow processes. The returned items are of type application/vnd.sas.investigation.workflow.process+json.Get a list of active workflow processes
head
Returns the headers for the details for a specified workflow process.Get the headers for specified workflow process
get
Retrieves the details for a specified workflow process.Get details for specified workflow process
delete
Stops and deletes a workflow process.Delete a workflow process
put
Suspends a workflow process.Suspend a workflow process
post
Suspends a selection of the workflow processes. This request allows for 100 selections.Suspend a selection of the workflow processes
put
Suspends all workflow processes.Suspend all workflow processes
put
Suspends a workflow process by entity instance ID.Suspend a workflow process by entity instance ID
put
Suspends all workflow processes for an entity.Suspend all workflow processes for an entity
put
Resumes a previously suspended workflow process.Resume a previously suspended workflow process
post
Resumes a selection of previously suspended workflow processes. This request allows for 100 selections.Resume a selection of previously suspended workflow processes
put
Resumes all previously suspended workflow processes.Resume all previously suspended workflow processes
put
Resumes a previously suspended workflow process by entity instance ID.Resume a previously suspended workflow process by entity instance ID
put
Resumes all previously suspended workflow process for an entity.Resume all previously suspended workflow process for an entity
post
Stops and deletes a selection of workflow processes. This request allows for 100 selections.Stop and delete a selection of workflow processes
delete
Stops and deletes a workflow process by entity instance ID.Stop and delete a workflow process by entity instance ID
delete
Stops and deletes all workflow processes for an entity.Stop and delete all workflow processes for an entity
Endpoints related to workflow tasks.
head
Returns the headers for a list of workflow tasks.Get the headers for a list of workflow tasks
get
Retrieves a list of workflow tasks. The returned items are of type application/vnd.sas.investigation.workflow.task+json.Get a list of workflow tasks
head
Returns the headers for the specified workflow task.Get the headers for a workflow task
get
Retrieves details for the specified workflow task.Get a workflow task
put
Claims a workflow task.Claim a workflow task
post
Claims a selection of workflow tasks. This request allows for 100 selections.Claim a selection of workflow tasks
put
Releases a claim on a workflow task.kRelease a claim on a workflow task
post
Releases a claim on a selection of workflow tasks. This request allows for 100 selections.Release claim on selected workflow tasks
put
Releases a claim on a workflow task by the workflow administrator. This follows the same design as the existing /workflows/processes/tasks/tasks/{taskId}/claimReleased REST API. The requirement on this API is that the user must have the workflow administrator capability (svi.administration.workflows.process).Release a claim on a workflow task by the workflow administrator
post
Releases a claim on a selection of workflow tasks by the workflow administrator. This follows the same design as the existing /workflows/processes/tasks/claimReleased REST API. The requirement on this API is that the user must have the workflow administrator capability (svi.administration.workflows.process). This request allows for 100 selections.Release a claim on a selection of workflow tasks by the workflow administrator
put
Updates the status of a workflow task to complete.Complete a workflow task
Endpoints to view historical process activity measurements.
head
Returns the headers for the history metrics summary for all workflows by entity.Get the headers for the history metrics summary for all workflows by entity
get
Retrieves the history metrics summary for all workflows by entity. The returned items are of type application/vnd.sas.investigation.workflow.historical.metrics.summary+json.Get the history metrics summary for all workflows by entity
head
Returns the headers for the history metrics summary for all workflows.Get the headers for the history metrics summary for all workflows
get
Retrieves the history metrics summary for all workflows. The returned items are of type application/vnd.sas.investigation.workflow.historical.metrics.summary+json.Get the history metrics summary for all workflows
head
Returns the headers for a history metrics summary for all groups.Get the headers for a history metrics summary for all groups
get
Retrieves a history metrics summary for all groups. The returned items are of type application/vnd.sas.investigation.workflow.historical.metrics.summary+json.Get a history metrics summary for all groups
head
Returns the headers for the history metrics summary for all users.Get the headers for the history metrics summary for all users
get
Retrieves the history metrics summary for all users. The returned items are of type application/vnd.sas.investigation.workflow.historical.metrics.summary+jsonGet the history metrics summary for all users
head
Returns the headers for the history metrics summary for all users.Get the headers for the history metrics summary for all users
get
Retrieves the history metrics summary for all users. The returned items are of type application/vnd.sas.investigation.workflow.historical.metrics.summary+json.Get the history metrics summary for all users
head
Returns the headers for the history metrics summary for specific workflows.Get the headers for history metrics summary for workflows
get
Retrieves the history metrics summary for specific workflows. The returned items are of type application/vnd.sas.investigation.workflow.historical.metrics.summary+json.Get history metrics summary for workflows
head
Returns the headers for the history metrics summary for all groups of a selected workflow version. The returned items are of type application/vnd.sas.investigation.workflow.historical.metrics.summary+json.Get the headers for the history metrics summary for all groups of a selected workflow version
get
Retrieves the history metrics summary for all groups of a selected workflow version. The returned items are of type application/vnd.sas.investigation.workflow.historical.metrics.summary+json.Retrieve the history metrics summary for all groups of a selected workflow version
head
Returns the headers for the history metrics summary for all users of a selected workflow version.Get the headers for the history metrics summary for all users of a selected workflow version
get
Retrieves the history metrics summary for all users of a selected workflow version. The returned items are of type application/vnd.sas.investigation.workflow.historical.metrics.summary+json.Retrieve the history metrics summary for all users of a selected workflow version
head
Returns the headers for the history metrics summary for all of the users of a selected workflow version and group.RetriGet the headers for the history metrics summary for all of the users of a selected workflow version and group
get
Retrieves the history metrics summary for all of the users of a selected workflow version and group. The returned items are of type application/vnd.sas.investigation.workflow.historical.metrics.summary+json.Retrieve the history metrics summary for all of the users of a selected workflow version and group
Endpoint to view history of workflow process activity.
head
Returns the headers for the history for any number of process instances.Get the headers for the history for any number of process instances
get
Retrieves the history for any number of process instances. The returned items are of type application/vnd.sas.investigation.workflow.historical.workflow.task+json.Get the history for any number of process instances
post
Creates a new administrator workflow setting.Create a new administrator workflow setting
head
Returns the headers for a list of administrator workflow settings.Get the headers for list of administrator workflow settings
get
Retrieves a list of administrator workflow settings. The returned items are of type application/vnd.sas.investigation.workflow.setting+json.Get a list of administrator workflow settings
delete
Deletes all of the administrator workflow settings.Delete all of the administrator workflow settings
head
Returns the headers for the details for a specified administrator workflow setting.Get the headers for administrator setting information
get
Retrieves the details for a specified administrator workflow setting.Get administrator setting information
delete
Deletes an administrator workflow setting.Delete an administrator workflow setting
put
Updates an existing administrator workflow setting.