Get an application object by application ID

GET {{baseUrl}}/api/v2/applications/:id

Get an application object by application id, which contains name, description, generalSettings, homeScreenSettings, etc.

Request Params

KeyDatatypeRequiredDescription
outputFlagstringSpecify what should be included or filtered out of the application output
fieldsnullComma-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

KeyDatatypeRequiredDescription
X-MSTR-AuthTokenstring(Required) Authorization token

RESPONSES

status: OK

{"id":"C2B2023642F6753A2EF159A75E0CFF29","projectId":"38A062302D4411D28E71006008960167","name":"MicroStrategy","description":"This is the default application for viewing content in MicroStrategy Library. The application can be customized or used as is.","type":78,"dateCreated":"2021-10-30T18:23:15.983+0000","dateModified":"2021-10-30T18:24:41.935+0000","objectVersion":"979281A2BA475E38F4D0E69DCFD5199E","ownerId":"54F3D26011D2896560009A8E67019608","parentObjectId":"4B979645463C14EF5A32EF8A032C9AC1","schemaVersion":2,"general":{"disableAdvancedSettings":false,"disablePreferences":false,"networkTimeout":180,"cacheClearMode":1,"clearCacheOnLogout":false,"maxLogSize":500,"logLevel":12,"updateInterval":-1},"homeScreen":{"mode":0,"homeDocument":{"url":"","icons":["table_of_contents","bookmarks","reset","filters","comments","share"],"toolbarMode":0,"toolbarEnabled":true},"homeLibrary":{"contentBundleIds":[],"icons":["sidebars","sort_and_filter","multi_select","search","notifications","options"],"toolbarMode":0,"sidebars":["all","favorites","recents","default_groups","my_groups","options"],"toolbarEnabled":true,"defaultGroupsName":"Default Groups"}},"platforms":["mobile","web","desktop"],"isDefault":true}