MicroStrategy REST API API Documentation
Get an single script info
GET {{baseUrl}}/api/scripts/:id
Get an single script info.You obtain the authorization token needed to execute the request using POST /auth/login; you pass the authorization token in the request header. You specify script id in the path of the request, then you can obtain the script information about its base info(such as name, id and type), script type and script content.
Body
PARAM
| Key | Datatype | Required | Description |
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
status OK
| {
"name": "Test Script",
"id": "94D7E8D847416582161F66A32D978F44",
"type": 76,
"description": "Test script description",
"subtype": 19457,
"dateCreated": "2022-02-12T04:09:38.000+0000",
"dateModified": "2022-03-21T19:24:06.000+0000",
"version": "51F72FE6094ED0D97304CD80206D60F9",
"acg": 255,
"owner": {
"name": "MSTR User",
"id": "7FC05A65473CE2FD845CE6A1D3F13233"
},
"acl": [
{
"deny": false,
"type": 1,
"rights": 199,
"trusteeId": "294DEDC011D2F1D56000D98E67019608",
"trusteeName": "Public / Guest",
"trusteeType": 34,
"trusteeSubtype": 8705,
"inheritable": false
},
{
"deny": false,
"type": 1,
"rights": 199,
"trusteeId": "C82C6B1011D2894CC0009D9F29718E4F",
"trusteeName": "Everyone",
"trusteeType": 34,
"trusteeSubtype": 8705,
"inheritable": false
},
{
"deny": false,
"type": 1,
"rights": 255,
"trusteeId": "54F3D26011D2896560009A8E67019608",
"trusteeName": "Administrator",
"trusteeType": 34,
"trusteeSubty Curl curl -X GET 'baseUrl/api/scripts/:id?fields=' -H 'X-MSTR-AuthToken: authToken' -H 'X-MSTR-ProjectID: projectId' ENDPOINTS |