IWorkspaceAttributesService

Home > @gooddata/sdk-backend-spi > IWorkspaceAttributesService

IWorkspaceAttributesService interface

Service for querying additional attributes and attribute display forms data, and their elements.

Signature:

export interface IWorkspaceAttributesService 

Remarks

If you want to query attributes themselves, use catalog IWorkspaceCatalogFactory

Methods

Method	Description
elements()	Returns service that can be used to query attribute elements for attributes defined in this workspace.
getAttribute(ref, opts)	Gets metadata of the attribute.
getAttributeByDisplayForm(ref)	Gets metadata of the attribute for particular display form reference.
getAttributeDatasetMeta(ref)	Get information about the given attribute's dataset
getAttributeDisplayForm(ref)	Gets the attribute display form with the provided identifier.
getAttributeDisplayForms(refs)	Gets the list of metadata of attribute display form with the provided list of uris or identifiers. (list of object refs).
getAttributes(refs)	Gets the list of metadata of attribute with the provided list of uris. (list of object refs)
getAttributesQuery()	Attributes query factory.
getAttributesWithReferences(displayFormRefs)	Get attributes with their related objects, by their respective display forms.
getCommonAttributes(attributeRefs)	Request list of attributes that are "center of star" for the input attributes in the data model.
getCommonAttributesBatch(attributesRefsBatch)	Request the "center of star" for multiple series of attributes.
getConnectedAttributesByDisplayForm(ref)	Request list of attributes that have a connection with specified display form in the data model.
updateAttributeMeta(updatedAttribute)	Updates metadata of the attribute.