Create a shortcut object
POST {{baseUrl}}/api/objects/:id/type/:type/shortcuts
Create shortcut object for a specific object in a specific project. You obtain the authorization token needed to execute the request using POST /auth/login and the project ID using GET /projects; you pass the authorization token and the project ID in the request header. You identify the target object you are creating shortcut for with the object ID and type in the path of the request. You also specify the destination folder in request body.
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 | Project ID | |
Content-Type
|
string |
RESPONSES
status OK
{
"name": "",
"id": "1B3992B84B43C4D375BC19BFE4E9AD40",
"type": 18,
"subtype": -1,
"dateCreated": "1970-01-01T00:00:00.000+0000",
"dateModified": "1970-01-01T00:00:00.000+0000",
"version": "",
"acg": 0,
"acl": [
{
"deny": false,
"type": 1,
"rights": 255,
"trusteeId": "7FC05A65473CE2FD845CE6A1D3F13233",
"trusteeName": "MSTR User",
"trusteeType": 34,
"trusteeSubtype": 8704,
Curl curl -X POST 'baseUrl/api/objects/:id/type/:type/shortcuts?fields=' -H 'X-MSTR-AuthToken: authToken' -H 'X-MSTR-ProjectID: projectId' -H 'Content-Type: application/json' -d '{"folderId":"publicObjectsFolderId"}' ENDPOINTS |