Versions Compared

Old Version 17

changes.mady.by.user Patryk Kotlarz

Saved on

compared with

New Version Current

changes.mady.by.user Joanna Jankowiak

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Polish

Pobieranie skrzynki zadań zalogowanego użytkownika

Ścieżka do servletu: api/activities/my

Metoda: GET

Parametry:

  • start - przesunięcie w zbiorze wynikowym
  • limit - maksymalna ilość zwracanych wyników

Odpowiedź:

  • Odpowiedź zawiera listę obiektów przechowujących informację o zadaniach użytkownika.
Code Block
languagejavascript
titlePrzykładowa odpowiedź
linenumberstrue
{
   "total":4,
   "data":[
      {
         "activityId":"901_901_api_zapisformularza_zadanie_1",
         "activityDefId":"zadanie_1",
         "activityName":"Zadanie 1",
		 "activityDescription":"Opis zadania",
		 "activityState":"RUNNING",
         "processName":"zapisFormularza 3/00002",
         "processId":"901_api_zapisformularza",
         "processDefId":"zapisformularza",
         "processDescription":"Opis procesu",
	     "processState":"RUNNING",
         "comingDate":1384344181635,
		 "finishDate":null
      },
      {
         "activityId":"801_801_api_zapisformularza_zadanie_1",
         "activityDefId":"zadanie_1",
         "activityName":"Zadanie 1",
		 "activityDescription":"Opis zadania",
		 "activityState":"RUNNING",
         "processName":"zapisFormularza 2/00002",
         "processId":"801_api_zapisformularza",
         "processDefId":"zapisformularza",
         "processDescription":"Opis procesu",
		 "processState":"RUNNING",
         "comingDate":1384257742840,
		 "finishDate":null
      },
      {
         "activityId":"701_701_api_zapisformularza_zadanie_1",
         "activityDefId":"zadanie_1",
         "activityName":"Zadanie 1",
		 "activityDescription":"Opis zadania",
		 "activityState":"RUNNING",
         "processName":"zapisFormularza 1/00002",
         "processId":"701_api_zapisformularza",
         "processDefId":"zapisformularza",
         "processDescription":"Opis procesu",
		 "processState":"RUNNING",
         "comingDate":1384241190607,
		 "finishDate":null
      },
      {
         "activityId":"601_601_api_proctest1_zadanie_1",
         "activityDefId":"zadanie_1",
         "activityName":"Zadanie 1",
		 "activityDescription":"Opis zadania",
		 "activityState":"RUNNING",
         "processName":"procTest1 1/00027",
         "processId":"601_api_proctest1",
         "processDefId":"proctest1",
         "processDescription":"Opis procesu",
		 "processState":"RUNNING",
         "comingDate":1383577844232,
		 "finishDate":null
      }
   ]
}

Pobieranie zadań wykonanych przez użytkownika

Ścieżka do servletu: api/activities/my/executed

Metoda: GET

Parametry:

  • start - przesunięcie w zbiorze wynikowym
  • limit - maksymalna ilość zwracanych wyników

Odpowiedź:

  • Odpowiedź zawiera listę obiektów przechowujących informację o zadaniach użytkownika. Przykład taki sam jak w przypadku "Pobieranie skrzynki zadań zalogowanego użytkownika". W tym przypadku pole "finishDate" jest uzupełnione datą zakończenia zadania.

Pobieranie zadania (od wersji 3.1.43)

Ścieżka do servletu: api/activities/{processId}/{activityId}

Metoda: GET

Parametry (przekazywane w ścieżce servletu):

  • processId - id procesu, do którego należy zadanie
  • activityId - id zadania, które pobieramy

Odpowiedź:

  • Odpowiedź obiekt przechowujący informację o zadaniu.

    Code Block
    languagejavascript
    titlePrzykładowa odpowiedź
    linenumberstrue
    {
	"activityId":"901_901_api_zapisformularza_zadanie_1",
    "activityDefId":"zadanie_1",
    "activityName":"Zadanie 1",
	"activityDescription":"Opis zadania",
	"activityState":"RUNNING",
    "processName":"zapisFormularza 3/00002",
    "processId":"901_api_zapisformularza",
    "processDefId":"zapisformularza",
    "processDescription":"Opis procesu",
	"processState":"RUNNING",
    "comingDate":1384344181635,
	"finishDate":null
}

Akceptacja zadania

Ścieżka do servletu: api/activities/accept

Metoda: POST

Request Content-Type: application/json

Treść zapytania:

 Obiekt JSON zawierający parametry akceptacji. Definicja powinna zawierać następujące pole:

    • processId - Id procesu
    • activityId - Id zadania
    • contextMap - Mapa wartości zmiennych
    • actionName - Nazwa akcji przycisku akceptacji

Odpowiedź(JSON):

  • nextActivityId - id zadania jeżeli istnieje i zdefiniowano NEXT_ACTIVITY
  • processId - id procesu

Pobieranie wartości zmiennych zadania

Ścieżka do servletu: api/activities/context

Metoda: GET

Parametry:

  • processId - Id procesu
  • activityId - Id zadania
  • extended - (opcjonalny) Domyślnie false. Zwraca rozszerzone wartości zmiennych w formie obiektu posiadającego pole value lub obiektu posiadającego pola value i displayValue. Na tę chwilę wprowadzono obsługę pól z atrybutem rozszerzonym EXTYPE = USERNAME, co pozwala na zwrócenie obiektu zawierającego pola value (login użytkownika) i displayValue (imię i nazwisko).

Odpowiedź:

  • Obiekt przechowujący wartości zmiennych.

Zapis zmiennych zadania

Ścieżka do servletu: api/activities/save

Metoda: POST

Request Content-Type: application/json

Treść zapytania:

 Obiekt JSON zawierający parametry akceptacji. Definicja powinna zawierać następujące pole:

    • processId - Id procesu
    • activityId - Id zadania
    • contextMap - Mapa wartości zmiennych

Odpowiedź:

  • brak odpowiedzi

Wejście w zadanie

Ścieżka do servletu: api/activities/open

Metoda: GET

Parametry:

  • processId - Id procesu
  • activityId - Id zadania

Odpowiedź:

  • bark odpowiedzi

Pobranie otwartych zadań

Ścieżka do servletu: api/activities/opened

Metoda: GET

Parametry:

  • processId - Id procesu

Odpowiedź:

  • Lista obiektów przechowujących informację o otwartych zadaniach w podanym procesie.
Code Block
languagejs
titlePrzykładowa odpowiedź
linenumberstrue
[{
	"activityId":"32301_13101_pakiet_3871_proces_3871_zadanie_1",
	"activityDefId":"zadanie_1","activityName":"Zadanie 1",
	"activityDescription":"",
	"activityState":"RUNNING",
	"processName":"Proces 3871 13/00005",
	"processId":"13101_pakiet_3871_proces_3871",
	"processDefId":"proces_3871",
	"processDescription":"Proces 3871",
	"processState":"RUNNING",
	"comingDate":1492772683431,
	"finishDate":null
}]



 

English

Downloading the task box of a logged-in user

Path to servlet: api/activities/my

Method: GET

Parameters:

  • start - offset in the result set
  • limit - the maximum number of returned results

Answer:

  • The answer contains a list of objects storing information about the user's tasks.
Code Block
titleExample answer
linenumberstrue
{
   "total":4,
   "data":[
      {
         "activityId":"901_901_api_zapisformularza_zadanie_1",
         "activityDefId":"zadanie_1",
         "activityName":"Zadanie 1",
		 "activityDescription":"Opis zadania",
		 "activityState":"RUNNING",
         "processName":"zapisFormularza 3/00002",
         "processId":"901_api_zapisformularza",
         "processDefId":"zapisformularza",
         "processDescription":"Opis procesu",
	     "processState":"RUNNING",
         "comingDate":1384344181635,
		 "finishDate":null
      },
      {
         "activityId":"801_801_api_zapisformularza_zadanie_1",
         "activityDefId":"zadanie_1",
         "activityName":"Zadanie 1",
		 "activityDescription":"Opis zadania",
		 "activityState":"RUNNING",
         "processName":"zapisFormularza 2/00002",
         "processId":"801_api_zapisformularza",
         "processDefId":"zapisformularza",
         "processDescription":"Opis procesu",
		 "processState":"RUNNING",
         "comingDate":1384257742840,
		 "finishDate":null
      },
      {
         "activityId":"701_701_api_zapisformularza_zadanie_1",
         "activityDefId":"zadanie_1",
         "activityName":"Zadanie 1",
		 "activityDescription":"Opis zadania",
		 "activityState":"RUNNING",
         "processName":"zapisFormularza 1/00002",
         "processId":"701_api_zapisformularza",
         "processDefId":"zapisformularza",
         "processDescription":"Opis procesu",
		 "processState":"RUNNING",
         "comingDate":1384241190607,
		 "finishDate":null
      },
      {
         "activityId":"601_601_api_proctest1_zadanie_1",
         "activityDefId":"zadanie_1",
         "activityName":"Zadanie 1",
		 "activityDescription":"Opis zadania",
		 "activityState":"RUNNING",
         "processName":"procTest1 1/00027",
         "processId":"601_api_proctest1",
         "processDefId":"proctest1",
         "processDescription":"Opis procesu",
		 "processState":"RUNNING",
         "comingDate":1383577844232,
		 "finishDate":null
      }
   ]
}

Downloading tasks performed by the user

Path to servlet: api/activities/my/executed

Method: GET

Parameters:

  • start - offset in the result set
  • limit - the maximum number of returned results

Answer:

  • The response contains a list of objects storing information about the user's tasks. The example is the same as "Downloading the task box of the logged-in user". In this case, the "finishDate" field is populated with the end date of the task.

Downloading task (from version 3.1.43)

Path to servlet: api/activities/{processId}/{activityId}

Method: GET

Parameters (transferred in the servlet path):

  • processId - id of the process to which the task belongs
  • activityId - id of the task we are downloading

Answer:

  • Response object storing information about the task.

    Code Block
    titleExample answer
    linenumberstrue
    {
	"activityId":"901_901_api_zapisformularza_zadanie_1",
    "activityDefId":"zadanie_1",
    "activityName":"Zadanie 1",
	"activityDescription":"Opis zadania",
	"activityState":"RUNNING",
    "processName":"zapisFormularza 3/00002",
    "processId":"901_api_zapisformularza",
    "processDefId":"zapisformularza",
    "processDescription":"Opis procesu",
	"processState":"RUNNING",
    "comingDate":1384344181635,
	"finishDate":null
}

Tast acceptance

Path to servlet: api/activities/accept

Method: POST

Request Content-Type: application/json

 Content of the request:

  JSON object containing acceptance parameters. The definition should contain the following field:

    • processId - process Id
    • activityId - task Id
    • contextMap - Map of variable values
    • actionName - Name of the acceptance button action

Answer (JSON):

  • nextActivityId - id of the task if it exists and NEXT_ACTIVITY is defined
  • processId - process id

Getting the values of task variables

Path to servlet: api/activities/context

Method: GET

Parameters:

  • processId - process Id
  • activityId - task Id
  • extended - (Optional) Defaults to false. Returns extended variable values in the form of an object having a value field or an object having value and displayValue fields. For the moment, support for fields with the EXTYPE = USERNAME extended attribute has been introduced, which allows you to return an object containing the value (user login) and displayValue (name) fields.

Answer:

  • An object that stores variable values.

Saving the task variables

Path to servlet: api/activities/save

Method: POST

Request Content-Type: application/json

Content of the request:

JSON object containing acceptance parameters. The definition should contain the following field:

    • processId - process Id
    • activityId - task Id
    • contextMap - Map of variable values

Answer:

  • no answer

Task entry

Path to servlet: api/activities/open

Method: GET

Parameters:

  • processId - process Id
  • activityId - task Id

Answer:

  • no answer

Download open tasks

Path to servlet: api/activities/opened

Method: GET

Parameters:

  • processId - process Id

Answer:

  • List of objects storing information about open tasks in the specified process.
Code Block
languagejs
titleExample answer
linenumberstrue
[{
	"activityId":"32301_13101_pakiet_3871_proces_3871_zadanie_1",
	"activityDefId":"zadanie_1","activityName":"Zadanie 1",
	"activityDescription":"",
	"activityState":"RUNNING",
	"processName":"Proces 3871 13/00005",
	"processId":"13101_pakiet_3871_proces_3871",
	"processDefId":"proces_3871",
	"processDescription":"Proces 3871",
	"processState":"RUNNING",
	"comingDate":1492772683431,
	"finishDate":null
}]