RestApiCategories.visualInvestigator.desc

visual_investigator

2024.09

2024.03

Viya_35

2025.08

2025.09

2025.10

2025.03

2025.11

2025.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

Suspends a workflow process by entity instance ID.

entityName

entityInstanceId

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 entity instance ID exists at the requested path.

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

Suspend a workflow process by entity instance ID

actionRep

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

columnPreferenceRep

A collection of settings for displaying grid columns.

columnSettingRep

A simple representation with name and ID.

genericReferenceRep

A simple representation with an ID and version.

genericVersionReferenceRep

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

historicalMetricsSummaryRep

A collection of information  about the process metric summary.

historicalMetricsSummaryRepResourceCollection

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

historicalWorkflowTaskRep

A collection of workflow process history.

historicalWorkflowTaskRepResourceCollection

A link to a related operation or resource.

Link

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

pageDetailsRep

The page template used when completing workflow tasks.

pagePromptRep

A participant assigned to a workflow task

participantRep

A representation of the selected element.

selectionRep

sortPreferenceRep

variableRep

A representation of a workflow instance's context.

workflowInstanceContextRep

workflowProcessRep

workflowProcessRepResourceCollection

A representation of a workflow definition view.

workflowRep

workflowRepResourceCollection

A representation of workflow settings applied per user.

Name	Type	Required	Description
entityInstanceId	string	true	The instance ID of the entity.
entityName	string	true	The name of the entity.

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

Suspend a workflow process by entity instance ID

Request Samples

Response Samples

Path Parameters

Responses