Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Zaktualizowano opis endpointa umożlwiającego dodanie dokumentu (zmiana od wersji 4.0.35)

...

  • Odpowiedź zawiera listę indeksów.

Dodanie

...

dokumentu (do wersji 4.0.35)

 

Ścieżka do servletu: api/documents/upload

...

Tip
titleWsparcie dla InternetExplorer

 W przeglądarce InternetExplorer aby wykonać upload pliku serwer musi odpowiedzieć z nagłówkiem Content-Type: text/html. Należy w takim wypadku wywołać żądanie z dodatkowym parametrem:

responseAsHtml - true wymusza ustawienie nagłówka Content-Type na text/html

 

Dodanie dokumentu (od wersji 4.0.35)

 

 

Ścieżka do servletu: api/documents/upload

Metoda: POST

enctypemultipart/form-data

 Treść zapytania:

 Formularz HTML zawierający definicję dokumentu. Definicja powinna zawierać następujące pole:

    • file - Pole typu file 
    • activityId - Id zadania
    • processId - Id procesu
    • documentClassId - Id klasy dokumentów
    • description - Opis
    • newVersion - (true/false) Czy zapisać jako nowa wersja
    • indexes - (opcjonalny) Wartości indeksów dodawanego dokumentu. Wartości powinny być przekazane w formacie JSON:

      Code Block
      languagejs
      titlePrzykład prawidłowej wartości pola indexes
      indexes: {
      	"1": "Wartość indeksu o id 1",
      	"3": "Wartość indeksu o id 3"
      }
    Code Block
    titlePrzykładowa treść zapytania z programu POSTMAN
    collapsetrue
    POST /PlusWorkflow/api/documents/upload HTTP/1.1
    Host: localhost:8080
    Cache-Control: no-cache
    Postman-Token: 4ab6c224-0ea3-9ecc-c8ac-a4823501a54b
    Content-Type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW
    ------WebKitFormBoundary7MA4YWxkTrZu0gW
    Content-Disposition: form-data; name="file"; filename="Nowy dokument tekstowy.txt"
    Content-Type: text/plain
    
    ------WebKitFormBoundary7MA4YWxkTrZu0gW
    Content-Disposition: form-data; name="documentClassId"
    1
    ------WebKitFormBoundary7MA4YWxkTrZu0gW
    Content-Disposition: form-data; name="newVersion"
    false
    ------WebKitFormBoundary7MA4YWxkTrZu0gW
    Content-Disposition: form-data; name="indexes"
    { "1": "Wartość indeksu o id 1", "3": "Wartość indeksu o id 3" }
    ------WebKitFormBoundary7MA4YWxkTrZu0gW--

     

    Parametry activityId i processId są opcjonalne:

    • Jeżeli podamy oba parametry, to dokument zostanie dodany do archiwum i podłączony do wskazanego zadania.
    • Jeżeli podamy tylko processId, to dokument zostanie dodany do archiwum i podłączony do wskazanego procesu.
    • Jeżeli nie podamy żadnego z tych parametrów lub podamy tylko activityId, to dokument zostanie dodany tylko do archiwum.

 

Odpowiedź:

  • Odpowiedź zawiera definicję zapisanego pliku

 

 

Tip
titleWsparcie dla InternetExplorer

 W przeglądarce InternetExplorer aby wykonać upload pliku serwer musi odpowiedzieć z nagłówkiem Content-Type: text/html. Należy w takim wypadku wywołać żądanie z dodatkowym parametrem:

responseAsHtml - true wymusza ustawienie nagłówka Content-Type na text/html

Pobieranie dokumentu

Ścieżka do servletu: api/documents/download/{fileId}

...