Page History

...

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

Metoda: GET

Parametry:

• processId - Id procesu dla którego chcemy pobrać dokumenty
• activityId - (opcjonalny) Id zadania dla którego chcemy pobrać dokumenty. Jeżeli nie podano, pobrane zostaną wszystkie dokumenty z procesu.

Odpowiedź:

• Odpowiedź zawiera listę dokumentów.

...

Ścieżka do servletu: api/documents/view/query

Metoda: GET

Parametry:

• processId - Id procesu dla którego chcemy pobrać dokumenty
• activityId - (opcjonalny) Id zadania dla którego chcemy pobrać dokumenty. Jeżeli nie podano, pobrane zostaną wszystkie dokumenty z procesu.

Odpowiedź:

• Odpowiedź zawiera listę dokumentów.

...

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

Metoda: GET

Parametry:

• rightType - typ uprawnień do dodawania dokumentów do systemu, jeden z:
  • ALL - do procesu lub archiwum,
  • PROCESS - do procesu,
  • ARCHIVE - do archiwum.

Odpowiedź:

• Odpowiedź zawiera listę klas dokumentów do których zalogowany użytkownik ma uprawnienia.

...

Dodanie dokumentu (do wersji 4.0.35)

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

...

Dodanie dokumentu (od wersji 4.0.35)

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

...

enctype: multipart/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
    language js title Przykład prawidłowej wartości pola indexes
    indexes: { "1": "Wartość indeksu o id 1", "3": "Wartość indeksu o id 3" }

  Code Block
  title Przykładowa treść zapytania z programu POSTMAN collapse true
  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

...

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

Metoda: GET

Parametry:

• fileId - Id pliku, który chcemy pobrać ( parametr przekazany w ścieżce servlet'u) 

Odpowiedź:

• Strumień danych z plikiem
• Status HTTP: OK lub UNAUTHORIZED 

...

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

Metoda: DELETE

Parametry:

• fileId - Id pliku, który chcemy pobrać ( parametr przekazany w ścieżce servlet'u) 
• processId - Id procesu, z którego odłączamy plik

Odpowiedź:

• brak odpowiedzi

...

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

Metoda: DELETE

Parametry:

• fileId - Id pliku, który chcemy usunąć (parametr przekazany w ścieżce servlet'u) 
• deleteAllVersions (opcjonalny - domyślnie false) - Określa, czy mają być również usunięte wszystkie wcześniejsze wersje tego dokumentu.

Odpowiedź:

• brak odpowiedzi

...

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

Metoda: GET

Parametry:

• fileId- Id pliku dla którego chcemy pobrać  wszystkie wersje( parametr przekazany w ścieżce servlet'u) 

Odpowiedź:

• Odpowiedź zawiera listę dokumentów.

...

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

Metoda: PUT

Parametry:

• fileId- Id pliku ( parametr przekazany w ścieżce servlet'u)

Odpowiedź:

• Odpowiedni HTTPStatus: OK, CONFLICT lub FORBIDDEN 
  
  

...

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

Metoda: PUT

Parametry:

• fileId- Id pliku ( parametr przekazany w ścieżce servlet'u)

Odpowiedź:

• Odpowiedni HTTPStatus: OK lub CONFLICT
  
  

...

• • file - Pole typu file 
  • description - Opis
  • parentFileId - id pliku, który aktualizujemy
  • comment - komentarz

  Code Block
  title Przykładowa treść zapytania z programu POSTMAN collapse true
  POST /PlusWorkflow/api/documents/checkIn HTTP/1.1 Host: localhost:8080 Authorization: Basic YWRtaW46ZW5oeWRyYQ== Cache-Control: no-cache Postman-Token: 201b80af-904e-de34-2678-c476fda6d348 Content-Type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW ------WebKitFormBoundary7MA4YWxkTrZu0gW Content-Disposition: form-data; name="file"; filename="x6.docx" Content-Type: ------WebKitFormBoundary7MA4YWxkTrZu0gW Content-Disposition: form-data; name="parentFileId" 179 ------WebKitFormBoundary7MA4YWxkTrZu0gW Content-Disposition: form-data; name="comment" my comment ------WebKitFormBoundary7MA4YWxkTrZu0gW--

Odpowiedź:

• Odpowiedź zawiera id zapisanego pliku w przypadku poprawnego zapisu lub treść błędu w zależności od zwróconego statusu odpowiedzi.

Pobieranie aktualnego statusu dokumentu

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

Metoda: GET

Parametry:

• fileId - Id pliku

Odpowiedź:

• Aktualny status dokumentu.

...