This section of the API relates to reference data.

interface SmiReferenceDataApi {
    getReferenceData(listName: string, includeArchived: boolean, parentCode?: string): Promise<SmiProcessedReferenceData>;
}

Methods

  • Method to return the reference data for the given listName.

    Parameters

    • listName: string

      {string} The reference data list name.

    • includeArchived: boolean

      {boolean} Whether the archived values are to be included in the response. Used in edit mode.

    • OptionalparentCode: string

      {string} The code for a parent reference data field. Optional.

    Returns Promise<SmiProcessedReferenceData>

    A promise that resolves to the reference data.

    window.sas.smi.metadata.referenceData.getReferenceData("my_list", false)
    .then((response) => displayItems(response.items))