POST
/
timmi-timesheet
/
api
/
reports
curl --request POST \
  --url https://{host}/timmi-timesheet/api/reports \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '{
  "templateId": "<string>",
  "startsOn": "2023-12-25",
  "endsOn": "2023-12-25",
  "filters": [
    {
      "kind": "<string>",
      "values": [
        123
      ]
    }
  ]
}'
{
  "id": 123,
  "templateId": "<string>",
  "status": "pending",
  "name": "<string>",
  "startsOn": "2023-12-25",
  "endsOn": "2023-12-25",
  "filters": [
    {
      "kind": "<string>",
      "values": [
        123
      ]
    }
  ],
  "columns": [
    {
      "kind": "<string>",
      "name": "<string>",
      "category": "<string>",
      "isRequired": true,
      "isDefault": true,
      "isPeriodic": true
    }
  ]
}

Headers

​
Authorization
string
required

API key. Value must be formatted like so: lucca application={api_key}.

Body

application/json

A report is generated from an existing report-template, referenced by its unique identifier templateId.

Status

The generation of a report content is a background process. As long as this process is not complete, the report status stays pending. Once the report is complete, its status is set to done. May an error be encountered while generating its content, then its status is set to error.

The report content can only be viewed and downloaded once it is done.

Start & end dates

Start startsOn and end endsOn dates can be left null. In this case, default dates from the report-template are applied.

Filters

Filters are usually set in the report-template. But these can be overriden for a given report.

Fields

Response

201
application/json

Created

A report is generated from an existing report-template, referenced by its unique identifier templateId.

Status

The generation of a report content is a background process. As long as this process is not complete, the report status stays pending. Once the report is complete, its status is set to done. May an error be encountered while generating its content, then its status is set to error.

The report content can only be viewed and downloaded once it is done.

Start & end dates

Start startsOn and end endsOn dates can be left null. In this case, default dates from the report-template are applied.

Filters

Filters are usually set in the report-template. But these can be overriden for a given report.

Fields