Gamma API
ProgressObjects

Export the status report in the background

POST
/api/projects/{projectId}/objects/exports

The CSV of GET …/objects/export.csv, built in the background and without its cap on rows. scopeId and untracked read the models' elements, so they also take the model.read permission. Answers at once with the queued job; the caller is told in the app and by email when the file is ready, and fetches it from GET …/exports/:jobId.

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

lang?string

The file's language; else the caller's own setting, else Accept-Language.

Request Body

application/json
  1. body
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.

Length1 <= length <= 100
scopeId?string

Only the elements of this dashboard scope.

Length1 <= length <= 100
untracked?boolean

Adds a row for each element holding no status: the scope's, or every model's without one.

Defaultfalse
tz?string

An IANA time zone for the dates and the file name; UTC when not one.

Lengthlength <= 100

Response Body

Created.

application/json
  1. response
export*
Example Request
curl -X POST 'http://localhost:3000/api/projects/string/objects/exports' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "export": {    "id": "string",    "status": "queued"  }}