Visual Investigator Workflow

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.

Workflows

Endpoints to manage workflow templates.
head
Get the headers for the workflow definitions
Returns the headers for the workflow definitions.
/
get
Get a list of workflow definitions
Retrieves a list of the latest workflow definitions. The returned items are of type application/vnd.sas.investigation.workflow.workflow+json.
/
head
Get the headers for all versions of the workflow definitions
Returns the headers for all versions of the workflow definitions
/revisions
get
Get a list of all versions of the workflow definitions
Retrieves a list of all versions of the workflow definitions. The returned items are of type application/vnd.sas.investigation.workflow.workflow+json.
/revisions
head
Get the headers for the specified workflow definition
Returns the headers for the specified workflow definition
/workflows/{workflowId}
get
Get the details for the specified workflow definition
Retrieves the details for the specified workflow definition.
/workflows/{workflowId}
delete
Delete a workflow definition
Deletes a workflow definition.
/workflows/{workflowId}
put
Update an existing workflow definition
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).
/workflows/{workflowId}
delete
Delete all workflow definitions for an entity
Deletes all workflow definitions for an entity.
/entityName/{entityName}
delete
Delete all workflow revisions by workflow name
Deletes all workflow revisions by workflow name.
/name/{name}
head
Get the headers for a specified workflow definition
Returns the headers for a specified workflow definition
/revisions/{workflowId}
get
Get details for a specified workflow definition
Retrieves details for a specified workflow definition.
/revisions/{workflowId}
post
Start a workflow process
Starts a process instance of a workflow definition.
/workflows/{workflowId}/processes
post
Start a workflow definition process instance
Starts a workflow definition process instance.
/processes/workflowName/{workflowName}

Processes

Endpoints manage workflow processes.
head
Get the headers for a list of workflow processes
Returns the headers for a list of workflow processes
/processes
get
Get a list of workflow processes
Retrieves a list of workflow processes. The returned items are of type application/vnd.sas.investigation.workflow.process+json.
/processes
delete
Stop and delete all workflow processes
Stops and deletes all workflow processes.
/processes
head
Get the headers for a list of active workflow processes
Returns the headers for a list of active workflow processes.
/processes/actives
get
Get a list of active workflow processes
Retrieves a list of active workflow processes. The returned items are of type application/vnd.sas.investigation.workflow.process+json.
/processes/actives
head
Get the headers for specified workflow process
Returns the headers for the details for a specified workflow process.
/processes/processes/{processId}
get
Get details for specified workflow process
Retrieves the details for a specified workflow process.
/processes/processes/{processId}
delete
Delete a workflow process
Stops and deletes a workflow process.
/processes/processes/{processId}
put
Suspend a workflow process
Suspends a workflow process.
/processes/processes/{processId}/suspended
post
Suspend a selection of the workflow processes
Suspends a selection of the workflow processes. This request allows for 100 selections.
/processes/suspended
put
Suspend all workflow processes
Suspends all workflow processes.
/processes/suspended
put
Suspend a workflow process by entity instance ID
Suspends a workflow process by entity instance ID.
/processes/entityName/{entityName}/entityInstanceId/{entityInstanceId}/suspended
put
Suspend all workflow processes for an entity
Suspends all workflow processes for an entity.
/processes/entityName/{entityName}/suspended
put
Resume a previously suspended workflow process
Resumes a previously suspended workflow process.
/processes/processes/{processId}/resumed
post
Resume a selection of previously suspended workflow processes
Resumes a selection of previously suspended workflow processes. This request allows for 100 selections.
/processes/resumed
put
Resume all previously suspended workflow processes
Resumes all previously suspended workflow processes.
/processes/resumed
put
Resume a previously suspended workflow process by entity instance ID
Resumes a previously suspended workflow process by entity instance ID.
/processes/entityName/{entityName}/entityInstanceId/{entityInstanceId}/resumed
put
Resume all previously suspended workflow process for an entity
Resumes all previously suspended workflow process for an entity.
/processes/entityName/{entityName}/resumed
post
Stop and delete a selection of workflow processes
Stops and deletes a selection of workflow processes. This request allows for 100 selections.
/processes/cancelled
delete
Stop and delete a workflow process by entity instance ID
Stops and deletes a workflow process by entity instance ID.
/processes/entityName/{entityName}/entityInstanceId/{entityInstanceId}
delete
Stop and delete all workflow processes for an entity
Stops and deletes all workflow processes for an entity.
/processes/entityName/{entityName}

Tasks

Endpoints related to workflow tasks.
head
Get the headers for a list of workflow tasks
Returns the headers for a list of workflow tasks.
/processes/tasks
get
Get a list of workflow tasks
Retrieves a list of workflow tasks. The returned items are of type application/vnd.sas.investigation.workflow.task+json.
/processes/tasks
head
Get the headers for a workflow task
Returns the headers for the specified workflow task.
/processes/tasks/tasks/{taskId}
get
Get a workflow task
Retrieves details for the specified workflow task.
/processes/tasks/tasks/{taskId}
put
Claim a workflow task
Claims a workflow task.
/processes/tasks/tasks/{taskId}/claimed
post
Claim a selection of workflow tasks
Claims a selection of workflow tasks. This request allows for 100 selections.
/processes/tasks/claimed
put
Release a claim on a workflow task
Releases a claim on a workflow task.k
/processes/tasks/tasks/{taskId}/claimReleased
post
Release claim on selected workflow tasks
Releases a claim on a selection of workflow tasks. This request allows for 100 selections.
/processes/tasks/claimReleased
put
Release a claim on a workflow task by the workflow administrator
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).
/processes/tasks/tasks/{taskId}/claimReleased/administrator
post
Release a claim on a selection of workflow tasks by the workflow administrator
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.
/processes/tasks/claimReleased/administrator
put
Complete a workflow task
Updates the status of a workflow task to complete.
/processes/tasks/tasks/{taskId}/completed

Metrics Summary

Endpoints to view historical process activity measurements.
head
Get the headers for the history metrics summary for all workflows by entity
Returns the headers for the history metrics summary for all workflows by entity.
/entity/processes/history/metrics
get
Get the history metrics summary for all workflows by entity
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.
/entity/processes/history/metrics
head
Get the headers for the history metrics summary for all workflows
Returns the headers for the history metrics summary for all workflows.
/processes/history/metrics
get
Get the history metrics summary for all workflows
Retrieves the history metrics summary for all workflows. The returned items are of type application/vnd.sas.investigation.workflow.historical.metrics.summary+json.
/processes/history/metrics
head
Get the headers for a history metrics summary for all groups
Returns the headers for a history metrics summary for all groups.
/processes/history/metrics/groups
get
Get a history metrics summary for all groups
Retrieves a history metrics summary for all groups. The returned items are of type application/vnd.sas.investigation.workflow.historical.metrics.summary+json.
/processes/history/metrics/groups
head
Get the headers for the history metrics summary for all users
Returns the headers for the history metrics summary for all users.
/processes/history/metrics/groups/users
get
Get the history metrics summary for all users
Retrieves the history metrics summary for all users. The returned items are of type application/vnd.sas.investigation.workflow.historical.metrics.summary+json
/processes/history/metrics/groups/users
head
Get the headers for the history metrics summary for all users
Returns the headers for the history metrics summary for all users.
/processes/history/metrics/groups/groups/{groupId}/users
get
Get the history metrics summary for all users
Retrieves the history metrics summary for all users. The returned items are of type application/vnd.sas.investigation.workflow.historical.metrics.summary+json.
/processes/history/metrics/groups/groups/{groupId}/users
head
Get the headers for history metrics summary for workflows
Returns the headers for the history metrics summary for specific workflows.
/workflows/{workflowId}/processes/history/metrics
get
Get history metrics summary for workflows
Retrieves the history metrics summary for specific workflows. The returned items are of type application/vnd.sas.investigation.workflow.historical.metrics.summary+json.
/workflows/{workflowId}/processes/history/metrics
head
Get the headers for the history metrics summary for all groups of a selected workflow version
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.
/workflows/{workflowId}/processes/history/metrics/groups
get
Retrieve the history metrics summary for all groups of a selected workflow version
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.
/workflows/{workflowId}/processes/history/metrics/groups
head
Get the headers for the history metrics summary for all users of a selected workflow version
Returns the headers for the history metrics summary for all users of a selected workflow version.
/workflows/{workflowId}/processes/history/metrics/groups/users
get
Retrieve the history metrics summary for all users of a selected workflow version
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.
/workflows/{workflowId}/processes/history/metrics/groups/users
head
RetriGet the headers for the history metrics summary for all of the users of a selected workflow version and group
Returns the headers for the history metrics summary for all of the users of a selected workflow version and group.
/workflows/{workflowId}/processes/history/metrics/groups/groups/{groupId}/users
get
Retrieve the history metrics summary for all of the users of a selected workflow version and group
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.
/workflows/{workflowId}/processes/history/metrics/groups/groups/{groupId}/users

Settings