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
Internal-Use OnlyReturns the headers for the workflow definitions./
get
Get a list of workflow definitions
Internal-Use OnlyRetrieves 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
Internal-Use OnlyReturns the headers for all versions of the workflow definitions/revisions
get
Get a list of all versions of the workflow definitions
Internal-Use OnlyRetrieves 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
Internal-Use OnlyReturns the headers for the specified workflow definition/workflows/{workflowId}
get
Get the details for the specified workflow definition
Internal-Use OnlyRetrieves the details for the specified workflow definition./workflows/{workflowId}
delete
Delete a workflow definition
Internal-Use OnlyDeletes a workflow definition./workflows/{workflowId}
put
Update an existing workflow definition
Internal-Use OnlyUpdates 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
Internal-Use OnlyDeletes all workflow definitions for an entity./entityName/{entityName}
delete
Delete all workflow revisions by workflow name
Internal-Use OnlyDeletes all workflow revisions by workflow name./name/{name}
head
Get the headers for a specified workflow definition
Internal-Use OnlyReturns the headers for a specified workflow definition/revisions/{workflowId}
get
Get details for a specified workflow definition
Internal-Use OnlyRetrieves details for a specified workflow definition./revisions/{workflowId}
post
Start a workflow process
Internal-Use OnlyStarts a process instance of a workflow definition./workflows/{workflowId}/processes
post
Start a workflow definition process instance
Internal-Use OnlyStarts a workflow definition process instance./processes/workflowName/{workflowName}

Processes

Endpoints manage workflow processes.
head
Get the headers for a list of workflow processes
Internal-Use OnlyReturns the headers for a list of workflow processes/processes
get
Get a list of workflow processes
Internal-Use OnlyRetrieves 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
Internal-Use OnlyStops and deletes all workflow processes./processes
head
Get the headers for a list of active workflow processes
Internal-Use OnlyReturns the headers for a list of active workflow processes./processes/actives
get
Get a list of active workflow processes
Internal-Use OnlyRetrieves 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
Internal-Use OnlyReturns the headers for the details for a specified workflow process./processes/processes/{processId}
get
Get details for specified workflow process
Internal-Use OnlyRetrieves the details for a specified workflow process./processes/processes/{processId}
delete
Delete a workflow process
Internal-Use OnlyStops and deletes a workflow process./processes/processes/{processId}
put
Suspend a workflow process
Internal-Use OnlySuspends a workflow process./processes/processes/{processId}/suspended
post
Suspend a selection of the workflow processes
Internal-Use OnlySuspends a selection of the workflow processes. This request allows for 100 selections./processes/suspended
put
Suspend all workflow processes
Internal-Use OnlySuspends all workflow processes./processes/suspended
put
Suspend a workflow process by entity instance ID
Internal-Use OnlySuspends a workflow process by entity instance ID./processes/entityName/{entityName}/entityInstanceId/{entityInstanceId}/suspended
put
Suspend all workflow processes for an entity
Internal-Use OnlySuspends all workflow processes for an entity./processes/entityName/{entityName}/suspended
put
Resume a previously suspended workflow process
Internal-Use OnlyResumes a previously suspended workflow process./processes/processes/{processId}/resumed
post
Resume a selection of previously suspended workflow processes
Internal-Use OnlyResumes a selection of previously suspended workflow processes. This request allows for 100 selections./processes/resumed
put
Resume all previously suspended workflow processes
Internal-Use OnlyResumes all previously suspended workflow processes./processes/resumed
put
Resume a previously suspended workflow process by entity instance ID
Internal-Use OnlyResumes 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
Internal-Use OnlyResumes all previously suspended workflow process for an entity./processes/entityName/{entityName}/resumed
post
Stop and delete a selection of workflow processes
Internal-Use OnlyStops 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
Internal-Use OnlyStops and deletes a workflow process by entity instance ID./processes/entityName/{entityName}/entityInstanceId/{entityInstanceId}
delete
Stop and delete all workflow processes for an entity
Internal-Use OnlyStops 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
Internal-Use OnlyReturns the headers for a list of workflow tasks./processes/tasks
get
Get a list of workflow tasks
Internal-Use OnlyRetrieves 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
Internal-Use OnlyReturns the headers for the specified workflow task./processes/tasks/tasks/{taskId}
get
Get a workflow task
Internal-Use OnlyRetrieves details for the specified workflow task./processes/tasks/tasks/{taskId}
put
Claim a workflow task
Internal-Use OnlyClaims a workflow task./processes/tasks/tasks/{taskId}/claimed
post
Claim a selection of workflow tasks
Internal-Use OnlyClaims a selection of workflow tasks. This request allows for 100 selections./processes/tasks/claimed
put
Release a claim on a workflow task
Internal-Use OnlyReleases a claim on a workflow task.k/processes/tasks/tasks/{taskId}/claimReleased
post
Release claim on selected workflow tasks
Internal-Use OnlyReleases 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
Internal-Use OnlyReleases 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
Internal-Use OnlyReleases 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
Internal-Use OnlyUpdates 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
Internal-Use OnlyReturns 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
Internal-Use OnlyRetrieves 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
Internal-Use OnlyReturns the headers for the history metrics summary for all workflows./processes/history/metrics
get
Get the history metrics summary for all workflows
Internal-Use OnlyRetrieves 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
Internal-Use OnlyReturns the headers for a history metrics summary for all groups./processes/history/metrics/groups
get
Get a history metrics summary for all groups
Internal-Use OnlyRetrieves 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
Internal-Use OnlyReturns the headers for the history metrics summary for all users./processes/history/metrics/groups/users
get
Get the history metrics summary for all users
Internal-Use OnlyRetrieves 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
Internal-Use OnlyReturns 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
Internal-Use OnlyRetrieves 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
Internal-Use OnlyReturns the headers for the history metrics summary for specific workflows./workflows/{workflowId}/processes/history/metrics
get
Get history metrics summary for workflows
Internal-Use OnlyRetrieves 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
Internal-Use OnlyReturns 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
Internal-Use OnlyRetrieves 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
Internal-Use OnlyReturns 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
Internal-Use OnlyRetrieves 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
Internal-Use OnlyReturns 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
Internal-Use OnlyRetrieves 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

post
Create a new administrator workflow setting
Internal-Use OnlyCreates a new administrator workflow setting./settings/administrators
head
Get the headers for list of administrator workflow settings
Internal-Use OnlyReturns the headers for a list of administrator workflow settings./settings/administrators
get
Get a list of administrator workflow settings
Internal-Use OnlyRetrieves a list of administrator workflow settings. The returned items are of type application/vnd.sas.investigation.workflow.setting+json./settings/administrators
delete
Delete all of the administrator workflow settings
Internal-Use OnlyDeletes all of the administrator workflow settings./settings/administrators
head
Get the headers for administrator setting information
Internal-Use OnlyReturns the headers for the details for a specified administrator workflow setting./settings/administrators/{settingId}
get
Get administrator setting information
Internal-Use OnlyRetrieves the details for a specified administrator workflow setting./settings/administrators/{settingId}
delete
Delete an administrator workflow setting
Internal-Use OnlyDeletes an administrator workflow setting./settings/administrators/{settingId}
put
Update an existing administrator workflow setting
Internal-Use OnlyUpdates an existing administrator workflow setting./settings/administrators/{settingId}