Interface MetadataApi

This API provides the functionality related to retrieval of metadata.

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

Example

window.sas.vi.metadata.getEntityAccessRules(objectType);
interface MetadataApi {
    getAllValidRelationshipTypes(objectType: string, relationshipObjectType?: string, relationshipName?: string, flattenMultiLinkIntoSingles?: boolean): Promise<ValidRelationshipTypes>;
    getChildEntityTypes(objectType: string): Promise<StoredObjectDTO[]>;
    getEntitiesAccessRules(objectTypes: string[]): EntitiesAccessRules;
    getEntity(objectType: string): Promise<undefined | StoredObjectDTO>;
    getEntityAccessRules(objectType: string): EntityAccessRules;
    getField(objectType: string, fieldName: string): Promise<CoreStoredObjectField>;
    getIconForEntity(objectType: string, iconType?: string): undefined | string;
    getManagedEntityTypes(): Promise<StoredObjectDTO[]>;
    getReferenceData(name: string, options?: {
        constrainingListName?: string;
        parentCode?: string;
    }): Promise<undefined | Picklist>;
    getRelationshipsFilteredByEndType(endType: string, includeHeterogeneous?: boolean): Promise<RelationshipWithLabel[]>;
    getRelationshipsForObjectType(endType: string, options: OptionsForGetRelationshipsForObjectType): Promise<RelationshipWithLabel[]>;
    getResolvedEntities(): Promise<Entity[]>;
    getResolvedEntityMetadata(objectType: string): Promise<undefined | Entity>;
    getRootTypes(): Promise<StoredObjectDTO[]>;
    getSearchMetadata(): Promise<EntityMetadata>;
}

Hierarchy (view full)

Methods

getAllValidRelationshipTypes getChildEntityTypes getEntitiesAccessRules getEntity getEntityAccessRules getField getIconForEntity getManagedEntityTypes getReferenceData getRelationshipsFilteredByEndType getRelationshipsForObjectType getResolvedEntities getResolvedEntityMetadata getRootTypes getSearchMetadata

Methods

getAllValidRelationshipTypes

  • getAllValidRelationshipTypes(objectType, relationshipObjectType?, relationshipName?, flattenMultiLinkIntoSingles?): Promise<ValidRelationshipTypes>

  • Parameters

    • objectType: string

      {string} Finds relationships for the entity.

    • OptionalrelationshipObjectType: string

      {string} Used for filtering the name of an expected related entity.

    • OptionalrelationshipName: string

      {string} Used for filtering the name of an expected relationship.

    • OptionalflattenMultiLinkIntoSingles: boolean

      Whether Relationships with a One->(multiple) links will get flattened into many One->Single relationships.

    Returns Promise<ValidRelationshipTypes>

    A Promise resolving to an object containing relationship type metadata. The object is empty if no relationship types exist.

    Method

    Description

    Gets valid relationship types for a specified entity. If relationshipObjectType and RelationshipName are provided, the link types are filtered accordingly. Otherwise, all valid relationships related to the objectType are returned.

getChildEntityTypes

  • getChildEntityTypes(objectType): Promise<StoredObjectDTO[]>

  • Parameters

    • objectType: string

      {string} Checks for children for the named entity.

    Returns Promise<StoredObjectDTO[]>

    A Promise containing an array of child entity types or an empty list if none are found.

    Method

    Description

    Gets child entity types for a given entity.

getEntitiesAccessRules

  • getEntitiesAccessRules(objectTypes): EntitiesAccessRules

  • Parameters

    • objectTypes: string[]

      Entity names.

    Returns EntitiesAccessRules

    Object with a Promise of type EntityAccessRule[] for each rule, where EntityAccessRule maps to the access rule of a given entity name.

    Method

    Description

    Gets create, read, and update access rights for the provided entities via batch call.

getEntity

  • getEntity(objectType): Promise<undefined | StoredObjectDTO>

  • Parameters

    • objectType: string

      {string} Entity name.

    Returns Promise<undefined | StoredObjectDTO>

    A Promise containing the entity metadata.

    Method

    Description

    Checks access rights and gets metadata for an entity. Returns undefined if the entity does not exist.

getEntityAccessRules

  • getEntityAccessRules(objectType): EntityAccessRules

  • Parameters

    • objectType: string

      {string} Entity name.

    Returns EntityAccessRules

    Object with a Promise of type boolean for each rule.

    Method

    Description

    Gets create, read, and update access rights for an entity.

getField

  • getField(objectType, fieldName): Promise<CoreStoredObjectField>

  • Parameters

    • objectType: string

      {string} Entity name.

    • fieldName: string

      {string} Field name.

    Returns Promise<CoreStoredObjectField>

    A Promise containing the field metadata.

    Method

    Description

    Gets metadata for an entity field.

getIconForEntity

  • getIconForEntity(objectType, iconType?): undefined | string

  • Parameters

    • objectType: string

      {string} Entity name.

    • OptionaliconType: string

      {string} Icon type. If iconType is not provided it is set to REGULAR by default.

    Returns undefined | string

    A string containing the icon path. Returns undefined if objectType is empty.

    Method

    Description

    Gets the icon path for an entity.

getManagedEntityTypes

  • getManagedEntityTypes(): Promise<StoredObjectDTO[]>

  • Returns Promise<StoredObjectDTO[]>

    A Promise containing an array of managed entity types.

    Method

    Description

    Gets managed entity types.

getReferenceData

  • getReferenceData(name, options?): Promise<undefined | Picklist>

  • Parameters

    • name: string

      Reference data list name.

    • Optionaloptions: {
          constrainingListName?: string;
          parentCode?: string;
      }

      Object containing name and filter constraints. If constrainingListName is defined, then the refDataName parameter is ignored. parentCode is used to filter list items to those that are children of this list name.

      • OptionalconstrainingListName?: string
      • OptionalparentCode?: string

    Returns Promise<undefined | Picklist>

    Promise containing the reference data or undefined if none exists.

    Method

    Description

    Gets reference data with the given name.

getRelationshipsFilteredByEndType

  • getRelationshipsFilteredByEndType(endType, includeHeterogeneous?): Promise<RelationshipWithLabel[]>

  • Parameters

    • endType: string

      {string} End type entity name.

    • OptionalincludeHeterogeneous: boolean

      {boolean} Boolean value to determine whether heterogeneous relationships are included.

    Returns Promise<RelationshipWithLabel[]>

    A Promise resolving to a list of relationships, or an empty list if none are found.

    Deprecated

    Method

    Description

    Gets relationships with a specified end type.

getRelationshipsForObjectType

getResolvedEntities

  • getResolvedEntities(): Promise<Entity[]>

  • Returns Promise<Entity[]>

    A Promise containing an array of the resolved entities metadata.

    Method

    Description

    Gets metadata for all resolved entities.

getResolvedEntityMetadata

  • getResolvedEntityMetadata(objectType): Promise<undefined | Entity>

  • Parameters

    • objectType: string

      {string} Resolved Entity Name.

    Returns Promise<undefined | Entity>

    A Promise containing resolved entity metadata or undefined if none exists.

    Method

    Description

    Gets metadata for a resolved entity.

getRootTypes

  • getRootTypes(): Promise<StoredObjectDTO[]>

  • Returns Promise<StoredObjectDTO[]>

    A Promise containing an array of root types.

    Method

    Description

    Gets root type entities that are not child types.

getSearchMetadata

Settings

Member Visibility

On This Page

Methods