Manage data and workflows and search and discovery

visual_investigator

Viya_35

2023.03

2023.10

2024.03

2024.06

2024.07

2024.08

2024.09

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

Updates the status of a workflow task to complete.

actionRep

The client that is issuing the request. Accepted values include desktop and mobile.

VI-Client-Application

taskId

This is an example of an error returned for bad requests.

Error

application/vnd.sas.error

This is an example of an error returned when a resource is not found.

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

Complete a workflow task

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

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

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
entityFieldVariables	array [variableRep]	false	Entity fields to be updated upon completion of this action.
name	string	false	The name of the action.
disabled	boolean	false	The disable action is disabled for user {NEW PROPERTY}. Example: false
id	string	false	The ID of the action.
processVariables	array [variableRep]	false	The workflow process variables to be updated upon completion of this action.
pagePrompt	pagePromptRep	false	The page template used when completing workflow tasks.
tag	variableRep	false	A representation of a workflow variable.

Status	Meaning	Description
204	No Content	The operation was successful.
400	Bad Request	The request was invalid.	Schema
404	Not Found	No task exists at the requested path.	Schema

Complete a workflow task

Request Samples

Response Samples

Path Parameters

Header Parameters

Request Body

Responses