RestApiCategories.visualInvestigator.desc

visual_investigator

2025.09

2025.10

2025.11

2025.12

The Data Hub API provides access to information that is managed by SAS Visual Investigator. This API facilitates describing data that resides in either internal writable databases or external customer-controlled read-only databases. Once the data definitions are provided as entity types, the data becomes accessible within SAS Visual Investigator. This API also provides mechanisms for fetching individual entity records that were defined by the entity type definitions. <br/> <br/>


Data Hub

2025.08

2025.03

2024.09

2024.03

Viya_35

Returns table metadata from a data store for the specified data store ID and table name.
This endpoint requires the "svi.administration.core_metadata" capability.


The ID of the data store from which to get the table.

dataStoreId

The name of the table from which to get the metadata.

tableName

Table Metadata

The request succeeded. The metadata for the table is returned.

The representation of an error. This schema is based on http://{SAS API Portal}/reference/schema/application/vnd.sas.error/v2/error2.json.


SAS Error

A data store with the specified ID was not found.

The Data Hub service serves all requests at this URL.


Get table metadata from a data store

The abstract parent class for expression types. Subclasses include the following expression types: <ul>
  <li>Arithmetic</li>
  <li>Boolean</li>
  <li>Conditional</li>
  <li>Field Reference</li>
  <li>Function Call</li>
  <li>Literal</li>
  <li>Logical</li>
  <li>Named Parameter</li>
  <li>String</li>
</ul>


Abstract Expression

A representation of an action against a document or link.
For example, an action could be: <ul>
  <li>Created the document</li>
  <li>Added a comment</li>
  <li>Deleted an attachment</li>
</ul>
This representation contains detailed information about the action. For example, field value changes that occur when a document is edited.


Action

A representation of an action against a document or link.
For example, an action could be: <ul>
  <li>Created the document</li>
  <li>Added a comment</li>
  <li>Deleted an attachment</li>
</ul>
The summary version of this representation omits detailed information about the action.


Action Summary

Action Summary Collection

Represents a table cell within a table action item.


Action Table Value

Represents a type of action that the client can filter on.


Action Type

Action Type Collection

Represents additional information about a historical version of a document. For example, showing that a change occurred to an insight.


Additional History Information

A collection of additional history information.


Additional History Information Collection

Arithmetic expression of the form: leftOperand operator rightOperand. The expression evaluates to a Boolean result.


Arithmetic Expression

Reserved for internal use. An abstract object for handling audit information.

Auditable Object

The abstract type that represents a conditional or a logical expression.

Boolean Expression

When performing a bulk Insert or Update operation on documents, this type represents the result that operation for an individual document. The result is either success or failure. If the error property is present, the operation failed. If there is no value in the error property, the operation was successful.


Bulk Operation Result

A list of bulk operation result items. Each item represents whether an operation succeeded or failed for an individual document.


Bulk Operation Result Collection

An individual cell on a workspace or an insight.

Cell

A representation of a single version of child document. This representation contains an array of values that compares field values between the previous and requested version of the child document.


Child Version

A representation of a single version of a child document. The summary version of this representation omits the comparison of field values between the requested and previous version of the child document.


Child Version Summary

A collection of child version summaries.


Child Version Summary Collection

columnDataType

Additional text on an internal document.
During an Update operation, all properties of a comment are read-only except the category. This is for security and audit purposes to keep historical data accurate.


Comment

Information about an author of a comment.

Comment Author

Contains the comment category name and the count of that category on the object.

Comment Category Summary

Comment Collection

The shared style icon properties for a condition. When the condition is true, the style is applied.


Common Style Properties

A conditional expression of the form: leftOperand operator rightOperands.


Conditional Expression

Reserved for internal use. An abstract object representing the metadata that all data object fields have in common.

Data Field

Reserved for internal use. An abstract object for representing an object that is associated with a data table.

Data Object

Information that is used for connecting to a database such as Oracle or SQL Server.

Data Store

The user name and password for a data store.

Data Store Credentials

Data Store Supported Type

The actual data that is associated with a particular Entity Type. Entity Types are the metadata and Documents are the data.


Document

A request to filter a collection of documents.

Document Filter Request

A request for a collection of documents by ID.

Document ID Request

The actual data that is associated with a particular Entity Type. Entity Types are the metadata and Documents are the data. The document is "enriched" with additional data such as comments, insights, and workspaces.


Enriched Document

Enriched Document Collection

The properties for styling an icon, nodes, and map pins for an entity type. The style is tied to a condition. When the condition is true, the style is applied.


Entity Style

The metadata that defines a class of entities. This definition includes a list of fields, language-specific labels, icons, and other relevant information.


Entity Type

A single field that is associated with an entity type object.

Entity Type Field

Entity Type Summary

A data object field that is used as an Expression in queries and SortCriteria.

Field Reference Expression

File Association Collection

The metadata for a file associated that is with a document. The actual file content is stored by the Files service.


File Association Object

An expression that makes a function call.


Function Call Expression

Icon

A Job describes a bundle of work to be performed asynchronously. It consists of one or more Tasks.

An action item representation that can be used to display a message to the user.


Label Action Item

Reserved for internal use. Abstract object that contains links to other resources.

Linkable Object

A literal value to be used in an expression.

Literal Expression

Reserved for internal use. An abstract object for handling the localizable label and description.

Localizable Object

The description text that is associated with a specific locale.

Localized Description

Localized Label

A logical expression of the form: leftOperand operator rightOperand. The expression evaluates to a Boolean result.


Logical Expression

A named parameter to use when creating parameterized queries for repeated calls.

Named Parameter Expression

Represents a list of choices that the user can select as the value for a field. Common examples might include "Size" (small, medium, large) or "Color" (red, green, blue). In the first example, "Size" is the list and (small, medium, large) are items of that list.


Reference List

Reference List Item

A link between two documents as defined by a relationship type.

Relationship Link

The properties for styling of links for a relationship type.

Relationship Style

The definition of a connection that can be established between two entities.

Relationship Type

Relationship Type Field

This is a base schema that is used to define paginated collections of resources. It is based on http://{SAS API Portal}/reference/schema/baseCollection/v2/baseCollection2.json. Other APIs can extend this base schema by adding an "items" array property. 


SAS Collection

A link to a related operation or resource. This schema is based on http://{SAS API Portal}/reference/schema/link/v1/link.json.


SAS Link

Contains a set of properties, each of which is a pair that consists of a string name and a string value. This schema is based on http://{SAS API Portal}/reference/schema/application/vnd.sas.properties/v1/properties.json.


SAS Properties

A pair that consists of a string name and a string value.  This is based on http://{SAS API Portal}/reference/schema/property/v1/property.json.


SAS Property

Sheet

Sheet Copy Selection

The results of a publish operation. This includes counts of how many items were published and a summary of any that failed.


Solution Publish Result

Detailed information about an item that was not successfully published.


Solution Publish Result Error

The results of a publish operation for a specific item type. This includes counts of how many items were published and a summary of any that failed.


Solution Publish Result Item

The criteria that specifies how to sort a collection.

Sort Criteria

A name (typically a field name) with an ordinal that indicates its position in a sequence.

Sortable Name Reference

An expression for performing operations on String operands.


String Expression

An action item representation of a sub-action that occurred inside the scope of an action. For example, the "Deleted child objects" action inside an "Edited the document" action.


Sub-Action Item

The information that describes an icon that contains SVG/XML data.

SVG Icon

An action item representation that can be used to present a table to the user.


Table Action Item

A Task is one unit of work that makes up a Job. It may succeed or fail independ of other Tasks in the same Job.

Task

The metadata that defines a class of transactions. This definition includes a "from" entity type, a "to" entity type, a date-time field, as well as on optional list of additional fields. A transaction, which is an instance of a transaction type, defines an action that was performed between two entities at a specific point in time.


Transaction Type

A single field that is associated with a transaction type object.

Transaction Type Field

A representation of a single historical version of document or link. This representation contains an array of values that compares field values between the previous and requested version of the document or link.


Version

A representation of a single historical version of document or link. The summary version of this representation omits the comparison of field values between the requested and previous version of the document or link.


Version Summary

Version Summary Collection

A comparison of a field value between the requested and previous version of a document or link.


Status	Meaning	Description
200	OK	The request succeeded. The metadata for the table is returned.		Schema
404	Not Found	A data store with the specified ID was not found.		Schema

Get table metadata from a data store

Request Samples

Response Samples

Path Parameters

Responses

Name	Type	Required	Description
dataStoreId	integer	true	The ID of the data store from which to get the table.
tableName	string	true	The name of the table from which to get the metadata.