Url structure

Usually an api resource follows this pattern:

  • server is the location of your teamspace installation, e.g. „https://app1.teamspace.de“
  • Everything api is located under, well, api
  • Next part of the URL is the collection you want to access, e.g. „project“, „time“.
  • To access a certain element, the collection is followed by the elements id
  • The path can be followed by one ore more matrix parameters. These are options, e.g. to limit the result size
  • At last you can specify a query, to filter the collection, eg „?name=alice&date=2000-01-01“

Example of a collection ressource

server/api/collection;matrixparameters?query
https://app1.teamspace.de/api/time;limit=10;sort=project?date=2022-01-31

Example of an item ressource

server/api/collection/itemid;matrixparameters
https://app1.teamspace.de/api/time/123;depth=0