Programmierschnittstellen (API)

English version of this page: Workity API

Auf dieser Seite werden die Programmierschnittstellen (API) von Simprove Workity beschrieben. Wenn Sie weitere Unterstützung benötigen, um eigene Workity-Zusatzanwendungen (z.B. Desktop- und Mobile-Clients, Widgets, alternative Web-Frontends, etc.) zu entwickeln, wenden Sie sich bitte per Kontaktformular an unseren Support.

Nur Premium-Mitglieder können unter Verwendung der Programmierschnittstellen (API) eigene Workity-Zusatzanwendungen entwickeln.

Nur Premium-Mitglieder können unter Verwendung der Programmierschnittstellen (API) entwickelte Workity-Zusatzanwendungen nutzen.

Table of Contents [Hide/Show]

Einleitung
    Webservice-Schnittstelle
    Ticket-Authentisierung
    Schreib-Schreib-Konflikt
    Lösch-Schreib-Konflikt
Daten-Referenz
    Datenfeld (Array)
    true/false-Wert (boolean)
    8-Bit-Ganzzahl (byte)
    32-Bit-Ganzzahl (int)
    64-Bit-Ganzzahl (long)
    Zeichenkette (string)
    Zeitpunkt (dateTime)
    Project
    ProjectInfo
    Person
    PersonInfo
    Keyword
    KeywordInfo
    Modification
    Upload
    TaskItem
    NoteItem
    FileItem
Funktionen
    AddKeywords
    AddPersons
    DeleteItems
    DownloadFile
    GetItems
    GetItemsByAdvancedSearch
    GetItemsByFullTextSearch
    GetItemsByNewsSearch
    GetKeywordID
    GetProjectKeywords
    GetProjectTeam
    GetUserInfo
    GetUserKeywords
    GetUserProjects
    GetUserTeam
    IsAuthenticated
    Login
    Logout
    NewFile
    NewNote
    NewTask
    RemoveKeywords
    RemovePersons
    ResetNews
    SaveFile
    SaveNote
    SaveTask
    UpdateTaskStatus
Beispiele
    HTML-Backup-Anwendung

Edit

Einleitung

Edit

Webservice-Schnittstelle

Die einzelnen Funktionen der Workity API sind als Webservice unter folgender URI verfügbar:

https://www.workity.com/services/api.asmx

Ein direkter Aufruf dieser Webservice-URI im Browser bietet einen Überblick zu allen verfügbaren Funktionen und der zugehörigen WSDL-Dienstbeschreibung. Durch Auswahl einer bestimmten Funktion wird die SOAP 1.1 und SOAP 1.2 Definition dieser Service-Anfrage und deren Antwort dargestellt.

nach oben

Edit

Ticket-Authentisierung

Damit nicht bei jedem Aufruf einer API-Funktion die Zugangsdaten (Nutzer-E-Mail-Adresse und Passwort) des aufrufenden Workity-Nutzers übergeben werden müssen, wird ein so genanntes Ticket in Form einer GUID zur Nutzer-Authentisierung verwendet. Durch einen erfolgreichen Aufruf der Login-Funktion mit den gültigen Zugangsdaten eines bestimmten Workity-Nutzers wird ein neues Ticket für diesen Nutzer erstellt und im Header der entsprechenden SOAP-Antwort zurückgeliefert.

Beispiel für eine SOAP-Antwort der Login-Funktion mit einer GUID als Ticket im SOAP-Header:


<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
  xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
  xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <TicketHeader xmlns="http://www.workity.com/services/api">
      <Ticket>f30f74e1-05e0-43bc-8a93-1ac90106a986</Ticket>
    </TicketHeader>
  </soap:Header>
  <soap:Body>
    <LoginResponse xmlns="http://www.workity.com/services/api">
      <LoginResult>0</LoginResult>
    </LoginResponse>
  </soap:Body>
</soap:Envelope>

Beim jedem Aufruf einer anderen Funktion muss das für den aufrufenden Nutzer durch die Login-Funktion erstellte Ticket im Header der entsprechenden SOAP-Anforderung übergeben werden, um eine entsprechende Nutzer-Authentisierung zu ermöglichen.

Beispiel für eine SOAP-Anforderung der GetUserInfo-Funktion mit einer GUID als Ticket im SOAP-Header:


<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
  xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
  xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <TicketHeader xmlns="http://www.workity.com/services/api">
      <Ticket>f30f74e1-05e0-43bc-8a93-1ac90106a986</Ticket>
    </TicketHeader>
  </soap:Header>
  <soap:Body>
    <GetUserInfo xmlns="http://www.workity.com/services/api" />
  </soap:Body>
</soap:Envelope>

Durch einen erfolgreichen Aufruf der Logout-Funktion wird das dabei im SOAP-Header übergebene Ticket ungültig und kann somit anschließend nicht mehr zur Authentisierung des aufrufenden Nutzers verwendet werden.

Durch Aufruf der IsAuthenticated-Funktion kann geprüft werden, ob das dabei im SOAP-Header übergebene Ticket noch gültig ist.

Ein Ticket wird automatisch ungültig, wenn dieses länger als 1 Stunde nicht mehr zum Aufruf einer API-Funktion verwendet wurde.

nach oben

Edit

Schreib-Schreib-Konflikt

Beim Aufruf der Funktionen SaveFile, SaveNote oder SaveTask kann ein so genannter Schreib-Schreib-Konflikt entstehen, wenn 2 oder mehr Mitglieder eines Projektes unabhängig und zeitnah die gleiche Revision x eines bestimmten Elementes (Aufgabe, Notiz oder Datei) bearbeiten und diese Änderungen mit der gleichen neuen Revision x + 1 speichern.

Im Falle eines Schreib-Schreib-Konfliktes werden vor dem Speichern neuer Inhalte mit der Revision x + 1 zunächst alle aktuellen Inhalte (außer die zugewiesenen Schlagwörter und Personen) der Revision x + 1 des betroffen Elementes in ein neues Element des zugehörigen Projektes kopiert. Im Anschluss werden die alten Inhalte des betroffenen Elementes durch die neuen Inhalte überschrieben. Zusätzlich werden das betroffene Element und dessen Kopie mit dem Schlagwort !WRITE-WRITE-CONFLICT! getaggt. Dieses Schlagwort hat die Identifikationsnummer 1, welche dem Rückgabewert der Funktionen SaveFile, SaveNote oder SaveTask im Falle eines Schreib-Schreib-Konfliktes entspricht.

Wenn ein Datei-Element von einem Schreib-Schreib-Konflikt betroffen ist, wird als Kopie ein Notiz-Element mit dem Dateinamen als Kurzbeschreibung und den Details des Datei-Elementes angelegt. Der binäre Inhalt der betroffenen Datei wird nicht kopiert und kann nach wie vor nur über das originale Datei-Element wieder heruntergeladen werden.

Nachdem ein Schreib-Schreib-Konflikt aufgetreten ist, kann dieser von den beteiligten Personen aufgelöst werden, indem durch Aufruf der GetItemsByAdvancedSearch-Funktion nach allen Elementen mit der Schlagwort-Identifikationsnummer 1 gesucht wird und die Inhalte der gefundenen Elemente wieder zu einem einheitlichen Element zusammengefasst werden. Im Anschluss können die überflüssigen Kopien des betroffenen Elementes durch Aufruf der DeleteItems-Funktion gelöscht werden. Weiterhin kann nach Auflösung des Konfliktes das Schlagwort !WRITE-WRITE-CONFLICT! durch Aufruf der RemoveKeywords-Funktion wieder von dem betroffenen Element entfernt werden.

Beispiel: Lenny und Carl erarbeiten in einem Notiz-Element die Gästeliste für eine gemeinsame Geburtstagsparty. Dieses Notiz-Element hat aktuell die Revision 10 und wird unabhängig und zeitnah von beiden bearbeitet. Zunächst fügt Lenny noch Homer als neuen Gast hinzu und speichert das Notiz-Element mit der neuen Revision 11. Kurze Zeit später speichert Carl das Notiz-Element ebenfalls mit der Revision 11, weil er Ned noch als neuen Gast hinzugefügt hat. Hierdurch entsteht ein Schreib-Schreib-Konflikt, welcher von Carl durch den Rückgabewert 1 beim Aufruf der SaveNote-Funktion erkannt wird. Nun lässt sich Carl durch Aufruf der GetItemsByAdvancedSearch-Funktion die beiden Notiz-Elemente anzeigen, die mit dem Schlagwort mit der Identifikationsnummer 1 getaggt sind. An der Gästeliste-Kopie erkennt Carl, dass Lenny noch Homer hinzugefügt hat und übernimmt diese Änderung in die originale Gästeliste. Im Anschluss löscht Carl die Kopie durch Aufruf der DeleteItems-Funktion und entfernt durch Aufruf der RemoveKeywords-Funktion das Schlagwort !WRITE-WRITE-CONFLICT! wieder vom originalen Notiz-Element.

siehe auch: Lösch-Schreib-Konflikt, SaveFile, SaveNote, SaveTask

nach oben

Edit

Lösch-Schreib-Konflikt

Beim Aufruf der Funktionen SaveFile, SaveNote oder SaveTask kann ein so genannter Lösch-Schreib-Konflikt entstehen, wenn unabhängig und zeitnah ein Projektmitglied ein bestimmtes Element (Aufgabe, Notiz oder Datei) löscht und kurz darauf ein anderes Projektmitglied versucht, dieses Element zu speichern.

Im Falle eines Lösch-Schreib-Konfliktes werden die neuen Inhalte des bereits gelöschten Elementes in einem neuen Element des zugehörigen Projektes gespeichert. Zusätzlich wird dieses neue Element mit dem Schlagwort !DELETE-WRITE-CONFLICT! getaggt. Dieses Schlagwort hat die Identifikationsnummer 2, welche dem Rückgabewert der Funktionen SaveFile, SaveNote oder SaveTask im Falle eines Lösch-Schreib-Konfliktes entspricht.

Wenn ein Datei-Element von einem Lösch-Schreib-Konflikt betroffen ist, werden lediglich die neuen Details dieses Datei-Elementes in einem neuen Notiz-Element mit der Kurzbeschreibung ??? gespeichert. Der binäre Inhalt der betroffenen Datei geht unwideruflich beim Löschen des originalen Datei-Elementes verloren.

Nachdem ein Lösch-Schreib-Konflikt aufgetreten ist, kann dieser von den beteiligten Personen aufgelöst werden, indem durch Aufruf der GetItemsByAdvancedSearch-Funktion nach dem Element mit der Schlagwort-Identifikationsnummer 2 gesucht wird. Abhängig von der inhaltlichen Bedeutung kann dieses Element entweder durch Aufruf der DeleteItems-Funktion erneut gelöscht oder durch Aufruf der Funktionen AddPersons bzw. AddKeywords wieder mit gültigen Personen und Schlagwörtern getaggt werden. Zudem kann durch Aufruf der RemoveKeywords-Funktion das Schlagwort !DELETE-WRITE-CONFLICT! wieder von diesem Element entfernt werden.

Beispiel: Lenny und Carl haben gemeinsam eine Geburtstagsparty veranstaltet. Im Anschluss an die Party möchte Lenny noch die in einem Notiz-Element erstellte Gästeliste um einige Kontakt-Informationen ergänzen und die Liste im nächsten Jahr erneut verwenden. Während Lenny die Liste bearbeitet, löscht Carl jedoch dieses Notiz-Element. Wenn Lenny durch Aufruf der SaveNote-Funktion versucht, seine Änderungen zu speichern, wird er durch den Rückgabewert 2 auf einen Lösch-Schreib-Konflikt aufmerksam gemacht. Nun lässt sich Lenny durch Aufruf der GetItemsByAdvancedSearch-Funktion das Notiz-Element anzeigen, das mit dem Schlagwort mit der Identifikationsnummer 2 getaggt ist. Da Lenny die aktualisierte Gästeliste noch weiter verwenden möchte, taggt er durch Aufruf der AddPersons-Funktion das gefundene Notiz-Element wieder mit seiner Person und entfernt durch Aufruf der RemoveKeywords-Funktion das Schlagwort !DELETE-WRITE-CONFLICT!.

siehe auch: Schreib-Schreib-Konflikt, SaveFile, SaveNote, SaveTask

nach oben

Edit

Daten-Referenz

Edit

Datenfeld (Array)

Ein Datenfeld (engl. Array) eines bestimmten Datentyps wird innerhalb dieser Dokumentation durch die Notation Datentyp-Array beschrieben. Beispielsweise beschreibt die Notation long-Array ein Datenfeld des Datentyps long.

nach oben

Edit

true/false-Wert (boolean)

Datentyp zur Beschreibung eines true/false-Wertes.

nach oben

Edit

8-Bit-Ganzzahl (byte)

Datentyp zur Beschreibung von Ganzzahlen ohne Vorzeichen im Wertebereich von 0 bis 255.

nach oben

Edit

32-Bit-Ganzzahl (int)

Datentyp zur Beschreibung von Ganzzahlen mit Vorzeichen im Wertebereich von -2.147.483.648 bis 2.147.483.647.

nach oben

Edit

64-Bit-Ganzzahl (long)

Datentyp zur Beschreibung von Ganzzahlen mit Vorzeichen im Wertebereich von -9.223.372.036.854.775.808 bis 9.223.372.036.854.775.807.

nach oben

Edit

Zeichenkette (string)

Datentyp zur Beschreibung von Zeichenketten im Unicode-Format.

nach oben

Edit

Zeitpunkt (dateTime)

Datentyp zur Beschreibung von Zeitpunkten, die durch Datum und Uhrzeit angegeben werden. Die Notation eines bestimmten Zeitpunktes erfolgt entsprechend dem ISO 8601 Standard im Format:

YYYY-MM-DDThh:mmTZD (z.B. 1989-11-09T22:30 für den 9. November 1989 um 22:30 Uhr)

YYYY = 4-stellige Jahreszahl (z.B. 1989)
MM = 2-stellige Monatszahl (01 = Januar, 02 = Februar, etc.)
DD = 2-stellige Tageszahl im Bereich von 01 bis 31
hh = 2-stellige Stundenzahl im Bereich von 00 bis 23
mm = 2-stellige Minutenzahl im Bereich von 00 bis 59
TZD = optionaler Zeitzonen-Bezeichner (engl. time zone designator) durch Angabe von Z oder +hh:mm oder -hh:mm

Die zusätzliche Angabe von Sekunden ist möglich, wird jedoch vom System ignoriert. Somit werden bespielweise die Zeitpunkte 1989-11-09T22:30:01 und 1989-11-09T22:30:59 vom System als gleichwertig interpretiert.

Es werden nur Werte im Bereich von 1900-01-01T00:00 bis 2079-06-06T23:59 als gültige Zeitpunkte akzeptiert.

nach oben

Edit

Project

Datenstruktur zur Kurzbeschreibung eines Projektes mit folgenden Eigenschaften:

Datentyp	Name	Beschreibung
long	ProjectID	Identifikationsnummer
string	Name	Projektname

nach oben

Edit

ProjectInfo

Datenstruktur zur ausführlichen Beschreibung eines Projektes mit folgenden Eigenschaften:

Datentyp	Name	Beschreibung
long	ProjectID	Identifikationsnummer
string	Name	Projektname

Diese Datenstruktur entspricht aktuell der Project-Datenstruktur, wird aber möglicherweise noch um weitere Projekt-Eigenschaften erweitert.

nach oben

Edit

Person

Datenstruktur zur Kurzbeschreibung einer Person mit folgenden Eigenschaften:

Datentyp	Name	Beschreibung
long	PersonID	Identifikationsnummer
string	Name	Name der Person

nach oben

Edit

PersonInfo

Datenstruktur zur ausführlichen Beschreibung einer Person mit folgenden Eigenschaften:

Datentyp	Name	Beschreibung
long	PersonID	Identifikationsnummer
string	Name	Name der Person
string	PictureURL	URL zum Profil-Bild der Person

nach oben

Edit

Keyword

Datenstruktur zur Kurzbeschreibung eines Schlagwortes mit folgenden Eigenschaften:

Datentyp	Name	Beschreibung
long	KeywordID	Identifikationsnummer
string	Name	Bezeichnung des Schlagwortes

nach oben

Edit

KeywordInfo

Datenstruktur zur ausführlichen Beschreibung eines Schlagwortes mit folgenden Eigenschaften:

Datentyp	Name	Beschreibung
long	KeywordID	Identifikationsnummer
string	Name	Bezeichnung des Schlagwortes
int	UsageCount	Anzahl, wie oft das Schlagwort verwendet wird.

Die UsageCount-Eigenschaft kann beispielweise verwendet werden, um eine Menge von Schlagwörtern als so genannte Schlagwortwolke (engl. tag cloud) darzustellen.

nach oben

Edit

Modification

Datenstruktur zur Beschreibung der Person und des Zeitpunktes in Verbindung mit der Änderung eines Elementes (Aufgabe, Notiz oder Datei):

Datentyp	Name	Beschreibung
Person	Person	Person, die das Element zuletzt geändert hat.
dateTime	Date	Änderungszeitpunkt

nach oben

Edit

Upload

Datenstruktur zur Beschreibung der Person und des Zeitpunktes in Verbindung mit dem Hochladen einer Datei:

Datentyp	Name	Beschreibung
Person	Person	Person, von der die Datei hochgeladen wurde.
dateTime	Date	Zeitpunkt, zu dem die Datei hochgeladen wurde.

nach oben

Edit

TaskItem

Datenstruktur zur Beschreibung eines Aufgaben-Elementes mit folgenden Eigenschaften:

Datentyp	Name	Beschreibung
long	TaskID	Identifikationsnummer
Project	Project	zugehöriges Projekt
string	Title	Kurzbeschreibung des Aufgaben-Elementes
string	Details	Details des Aufgaben-Elementes
boolean	IsFinished	aktueller Bearbeitungszustand der Aufgabe
dateTime	DueDate	Fälligkeitszeitpunkt der Aufgabe
Modification	Modification	Informationen zur letzten Änderung des Aufgaben-Elementes
Person-Array	Persons	Personen, mit denen das Aufgaben-Element getaggt ist.
Keyword-Array	Keywords	Schlagwörter, mit denen das Aufgaben-Element getaggt ist.
int	Revision	Anzahl, wie oft das Aufgaben-Element bereits geändert wurde.

nach oben

Edit

NoteItem

Datenstruktur zur Beschreibung eines Notiz-Elementes mit folgenden Eigenschaften:

Datentyp	Name	Beschreibung
long	NoteID	Identifikationsnummer
Project	Project	zugehöriges Projekt
string	Title	Kurzbeschreibung des Notiz-Elementes
string	Details	Details des Notiz-Elementes
Modification	Modification	Informationen zur letzten Änderung des Notiz-Elementes
Person-Array	Persons	Personen, mit denen das Notiz-Element getaggt ist.
Keyword-Array	Keywords	Schlagwörter, mit denen das Notiz-Element getaggt ist.
int	Revision	Anzahl, wie oft das Notiz-Element bereits geändert wurde.

nach oben

Edit

FileItem

Datenstruktur zur Beschreibung eines Datei-Elementes mit folgenden Eigenschaften:

Datentyp	Name	Beschreibung
long	FileID	Identifikationsnummer
Project	Project	zugehöriges Projekt
string	Name	Dateiname
string	ContentType	Inhaltstyp der Datei, z.B. text/plain, image/jpeg, application/pdf, etc.
long	Size	Größe der Datei in Bytes
string	Details	Details des Datei-Elementes
Upload	Upload	Informationen in Verbindung mit dem Hochladen der Datei
Modification	Modification	Informationen zur letzten Änderung des Datei-Elementes
Person-Array	Persons	Personen, mit denen das Datei-Element getaggt ist.
Keyword-Array	Keywords	Schlagwörter, mit denen das Datei-Element getaggt ist.
int	Revision	Anzahl, wie oft das Datei-Element bereits geändert wurde.

nach oben

Edit

Funktionen

Edit

AddKeywords

Weist eine Menge von Schlagwörtern einer Menge von Elementen (Aufgaben, Notizen, Dateien) zu.

SOAP 1.1 und SOAP 1.2 Beschreibung dieser Funktion

Parameter:

Datentyp	Name	Beschreibung
long-Array	TaskIDs	Identifikationsnummern der Aufgaben-Elemente, die mit den gegebenen Schlagwörtern getaggt werden sollen.
long-Array	NoteIDs	Identifikationsnummern der Notiz-Elemente, die mit den gegebenen Schlagwörtern getaggt werden sollen.
long-Array	FileIDs	Identifikationsnummern der Datei-Elemente, die mit den gegebenen Schlagwörtern getaggt werden sollen.
long-Array	KeywordIDs	Identifikationsnummern der Schlagwörter, mit denen die gegebenen Elemente getaggt werden sollen.
dateTime	ModificationDate	Lokaler Zeitpunkt des aufrufenden Nutzers, zu dem die gegebenen Elemente geändert werden.

Ungültige Identifikationsnummern für Elemente und Schlagwörter werden ignoriert.

Rückgabe: Diese Funktion liefert keinen Rückgabewert.

siehe auch: RemoveKeywords

nach oben

Edit

AddPersons

Weist eine Menge von Personen einer Menge von Elementen (Aufgaben, Notizen, Dateien) zu.

SOAP 1.1 und SOAP 1.2 Beschreibung dieser Funktion

Parameter:

Datentyp	Name	Beschreibung
long-Array	TaskIDs	Identifikationsnummern der Aufgaben-Elemente, die mit den gegebenen Personen getaggt werden sollen.
long-Array	NoteIDs	Identifikationsnummern der Notiz-Elemente, die mit den gegebenen Personen getaggt werden sollen.
long-Array	FileIDs	Identifikationsnummern der Datei-Elemente, die mit den gegebenen Personen getaggt werden sollen.
long-Array	PersonIDs	Identifikationsnummern der Personen, mit denen die gegebenen Elemente getaggt werden sollen.
dateTime	ModificationDate	Lokaler Zeitpunkt des aufrufenden Nutzers, zu dem die gegebenen Elemente geändert werden.

Ungültige Identifikationsnummern für Elemente und Personen werden ignoriert.

Rückgabe: Diese Funktion liefert keinen Rückgabewert.

siehe auch: RemovePersons

nach oben

Edit

DeleteItems

Löscht eine Menge von Elementen (Aufgaben, Notizen, Dateien).

SOAP 1.1 und SOAP 1.2 Beschreibung dieser Funktion

Parameter:

Datentyp	Name	Beschreibung
long-Array	TaskIDs	Identifikationsnummern der Aufgaben-Elemente, die gelöscht werden sollen.
long-Array	NoteIDs	Identifikationsnummern der Notiz-Elemente, die gelöscht werden sollen.
long-Array	FileIDs	Identifikationsnummern der Datei-Elemente, die gelöscht werden sollen.

Ungültige Identifikationsnummern für Elemente werden ignoriert.

Rückgabe: Diese Funktion liefert keinen Rückgabewert.

nach oben

Edit

DownloadFile

Herunterladen einer bestimmten Datei.

SOAP 1.1 und SOAP 1.2 Beschreibung dieser Funktion

Parameter:

Datentyp	Name	Beschreibung
long	FileID	Identifikationsnummer der Datei, die heruntergeladen werden soll.

Rückgabe:

Datentyp	Name	Beschreibung
string	Name	Name der heruntergeladenen Datei
string	ContentType	Inhaltstyp der heruntergeladenen Datei, z.B. text/plain, image/jpeg, application/pdf, etc.
byte-Array	Bytes	binärer Inhalt der heruntergeladenen Datei

siehe auch: NewFile

nach oben

Edit

GetItems

Liefert eine Menge bestimmter Elemente (Aufgaben, Notizen, Dateien) zurück.

SOAP 1.1 und SOAP 1.2 Beschreibung dieser Funktion

Parameter:

Datentyp	Name	Beschreibung
long-Array	TaskIDs	Identifikationsnummern der Aufgaben-Elemente, die zurückgegeben werden sollen.
long-Array	NoteIDs	Identifikationsnummern der Notiz-Elemente, die zurückgegeben werden sollen.
long-Array	FileIDs	Identifikationsnummern der Datei-Elemente, die zurückgegeben werden sollen.
boolean	IsDetails	Flag, ob von den angeforderten Elementen auch der Inhalt der Details-Eigenschaft zurückgeliefert werden soll.

Ungültige Identifikationsnummern für Elemente werden ignoriert.

Rückgabe:

Datentyp	Name	Beschreibung
TaskItem-Array	TaskItems	Aufgaben-Elemente, die durch den TaskIDs-Parameter angefordert wurden.
NoteItem-Array	NoteItems	Notiz-Elemente, die durch den NoteIDs-Parameter angefordert wurden.
FileItem-Array	FileItems	Datei-Elemente, die durch den FileIDs-Parameter angefordert wurden.

siehe auch: GetItemsByAdvancedSearch, GetItemsByNewsSearch

nach oben

Edit

GetItemsByAdvancedSearch

Liefert auf der Basis bestimmter Suchkriterien eine Menge gefundener Elemente (Aufgaben, Notizen, Dateien) zurück.

SOAP 1.1 und SOAP 1.2 Beschreibung dieser Funktion

Parameter:

Datentyp	Name	Beschreibung
string	SearchString	Suchtext, auf dessen Basis bestimmte Elemente gefunden werden sollen. Der Suchtext kann so formuliert werden, wie man es von der Suche im Internet (z.B. Google) gewohnt ist. Ein leerer Suchtext wird als Suchkriterium nach bestimmten Elementen ignoriert. Ein Wert mit mehr als 50 Zeichen führt zu einer Fehlerausnahme (Exception).
long-Array	ProjectIDs	Identifikationsnummern von aktiven Projekten des aufrufenden Nutzers, in denen nach bestimmten Elementen gesucht werden soll. Wenn keine Projekte angegeben werden (leeres Array), wird in allen aktiven Projekten des aufrufenden Nutzers gesucht.
long-Array	PersonIDs	Identifikationsnummern von Personen, mit denen die zu suchenden Elemente getaggt sein müssen.
long-Array	KeywordIDs	Identifikationsnummern von Schlagwörtern, mit denen die zu suchenden Elemente getaggt sein müssen.
boolean	IsUnfinishedTasks	Flag, ob nach unerledigten Aufgaben-Elementen gesucht werden soll.
boolean	IsFinishedTasks	Flag, ob nach erledigten Aufgaben-Elementen gesucht werden soll.
boolean	IsMinDueDate	Flag, ob der Fälligkeitszeitpunkt der zu suchenden Aufgaben größer oder gleich dem Wert des MinDueDate-Parameters sein muss.
dateTime	MinDueDate	minimaler Fälligkeitszeitpunkt der zu suchenden Aufgaben Dieser Wert wird ignoriert, wenn der IsMinDueDate-Parameter den Wert false hat.
boolean	IsMaxDueDate	Flag, ob der Fälligkeitszeitpunkt der zu suchenden Aufgaben kleiner oder gleich dem Wert des MaxDueDate-Parameters sein muss.
dateTime	MaxDueDate	maximaler Fälligkeitszeitpunkt der zu suchenden Aufgaben Dieser Wert wird ignoriert, wenn der IsMaxDueDate-Parameter den Wert false hat.
boolean	IsNotes	Flag, ob nach Notiz-Elementen gesucht werden soll.
boolean	IsFiles	Flag, ob nach Datei-Elementen gesucht werden soll.
boolean	IsModificationDate	Flag, ob nach Elementen gesucht werden soll, deren letzter Änderungszeitpunkt größer oder gleich dem Wert des ModificationDate-Parameters sein muss.
dateTime	ModificationDate	minimaler letzter Änderungszeitpunkt der zu suchenden Elemente Dieser Wert wird ignoriert, wenn der IsModificationDate-Parameter den Wert false hat.
boolean	IsModificationPerson	Flag, ob nach Elementen gesucht werden soll, die zuletzt von einer bestimmten Person geändert wurden.
long	ModificationPersonID	Identifikationsnummer der Person, die zuletzt die zu suchenden Elemente geändert hat. Dieser Wert wird ignoriert, wenn der IsModificationPerson-Parameter den Wert false hat.
boolean	IsDetails	Flag, ob von den gefundenen Elementen auch der Inhalt der Details-Eigenschaft zurückgeliefert werden soll.

Ungültige Identifikationsnummern für Projekte, Personen und Schlagwörter liefern keine Elemente zurück.

Rückgabe:

Datentyp	Name	Beschreibung
TaskItem-Array	TaskItems	Aufgaben-Elemente, die auf Basis der Suchkriterien gefunden wurden.
NoteItem-Array	NoteItems	Notiz-Elemente, die auf Basis der Suchkriterien gefunden wurden.
FileItem-Array	FileItems	Datei-Elemente, die auf Basis der Suchkriterien gefunden wurden.

siehe auch: GetItems, GetItemsByNewsSearch

nach oben

Edit

GetItemsByFullTextSearch

Liefert auf der Basis eines bestimmten Suchtextes eine Menge gefundener Elemente (Aufgaben, Notizen, Dateien) zurück.

Diese Funktion ist überflüssig und sollte nicht mehr verwendet werden. Verwenden Sie bitte stattdessen die GetItemsByAdvancedSearch-Funktion, um auf der Basis eines bestimmten Suchtextes nach Elementen zu suchen.

SOAP 1.1 und SOAP 1.2 Beschreibung dieser Funktion

Parameter:

Datentyp	Name	Beschreibung
string	SearchString	Suchtext, auf dessen Basis bestimmte Elemente gefunden werden sollen. Der Suchtext kann so formuliert werden, wie man es von der Suche im Internet (z.B. Google) gewohnt ist. Ein Wert mit mehr als 50 Zeichen führt zu einer Fehlerausnahme (Exception).
long-Array	ProjectIDs	Identifikationsnummern von aktiven Projekten des aufrufenden Nutzers, in denen nach bestimmten Elementen gesucht werden soll. Wenn keine Projekte angegeben werden (leeres Array), wird in allen aktiven Projekten des aufrufenden Nutzers gesucht.
boolean	IsUnfinishedTasks	Flag, ob nach unerledigten Aufgaben-Elementen gesucht werden soll.
boolean	IsFinishedTasks	Flag, ob nach erledigten Aufgaben-Elementen gesucht werden soll.
boolean	IsNotes	Flag, ob nach Notiz-Elementen gesucht werden soll.
boolean	IsFiles	Flag, ob nach Datei-Elementen gesucht werden soll.
boolean	IsDetails	Flag, ob von den gefundenen Elementen auch der Inhalt der Details-Eigenschaft zurückgeliefert werden soll.

Rückgabe:

Datentyp	Name	Beschreibung
TaskItem-Array	TaskItems	Aufgaben-Elemente, deren Title-Eigenschaft oder Details-Eigenschaft den Suchtext enthalten.
NoteItem-Array	NoteItems	Notiz-Elemente, deren Title-Eigenschaft oder Details-Eigenschaft den Suchtext enthalten.
FileItem-Array	FileItems	Datei-Elemente, deren Name-Eigenschaft oder Details-Eigenschaft den Suchtext enthalten.

siehe auch: GetItems, GetItemsByAdvancedSearch, GetItemsByNewsSearch

nach oben

Edit

GetItemsByNewsSearch

Liefert auf der Basis bestimmter Suchkriterien eine Menge gefundener Elemente (Aufgaben, Notizen, Dateien) zurück, die seit dem letzten Aufruf der ResetNews-Funktion von einer anderen Person als dem aufrufenden Nutzer geändert wurden.

SOAP 1.1 und SOAP 1.2 Beschreibung dieser Funktion

Parameter:

Datentyp	Name	Beschreibung
long-Array	ProjectIDs	Identifikationsnummern von aktiven Projekten des aufrufenden Nutzers, in denen nach bestimmten Elementen gesucht werden soll. Wenn keine Projekte angegeben werden (leeres Array), wird in allen aktiven Projekten des aufrufenden Nutzers gesucht.
long-Array	PersonIDs	Identifikationsnummern von Personen, mit denen die zu suchenden Elemente getaggt sein müssen.
long-Array	KeywordIDs	Identifikationsnummern von Schlagwörtern, mit denen die zu suchenden Elemente getaggt sein müssen.
boolean	IsUnfinishedTasks	Flag, ob nach unerledigten Aufgaben-Elementen gesucht werden soll.
boolean	IsFinishedTasks	Flag, ob nach erledigten Aufgaben-Elementen gesucht werden soll.
boolean	IsNotes	Flag, ob nach Notiz-Elementen gesucht werden soll.
boolean	IsFiles	Flag, ob nach Datei-Elementen gesucht werden soll.
boolean	IsDetails	Flag, ob von den gefundenen Elementen auch der Inhalt der Details-Eigenschaft zurückgeliefert werden soll.

Ungültige Identifikationsnummern für Projekte, Personen und Schlagwörter liefern keine Elemente zurück.

Rückgabe:

Datentyp	Name	Beschreibung
TaskItem-Array	TaskItems	Aufgaben-Elemente, die auf Basis der Suchkriterien gefunden wurden und die seit dem letzten Aufruf der ResetNews-Funktion von einer anderen Person als dem aufrufenden Nutzer geändert wurden.
NoteItem-Array	NoteItems	Notiz-Elemente, die auf Basis der Suchkriterien gefunden wurden und die seit dem letzten Aufruf der ResetNews-Funktion von einer anderen Person als dem aufrufenden Nutzer geändert wurden.
FileItem-Array	FileItems	Datei-Elemente, die auf Basis der Suchkriterien gefunden wurden und die seit dem letzten Aufruf der ResetNews-Funktion von einer anderen Person als dem aufrufenden Nutzer geändert wurden.

siehe auch: ResetNews, GetItems, GetItemsByAdvancedSearch

nach oben

Edit

GetKeywordID

Liefert die Identifikationsnummer eines neuen oder bereits vorhandenen Schlagwortes zurück.

SOAP 1.1 und SOAP 1.2 Beschreibung dieser Funktion

Parameter:

Datentyp	Name	Beschreibung
string	Keyword	Schlagwort, dessen Identifikationsnummer zurückgegeben werden soll. Der Wert dieses Parameters muss dem folgenden regulären Ausdruck entsprechen: ^\S{1,20}$

Rückgabe:

Datentyp	Beschreibung
long	Identifikationsnummer des übergebenen Schlagwortes

nach oben

Edit

GetProjectKeywords

Liefert alle Schlagwörter zurück, mit denen Elemente (Aufgaben, Notizen, Dateien) eines bestimmten aktiven Projektes des aufrufenden Nutzers getaggt sind.

SOAP 1.1 und SOAP 1.2 Beschreibung dieser Funktion

Parameter:

Datentyp	Name	Beschreibung
long	ProjectID	Identifikationsnummer des Projektes, dessen Schlagwörter zurückgegeben werden sollen. Eine ungültige Projekt-Identifikationsnummer führt zu einer Fehlerausnahme (Exception).

Rückgabe:

Datentyp	Beschreibung
KeywordInfo-Array	Alphabetisch sortierte Liste aller Schlagwörter, mit denen Elemente des gegebenen Projektes getaggt sind.

siehe auch: GetUserKeywords

nach oben

Edit

GetProjectTeam

Liefert alle Personen eines bestimmten aktiven Projektes des aufrufenden Nutzers zurück.

SOAP 1.1 und SOAP 1.2 Beschreibung dieser Funktion

Parameter:

Datentyp	Name	Beschreibung
long	ProjectID	Identifikationsnummer des Projektes, dessen Teammitglieder zurückgegeben werden sollen. Eine ungültige Projekt-Identifikationsnummer führt zu einer Fehlerausnahme (Exception).

Rückgabe:

Datentyp	Beschreibung
PersonInfo-Array	nach Namen alphabetisch sortierte Liste aller Personen des gegebenen Projektes

siehe auch: GetUserTeam

nach oben

Edit

GetUserInfo

Liefert Informationen zum aufrufenden Nutzer zurück.

SOAP 1.1 und SOAP 1.2 Beschreibung dieser Funktion

Parameter: Diese Funktion erfordert keine Parameter.

Rückgabe:

Datentyp	Name	Beschreibung
long	UserID	Identifikationsnummer des aufrufenden Nutzers
string	Name	Name des aufrufenden Nutzers
string	PictureURL	URL zum Profil-Bild des aufrufenden Nutzers
long	FreeFileStorage	Speicherplatz in Bytes, der dem aufrufenden Nutzer noch zum Hochladen von Dateien zur Verfügung steht.

siehe auch: GetUserKeywords, GetUserProjects, GetUserTeam

nach oben

Edit

GetUserKeywords

Liefert alle Schlagwörter zurück, mit denen Elemente (Aufgaben, Notizen, Dateien) aus allen aktiven Projekten des aufrufenden Nutzers getaggt sind. Das Ergebnis umfasst somit alle Schlagwörter, wie sie auf dem klassischen Workity-Dashboard dargestellt werden.

SOAP 1.1 und SOAP 1.2 Beschreibung dieser Funktion

Parameter: Diese Funktion erfordert keine Parameter.

Rückgabe:

Datentyp	Beschreibung
KeywordInfo-Array	Alphabetisch sortierte Liste aller Schlagwörter, mit denen Elemente aus allen aktiven Projekten des aufrufenden Nutzers getaggt sind.

siehe auch: GetProjectKeywords, GetUserInfo, GetUserProjects, GetUserTeam

nach oben

Edit

GetUserProjects

Liefert alle aktiven Projekte des aufrufenden Nutzers zurück.

SOAP 1.1 und SOAP 1.2 Beschreibung dieser Funktion

Parameter: Diese Funktion erfordert keine Parameter.

Rückgabe:

Datentyp	Beschreibung
ProjectInfo-Array	alphabetisch sortierte Liste aller aktiven Projekte des aufrufenden Nutzers

siehe auch: GetUserInfo, GetUserKeywords, GetUserTeam

nach oben

Edit

GetUserTeam

Liefert alle Personen aus allen aktiven Projekten des aufrufenden Nutzers zurück. Das Ergebnis umfasst somit das gesamte Team (einschließlich des aufrufenden Nutzers), wie es auf dem klassischen Workity-Dashboard dargestellt wird.

SOAP 1.1 und SOAP 1.2 Beschreibung dieser Funktion

Parameter: Diese Funktion erfordert keine Parameter.

Rückgabe:

Datentyp	Beschreibung
PersonInfo-Array	nach Namen alphabetisch sortierte Liste aller Personen aus allen aktiven Projekten des aufrufenden Nutzers

siehe auch: GetProjectTeam, GetUserInfo, GetUserKeywords, GetUserProjects

nach oben

Edit

IsAuthenticated

Gibt zurück, ob die Authentisierung des aufrufenden Nutzers gültig ist.

SOAP 1.1 und SOAP 1.2 Beschreibung dieser Funktion

Parameter: Diese Funktion erfordert keine Parameter.

Rückgabe:

Datentyp	Beschreibung
boolean	true: Die Authentisierung des aufrufenden Nutzers ist (noch) gültig. false: Die Authentisierung des aufrufenden Nutzers ist nicht (mehr) gültig.

siehe auch: Ticket-Authentisierung, Login, Logout

nach oben

Edit

Login

Ermöglicht die Authentisierung eines bestimmten Nutzers anhand der zugehörigen Workity-Zugangsdaten.

Ohne gültige Nutzer-Authentisierung kann keine andere Funktion der Programmierschnittstellen erfolgreich aufgerufen werden.

SOAP 1.1 und SOAP 1.2 Beschreibung dieser Funktion

Parameter:

Datentyp	Name	Beschreibung
string	Email	Nutzer-E-Mail-Adresse des Workity-Nutzers, der sich authentisieren möchte.
string	Password	Passwort des Workity-Nutzers, der sich authentisieren möchte.

Rückgabe:

Datentyp

Beschreibung

int

0: Die Nutzer-Authentisierung war erfolgreich.
-1: Die Nutzer-Authentisierung war nicht erfolgreich, weil eine ungültige Nutzer-E-Mail-Adresse und/oder ein ungültiges Passwort übergeben wurden.
-2: Die Nutzer-Authentisierung war nicht erfolgreich, weil der Nutzer mit der übergebenen Nutzer-E-Mail-Adresse aufgrund von mehr als 5 ungültigen Authentisierungsversuchen aktuell gesperrt ist.
-3: Die Nutzer-Authentisierung war nicht erfolgreich, weil der Nutzer mit der übergebenen Nutzer-E-Mail-Adresse noch nicht die Workity Nutzungsbedingungen und Datenschutzbestimmungen akzeptiert hat.
-4: Die Nutzer-Authentisierung war nicht erfolgreich, weil der Nutzer mit der übergebenen Nutzer-E-Mail-Adresse aktuell kein Workity Premium-Mitglied ist.

siehe auch: Ticket-Authentisierung, Logout, IsAuthenticated

nach oben

Edit

Logout

Macht die Authentisierung des aufrufenden Nutzers ungültig.

SOAP 1.1 und SOAP 1.2 Beschreibung dieser Funktion

Parameter: Diese Funktion erfordert keine Parameter.

Rückgabe:

Datentyp	Beschreibung
boolean	true: Die Authentisierung des aufrufenden Nutzers war zum Aufrufzeitpunkt (noch) gültig. false: Die Authentisierung des aufrufenden Nutzers war bereits zum Aufrufzeitpunkt nicht (mehr) gültig.

siehe auch: Ticket-Authentisierung, Login, IsAuthenticated

nach oben

Edit

NewFile

Erzeugt ein neues Datei-Element.

SOAP 1.1 und SOAP 1.2 Beschreibung dieser Funktion

Parameter:

Datentyp	Name	Beschreibung
long	ProjectID	Identifikationsnummer des Projektes, innerhalb dessen das neue Datei-Element erstellt werden soll. Eine ungültige Projekt-Identifikationsnummer führt zu einer Fehlerausnahme (Exception).
long-Array	PersonIDs	Identifikationsnummern von Personen, mit denen das neue Datei-Element getaggt sein soll. Ungültige Identifikationsnummern von Personen, die nicht an dem durch den ProjectID-Parameter bestimmten Projekt beteiligt sind, werden ignoriert. Wenn keine gültigen Identifikationsnummern von Personen übergeben werden, wird das neue Datei-Element automatisch mit der Identifikationsnummer des aufrufenden Nutzers getaggt.
long-Array	KeywordIDs	Identifikationsnummern von Schlagwörtern, mit denen das neue Datei-Element getaggt sein soll. Ungültige Identifikationsnummern von Schlagwörtern werden ignoriert.
string	Name	Dateiname Eine leere Zeichenkette oder ein Wert mit mehr als 100 Zeichen führt zu einer Fehlerausnahme (Exception).
string	ContentType	Inhaltstyp der Datei, z.B. text/plain, image/jpeg, application/pdf, etc. Eine leere Zeichenkette oder ein Wert mit mehr als 100 Zeichen führt zu einer Fehlerausnahme (Exception).
string	Details	Details des neuen Datei-Elementes
byte-Array	Bytes	binärer Inhalt der Datei Ein leeres Datenfeld (Array) führt zu einer Fehlerausnahme (Exception).
dateTime	ModificationDate	Lokaler Zeitpunkt des aufrufenden Nutzers, zu dem das neue Datei-Element erstellt wurde.

Rückgabe:

Datentyp	Beschreibung
long	Identifikationsnummer des neuen Datei-Elementes Wenn für den aufrufenden Nutzer nicht mehr ausreichend Speicherplatz zum Hochladen der Datei zur Verfügung steht, wird -1 zurückgegeben.

siehe auch: NewNote, NewTask

nach oben

Edit

NewNote

Erzeugt ein neues Notiz-Element.

SOAP 1.1 und SOAP 1.2 Beschreibung dieser Funktion

Parameter:

Datentyp	Name	Beschreibung
long	ProjectID	Identifikationsnummer des Projektes, innerhalb dessen das neue Notiz-Element erstellt werden soll. Eine ungültige Projekt-Identifikationsnummer führt zu einer Fehlerausnahme (Exception).
long-Array	PersonIDs	Identifikationsnummern von Personen, mit denen das neue Notiz-Element getaggt sein soll. Ungültige Identifikationsnummern von Personen, die nicht an dem durch den ProjectID-Parameter bestimmten Projekt beteiligt sind, werden ignoriert. Wenn keine gültigen Identifikationsnummern von Personen übergeben werden, wird das neue Notiz-Element automatisch mit der Identifikationsnummer des aufrufenden Nutzers getaggt.
long-Array	KeywordIDs	Identifikationsnummern von Schlagwörtern, mit denen das neue Notiz-Element getaggt sein soll. Ungültige Identifikationsnummern von Schlagwörtern werden ignoriert.
string	Title	Kurzbeschreibung des neuen Notiz-Elementes Eine leere Zeichenkette oder ein Wert mit mehr als 100 Zeichen führt zu einer Fehlerausnahme (Exception).
string	Details	Details des neuen Notiz-Elementes
dateTime	ModificationDate	Lokaler Zeitpunkt des aufrufenden Nutzers, zu dem das neue Notiz-Element erstellt wurde.

Rückgabe:

Datentyp	Beschreibung
long	Identifikationsnummer des neuen Notiz-Elementes

siehe auch: NewFile, NewTask

nach oben

Edit

NewTask

Erzeugt ein neues Aufgaben-Element.

SOAP 1.1 und SOAP 1.2 Beschreibung dieser Funktion

Parameter:

Datentyp	Name	Beschreibung
long	ProjectID	Identifikationsnummer des Projektes, innerhalb dessen das neue Aufgaben-Element erstellt werden soll. Eine ungültige Projekt-Identifikationsnummer führt zu einer Fehlerausnahme (Exception).
long-Array	PersonIDs	Identifikationsnummern von Personen, mit denen das neue Aufgaben-Element getaggt sein soll. Ungültige Identifikationsnummern von Personen, die nicht an dem durch den ProjectID-Parameter bestimmten Projekt beteiligt sind, werden ignoriert. Wenn keine gültigen Identifikationsnummern von Personen übergeben werden, wird das neue Aufgaben-Element automatisch mit der Identifikationsnummer des aufrufenden Nutzers getaggt.
long-Array	KeywordIDs	Identifikationsnummern von Schlagwörtern, mit denen das neue Aufgaben-Element getaggt sein soll. Ungültige Identifikationsnummern von Schlagwörtern werden ignoriert.
string	Title	Kurzbeschreibung des neuen Aufgaben-Elementes Eine leere Zeichenkette oder ein Wert mit mehr als 100 Zeichen führt zu einer Fehlerausnahme (Exception).
string	Details	Details des neuen Aufgaben-Elementes
dateTime	DueDate	Fälligkeitszeitpunkt der neuen Aufgabe
dateTime	ModificationDate	Lokaler Zeitpunkt des aufrufenden Nutzers, zu dem das neue Aufgaben-Element erstellt wurde.

Rückgabe:

Datentyp	Beschreibung
long	Identifikationsnummer des neuen Aufgaben-Elementes

siehe auch: NewFile, NewNote

nach oben

Edit

RemoveKeywords

Entfernt eine Menge von Schlagwörtern von einer Menge von Elementen (Aufgaben, Notizen, Dateien).

SOAP 1.1 und SOAP 1.2 Beschreibung dieser Funktion

Parameter:

Datentyp	Name	Beschreibung
long-Array	TaskIDs	Identifikationsnummern der Aufgaben-Elemente, die nicht mehr mit den gegebenen Schlagwörtern getaggt sein sollen.
long-Array	NoteIDs	Identifikationsnummern der Notiz-Elemente, die nicht mehr mit den gegebenen Schlagwörtern getaggt sein sollen.
long-Array	FileIDs	Identifikationsnummern der Datei-Elemente, die nicht mehr mit den gegebenen Schlagwörtern getaggt sein sollen.
long-Array	KeywordIDs	Identifikationsnummern der Schlagwörter, mit denen die gegebenen Elemente nicht mehr getaggt sein sollen.
dateTime	ModificationDate	Lokaler Zeitpunkt des aufrufenden Nutzers, zu dem die gegebenen Elemente geändert werden.

Ungültige Identifikationsnummern für Elemente und Schlagwörter werden ignoriert.

Rückgabe: Diese Funktion liefert keinen Rückgabewert.

siehe auch: AddKeywords

nach oben

Edit

RemovePersons

Entfernt eine Menge von Personen von einer Menge von Elementen (Aufgaben, Notizen, Dateien).

SOAP 1.1 und SOAP 1.2 Beschreibung dieser Funktion

Parameter:

Datentyp	Name	Beschreibung
long-Array	TaskIDs	Identifikationsnummern der Aufgaben-Elemente, die nicht mehr mit den gegebenen Personen getaggt sein sollen.
long-Array	NoteIDs	Identifikationsnummern der Notiz-Elemente, die nicht mehr mit den gegebenen Personen getaggt sein sollen.
long-Array	FileIDs	Identifikationsnummern der Datei-Elemente, die nicht mehr mit den gegebenen Personen getaggt sein sollen.
long-Array	PersonIDs	Identifikationsnummern der Personen, mit denen die gegebenen Elemente nicht mehr getaggt sein sollen.
dateTime	ModificationDate	Lokaler Zeitpunkt des aufrufenden Nutzers, zu dem die gegebenen Elemente geändert werden.

Ungültige Identifikationsnummern für Elemente und Personen werden ignoriert.

Rückgabe: Diese Funktion liefert keinen Rückgabewert.

siehe auch: AddPersons

nach oben

Edit

ResetNews

Nach Aufruf dieser Funktion werden durch die GetItemsByNewsSearch-Funktion nur Elemente (Aufgaben, Notizen, Dateien) gefunden, die seit diesem Aufrufzeitpunkt von einer anderen Person als dem aufrufenden Nutzer geändert wurden. Ein Aufruf dieser Funktion setzt somit die Menge aller zuletzt durch die GetItemsByNewsSearch-Funktion gefundenen Elemente zurück.

SOAP 1.1 und SOAP 1.2 Beschreibung dieser Funktion

Parameter: Diese Funktion erfordert keine Parameter.

Rückgabe: Diese Funktion liefert keinen Rückgabewert.

siehe auch: GetItemsByNewsSearch

nach oben

Edit

SaveFile

Speichert ein bestehendes Datei-Element.

SOAP 1.1 und SOAP 1.2 Beschreibung dieser Funktion

Parameter:

Datentyp	Name	Beschreibung
long	ProjectID	Identifikationsnummer des zugehörigen Projektes Eine ungültige Projekt-Identifikationsnummer führt zu einer Fehlerausnahme (Exception).
long	FileID	Identifikationsnummer des Datei-Elementes
string	Details	Details des Datei-Elementes
int	NewRevision	neue Revision des Datei-Elementes Die neue Revision sollte stets der aktuellen Revision + 1 entsprechen. Eine neue Revision kleiner 1 oder größer der aktuellen Revision + 1 führt zu einer Fehlerausnahme (Exception).
dateTime	ModificationDate	Lokaler Zeitpunkt des aufrufenden Nutzers, zu dem das Datei-Element gespeichert wurde.

Rückgabe:

Datentyp	Beschreibung
long	0: Das Datei-Element wurde erfolgreich gespeichert. 1: Beim Speichern des Datei-Elementes ist ein Schreib-Schreib-Konflikt aufgetreten. 2: Beim Speichern des Datei-Elementes ist ein Lösch-Schreib-Konflikt aufgetreten.

siehe auch: SaveNote, SaveTask

nach oben

Edit

SaveNote

Speichert ein bestehendes Notiz-Element.

SOAP 1.1 und SOAP 1.2 Beschreibung dieser Funktion

Parameter:

Datentyp	Name	Beschreibung
long	ProjectID	Identifikationsnummer des zugehörigen Projektes Eine ungültige Projekt-Identifikationsnummer führt zu einer Fehlerausnahme (Exception).
long	NoteID	Identifikationsnummer des Notiz-Elementes
string	Title	Kurzbeschreibung des Notiz-Elementes Eine leere Zeichenkette oder ein Wert mit mehr als 100 Zeichen führt zu einer Fehlerausnahme (Exception).
string	Details	Details des Notiz-Elementes
int	NewRevision	neue Revision des Notiz-Elementes Die neue Revision sollte stets der aktuellen Revision + 1 entsprechen. Eine neue Revision kleiner 1 oder größer der aktuellen Revision + 1 führt zu einer Fehlerausnahme (Exception).
dateTime	ModificationDate	Lokaler Zeitpunkt des aufrufenden Nutzers, zu dem das Notiz-Element gespeichert wurde.

Rückgabe:

Datentyp	Beschreibung
long	0: Das Notiz-Element wurde erfolgreich gespeichert. 1: Beim Speichern des Notiz-Elementes ist ein Schreib-Schreib-Konflikt aufgetreten. 2: Beim Speichern des Notiz-Elementes ist ein Lösch-Schreib-Konflikt aufgetreten.

siehe auch: SaveFile, SaveTask

nach oben

Edit

SaveTask

Speichert ein bestehendes Aufgaben-Element.

SOAP 1.1 und SOAP 1.2 Beschreibung dieser Funktion

Parameter:

Datentyp	Name	Beschreibung
long	ProjectID	Identifikationsnummer des zugehörigen Projektes Eine ungültige Projekt-Identifikationsnummer führt zu einer Fehlerausnahme (Exception).
long	TaskID	Identifikationsnummer des Aufgaben-Elementes
string	Title	Kurzbeschreibung des Aufgaben-Elementes Eine leere Zeichenkette oder ein Wert mit mehr als 100 Zeichen führt zu einer Fehlerausnahme (Exception).
string	Details	Details des Aufgaben-Elementes
dateTime	DueDate	Fälligkeitszeitpunkt der Aufgabe
int	NewRevision	neue Revision des Aufgaben-Elementes Die neue Revision sollte stets der aktuellen Revision + 1 entsprechen. Eine neue Revision kleiner 1 oder größer der aktuellen Revision + 1 führt zu einer Fehlerausnahme (Exception).
dateTime	ModificationDate	Lokaler Zeitpunkt des aufrufenden Nutzers, zu dem das Aufgaben-Element gespeichert wurde.

Rückgabe:

Datentyp	Beschreibung
long	0: Das Aufgaben-Element wurde erfolgreich gespeichert. 1: Beim Speichern des Aufgaben-Elementes ist ein Schreib-Schreib-Konflikt aufgetreten. 2: Beim Speichern des Aufgaben-Elementes ist ein Lösch-Schreib-Konflikt aufgetreten.

siehe auch: SaveFile, SaveNote

nach oben

Edit

UpdateTaskStatus

Aktualisiert den Bearbeitungsstand einer Aufgabe.

SOAP 1.1 und SOAP 1.2 Beschreibung dieser Funktion

Parameter:

Datentyp	Name	Beschreibung
long	TaskID	Identifikationsnummer des zugehörigen Aufgaben-Elementes Eine ungültige Identifikationsnummer führt zu einer Fehlerausnahme (Exception).
boolean	IsFinished	neuer Bearbeitungsstand der Aufgabe true: Die Aufgabe ist nun erledigt. false: Die Aufgabe ist noch nicht erledigt.
dateTime	ModificationDate	Lokaler Zeitpunkt des aufrufenden Nutzers, zu dem das Aufgaben-Element aktualisiert wurde.

Rückgabe: Diese Funktion liefert keinen Rückgabewert.

nach oben

Edit

Beispiele

Edit

HTML-Backup-Anwendung

Die HTML-Backup-Anwendung ist eine einfache Windows Konsolen-Anwendung, um automatisch regelmäßige Backups aller Projektinhalte im HTML-Format zu erstellen.

Beim Start der Anwendung werden zunächst die Nutzer-E-Mail-Adresse und das Passwort eines Premium-Nutzers abgefragt. Nach erfolgreicher Anmeldung wird im Anwendungsverzeichnis eine HTML-Datei erzeugt, die alle aktuellen Inhalte (Aufgaben, Notizen, Dateien) aus allen aktiven Projekten dieses Workity-Nutzers umfasst.

Dementsprechend fasst diese Konsolen-Anwendung die folgenden Aktionen der Workity Web-Anwendung zusammen:

Auswahl aller aktiven Projekte auf dem Dashboard
Ausführung der Aktion "Elemente anzeigen"
Auswahl aller Elemente auf dem Dashboard
Ausführung der Aktion "Ausgewählte Elemente als HTML-Datei exportieren"

Download der Anwendung: WorkityBackup.zip (20 KB)

Download C# Quellcode der Anwendung als Microsoft Visual Studio Projekt: WorkityBackupSource.zip (151 KB)

siehe auch: Wie kann ich meine Projektinhalte exportieren?

nach oben

English version of this page: Workity API