-
Notifications
You must be signed in to change notification settings - Fork 6
Supported HTTP verbs and combining multiple requests
GET verb in requests is used to query results from a collection of resources, i.e. a list of timereports containing different attributes for different timereports. A collection of items is always returned as a JSON array. It can be filtered using query parameters like /timereports?project=123&rowcount=10 (returns 10 timereports from project 123).
GET is also used to return all available information about a single item (e.g. GET /timereports/123 will return all attributes of a single timereport with id 123). The same information can also be used for creating an updating the item. Query parameters can't be used with single items.
Information returned for multiple items (collection like /timereports) and single items (like /timereports/123) can include different data. For example long text information is only returned for a single item. See section Metadata for further information on how to get information about available data and formats
POST -requests are used for creating, updating and partially updating data. For back-end reasons we don't currently provide support with PATCH -verb and delta (change) instructions with it, but partial updates are allowed with POST.
Not supported, see POST.
PUT requests are used for replacing single resources. For example, you can set capacity for a day in a capacity calendar with PUT /capacitycalendars/1/capacity/2014-01-01T00:00:00.000+0200. The new capacity will replace the old one set for the same day.
Delete single resources. Not supported for deleting collections, e.g. DELETE /timereports/123 will delete (remove permanently) the timereport with id 123.
Multiple different API requests can be combined to one JSON array and posted at the same time. See more information from the API documentation /batch -endpoint