Zum Hauptinhalt springen

Aufgaben

Eine Aufgabe ist ein To-do, oft aus einem Meeting abgeleitet. Diese Endpunkte listen, durchsuchen, erstellen, ändern, erledigen und löschen Aufgaben. Ein weiterer Endpunkt listet die Aufgabenkategorien, mit denen du die taskCategoryId einer Aufgabe auflöst.

Jeder Endpunkt unten zeigt in der Mitte seine Parameter und Antwortfelder. Rechts findest du Anfragebeispiele in cURL, JavaScript und Python, eine Beispielantwort und Ausprobieren, das die Anfrage mit deinem eigenen Token wirklich abschickt.

Listet die Aufgaben eines Unternehmenskontos auf (paginiert, optional gefiltert)​

GET/v1.0/directories/{directoryId}/tasksAusprobieren →

Der ?filter wählt eine Aufgabenansicht aus (Standard myTasks); die all*-Varianten sind nur für Admins/Owner verfügbar. Ein optionaler Teilstring in ?search wird mit dem Betreff der Aufgabe abgeglichen. Paginierung über ?page + ?pageSize (max. 100). Löse responsibleUserId/ownerId über GET /v1.0/directories/{directoryId}/memberships/users/{userId} auf.

Feldübersicht aus der Spezifikation

Felder der Antwort:

  • page / pageSize / total / hasMore: Paginierungsrahmen (aktuelle Seite, Seitengröße, Gesamtanzahl, ob weitere Seiten folgen).
  • items (array): die Aufgaben auf dieser Seite. Jeder Eintrag enthält:
    • taskId (string): Id der Aufgabe.
    • subject (string): Betreff der Aufgabe.
    • description (string | null): Beschreibung der Aufgabe; null, wenn nicht gesetzt.
    • ownerId (string): Id des Nutzers, dem die Aufgabe gehört (der sie erstellt hat).
    • responsibleUserId (string | null): Id des für die Aufgabe verantwortlichen Nutzers; null, wenn nicht zugewiesen.
    • taskCategoryId (string | null): Id der Aufgabenkategorie; null, wenn keine. Auflösen über GET /v1.0/directories/{directoryId}/task-categories.
    • dueDate (string | null): Fälligkeitsdatum (ISO 8601); null, wenn kein Fälligkeitsdatum gesetzt ist.
    • isDone (boolean): ob die Aufgabe als erledigt markiert ist.
    • doneOn (string | null): Zeitstempel, zu dem die Aufgabe erledigt wurde (ISO 8601); null, wenn nicht erledigt.
    • isCanceled (boolean): ob die Aufgabe abgebrochen ist.
    • canceledOn (string | null): Zeitstempel, zu dem die Aufgabe abgebrochen wurde (ISO 8601); null, wenn nicht abgebrochen.
    • recordingSummaryId (string | null): Id der Zusammenfassung, aus der diese Aufgabe stammt; null, wenn keine.
    • appointmentId (string | null): Id des Termins, mit dem diese Aufgabe verknüpft ist; null, wenn keiner.
    • createdOn (string): Erstellungszeitstempel (ISO 8601).
    • modifiedOn (string): Zeitstempel der letzten Änderung (ISO 8601).

Pfadparameter

  • directoryIdstringPflicht

    Id des Unternehmenskontos (des Sally-Firmenkontos), zu dem die Ressource gehört. Die Unternehmenskonten, die ein Token ansprechen kann, listet GET /v1.0/me/directories/memberships auf.

Query-Parameter

  • filterstringoptional

    Benannte Voreinstellung, die Umfang und Status kombiniert. my… umfasst jede Aufgabe, an der der aufrufende Nutzer beteiligt ist, also als verantwortliche Person ODER als Owner; all… jede Aufgabe des Unternehmenskontos, die der Aufrufer sehen darf. Der Statusteil ist Tasks (beliebig), Open, Overdue, Completed oder Forwarded. Forwarded ist die einzige Ausnahme vom obigen Umfang: Es listet nur, was der Aufrufer an jemand anderen übergeben hat (Owner ist der Aufrufer, verantwortlich ist jemand anderes). Weggelassen bedeutet: kein Voreinstellungsfilter.

    Erlaubte Werte: myTasksmyOpenmyOverduemyCompletedmyForwardedallTasksallOpenallOverdueallCompletedallForwarded
  • searchstringoptional

    Teilstring-Suche im Betreff der Aufgabe ohne Beachtung der Groß- und Kleinschreibung. Der Suchbegriff darf am Anfang, in der Mitte oder am Ende stehen.

  • pagenumberoptional

    Seitennummer, beginnend bei 1. Standard: 1.

  • pageSizenumberoptional

    Einträge pro Seite. Standard: 25, maximal 100.

  • fieldsstringoptional

    Kommagetrennte Liste der Felder, die zurückgegeben werden sollen. Lässt du den Parameter weg, bekommst du alle Felder, auch solche, die in Zukunft hinzukommen. Das ist deine Entscheidung: Nenne deine Felder explizit, wenn du davor geschützt sein willst.

    Nur Felder der ersten Ebene können angegeben werden. Eine verschachtelte Liste wie attendees, tags oder sectionItems wird ganz oder gar nicht zurückgegeben; attendees.name wird nicht unterstützt.

    Bei einer paginierten Antwort gilt die Auswahl für die Einträge in items; page, pageSize, total und hasMore werden immer zurückgegeben. Ein unbekannter Name wird mit 400 abgelehnt statt ignoriert.

    Hier auswählbar: appointmentId, canceledOn, createdOn, description, doneOn, dueDate, isCanceled, isDone, modifiedOn, ownerId, recordingSummaryId, responsibleUserId, subject, taskCategoryId, taskId.

    Beispiel: appointmentId,canceledOn

Antwort: je Eintrag in items

  • taskIdstringPflicht

    Id der Aufgabe.

  • subjectstringPflicht

    Betreff der Aufgabe.

  • descriptionstringPflichtkann null sein

    Beschreibung der Aufgabe; null, wenn nicht gesetzt.

  • ownerIdstringPflicht

    Id des Nutzers, dem die Aufgabe gehört (der sie erstellt hat).

  • responsibleUserIdstringPflichtkann null sein

    Id des für die Aufgabe verantwortlichen Nutzers; null, wenn nicht zugewiesen.

  • taskCategoryIdstringPflichtkann null sein

    Id der Aufgabenkategorie; null, wenn die Aufgabe keine hat. Auflösen über GET /v1.0/directories/{directoryId}/task-categories.

  • dueDatestringPflichtkann null sein

    Fälligkeitsdatum (ISO 8601); null, wenn kein Fälligkeitsdatum gesetzt ist.

  • isDonebooleanPflicht

    Ob die Aufgabe als erledigt markiert ist.

  • doneOnstringPflichtkann null sein

    Zeitstempel, zu dem die Aufgabe erledigt wurde (ISO 8601); null, wenn nicht erledigt.

  • isCanceledbooleanPflicht

    Ob die Aufgabe abgebrochen ist.

  • canceledOnstringPflichtkann null sein

    Zeitstempel, zu dem die Aufgabe abgebrochen wurde (ISO 8601); null, wenn nicht abgebrochen.

  • recordingSummaryIdstringPflichtkann null sein

    Id der Zusammenfassung, aus der diese Aufgabe stammt; null, wenn keine.

  • appointmentIdstringPflichtkann null sein

    Id des Termins, mit dem diese Aufgabe verknüpft ist; null, wenn keiner.

  • createdOnstringPflicht

    Erstellungszeitstempel (ISO 8601).

  • modifiedOnstringPflicht

    Zeitstempel der letzten Änderung (ISO 8601).

Jede Seite trägt außerdem page, pageSize, total, hasMore.

Statuscodes

  • 200Erfolg
  • 400

    Ungültige Anfrage (Validierungsfehler).

  • 401

    Fehlender oder ungültiger Bearer-Token.

  • 404

    Ressource nicht gefunden oder nicht zugänglich.

  • 429

    Rate-Limit überschritten (pro Token/IP). Transkriptions-Uploads können außerdem den code FUP_LIMIT_EXCEEDED oder TOO_MANY_CONCURRENT_TRANSCRIPTIONS zurückgeben.

  • 500

    Interner Serverfehler.

Erstellt eine Aufgabe​

POST/v1.0/directories/{directoryId}/tasksAusprobieren →

Erstellt eine Aufgabe. Der Aufrufer wird zum Owner.

Feldübersicht aus der Spezifikation

Body-Felder:

  • subject (string, Pflicht): Betreff der Aufgabe (1..1000 Zeichen).
  • description (string, optional): Beschreibung der Aufgabe (max. 4000 Zeichen); null für keine.
  • responsibleUserId (string, optional): Id des verantwortlichen Nutzers; null oder weggelassen lässt die Aufgabe unzugewiesen.
  • taskCategoryId (string, optional): Id der Aufgabenkategorie; null oder weggelassen für keine. Wähle eine aus GET /v1.0/directories/{directoryId}/task-categories.
  • dueDate (string, optional): Fälligkeitsdatum als ISO 8601-String; null für kein Fälligkeitsdatum.

Pfadparameter

  • directoryIdstringPflicht

    Id des Unternehmenskontos (des Sally-Firmenkontos), zu dem die Ressource gehört. Die Unternehmenskonten, die ein Token ansprechen kann, listet GET /v1.0/me/directories/memberships auf.

Query-Parameter

  • fieldsstringoptional

    Kommagetrennte Liste der Felder, die zurückgegeben werden sollen. Lässt du den Parameter weg, bekommst du alle Felder, auch solche, die in Zukunft hinzukommen. Das ist deine Entscheidung: Nenne deine Felder explizit, wenn du davor geschützt sein willst.

    Nur Felder der ersten Ebene können angegeben werden. Eine verschachtelte Liste wie attendees, tags oder sectionItems wird ganz oder gar nicht zurückgegeben; attendees.name wird nicht unterstützt.

    Bei einer paginierten Antwort gilt die Auswahl für die Einträge in items; page, pageSize, total und hasMore werden immer zurückgegeben. Ein unbekannter Name wird mit 400 abgelehnt statt ignoriert.

    Hier auswählbar: appointmentId, canceledOn, createdOn, description, doneOn, dueDate, isCanceled, isDone, modifiedOn, ownerId, recordingSummaryId, responsibleUserId, subject, taskCategoryId, taskId.

    Beispiel: appointmentId,canceledOn

Request-Body application/json

  • subjectstringPflicht

    Betreff der Aufgabe (1..1000 Zeichen).

  • descriptionstringoptionalkann null sein

    Beschreibung der Aufgabe (max. 4000 Zeichen); null für keine.

  • responsibleUserIdstringoptionalkann null sein

    Id des verantwortlichen Nutzers; null für nicht zugewiesen.

  • taskCategoryIdstringoptionalkann null sein

    Id der Aufgabenkategorie; null für keine. Wähle eine aus GET /v1.0/directories/{directoryId}/task-categories; eine Id aus einem anderen Unternehmenskonto wird abgelehnt.

  • dueDatestringoptionalkann null sein

    Fälligkeitsdatum als ISO 8601-String; null für kein Fälligkeitsdatum.

Antwort

  • taskIdstringPflicht

    Id der Aufgabe.

  • subjectstringPflicht

    Betreff der Aufgabe.

  • descriptionstringPflichtkann null sein

    Beschreibung der Aufgabe; null, wenn nicht gesetzt.

  • ownerIdstringPflicht

    Id des Nutzers, dem die Aufgabe gehört (der sie erstellt hat).

  • responsibleUserIdstringPflichtkann null sein

    Id des für die Aufgabe verantwortlichen Nutzers; null, wenn nicht zugewiesen.

  • taskCategoryIdstringPflichtkann null sein

    Id der Aufgabenkategorie; null, wenn die Aufgabe keine hat. Auflösen über GET /v1.0/directories/{directoryId}/task-categories.

  • dueDatestringPflichtkann null sein

    Fälligkeitsdatum (ISO 8601); null, wenn kein Fälligkeitsdatum gesetzt ist.

  • isDonebooleanPflicht

    Ob die Aufgabe als erledigt markiert ist.

  • doneOnstringPflichtkann null sein

    Zeitstempel, zu dem die Aufgabe erledigt wurde (ISO 8601); null, wenn nicht erledigt.

  • isCanceledbooleanPflicht

    Ob die Aufgabe abgebrochen ist.

  • canceledOnstringPflichtkann null sein

    Zeitstempel, zu dem die Aufgabe abgebrochen wurde (ISO 8601); null, wenn nicht abgebrochen.

  • recordingSummaryIdstringPflichtkann null sein

    Id der Zusammenfassung, aus der diese Aufgabe stammt; null, wenn keine.

  • appointmentIdstringPflichtkann null sein

    Id des Termins, mit dem diese Aufgabe verknüpft ist; null, wenn keiner.

  • createdOnstringPflicht

    Erstellungszeitstempel (ISO 8601).

  • modifiedOnstringPflicht

    Zeitstempel der letzten Änderung (ISO 8601).

Statuscodes

  • 200Erfolg
  • 400

    Ungültige Anfrage (Validierungsfehler).

  • 401

    Fehlender oder ungültiger Bearer-Token.

  • 403

    Verboten (unzureichende Berechtigungen).

  • 404

    Ressource nicht gefunden oder nicht zugänglich.

  • 429

    Rate-Limit überschritten (pro Token/IP). Transkriptions-Uploads können außerdem den code FUP_LIMIT_EXCEEDED oder TOO_MANY_CONCURRENT_TRANSCRIPTIONS zurückgeben.

  • 500

    Interner Serverfehler.

POST/v1.0/directories/{directoryId}/tasks/searchAusprobieren →

Durchsucht Aufgaben.

Feldübersicht aus der Spezifikation

Body-Felder:

  • search (string, optional): Teilstring über Betreff UND Beschreibung der Aufgabe, ohne Beachtung der Groß- und Kleinschreibung.
  • responsible (string, optional): Filter nach der Id des verantwortlichen Nutzers; deine eigene ist immer erlaubt, ein anderer Nutzer oder das Weglassen (= alle Verantwortlichen) erfordert Admin/Owner.
  • status (string, optional): einer von open (nicht erledigt/abgebrochen), completed, overdue (offen + überfällig), canceled; weglassen für jeden Status.
  • page (number, optional, Standard 1): Seitennummer, beginnend bei 1.
  • pageSize (number, optional, Standard 25): Seitengröße (max. 100).

Die Ergebnisse sind aufsteigend nach Fälligkeitsdatum sortiert.

Pfadparameter

  • directoryIdstringPflicht

    Id des Unternehmenskontos (des Sally-Firmenkontos), zu dem die Ressource gehört. Die Unternehmenskonten, die ein Token ansprechen kann, listet GET /v1.0/me/directories/memberships auf.

Query-Parameter

  • fieldsstringoptional

    Kommagetrennte Liste der Felder, die zurückgegeben werden sollen. Lässt du den Parameter weg, bekommst du alle Felder, auch solche, die in Zukunft hinzukommen. Das ist deine Entscheidung: Nenne deine Felder explizit, wenn du davor geschützt sein willst.

    Nur Felder der ersten Ebene können angegeben werden. Eine verschachtelte Liste wie attendees, tags oder sectionItems wird ganz oder gar nicht zurückgegeben; attendees.name wird nicht unterstützt.

    Bei einer paginierten Antwort gilt die Auswahl für die Einträge in items; page, pageSize, total und hasMore werden immer zurückgegeben. Ein unbekannter Name wird mit 400 abgelehnt statt ignoriert.

    Hier auswählbar: appointmentId, canceledOn, createdOn, description, doneOn, dueDate, isCanceled, isDone, modifiedOn, ownerId, recordingSummaryId, responsibleUserId, subject, taskCategoryId, taskId.

    Beispiel: appointmentId,canceledOn

Request-Body application/json

  • searchstringoptionalkann null sein

    Teilstring-Suche im Betreff UND in der Beschreibung der Aufgabe ohne Beachtung der Groß- und Kleinschreibung. Der Suchbegriff darf am Anfang, in der Mitte oder am Ende stehen.

  • responsiblestringoptionalkann null sein

    Filter nach der Id des verantwortlichen Nutzers. Deine eigene Id ist immer erlaubt; ein anderer Nutzer oder das Weglassen (= alle Verantwortlichen) erfordert Admin/Owner.

  • statusstringoptionalkann null sein

    Filter nach Status: open (nicht erledigt/abgebrochen), completed, overdue (offen + überfällig), canceled. Weglassen für jeden Status.

    Erlaubte Werte: opencompletedoverduecanceled
  • pagenumberoptional

    Seite (beginnend bei 1, Standard 1).

  • pageSizenumberoptional

    Seitengröße (Standard 25, max. 100).

Antwort: je Eintrag in items

  • taskIdstringPflicht

    Id der Aufgabe.

  • subjectstringPflicht

    Betreff der Aufgabe.

  • descriptionstringPflichtkann null sein

    Beschreibung der Aufgabe; null, wenn nicht gesetzt.

  • ownerIdstringPflicht

    Id des Nutzers, dem die Aufgabe gehört (der sie erstellt hat).

  • responsibleUserIdstringPflichtkann null sein

    Id des für die Aufgabe verantwortlichen Nutzers; null, wenn nicht zugewiesen.

  • taskCategoryIdstringPflichtkann null sein

    Id der Aufgabenkategorie; null, wenn die Aufgabe keine hat. Auflösen über GET /v1.0/directories/{directoryId}/task-categories.

  • dueDatestringPflichtkann null sein

    Fälligkeitsdatum (ISO 8601); null, wenn kein Fälligkeitsdatum gesetzt ist.

  • isDonebooleanPflicht

    Ob die Aufgabe als erledigt markiert ist.

  • doneOnstringPflichtkann null sein

    Zeitstempel, zu dem die Aufgabe erledigt wurde (ISO 8601); null, wenn nicht erledigt.

  • isCanceledbooleanPflicht

    Ob die Aufgabe abgebrochen ist.

  • canceledOnstringPflichtkann null sein

    Zeitstempel, zu dem die Aufgabe abgebrochen wurde (ISO 8601); null, wenn nicht abgebrochen.

  • recordingSummaryIdstringPflichtkann null sein

    Id der Zusammenfassung, aus der diese Aufgabe stammt; null, wenn keine.

  • appointmentIdstringPflichtkann null sein

    Id des Termins, mit dem diese Aufgabe verknüpft ist; null, wenn keiner.

  • createdOnstringPflicht

    Erstellungszeitstempel (ISO 8601).

  • modifiedOnstringPflicht

    Zeitstempel der letzten Änderung (ISO 8601).

Jede Seite trägt außerdem page, pageSize, total, hasMore.

Statuscodes

  • 200Erfolg
  • 400

    Ungültige Anfrage (Validierungsfehler).

  • 401

    Fehlender oder ungültiger Bearer-Token.

  • 403

    Verboten (unzureichende Berechtigungen).

  • 404

    Ressource nicht gefunden oder nicht zugänglich.

  • 429

    Rate-Limit überschritten (pro Token/IP). Transkriptions-Uploads können außerdem den code FUP_LIMIT_EXCEEDED oder TOO_MANY_CONCURRENT_TRANSCRIPTIONS zurückgeben.

  • 500

    Interner Serverfehler.

Gibt eine einzelne Aufgabe anhand ihrer Id zurück​

GET/v1.0/directories/{directoryId}/tasks/{taskId}Ausprobieren →

Der Aufrufer muss die Aufgabe ansehen dürfen (Owner, Verantwortlicher oder Admin/Owner).

Feldübersicht aus der Spezifikation

Felder der Antwort:

  • taskId (string): Id der Aufgabe.
  • subject (string): Betreff der Aufgabe.
  • description (string | null): Beschreibung der Aufgabe; null, wenn nicht gesetzt.
  • ownerId (string): Id des Nutzers, dem die Aufgabe gehört (der sie erstellt hat).
  • responsibleUserId (string | null): Id des für die Aufgabe verantwortlichen Nutzers; null, wenn nicht zugewiesen.
  • dueDate (string | null): Fälligkeitsdatum (ISO 8601); null, wenn kein Fälligkeitsdatum gesetzt ist.
  • isDone (boolean): ob die Aufgabe als erledigt markiert ist.
  • doneOn (string | null): Zeitstempel, zu dem die Aufgabe erledigt wurde (ISO 8601); null, wenn nicht erledigt.
  • isCanceled (boolean): ob die Aufgabe abgebrochen ist.
  • canceledOn (string | null): Zeitstempel, zu dem die Aufgabe abgebrochen wurde (ISO 8601); null, wenn nicht abgebrochen.
  • recordingSummaryId (string | null): Id der Zusammenfassung, aus der diese Aufgabe stammt; null, wenn keine.
  • appointmentId (string | null): Id des Termins, mit dem diese Aufgabe verknüpft ist; null, wenn keiner.
  • createdOn (string): Erstellungszeitstempel (ISO 8601).
  • modifiedOn (string): Zeitstempel der letzten Änderung (ISO 8601).

Pfadparameter

  • directoryIdstringPflicht

    Id des Unternehmenskontos (des Sally-Firmenkontos), zu dem die Ressource gehört. Die Unternehmenskonten, die ein Token ansprechen kann, listet GET /v1.0/me/directories/memberships auf.

  • taskIdstringPflicht

    Id der Aufgabe.

Query-Parameter

  • fieldsstringoptional

    Kommagetrennte Liste der Felder, die zurückgegeben werden sollen. Lässt du den Parameter weg, bekommst du alle Felder, auch solche, die in Zukunft hinzukommen. Das ist deine Entscheidung: Nenne deine Felder explizit, wenn du davor geschützt sein willst.

    Nur Felder der ersten Ebene können angegeben werden. Eine verschachtelte Liste wie attendees, tags oder sectionItems wird ganz oder gar nicht zurückgegeben; attendees.name wird nicht unterstützt.

    Bei einer paginierten Antwort gilt die Auswahl für die Einträge in items; page, pageSize, total und hasMore werden immer zurückgegeben. Ein unbekannter Name wird mit 400 abgelehnt statt ignoriert.

    Hier auswählbar: appointmentId, canceledOn, createdOn, description, doneOn, dueDate, isCanceled, isDone, modifiedOn, ownerId, recordingSummaryId, responsibleUserId, subject, taskCategoryId, taskId.

    Beispiel: appointmentId,canceledOn

Antwort

  • taskIdstringPflicht

    Id der Aufgabe.

  • subjectstringPflicht

    Betreff der Aufgabe.

  • descriptionstringPflichtkann null sein

    Beschreibung der Aufgabe; null, wenn nicht gesetzt.

  • ownerIdstringPflicht

    Id des Nutzers, dem die Aufgabe gehört (der sie erstellt hat).

  • responsibleUserIdstringPflichtkann null sein

    Id des für die Aufgabe verantwortlichen Nutzers; null, wenn nicht zugewiesen.

  • taskCategoryIdstringPflichtkann null sein

    Id der Aufgabenkategorie; null, wenn die Aufgabe keine hat. Auflösen über GET /v1.0/directories/{directoryId}/task-categories.

  • dueDatestringPflichtkann null sein

    Fälligkeitsdatum (ISO 8601); null, wenn kein Fälligkeitsdatum gesetzt ist.

  • isDonebooleanPflicht

    Ob die Aufgabe als erledigt markiert ist.

  • doneOnstringPflichtkann null sein

    Zeitstempel, zu dem die Aufgabe erledigt wurde (ISO 8601); null, wenn nicht erledigt.

  • isCanceledbooleanPflicht

    Ob die Aufgabe abgebrochen ist.

  • canceledOnstringPflichtkann null sein

    Zeitstempel, zu dem die Aufgabe abgebrochen wurde (ISO 8601); null, wenn nicht abgebrochen.

  • recordingSummaryIdstringPflichtkann null sein

    Id der Zusammenfassung, aus der diese Aufgabe stammt; null, wenn keine.

  • appointmentIdstringPflichtkann null sein

    Id des Termins, mit dem diese Aufgabe verknüpft ist; null, wenn keiner.

  • createdOnstringPflicht

    Erstellungszeitstempel (ISO 8601).

  • modifiedOnstringPflicht

    Zeitstempel der letzten Änderung (ISO 8601).

Statuscodes

  • 200Erfolg
  • 400

    Ungültige Anfrage (Validierungsfehler).

  • 401

    Fehlender oder ungültiger Bearer-Token.

  • 404

    Ressource nicht gefunden oder nicht zugänglich.

  • 429

    Rate-Limit überschritten (pro Token/IP). Transkriptions-Uploads können außerdem den code FUP_LIMIT_EXCEEDED oder TOO_MANY_CONCURRENT_TRANSCRIPTIONS zurückgeben.

  • 500

    Interner Serverfehler.

Aktualisiert eine Aufgabe (teilweise Aktualisierung)​

PATCH/v1.0/directories/{directoryId}/tasks/{taskId}Ausprobieren →

Aktualisiert eine Aufgabe. Nur die übergebenen Felder werden geändert; weggelassene Felder behalten ihren aktuellen Wert, ein null-Wert leert ein Feld explizit. Der Aufrufer muss die Aufgabe bearbeiten dürfen.

Feldübersicht aus der Spezifikation

Body-Felder:

  • subject (string, optional): neuer Betreff der Aufgabe (1..1000 Zeichen).
  • description (string, optional): neue Beschreibung der Aufgabe (max. 4000 Zeichen); null zum Entfernen.
  • responsibleUserId (string, optional): neue Id des verantwortlichen Nutzers; null, um die Zuweisung aufzuheben.
  • taskCategoryId (string, optional): neue Id der Aufgabenkategorie; null zum Entfernen. Wähle eine aus GET /v1.0/directories/{directoryId}/task-categories.
  • dueDate (string, optional): neues Fälligkeitsdatum als ISO 8601-String; null zum Entfernen.

Pfadparameter

  • directoryIdstringPflicht

    Id des Unternehmenskontos (des Sally-Firmenkontos), zu dem die Ressource gehört. Die Unternehmenskonten, die ein Token ansprechen kann, listet GET /v1.0/me/directories/memberships auf.

  • taskIdstringPflicht

    Id der Aufgabe.

Query-Parameter

  • fieldsstringoptional

    Kommagetrennte Liste der Felder, die zurückgegeben werden sollen. Lässt du den Parameter weg, bekommst du alle Felder, auch solche, die in Zukunft hinzukommen. Das ist deine Entscheidung: Nenne deine Felder explizit, wenn du davor geschützt sein willst.

    Nur Felder der ersten Ebene können angegeben werden. Eine verschachtelte Liste wie attendees, tags oder sectionItems wird ganz oder gar nicht zurückgegeben; attendees.name wird nicht unterstützt.

    Bei einer paginierten Antwort gilt die Auswahl für die Einträge in items; page, pageSize, total und hasMore werden immer zurückgegeben. Ein unbekannter Name wird mit 400 abgelehnt statt ignoriert.

    Hier auswählbar: appointmentId, canceledOn, createdOn, description, doneOn, dueDate, isCanceled, isDone, modifiedOn, ownerId, recordingSummaryId, responsibleUserId, subject, taskCategoryId, taskId.

    Beispiel: appointmentId,canceledOn

Request-Body application/json

  • subjectstringoptional

    Neuer Betreff der Aufgabe (1..1000 Zeichen).

  • descriptionstringoptionalkann null sein

    Neue Beschreibung der Aufgabe (max. 4000 Zeichen); null zum Entfernen.

  • responsibleUserIdstringoptionalkann null sein

    Neue Id des verantwortlichen Nutzers; null, um die Zuweisung aufzuheben.

  • taskCategoryIdstringoptionalkann null sein

    Neue Id der Aufgabenkategorie; null zum Entfernen. Wähle eine aus GET /v1.0/directories/{directoryId}/task-categories; eine Id aus einem anderen Unternehmenskonto wird abgelehnt.

  • dueDatestringoptionalkann null sein

    Neues Fälligkeitsdatum als ISO 8601-String; null zum Entfernen.

Antwort

  • taskIdstringPflicht

    Id der Aufgabe.

  • subjectstringPflicht

    Betreff der Aufgabe.

  • descriptionstringPflichtkann null sein

    Beschreibung der Aufgabe; null, wenn nicht gesetzt.

  • ownerIdstringPflicht

    Id des Nutzers, dem die Aufgabe gehört (der sie erstellt hat).

  • responsibleUserIdstringPflichtkann null sein

    Id des für die Aufgabe verantwortlichen Nutzers; null, wenn nicht zugewiesen.

  • taskCategoryIdstringPflichtkann null sein

    Id der Aufgabenkategorie; null, wenn die Aufgabe keine hat. Auflösen über GET /v1.0/directories/{directoryId}/task-categories.

  • dueDatestringPflichtkann null sein

    Fälligkeitsdatum (ISO 8601); null, wenn kein Fälligkeitsdatum gesetzt ist.

  • isDonebooleanPflicht

    Ob die Aufgabe als erledigt markiert ist.

  • doneOnstringPflichtkann null sein

    Zeitstempel, zu dem die Aufgabe erledigt wurde (ISO 8601); null, wenn nicht erledigt.

  • isCanceledbooleanPflicht

    Ob die Aufgabe abgebrochen ist.

  • canceledOnstringPflichtkann null sein

    Zeitstempel, zu dem die Aufgabe abgebrochen wurde (ISO 8601); null, wenn nicht abgebrochen.

  • recordingSummaryIdstringPflichtkann null sein

    Id der Zusammenfassung, aus der diese Aufgabe stammt; null, wenn keine.

  • appointmentIdstringPflichtkann null sein

    Id des Termins, mit dem diese Aufgabe verknüpft ist; null, wenn keiner.

  • createdOnstringPflicht

    Erstellungszeitstempel (ISO 8601).

  • modifiedOnstringPflicht

    Zeitstempel der letzten Änderung (ISO 8601).

Statuscodes

  • 200Erfolg
  • 400

    Ungültige Anfrage (Validierungsfehler).

  • 401

    Fehlender oder ungültiger Bearer-Token.

  • 403

    Verboten (unzureichende Berechtigungen).

  • 404

    Ressource nicht gefunden oder nicht zugänglich.

  • 429

    Rate-Limit überschritten (pro Token/IP). Transkriptions-Uploads können außerdem den code FUP_LIMIT_EXCEEDED oder TOO_MANY_CONCURRENT_TRANSCRIPTIONS zurückgeben.

  • 500

    Interner Serverfehler.

Löscht eine Aufgabe (weiches Löschen, Soft Delete)​

DELETE/v1.0/directories/{directoryId}/tasks/{taskId}Ausprobieren →

Nur der Owner der Aufgabe oder ein Admin/Owner darf eine Aufgabe löschen.

Pfadparameter

  • directoryIdstringPflicht

    Id des Unternehmenskontos (des Sally-Firmenkontos), zu dem die Ressource gehört. Die Unternehmenskonten, die ein Token ansprechen kann, listet GET /v1.0/me/directories/memberships auf.

  • taskIdstringPflicht

    Id der Aufgabe.

Statuscodes

  • 204Erfolg
  • 400

    Ungültige Anfrage (Validierungsfehler).

  • 401

    Fehlender oder ungültiger Bearer-Token.

  • 403

    Verboten (unzureichende Berechtigungen).

  • 404

    Ressource nicht gefunden oder nicht zugänglich.

  • 429

    Rate-Limit überschritten (pro Token/IP). Transkriptions-Uploads können außerdem den code FUP_LIMIT_EXCEEDED oder TOO_MANY_CONCURRENT_TRANSCRIPTIONS zurückgeben.

  • 500

    Interner Serverfehler.

Schaltet den Erledigt-Status einer Aufgabe um​

POST/v1.0/directories/{directoryId}/tasks/{taskId}/doneAusprobieren →

Schaltet den Erledigt-Status einer Aufgabe um.

Feldübersicht aus der Spezifikation

Body-Felder:

  • isDone (boolean, Pflicht): true, um die Aufgabe als erledigt zu markieren, false, um sie wieder zu öffnen.

Pfadparameter

  • directoryIdstringPflicht

    Id des Unternehmenskontos (des Sally-Firmenkontos), zu dem die Ressource gehört. Die Unternehmenskonten, die ein Token ansprechen kann, listet GET /v1.0/me/directories/memberships auf.

  • taskIdstringPflicht

    Id der Aufgabe.

Query-Parameter

  • fieldsstringoptional

    Kommagetrennte Liste der Felder, die zurückgegeben werden sollen. Lässt du den Parameter weg, bekommst du alle Felder, auch solche, die in Zukunft hinzukommen. Das ist deine Entscheidung: Nenne deine Felder explizit, wenn du davor geschützt sein willst.

    Nur Felder der ersten Ebene können angegeben werden. Eine verschachtelte Liste wie attendees, tags oder sectionItems wird ganz oder gar nicht zurückgegeben; attendees.name wird nicht unterstützt.

    Bei einer paginierten Antwort gilt die Auswahl für die Einträge in items; page, pageSize, total und hasMore werden immer zurückgegeben. Ein unbekannter Name wird mit 400 abgelehnt statt ignoriert.

    Hier auswählbar: appointmentId, canceledOn, createdOn, description, doneOn, dueDate, isCanceled, isDone, modifiedOn, ownerId, recordingSummaryId, responsibleUserId, subject, taskCategoryId, taskId.

    Beispiel: appointmentId,canceledOn

Request-Body application/json

  • isDonebooleanPflicht

    True, um die Aufgabe als erledigt zu markieren, false, um sie wieder zu öffnen.

Antwort

  • taskIdstringPflicht

    Id der Aufgabe.

  • subjectstringPflicht

    Betreff der Aufgabe.

  • descriptionstringPflichtkann null sein

    Beschreibung der Aufgabe; null, wenn nicht gesetzt.

  • ownerIdstringPflicht

    Id des Nutzers, dem die Aufgabe gehört (der sie erstellt hat).

  • responsibleUserIdstringPflichtkann null sein

    Id des für die Aufgabe verantwortlichen Nutzers; null, wenn nicht zugewiesen.

  • taskCategoryIdstringPflichtkann null sein

    Id der Aufgabenkategorie; null, wenn die Aufgabe keine hat. Auflösen über GET /v1.0/directories/{directoryId}/task-categories.

  • dueDatestringPflichtkann null sein

    Fälligkeitsdatum (ISO 8601); null, wenn kein Fälligkeitsdatum gesetzt ist.

  • isDonebooleanPflicht

    Ob die Aufgabe als erledigt markiert ist.

  • doneOnstringPflichtkann null sein

    Zeitstempel, zu dem die Aufgabe erledigt wurde (ISO 8601); null, wenn nicht erledigt.

  • isCanceledbooleanPflicht

    Ob die Aufgabe abgebrochen ist.

  • canceledOnstringPflichtkann null sein

    Zeitstempel, zu dem die Aufgabe abgebrochen wurde (ISO 8601); null, wenn nicht abgebrochen.

  • recordingSummaryIdstringPflichtkann null sein

    Id der Zusammenfassung, aus der diese Aufgabe stammt; null, wenn keine.

  • appointmentIdstringPflichtkann null sein

    Id des Termins, mit dem diese Aufgabe verknüpft ist; null, wenn keiner.

  • createdOnstringPflicht

    Erstellungszeitstempel (ISO 8601).

  • modifiedOnstringPflicht

    Zeitstempel der letzten Änderung (ISO 8601).

Statuscodes

  • 200Erfolg
  • 400

    Ungültige Anfrage (Validierungsfehler).

  • 401

    Fehlender oder ungültiger Bearer-Token.

  • 403

    Verboten (unzureichende Berechtigungen).

  • 404

    Ressource nicht gefunden oder nicht zugänglich.

  • 429

    Rate-Limit überschritten (pro Token/IP). Transkriptions-Uploads können außerdem den code FUP_LIMIT_EXCEEDED oder TOO_MANY_CONCURRENT_TRANSCRIPTIONS zurückgeben.

  • 500

    Interner Serverfehler.

Listet die Aufgabenkategorien eines Unternehmenskontos auf (löst `taskCategoryId` auf)​

GET/v1.0/directories/{directoryId}/task-categoriesAusprobieren →

Gibt die Kategorien zurück, die eine Aufgabe tragen kann: die eigenen des Unternehmenskontos und die globalen Sally-Standardkategorien, sortiert nach Name.

Deaktivierte Kategorien sind mit active: false enthalten, damit eine Aufgabe, die noch eine davon trägt, auflösbar bleibt; für neue Aufgaben werden sie nicht mehr angeboten.

Feldübersicht aus der Spezifikation

Felder der Antwort:

  • items (array): die Aufgabenkategorien. Jeder Eintrag enthält:
    • taskCategoryId (string): Id der Kategorie.
    • name (string): Name der Kategorie.
    • description (string | null): was die Kategorie abdeckt; diesen Text bekommt Sally, wenn sie einer erkannten Aufgabe eine Kategorie zuordnet. Null, wenn nicht gesetzt.
    • active (boolean): ob die Kategorie für neue Aufgaben noch angeboten wird.
    • isGlobal (boolean): true bei einer globalen Sally-Standardkategorie, false bei einer, die dem Unternehmenskonto gehört.

Pfadparameter

  • directoryIdstringPflicht

    Id des Unternehmenskontos (des Sally-Firmenkontos), zu dem die Ressource gehört. Die Unternehmenskonten, die ein Token ansprechen kann, listet GET /v1.0/me/directories/memberships auf.

Query-Parameter

  • fieldsstringoptional

    Kommagetrennte Liste der Felder, die zurückgegeben werden sollen. Lässt du den Parameter weg, bekommst du alle Felder, auch solche, die in Zukunft hinzukommen. Das ist deine Entscheidung: Nenne deine Felder explizit, wenn du davor geschützt sein willst.

    Nur Felder der ersten Ebene können angegeben werden. Eine verschachtelte Liste wie attendees, tags oder sectionItems wird ganz oder gar nicht zurückgegeben; attendees.name wird nicht unterstützt.

    Bei einer paginierten Antwort gilt die Auswahl für die Einträge in items; page, pageSize, total und hasMore werden immer zurückgegeben. Ein unbekannter Name wird mit 400 abgelehnt statt ignoriert.

    Hier auswählbar: active, description, isGlobal, name, taskCategoryId.

    Beispiel: active,description

Antwort

  • itemsobject[]Pflicht

    Die Aufgabenkategorien des Unternehmenskontos.

    5 Unterfelder
    • taskCategoryIdstringPflicht

      Id der Aufgabenkategorie.

    • namestringPflicht

      Name der Kategorie.

    • descriptionstringPflichtkann null sein

      Was die Kategorie abdeckt. Diesen Text bekommt Sally, wenn sie einer erkannten Aufgabe eine Kategorie zuordnet. Null, wenn nicht gesetzt.

    • activebooleanPflicht

      Ob die Kategorie für neue Aufgaben noch angeboten wird. Eine deaktivierte Kategorie bleibt lesbar, damit bestehende Aufgaben weiterhin aufgelöst werden können.

    • isGlobalbooleanPflicht

      True bei einer globalen Sally-Standardkategorie, false bei einer Kategorie, die dem Unternehmenskonto gehört.

Statuscodes

  • 200Erfolg
  • 400

    Ungültige Anfrage (Validierungsfehler).

  • 401

    Fehlender oder ungültiger Bearer-Token.

  • 404

    Ressource nicht gefunden oder nicht zugänglich.

  • 429

    Rate-Limit überschritten (pro Token/IP). Transkriptions-Uploads können außerdem den code FUP_LIMIT_EXCEEDED oder TOO_MANY_CONCURRENT_TRANSCRIPTIONS zurückgeben.

  • 500

    Interner Serverfehler.