Bitte beachten: Lesezeichen können über die mite.api von allen Benutzern ausschließlich gelesen, jedoch nicht angelegt und modifiziert werden. Zudem sind wie auf der Weboberfläche Team-Lesezeichen für Zeiterfasser nicht sichtbar, sie sehen nur ihre eigenen. Alle anderen Rollen können auf ihre eigenen sowie auf Team-Lesezeichen zugreifen.
Alle Lesezeichen auflisten
Listet alle Lesezeichen sortiert nach deren Namen auf.
GET /time_entries/bookmarks.xml
GET /time_entries/bookmarks.json
[ { "bookmark": {...} }, { "bookmark": {...} } ]
<?xml version="1.0" encoding="UTF-8"?> <bookmarks type="array"> <bookmark> ... </bookmark> <bookmark> ... </bookmark> </bookmarks>
Einzelnes Lesezeichen anzeigen
Gibt ein einzelnes Lesezeichen zurück.
GET /time_entries/bookmarks/:id.xml
GET /time_entries/bookmarks/:id.json
Antwort
{ "bookmark": { "id": 79133, "name": "Projekt 'Website Konzeption' diese Woche", "query": "project_id=21243&at=this_week", "type": "time_entries", "account_id": 1932, "user_id": 6546, "created_at": "2015-09-23T19:46:23+02:00", "updated_at": "2015-09-23T19:46:23+02:00" } }
<?xml version="1.0" encoding="UTF-8"?> <bookmark> <id type="integer">79133</id> <name>Projekt 'Website Konzeption' diese Woche</name> <query>project_id=212&at=this_week</query> <type>time_entries</type> <account-id type="integer">1932</account-id> <user-id type="integer">6546</user-id> <created-at type="datetime">2015-09-23T19:46:23+02:00</created-at> <updated-at type="datetime">2015-09-23T19:46:23+02:00</updated-at> </bookmark>
Team-Lesezeichen unterscheiden sich von benutzerspezifischen dadurch, dass sie nur einem Account aber keinem Benutzer zugeordnet sind. Das Attribut user_id steht bei ihnen auf null.
Das query-Attribut enthält die eigentlichen Daten des Lesezeichens: die Parameter der Filterung. Um die gefilterten Zeiten aufzurufen werden diese Parameter einfach an die URL angehängt:
GET /time_entries.xml?project_id=21243&at=this_week
GET /time_entries.json?project_id=21243&at=this_week
Zeiteinträge eines Lesezeichen anzeigen
Alternativ kann ein Lesezeichen auch direkt benutzt werden:
GET /time_entries/bookmarks/{id}/follow.xml
GET /time_entries/bookmarks/{id}/follow.json
Antwort
Location: https://demo.{{ site.webapp_domain }}/time_entries.json?project_id=212&at=this_week
{leer}
Location: https://demo.{{ site.webapp_domain }}/time_entries.xml?project_id=212&at=this_week
{leer}
Wenn der HTTP-Client der Umleitung folgt werden die gefilterten Zeiten somit direkt ausgegeben.