Logo
MicroStrategy REST API API Documentation

Read an attribute's relationships

GET {{baseUrl}}/api/model/systemHierarchy/attributes/:attributeId/relationships

The response returns the definition of a single attribute.

relationships is a read-only field and it returns the relationship(s) of this attribute as a set of tuples (pairs of related attributes) with their relationship type (1-N, 1-1, etc.) and corresponding relationship table. It contains the same information as GET systemHierarchy/attributes/{attributeId}/relationships. To update the relationship(s) of the attribute, use PUT systemHierarchy/attributes/{attributeId}/relationships.

The project ID is required to return an attribute's definition in the metadata. The changeset ID is required to return an attribute's definition within a specific changeset. To execute the request, either the project ID or changeset ID needs to be provided. If both are provided, only the changeset ID is used.

The changeset ID can be obtained using the changeset creation API. An authorization token is required to execute the request and can be obtained using Authentication endpoints.

 

Body PARAM

Key Datatype Required Description 



HEADERS

Key Datatype Required Description 
X-MSTR-AuthToken
string (Required) Authorization Token
X-MSTR-ProjectID
string (Project ID or Changeset ID Required) Project ID
X-MSTR-MS-Changeset
string (Project ID or Changeset ID Required) Changeset ID




RESPONSES

status





Curl
curl -X GET 'baseUrl/api/model/systemHierarchy/attributes/:attributeId/relationships' -H 'X-MSTR-AuthToken: authToken' -H 'X-MSTR-ProjectID: projectId' -H 'X-MSTR-MS-Changeset: rd_changesetId'

ENDPOINTS