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

workflowTaskRep

This indicates which client 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.

No workflow task exists at the requested path.

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

Claim 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

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

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
entityLabel	string	false	The label of the entity.
participantsVariable	variableRep	false	A representation of a workflow variable.
workflowDefinitionId	string	false	The ID of the workflow definition.
description	string	false	The description of the task.
workflowLabel	string	false	The label of the workflow.
savedAssigneeOnCompleteVariable	variableRep	false	A representation of a workflow variable.
workflowDescriptionResource	string	false	The resource key for the workflow description.
workflowLabelResource	string	false	The resource key for the workflow label.
createdAt	string<date-time>	false	The task creation time.
boundaryEventType	string	false	The type of boundary timer event (duration or date). Allowed values: TIMER_DURATIONTIMER_DATE
isProcessInstanceSuspended	boolean	false	A flag designating whether the process associated with the task is suspended. Example: false
isBoundaryEventInterrupting	boolean	false	A flag designating whether the boundary timer event cancels this task when triggered. Example: false
boundaryEventDueDateTimeStamp	integer<int64>	false	The time for the boundary event.
entityName	string	false	The name of the entity.
links	array [Link]	false	The links that apply to this resource
id	string	false	The ID of the task.
tag	variableRep	false	A representation of a workflow variable.
definitionId	string	false	The ID of the workflow definition this task is running against.
participants	array [participantRep]	false	A list of user and group participants who can work this task.
claimedAt	string<date-time>	false	The date claimed.
owner	string	false	The owner of the task.
processInstanceId	string	false	The ID of the workflow process this task is running under.
entityInstanceLabel	string	false	The label of the entity instance this workflow process is running against.
dueDateTimeStamp	integer<int64>	false	The due date.
entityId	integer<int64>	false	The ID of the entity.
workflowName	string	false	The name of the workflow.
workflowDescription	string	false	The description of the workflow.
entityInstanceId	string	false	The ID of the entity instance this workflow process is running against.
version	integer<int32>	false	This media type's schema version number. This representation is version 1.
isClaimedByCurrentUser	boolean	false	The flag designating whether the task is claimed by the user issuing the request. Example: false
autoAssigneeVariable	variableRep	false	A representation of a workflow variable.
name	string	false	The name of the task.
assignee	string	false	The user name of the user assigned to this task.
workflowVersion	integer<int32>	false	The version of the workflow definition.
actions	array [actionRep]	false	A list of actions for this task.

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

Claim a workflow task

Request Samples

Response Samples

Path Parameters

Header Parameters

Request Body

Responses