Search And Discovery

The SAS Visual Investigator Search and Discovery API provides access to real-time exploration and visualization of the data in SAS Visual Investigator.

Root

Contains the operations for the root resource of this API.

Get a list of top-level links

Internal-Use OnlyReturns the links to the top-level resources for the API./

Get the headers for the API

Internal-Use OnlyReturns the headers for the API. Also used to determine whether the service provided by the API is available./

Search

Contains search related endpoints.

Perform a search

Internal-Use OnlyPerforms a new search, refines a previous search, or requests different visualizations of the results of a previous search./searches

Create highlighting for a single object

Internal-Use OnlyProduces highlighting snippets for a single object based on a given query./highlighting

Network

Contains network visualization related endpoints.

Generate a network

Internal-Use OnlyProvides access to the Network visualization. Returns a graph showing the objects that matched the search request as vertices and the relationships between them as edges./graphs

Find edges with additional summary information

Internal-Use OnlyPerforms a new search and returns edges with additional summary information. The response item media type is application/vnd.sas.sand.edge./graphs/edges

Get the details for a vertex

Internal-Use OnlyReturns additional information about a single vertex on the Network visualization. This is intended to be used to enhance the Network visualization after retrieving it from /graphs or /traversals; the response from which includes the values for this resource's parameters. The additional information includes the label, adjacent (number of vertices one edge away from this vertex), degree (number of edges entering and leaving the vertex), the adjacent count broken down by entity type, and the degree broken down by relationship type./vertices/{type}/{identifier}

Check the existence of a vertex

Internal-Use OnlyChecks the existence of an object. 200 OK is returned if the vertex exists and 404 Not Found if it does not exist./vertices/{type}/{identifier}

Calculate the centrality metrics for a network

Internal-Use OnlyCalculates the centrality metrics of each object on a network./centrality

Expand the relationships of one or more vertices

Internal-Use OnlyPerforms a breadth first graph search following all the relationships (edges) extending outwards from one or more objects (vertices) in the Network visualization. The initial objects whose relationships are to be traversed are found by executing the given query./traversals

Find matching paths from one or more start objects

Internal-Use OnlyPerforms a path search from one or more start objects. The desired path is described by a sequence of vertex and edge filters. Matching paths are returned as a list of endpoints, from the leaf vertex to the root vertex, since clients are typically most interested in the leaves, and the rest of the path provides contextual information. The response item media type is application/vnd.sas.sand.path. This endpoint is experimental and should be used only in test environments./paths

Find paths between the start and end objects up to a specified number of hops in length

Internal-Use OnlyPerforms a path search between the start and end objects. Matching paths are returned as a list of endpoints, from the leaf vertex to the root vertex, since clients are typically most interested in the leaves, and the rest of the path provides contextual information. The response item media type is application/vnd.sas.sand.path. This endpoint is experimental and should be used only in test environments./relatedObjects

Text Analytics

Contains text Analytics visualization related endpoints.

Start a new text analytics job

Internal-Use OnlyStarts a new background job that performs text analytics on the unstructured text in the objects found by the search. The job extracts significant terms, phrases, and topics as well as resolving named person, location, and organization entities. The response includes the unique identifier to be used with the related API endpoints to navigate the results./analytics

Get the locales supported by text analytics

Internal-Use OnlyReturns the name and BCP-47 language tag for each locale supported by text analytics./analytics/locales

Get the headers for the locales supported by text analytics

Internal-Use OnlyReturns the headers for the locales supported by text analytics./analytics/locales

Get the details of a text analytics job

Internal-Use OnlyReturns the state and parameters of a given text analytics job./analytics/{jobId}

Get the headers for a text analytics job

Internal-Use OnlyReturns the headers for a given text analytics job./analytics/{jobId}

Delete a text analytics job

Internal-Use OnlyDeletes a text analytics job before the user's session ends. Although jobs are automatically deleted when the session ends, this endpoint allows early deletion and canceling the job before deletion is not required./analytics/{jobId}

Get the state of a text analytics job

Internal-Use OnlyReturns the current state of a given text analytics job. The valid states are: pending, running, completed, completedWithErrors, cancelled, failed./analytics/{jobId}/state

Get the headers for the get state operation

Internal-Use OnlyReturns the headers for the get state operation./analytics/{jobId}/state

Cancel a text analytics job

Internal-Use OnlyCancels the specified text analytics job and returns the new job state./analytics/{jobId}/state

Get the identities found by a text analytics job

Internal-Use OnlyReturns the identity information for the person, organization, and location entities that were resolved by the text analytics job. Identities consist of an entity name, frequency count, and any known aliases./analytics/{jobId}/identities

Get the headers for the get identities operation

Internal-Use OnlyReturns the headers for the get identities operation./analytics/{jobId}/identities

Get the categories of text analytics results

Internal-Use OnlyReturns the categories of text analytics results that are available at the specified exploration level./analytics/{jobId}/categories

Get the text analytics results

Internal-Use OnlyReturns the text analytics results that are available at the specified exploration level./analytics/{jobId}/results

Generate text analytics Sankey diagram

Internal-Use OnlyRetrieves related text analytics results as a Sankey diagram. There are two types of Sankey diagram: 1) based on the pairs of values extracted from the "from" and "to" fields where nodes represent field values and links represent the objects containing the field values. 2) based on two categories of results where nodes represent the results of each category and links represent the objects containing results of both categories./analytics/{jobId}/sankeyDiagrams

Administration

Contains administration-related endpoints.

Perform an administration-related operation

Internal-Use OnlyPerforms any one of the currently supported operations: 1. refreshConfiguration refreshes or just returns the status of the configuration in the cache and underlying search engine with respect to the stored configuration. 2. makeIndexSearchable makes any newly populated indices searchable and deletes any older indices. See the example Use Case Five./admin/operations

Get multiple application settings

Internal-Use OnlyReturns the values of multiple application settings./admin/settings

Get the headers for the get settings operation

Internal-Use OnlyReturns the headers for the get settings operation./admin/settings

Update multiple application settings

Internal-Use OnlyUpdates the values of multiple application settings./admin/settings

Get an application setting

Internal-Use OnlyReturns the value of an application setting./admin/settings/{setting}

Get the headers for the get setting operation

Internal-Use OnlyReturns the headers for the get setting operation./admin/settings/{setting}

Update an application setting

Internal-Use OnlyUpdates the value of an application setting./admin/settings/{setting}

Configuration

Contains configuration-related endpoints.

Export configuration

Internal-Use OnlyReturns the configuration for all of the types. This is intended to be used for moving the configuration between systems and as such, there are no version numbers in the response./admin/config

Get the headers for the export configuration operation

Internal-Use OnlyReturns the headers for the export configuration operation./admin/config

Import configuration

Internal-Use OnlyImports the configuration for multiple types. This is designed for transferring configurations between systems; therefore, the request does not include version numbers, and any existing configuration are overwritten. If the new configuration contains breaking changes, such as the field type or events configuration has changed, the changes are saved but also require the data to be re-indexed to take effect. A localized message is included in the response if this is the case. The /admin/indices resource can be used to re-index the data./admin/config

Delete configuration

Internal-Use OnlyDeletes the configuration and indexed data for all types. This operation cannot be undone without first exporting the configuration and making a backup of the indexed data directly from the underlying search engine./admin/config

Get all of the supported analyzers

Internal-Use OnlyReturns the details of all of the custom and system analyzers./admin/config/analyzers

Get the headers for the get analyzers operation

Internal-Use OnlyReturns the headers for the get analyzers operation./admin/config/analyzers

Register a new custom analyzer

Internal-Use OnlyRegisters the name and display name of a custom analyzer. The request is rejected if an analyzer already exists with the same name./admin/config/analyzers

Unregister all of the custom analyzers

Internal-Use OnlyUnregisters all of the custom analyzers. System analyzers cannot be unregistered./admin/config/analyzers

Get a supported analyzer

Internal-Use OnlyReturns the details of a custom or system analyzer./admin/config/analyzers/{analyzer}

Get the headers for the get analyzer operation

Internal-Use OnlyReturns the headers for the get analyzer operation./admin/config/analyzers/{analyzer}

Update the display name of a custom analyzer

Internal-Use OnlyUpdates the display name of a custom analyzer. System analyzers cannot be updated./admin/config/analyzers/{analyzer}

Unregister a custom analyzer

Internal-Use OnlyUnregisters the name and display name of a custom analyzer. System analyzers cannot be unregistered./admin/config/analyzers/{analyzer}

Get all of the GeoJSON shapes

Internal-Use OnlyReturns the details of all of the reusable GeoJSON shapes./admin/config/shapes

Get the headers for the get shapes operation

Internal-Use OnlyReturns the headers for the get shapes operation./admin/config/shapes

Create a new GeoJSON shape

Internal-Use OnlyCreates a new reusable GeoJSON shape. The request is rejected if a GeoJSON shape already exists with the same identifier./admin/config/shapes

Delete all GeoJSON shapes

Internal-Use OnlyDeletes all of the reusable GeoJSON shapes./admin/config/shapes

Get a GeoJSON shape

Internal-Use OnlyReturns the details of a GeoJSON shape./admin/config/shapes/{shapeId}

Get the headers for the get GeoJSON shape operation

Internal-Use OnlyReturns the headers for the get GeoJSON shape operation./admin/config/shapes/{shapeId}

Update the details of a GeoJSON shape

Internal-Use OnlyUpdates the details of a GeoJSON shape./admin/config/shapes/{shapeId}

Deletes a GeoJSON shape

Internal-Use OnlyDeletes the details of a GeoJSON shape./admin/config/shapes/{shapeId}

Get the list of synonyms

Internal-Use OnlyReturns the list of synonyms for synonym searching./admin/config/synonyms

Get the headers for the get synonyms operation

Internal-Use OnlyReturns the headers for the get synonyms operation./admin/config/synonyms

Create the list of synonyms

Internal-Use OnlyCreates the list of synonyms for synonym searching. If there is an existing list, it is overwritten./admin/config/synonyms

Delete the list of synonyms

Internal-Use OnlyDeletes the list of synonyms for synonym searching./admin/config/synonyms

Get the configuration for all types

Internal-Use OnlyReturns the configuration for all of the types./admin/config/types

Get the headers for the get all type configuration operation

Internal-Use OnlyReturns the headers for the get all type configuration operation./admin/config/types

Create a new type

Internal-Use OnlyConfigures a new type. The request is rejected if a type already exists with the same name./admin/config/types

Get the configuration for a single type

Internal-Use OnlyReturns the configuration (including the current version number) for the specified type./admin/config/types/{type}

Check the existence of a type

Internal-Use OnlyChecks the existence of the specified type. 200 OK means that the type exists; 404 Not Found means that the type does not exist./admin/config/types/{type}

Update the configuration for a single type

Internal-Use OnlyUpdates the configuration for the specified type. The request is rejected unless the specified version number matches the current version. This is to ensure the latest version of the configuration is being edited and not an out-of-date version. If the new configuration contains breaking changes, such as the field type or events configuration has changed, the changes are saved, but also require the data to be re-indexed to take effect. A localized message is included in the response if this is the case. The /admin/indices resource can be used to re-index the data./admin/config/types/{type}

Delete the configuration for a single type

Internal-Use OnlyDeletes the configuration and indexed data for the specified type. This operation cannot be undone without first exporting the configuration and making a backup of the indexed data directly from the underlying search engine./admin/config/types/{type}

Gets the index format version

Internal-Use OnlyReturns the index format version that this service supports/admin/indices/version

Gets the headers for the get index format version operation

Internal-Use OnlyReturns the headers for the get index format version operation./admin/indices/version

Data

Contains indexed data-related endpoints.

Delete by query

Internal-Use OnlyDeletes all of the indexed objects and relationships matching the given query. If no request body is provided, then all of the indexed objects and relationships are deleted. This operation cannot be undone without first making a backup of the indexed data directly from the underlying search engine./admin/data

Delete relationships for an entity type

Internal-Use OnlyDeletes all relationships relating to the entity or transaction type. This does not apply to relationships involving resolved entities. This operation cannot be undone without first making a backup of the indexed data directly from the underlying search engine./admin/data/{type}/relationships

Index

Contains index related endpoints.

Create indices for all types

Internal-Use OnlyEnsures that an index exists for each configured type when the searchable query parameter is set to true, otherwise creates new unsearchable indices for each configured type. This is especially required when re-indexing data from a source database (see example Use Case Five). No errors are reported if the indices already exist. Returns the name of the newest index for each type./admin/indices

Delete the indices for all types

Internal-Use OnlyDeletes the indexes (and therefore indexed data) for all of the configured types. This operation cannot be undone without first making a backup of the indexed data directly from the underlying search engine. No errors are reported when indexes have already been deleted. If the intention is to reload the data after deleting all the indexes, one will need to make a POST request to /admin/indices to create empty indexes for all of the configured types prior to reloading the data./admin/indices

Get the index name for a single type

Internal-Use OnlyReturns the name of the index for the specified type. SAND is responsible for managing the underlying indexes but to index large amounts of data, it might be appropriate for other services to send the data straight to the underlying search engine. This resource provides access to the index name for such a case./admin/indices/{type}

Check the existence of an index for a single type

Internal-Use OnlyChecks the existence of an index for the specified type. 200 OK means that an index exists; 404 Not Found means there is no index./admin/indices/{type}

Create an index for a single type

Internal-Use OnlyEnsures that an index exists for the specified type when the searchable query parameter is set to true, otherwise creates a new unsearchable index. This is especially required when re-indexing data from a source database (see example Use Case Five). No errors are reported if the index already exists. Returns the name of the newest index for the specified type./admin/indices/{type}

Delete the indices for a single type

Internal-Use OnlyDeletes the index (and therefore indexed data) for a specified type. This operation cannot be undone without first making a backup of the indexed data directly from the underlying search engine. No error is reported when the index has already been deleted. If the intention is to reload the data after deleting the index, the recreate parameter should be set to true otherwise a POST request to /admin/indices/{type} will be required to create an empty index prior to reloading the data./admin/indices/{type}