Manage data and workflows and search and discovery

visual_investigator

Viya_35

2023.03

2023.10

2024.10

2024.08

2024.03

2024.09

2024.07

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.

Visual Investigator Workflow

Returns the headers for the history metrics summary for all users.

groupId

The comma-separated list of resource members to return in the collection.

fields

Filters the collection by using the prefix function syntax using selected resource members.

filter

The zero-based index of the first item in the collection.

start

The number of items that were requested for the collection.

limit

The sorting preference for selected resource members in the returned collection.

sortBy

Filters on the entity name the workflow runs against.

entityName

workflowName

taskName

taskDefinitionId

Filters for all tasks whose workflow name contain this value.

containsWorkflowName

Filters for all task names that contain this value.

containsTaskName

startAt

endAt

Includes those tasks that are not currently assigned.

includeUnclaimedTasks

Includes tasks whose processes were canceled.

includeCancelledTasks

An example URL including the base path for this service that is based off svi-datahub.

Get the headers for the history metrics summary for all users

A representation of a workflow instance's context.

workflowInstanceContextRep

sortPreferenceRep

A representation of a workflow definition view.

workflowRep

workflowTaskRepResourceCollection

A participant assigned to a workflow task

participantRep

workflowSettingRepResourceCollection

workflowProcessRep

workflowTaskRep

actionRep

The page template details that are used when completing workflow tasks.

pageDetailsRep

A representation of the selected element.

selectionRep

workflowProcessRepResourceCollection

A simple representation with name and ID.

genericReferenceRep

A collection of settings for displaying grid columns.

columnSettingRep

columnPreferenceRep

A collection of work metrics details per workflow, user, or group.

historicalMetricsSummaryRep

variableRep

A collection of workflow process history.

historicalWorkflowTaskRepResourceCollection

A simple representation with an ID and version.

genericVersionReferenceRep

A collection of information  about the process metric summary.

historicalMetricsSummaryRepResourceCollection

A collection of information about a workflow task's history.

historicalWorkflowTaskRep

The page template used when completing workflow tasks.

pagePromptRep

workflowRepResourceCollection

A representation of workflow settings applied per user.

workflowSettingRep

Error

This is a base schema used to define paginated collections of resources. This base schema is extended by other schemas in APIs by adding an 'items' array property. These extensions define the application/vnd.sas.collection media type (version 2)

Base Collection

A link to a related operation or resource.

Name	Type	Required	Description
containsTaskName	string	false	Filters for all task names that contain this value.
containsWorkflowName	string	false	Filters for all tasks whose workflow name contain this value.
endAt	integer<int64>	false	Filters based on this end timestamp.
entityName	string	false	Filters on the entity name the workflow runs against.
fields	string	false	The comma-separated list of resource members to return in the collection.
filter	string	false	Filters the collection by using the prefix function syntax using selected resource members.
includeCancelledTasks	boolean	false	Includes tasks whose processes were canceled. Default: false
includeUnclaimedTasks	boolean	false	Includes those tasks that are not currently assigned. Default: false
limit	integer<int32>	false	The number of items that were requested for the collection. Default: 10
sortBy	string	false	The sorting preference for selected resource members in the returned collection. Default: id:ascending
start	integer<int64>	false	The zero-based index of the first item in the collection. Default: 0
startAt	integer<int64>	false	Filters based on this start timestamp.
taskDefinitionId	string	false	Filters on the specific task.
taskName	string	false	Filters on the task name.
workflowName	string	false	Filters on the workflow name.

Get the headers for the history metrics summary for all users

Request Samples

Response Samples

Path Parameters

Query Parameters

Responses