Logo
MicroStrategy REST API API Documentation

Get list of translations

GET {{baseUrl}}/api/objects/:type/:id/translations

Get translations for a specific object in a specific project. You identify the object with the object ID and object type. You obtain the authorization token needed to execute the request using POST /auth/login; you obtain the project ID using GET /projects. You pass the authorization token and the project ID in the request header. You specify the object ID in the path of the request. You specify the object type as a query parameter; possible values for object type are provided in EnumDSSXMLObjectTypes.

 

Body PARAM

Key Datatype Required Description 
offset
number Starting point within the collection of returned results. Used to control paging behavior.
limit
number Maximum number of items returned for a single request. Used to control paging behavior. Use -1 for no limit.
fields
null Comma-separated, top-level field whitelist that allows the client to selectively retrieve part of the response model. If specified, extra filtering is applied, and for top-level object (if root model is an array, each array element), only the listed fields are kept in the response. For example, "id,elements" keeps only the "id" field and whole "elements" array field, omitting all other fields in the top-level response model.



HEADERS

Key Datatype Required Description 
X-MSTR-AuthToken
string (Required) Authorization token
X-MSTR-ProjectID
string (Required) Project ID




RESPONSES

Curl
curl -X GET 'baseUrl/api/objects/:type/:id/translations?offset=0&limit=-1&fields=' -H 'X-MSTR-AuthToken: authToken' -H 'X-MSTR-ProjectID: projectId'

ENDPOINTS