Get info for a specific object
GET {{baseUrl}}/api/objects/:id?type=-72217378&fields=Excepteur Lorem
Get information for a specific object in a specific project; if you do not specify a project ID, you get information for the object in all projects. You identify the object with the object ID and object type. 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 specify the object ID in the path of the request. You specify the object type as a query parameter; possible values for object type are provided in EnumDSSXMLObjectTypes.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
type | number | (Required) Object type, which corresponds to a value from EnumDSSXMLObjectTypes | |
fields | string | Comma separated top-level field whitelist. This allows client to selectively retrieve part of the response model. If specified, extra filtering will be applied, and for top-level object (if root model is an array, each array element), only the listed fields will be kept in the response. e.g. "id,elements" means to keep only the "id" field and the whole "elements" array field, omitting all other fields of top-level response model. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
X-MSTR-AuthToken | string | (Required) Authorization token | |
X-MSTR-ProjectID | string | Project ID |
RESPONSES
status: OK
{"id":"deserunt Ex","name":"et exercitation cupidatat","type":3326359,"abbreviation":"Duis Excepteur","description":"est velit","subtype":97264998,"dateCreated":"1966-06-22T13:05:40.361Z","dateModified":"1947-05-13T06:14:48.836Z","version":"amet in","acg":19172667,"owner":{"name":"pariatur cillum occaec","id":"aliqua nisi"},"acl":[{"deny":false,"type":-30260368,"rights":-56144932,"trusteeId":"irure cillum magna elit","trusteeName":"aliquip","trusteeType":-31133611,"trusteeSubtype":-35937568,"inheritable":false},{"deny":true,"type":29639912,"rights":8084611,"trusteeId":"sed pariatur i","trusteeName":"tempor","trusteeType":54714589,"trusteeSubtype":-91988293,"inheritable":true}],"source":{"type":["MSTR","MSTR"]},"hidden":true,"extType":-98482099,"iconPath":"occaecat","viewMedia":68154772,"ancestors":[{"name":"elit quis in","id":"labore","level":-62106881},{"name":"enim esse","id":"dolore sint adipisicing consequat","level":17849201}],"certifiedInfo":{"certified":true,"dateCertified":"2004-03-28T03:09:56.761Z","certifier":{"id":"voluptate irure aute","username":"officia irure dolore","fullName":"quis ex do amet"}},"comments":["ex elit amet","Lorem proident sint"],"projectId":"Excepteur mollit ea","targetInfo":{"id":"amet proident","name":"commodo aliquip","type":-49666379,"abbreviation":"in in ullamco reprehender","description":"aute adipisicing enim","subtype":-41314791,"dateCreated":"1945-07-18T08:05:11.490Z","dateModified":"1963-10-18T15:10:54.920Z","version":"labore dolore","acg":-30645201,"owner":{"name":"proident deserunt","id":"cupidatat consequat dolore dolor reprehenderit"},"acl":[{"deny":true,"type":30802181,"rights":28915673,"trusteeId":"velit culpa ipsum nostrud veniam","trusteeName":"culpa elit ut","trusteeType":13879312,"trusteeSubtype":-67454328,"inheritable":false},{"deny":true,"type":-25676574,"rights":-97558935,"trusteeId":"dolore","trusteeName":"amet laboris","trusteeType":25323281,"trusteeSubtype":68065805,"inheritable":false}],"source":{"type":["MSTR","MSTR"]},"hidden":false,"extType":-56714509,"iconPath":"aute in","viewMedia":-29575690,"ancestors":[{"name":"D","id":"minim","level":-89099406},{"name":"inc","id":"labore officia irure occaecat","level":24648787}],"certifiedInfo":{"certified":true,"dateCertified":"2009-07-24T22:34:22.700Z","certifier":{"id":"magna ","username":"ad incididunt","fullName":"esse nisi"}},"comments":["veniam dolore irure","in incididunt in"],"projectId":"voluptate minim cillum","targetInfo":{"value":"\u003cCircular reference to #/components/schemas/ObjectInfo detected\u003e"}}}