RestApiCategories.visualInvestigator.desc

visual_investigator

2025.09

2025.10

2025.11

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

2025.03

2024.09

2024.03

Viya_35

Retrieves headers for a document by ID. Both internal and external documents can be read.


The name of the entity type to which the document belongs.

entityTypeName

documentId

The depth of child documents to return. Valid values are: <ul>
  <li>'0' - No child documents are included in each document</li>
  <li>'1' - Child documents are included in each document if they exist for that document</li>
</ul>


depth

Indicates whether to generate and include the display label in the document.

includeDisplayLabel

The Data Hub service serves all requests at this URL.


Get headers for a document by ID

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. If the field value is masked, the representation includes a field restriction object containing some additional masking metadata for the field value.


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

A request to process multiple condition evaluation requests at the same time.


Bulk Condition Evaluation Request

The results from processing a bulk condition evaluation request. Individual requests succeed and fail independently, and successes are reported alongside failures in the responses.


Bulk Condition Evaluation Response

When performing a bulk Insert or Update operation on documents, this type represents the result from 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

A representation of the set of client field properties that have been set for the given field.


Client Field Properties

Represents all of the client field properties of a data type as a map of the field name to its corresponding extended field properties object. The keys of this map are strings representing field names. The value mapped by each key is an Extended Field Properties object containing all the client field properties for the field with that name corresponding to the field's data type (if applicable).


Client Field Properties Field-Name Map

Represents a bundle of client field properties for related data object types, as a map of object type name to a Field Properties Map object. The keys of this map are strings representing object type names. The value mapped by each key is the Field Properties Field-Name Map object  for that data object type.


Client Field Properties Object Map

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 request to evaluate a condition against a specific object.


Condition Evaluation Request

The response that is generated when a condition is evaluated against an object.


Condition Evaluation Response

A conditional expression of the form: leftOperand operator rightOperands.


Conditional Expression

This type represents an individual result from counting the relationship links for a document. The "linkCount" property contains the total number of links that were found for each type. There will be one entry for each "to" entity type. Note that if the relationship type is  heterogeneous, then the "from" entity type will have a value, but the "to" entity type will be null.


Count Links Result

A list of count links result items. Each item provides a count of the number of links between the "from" entity and other entities of a specific type.


Count Links Result Collection

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. If a field is masked, its value will not appear in the `fieldValues` object.


Document

A representation that bundles together an Enriched Document and a Relationship Link.

Document and Link Bundle

Document Collection

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 representation of the masking configuration for a single field.


Field Masking Configuration

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

Field Reference Expression

A representation of the set of field restrictions that are applied to a single field. Not every type of restriction applies to every field. For example, the "maxLength" restriction does not apply to numerical fields, but "precision" and "scale" might. Note that many endpoints documented in this REST API populate only a subset of these field restrictions (often only "masked").


Field Restriction

Represents a bundle of field restrictions for related data object types, as a map of object type name to Restricted Fields Map object. The keys of this map are strings representing object type names. The value mapped by each key is the Restricted Fields Map object for that data object type. The purpose of this representation is to allow the field restrictions for a top-level entity type to be bundled with the field restrictions for all of its child entity types, in one map. In this case, the top-level entity name and the child entity names will all be sibling keys in the Field Restrictions Bundle map.


Field Restrictions Bundle

A representation of a single field value. The value is represented under the "raw" property of this object.


Field Value

Field Value Collection

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.

A specification of changes to make to an object. It consists of an array of patch operations.


JSON Patch

Specifies a patch operation that adds a value.


JSON Patch Add Operation

Specifies a patch operation that copies a value from one location to another.


JSON Patch Copy Operation

Specifies a patch operation that moves a value from one location to another.


JSON Patch Move Operation

Specifies a patch operation that removes a value.


JSON Patch Remove Operation

Specifies a patch operation that replaces a value.


JSON Patch Replace Operation

Specifies a patch operation that tests a value.


JSON Patch Test Operation

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


Label Action Item

When performing a bulk Insert or Update operation on links, this type represents the result from that operation for an individual link. 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.


Link Bulk Operation Result

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


Link Bulk Operation Result Collection

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 representation of a Document that has masked field values replaced with dot characters. Fields not configured to be masked are represented normally.


Masked Document

A representation that bundles together a Masked Enriched Document and a Masked Relationship Link.

Masked Document and Link Bundle

Masked Document Collection

A representation of an Enriched Document that has masked field values replaced with dot characters. Fields not configured to be masked are represented normally.


Masked Enriched Document

A collection of masked enriched documents.

Masked Enriched Document Collection

A representation of a relationship link that has masked field values replaced with dot characters. Fields not configured to be masked are represented normally.


Masked Relationship Link

A collection of masked relationship links.

Masked Relationship Link Collection

A representation of a Document that has the minimal amount of field masking applied. That is, for each masked field, if the requesting user is authorized to reveal its value, the value is unmasked in this representation. Otherwise, the value will remain masked.


Minimally-Masked Document

A collection of minimally-masked documents.

Minimally-Masked Document Collection

A representation of an Enriched Document that has the minimal amount of field masking applied. That is, for each masked field, if the requesting user is authorized to reveal its value, the value is unmasked in this representation. Otherwise, the value will remain masked.


Minimally-Masked Enriched Document

A representation of a Relationship Link that has the minimal amount of field masking applied. That is, for each masked field, if the requesting user is authorized to reveal its value, the value is unmasked in this representation. Otherwise, the value will remain masked.


Minimally-Masked Relationship Link

A collection of minimally-masked Relationship Links.

Minimally-Masked Relationship Link Collection

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

Named Parameter Expression

The information that describes a node decoration.

Node Decoration

A representation of the set of client field properties that have been set for the given number field.


Number Field Properties

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 condensed summary of a Reference List object.


Reference List Summary

A Resource Collection that contains Reference List Summary objects.


Reference List Summary Collection

A link between two documents as defined by a relationship type. If a field is masked, its value will not appear in the `fieldValues` object.

Status	Meaning	Description
200	OK	The request succeeded.
400	Bad Request	The request was invalid.
404	Not Found	The document was not found.

Get headers for a document by ID

Request Samples

Response Samples

Path Parameters

Query Parameters

Responses

Name	Type	Required	Description
documentId	string	true	The ID for the document.
entityTypeName	string	true	The name of the entity type to which the document belongs.

Name	Type	Required	Description
depth	string	false	The depth of child documents to return. Valid values are: Default: 0
includeDisplayLabel	boolean	false	Indicates whether to generate and include the display label in the document. Default: false