Manage data and workflows and search and discovery

visual_investigator

2024.09

2024.10

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

2024.08

2024.03

2023.03

2023.10

2024.07

Viya_35

Attempts to connect to the data store that is specified in the request body.
This endpoint requires the "svi.administration.core_metadata" capability.


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

Data Store

The data store object that is used to test the connection.

The connection attempt was successful or connection testing has been disabled via the configuration settings.

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

Bad request. The possible causes are an invalid database type, an invalid database name, a missing host or port, or the inability to establish a socket connection. The error message and logs should clarify the issue. 


The Data Hub service serves all requests at this URL.


Test the connection to the data store that is in the request body

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

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

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


File Association Object

File Association Collection

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

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

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

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

Data Field

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

Linkable Object

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

Auditable Object

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

Localizable Object

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

Data Object

The description text that is associated with a specific locale.

Localized Description

Localized Label

The criteria that specifies how to sort a collection.

Sort Criteria

User Group Chooser Selection

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 request to process multiple condition evaluation requests at the same time.


Bulk Condition Evaluation Request

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


Bulk Condition Evaluation Response

The user name and password for a data store.

Data Store Credentials

Data Store Supported Type

Table Metadata

columnDataType

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


Masked Document

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

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


Masked Enriched Document

Enriched Document Collection

A collection of masked enriched documents.

Masked Enriched Document Collection

Document Collection

A collection of minimally-masked documents.

Minimally-Masked Document Collection

Masked Document Collection

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

Document and Link Bundle

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

Masked Document and Link Bundle

A request to filter a collection of documents.

Document Filter Request

A request for a collection of documents by ID.

Document ID Request

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

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

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


Arithmetic Expression

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

Boolean Expression

A conditional expression of the form: leftOperand operator rightOperands.


Conditional Expression

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

Field Reference Expression

An expression that makes a function call.


Function Call Expression

A literal value to be used in an expression.

Literal Expression

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

An expression for performing operations on String operands.


String Expression

A representation of the masking configuration for a single field.


Field Masking Configuration

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


Field Restriction

Represents all of the field restrictions of a datatype as a map of field name to field restriction object. The keys of this map are strings representing field names. The value mapped by each key is the Field Restriction object containing all the field restrictions for the field with that name.


Restricted Fields Map

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

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

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

A condensed summary of a Reference List object.


Reference List Summary

A Resource Collection that contains Reference List Summary objects.


Reference List Summary Collection

Reference List Item

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.

Relationship Link

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

Relationship Link Collection

A collection of masked relationship links.

Masked Relationship Link Collection

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

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

Relationship Type

Relationship Type Field

Sheet

An individual cell on a workspace or an insight.

Cell

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

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

Detailed information about an item that was not successfully published.


Solution Publish Result Error

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

Sortable Name Reference

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 properties for styling of links for a relationship type.

Relationship Style

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


Common Style Properties

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

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

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


Label Action Item

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


Table Action Item

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

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.


Name	Type	Required	Description
id	integer	false	The primary key that uniquely identifies this metadata object.
createdBy	string	false	The user ID that created this metadata object.
createdAt	string<date-time>	false	The timestamp that indicates when this metadata object was created.
lastUpdatedBy	string	false	The user ID that most recently modified this metadata object.
lastUpdatedAt	string<date-time>	false	The timestamp that indicates when this metadata object was last modified.
name	string	false	The name of the data store.
type	string	false	The type of the data store. Allowed value: RELATIONAL
defaultSchemaName	string	false	The default schema name to be used for the data store.
version	integer	false	The internal version number for this data store.
connectionType	string	false	The type of database the system. Allowed values: internal_postgrespostgresdb2MySQLoracleSQL Serverteradata
host	string	false	The host name for the database server.
port	string	false	The TCP/IP port number for connecting to the database server.
username	string	false	The user name for connecting to the database server.
password	string	false	The password for connecting to the database server.
databaseNameOrServiceName	string	false	The name of the database to which to connect.
schema	string	false	The name of the target schema within the database.
initialSize	integer	false	The initial starting size for the database connection pool.
maxIdle	integer	false	The maximum number of idle connections that are allowed in the connection pool.
minIdle	integer	false	The minimum number of idle connections that are allowed in the connection pool.
maxActive	integer	false	The maximum number of active connections that are allowed in the connection pool.
handle	string	false	A string that is used to group key/value pairs that belong to a single data store (analogous to a folder). When creating a data store, this value must be unique. No other data store can have the same "handle" value. It is the responsibility of the client to determine a unique value.
urlAppendedParameters	string	false	Additional JDBC connection parameters that are appended to the end of the connection string.
advancedProperties	SAS Properties	false	Additional properties that are needed by other modules while interacting with this data store. For example, when loading data into CAS, etc.
assignedTimeZone	string	false	The default timezone for timestamp values that are stored in the database.

Status	Meaning	Description
204	No Content	The connection attempt was successful or connection testing has been disabled via the configuration settings.
400	Bad Request	Bad request. The possible causes are an invalid database type, an invalid database name, a missing host or port, or the inability to establish a socket connection. The error message and logs should clarify the issue.		Schema

Test the connection to the data store that is in the request body

Request Samples

Response Samples

Request Body

Responses