Gamma API
ProgressObjects

List tracked objects

GET
/api/projects/{projectId}/objects

The most recently statused first, each with the project's metadata columns read from its model. The trash (deleted=true) also takes the object.update permission.

Who may call it: Anyone on the project whose permission profile allows object.read. API keys: yes, given object.read for this project.

Authorization

cookiegamma.session_token<token>

The session cookie a sign-in sets. Over HTTPS its name carries the __Secure- prefix. Browsers send it on their own; other clients keep it from the sign-in response.

Path Parameters

projectId*string

The project's id.

Query Parameters

page?integer
Range1 <= value <= 9007199254740991
Default1
pageSize?integer
Range1 <= value <= 100
Default50
q?string

Matched in the GlobalId, name or category, ignoring case.

Lengthlength <= 200
categoryId?string

Only elements holding a status in this category.

Length1 <= length <= 100
valueId?string

Only elements holding this status value.

Length1 <= length <= 100
modelId?string

Only elements on this model or statused on it — with categoryId or valueId, that status set on it.

Length1 <= length <= 100
objectIds?string

Only these elements, up to 100 GlobalIds separated by commas: what the viewer has picked.

Lengthlength <= 20000
deleted?string

true lists the trash instead of the live elements.

Value in"true""false"

Response Body

OK.

application/json
  1. response
objects*array<>
total*integer

How many match the filters, every page.

Range-9007199254740991 <= value <= 9007199254740991
page*integer
Range-9007199254740991 <= value <= 9007199254740991
pageSize*integer
Range-9007199254740991 <= value <= 9007199254740991
Example Request
curl -X GET 'http://localhost:3000/api/projects/string/objects'
Example Response
{  "objects": [    {      "id": "string",      "objectId": "string",      "name": "string",      "category": "string",      "modelId": "string",      "modelVersionId": "string",      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z",      "deletedAt": "2019-08-24T14:15:22Z",      "deletedById": "string",      "deleteReason": "string",      "statuses": [        {          "categoryId": "string",          "valueId": "string",          "modelId": "string",          "modelVersionId": "string",          "viewpoint": null,          "updatedById": "string",          "updatedAt": "2019-08-24T14:15:22Z"        }      ],      "columns": {        "property1": "string",        "property2": "string"      }    }  ],  "total": -9007199254740991,  "page": -9007199254740991,  "pageSize": -9007199254740991}