TimeEntries update service

Before using this service

This service is aimed at updating a given user TimeEntries easily, as it automatically detects and applies changes needed to transform whatever TimeEntries might currently exist to what you send it. It create, edit, or delete TimeEntries. An algorithm tries to match and update any existing TimeEntries, but it might wipe clean TimeEntries before adding new ones.

There are different ways to update TimeEntries. Please see this guide for a guide on how to update TimeEntries the right way depending on your use case.

How to use

It will create, edit, or delete existing TimeEntries for a given period and owner to match the TimeEntries of the request body.

The request body is an array of ‘simplified’ TimeEntries, please see the API reference for a TimeEntry model for additional information and main validation rules.

Here the TimeEntry id field is optional as the matching algorithm does not take it into account.

PUT

timmi-timesheet

services

time-entries

curl --request PUT \
  --url https://{host}/timmi-timesheet/services/time-entries \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '[
  {
    "owner": {
      "id": 123
    },
    "startsAt": "2024-05-06T00:00:00",
    "duration": {
      "iso": "PT4H"
    },
    "comment": null,
    "timeSource": "manual",
    "unit": "duration",
    "timeType": null,
    "axisSections": [
      {
        "id": 41
      },
      {
        "id": 127
      },
      {
        "id": 285
      },
      {
        "id": 319
      }
    ]
  },
  {
    "owner": {
      "id": 123
    },
    "startsAt": "2024-05-06T00:00:00",
    "duration": {
      "iso": "PT2H"
    },
    "comment": null,
    "timeSource": "manual",
    "unit": "duration",
    "timeType": null,
    "axisSections": [
      {
        "id": 41
      },
      {
        "id": 290
      },
      {
        "id": 309
      },
      {
        "id": 311
      }
    ]
  },
  {
    "owner": {
      "id": 123
    },
    "startsAt": "2024-05-07T00:00:00",
    "duration": {
      "iso": "PT7H20M"
    },
    "comment": "This is a comment",
    "timeSource": "manual",
    "unit": "duration",
    "timeType": null,
    "axisSections": [
      {
        "id": 41
      },
      {
        "id": 127
      },
      {
        "id": 285
      },
      {
        "id": 319
      }
    ]
  }
]'

This response does not have an example.

Headers

Authorization

string

required

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

Query Parameters

startsOn

string

required

First day (included) of the period you want to update with provided TimeEntries.

endsOn

string

required

Last day (included) of the period you want to update with provided TimeEntries.

ownerId

integer

required

Unique identifier of the TimeEntries owner.

Body

application/json · object[]

The body is of type object[].

Response

200

Delete a TimeEntry by id

The timesheet resource

curl --request PUT \
  --url https://{host}/timmi-timesheet/services/time-entries \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '[
  {
    "owner": {
      "id": 123
    },
    "startsAt": "2024-05-06T00:00:00",
    "duration": {
      "iso": "PT4H"
    },
    "comment": null,
    "timeSource": "manual",
    "unit": "duration",
    "timeType": null,
    "axisSections": [
      {
        "id": 41
      },
      {
        "id": 127
      },
      {
        "id": 285
      },
      {
        "id": 319
      }
    ]
  },
  {
    "owner": {
      "id": 123
    },
    "startsAt": "2024-05-06T00:00:00",
    "duration": {
      "iso": "PT2H"
    },
    "comment": null,
    "timeSource": "manual",
    "unit": "duration",
    "timeType": null,
    "axisSections": [
      {
        "id": 41
      },
      {
        "id": 290
      },
      {
        "id": 309
      },
      {
        "id": 311
      }
    ]
  },
  {
    "owner": {
      "id": 123
    },
    "startsAt": "2024-05-07T00:00:00",
    "duration": {
      "iso": "PT7H20M"
    },
    "comment": "This is a comment",
    "timeSource": "manual",
    "unit": "duration",
    "timeType": null,
    "axisSections": [
      {
        "id": 41
      },
      {
        "id": 127
      },
      {
        "id": 285
      },
      {
        "id": 319
      }
    ]
  }
]'

This response does not have an example.