MicroStrategy REST API API Documentation
Apply and execute the filters on a dossier instance
PUT {{baseUrl}}/api/dossiers/:dossierId/instances/:instanceId/filters?ignoreMissingFilter=false
Execute a specific dossier instance with an updated filter definition. It updates the instance of the dossier with the new filter definition applied. You need auth token from POST /auth/login, project Id from GET /projects, dossier instance ID generated by POST /dossiers/{dossierId}/instances and filter applied criteria in the request body.
Body
PARAM
| Key | Datatype | Required | Description |
ignoreMissingFilter
|
boolean | The ignoreMissingFilter controls the selector matches no found behavior, if true and no selector matches are found, then this filter input will NOT be applied and will be ignored, if false and no found, then the request will fail. |
HEADERS
| Key | Datatype | Required | Description |
X-MSTR-AuthToken
|
string | (Required) Authorization token | |
X-MSTR-ProjectID
|
string | (Required) Project ID | |
Content-Type
|
string |
RESPONSES
status
Curl
curl -X PUT 'baseUrl/api/dossiers/:dossierId/instances/:instanceId/filters?ignoreMissingFilter=false?ignoreMissingFilter=false' -H 'X-MSTR-AuthToken: authToken' -H 'X-MSTR-ProjectID: projectId' -H 'Content-Type: application/json' -d '{"0":{"key":"W132","name":"Year","summary":"Year In List 2014","source":{"id":"8D679D5111D3E4981000E787EC6DE8A4","type":12}}}'
ENDPOINTS