Interface TraversalApi

This API provides functionality related to traversal data.

Accessed from the window at window.sas.vi.traversal.

Example

window.sas.vi.traversal.getTraversals();
interface TraversalApi {
    getFieldsByTraversals(rootObjectId: string, rootObjectType: string, traversalUuids: string[], destinationObjectType: string, fields: string[], options?: {
        includeDisplayLabels?: boolean;
    }): Promise<SviRecord[]>;
    getTraversalByUuid(uuid: string): Promise<Traversal>;
    getTraversals(): Promise<TraversalWithEndpoint[]>;
}

Methods

getFieldsByTraversals getTraversalByUuid getTraversals

Methods

getFieldsByTraversals

  • getFieldsByTraversals(rootObjectId, rootObjectType, traversalUuids, destinationObjectType, fields, options?): Promise<SviRecord[]>

  • Parameters

    • rootObjectId: string

      {string} Traversal's root object ID.

    • rootObjectType: string

      {string} Traversal's root object Type.

    • traversalUuids: string[]

      {string[]} Array of traversal UUIDs associated with the root object type.

    • destinationObjectType: string

      {string} Destination object's type.

    • fields: string[]

      {string[]} Names of the fields to be retrieved.

    • Optionaloptions: {
          includeDisplayLabels?: boolean;
      }

      {object} Optional object containing options: includeDisplayLabels.

      • OptionalincludeDisplayLabels?: boolean

    Returns Promise<SviRecord[]>

    Promise containing the array of objects with specified fields and their values.

    Method

    Description

    Gets field values from a list of traversals.

getTraversalByUuid

  • getTraversalByUuid(uuid): Promise<Traversal>

  • Parameters

    • uuid: string

      {string} UUID of the traversal to be returned.

    Returns Promise<Traversal>

    Promise containing the specified traversal.

    Method

    Description

    Gets a traversal with the specified UUID parameter.

getTraversals

Settings

Member Visibility

On This Page

Methods