Get elements for a specific attribute in a specific report
GET {{baseUrl}}/api/reports/:reportId/attributes/:attributeId/elements?offset=0&limit=1000
Get a list of elements for a specific attribute in a specific report in a specific project. 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 pass the report ID, and the attribute ID in the path of the request. You use the offset and limit query parameters to control paging behavior; the offset parameter specifies where to start returning results, and the limit parameter specifies how many results to return. You use the searchPattern query parameter to define a search pattern to apply, such as Begins With or Exactly. A list of Base Form IDs can be passed in as query parameter to specify what forms of elements be returned. If base form IDs not specified, all browse form values in the report are returned.
Body
PARAM
| Key | Datatype | Required | Description |
baseFormIds
|
string | Attribute Base Form IDs | |
baseFormIds
|
string | Attribute Base Form IDs | |
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. | |
searchPattern
|
string | Search pattern | |
fields
|
string | 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 | Curl curl -X GET 'baseUrl/api/reports/:reportId/attributes/:attributeId/elements?offset=0&limit=1000?baseFormIds=est laborum aliquip&baseFormIds=occaecat sed&offset=0&limit=1000&searchPattern=sed minim&fields=sed minim' -H 'X-MSTR-AuthToken: authToken' -H 'X-MSTR-ProjectID: projectId' ENDPOINTS |