Dokument anlegen (REST API)

POST auf api/task

Beispiel JSON Body:

{  
   "Title":"Anschreiben mit Bitte",
   "DateTime":"2015-10-12T10:59:28",
   "UserId":"7465",
   "PersonId":"28348708",
   "IsOutbound":true
}

Felder, die nicht gefüllt werden sollen, können weggelassen werden im JSON.

Feld Typ Bedeutung
Title Text Titel des Dokuments
DateTime DateTime Zeitstempel des Dokuments
User
UserId
Text
ID
Benutzer für den die Aufgabe sein soll
Es kann entweder die ID des Benutzers übergeben werden (UserId) oder die E-Mail-Adresse (User).
Wenn leer, wird der aktuelle Benutzer gesetzt.
Contact
ContactId
Person
PersonId
Text
ID
Text
ID
Es kann über ContactId oder PersonId die ID eines Kontaktes übergeben werden.
Im Feld Contact kann auch die E-Mail-Adresse eines Kontaktes übergeben werden.
ProjectId ID Es kann die ID eines Projektes übergeben werden.
IsOutbound Bool  True: Es handelt sich um ein ausgehendes Dokument
False: Es handelt sich um ein eingehendes Dokument
WithHistory Bool True: Es wird ein Historieneintrag für das Dokument angelegt.

Es muss entweder ein Contact, eine Person oder ein Project angegeben werden, sonst wird das Dokument nicht angelegt.

Die Datei des Dokuments muss beim POST Aufruf mit übergeben werden. D.h. der POST Aufruf muss als "multipart/form-data" erfolgen. Beispiel:

-------------------------------28947758029299
Content-Type: application/json
Content-Disposition: form-data; name="application/json"

"Title":"Test Dokument","ContactId":"233"}
-------------------------------28947758029299
Content-Disposition: form-data; name="Test Dokument.docx"; filename="Doc.docx"
Content-Type: application/octet-stream

Data...

Beispiel in C# mit RestSharp:

var document = new DocumentDTO
{
  Title = "Test Dokument",
  Contact = "test@test.de"
};

var client = new RestClient(textBoxUrl.Text);
client.Authenticator = new HttpBasicAuthenticator(textBoxUser.Text, textBoxApiKey.Text);
var request = new RestRequest("api/document", Method.POST);
request.RequestFormat = DataFormat.Json;
request.AddBody(document);
request.AddFile("Test Dokument.docx", @"C:\Temp\Doc.docx");
var response = client.Execute(request);
Haben Sie Fragen? Anfrage einreichen

Kommentare

  • Avatar
    Tobias Knipping

    POST auf api/task müsste wohl POST auf api/documents heißen oder?

Powered by Zendesk