Interface RefDataApi

This API provides functionality related to retrieving reference data.

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

Example

window.sas.vi.refData.getReferenceLists();

interface RefDataApi {
    getReferenceHierarchies(): Promise<HierarchicalList[]>;
    getReferenceHierarchy(name: string, includeArchived?: boolean): Promise<HierarchicalList>;
    getReferenceList(name: string, includeArchived?: boolean): Promise<ReferenceList>;
    getReferenceLists(): Promise<ReferenceList[]>;
}

Index

Methods

getReferenceHierarchies getReferenceHierarchy getReferenceList getReferenceLists

Methods

getReferenceHierarchies

getReferenceHierarchies(): Promise<HierarchicalList[]>
Returns Promise<HierarchicalList[]>
Promise containing the array of reference data hierarchies.

Method
Description
Gets all reference data hierarchies.

getReferenceHierarchy

getReferenceHierarchy(name, includeArchived?): Promise<HierarchicalList>
Parameters
- name: string
  {name} Name of the reference data hierarchy.
- OptionalincludeArchived: boolean
  {boolean} Boolean to determine if an archived hierarchy can be returned.
Returns Promise<HierarchicalList>
Promise containing the reference data hierarchy.

Method
Description
Gets reference data hierarchy with the given name.

getReferenceList

getReferenceList(name, includeArchived?): Promise<ReferenceList>
Parameters
- name: string
  {string} Name of the reference data list.
- OptionalincludeArchived: boolean
  {boolean} Boolean to determine if an archived list can be returned.
Returns Promise<ReferenceList>
Promise containing the reference data list.

Method
Description
Gets reference data list with the given name.

getReferenceLists

getReferenceLists(): Promise<ReferenceList[]>
Returns Promise<ReferenceList[]>
Promise containing the array of reference data lists.

Method
Description
Gets all reference data lists.