View Source

Pobieranie listy użytkowników

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

Metoda: GET

Parametry:

query - fraza, na podstawie której zostaną przefiltrowane wyniki. Filtrowanie dotyczy loginu, imienia i nazwiska użytkowników.
Z tym, że podaną frazę dopasowuje od początku wartości imienia i nazwiska. Natomiast w polu login, które zawiera także wartość domeny, szuka frazy w dowolnym miejscu.
start - przesunięcie w zbiorze wynikowym
limit - maksymalna ilość zwracanych wyników

Odpowiedź:

Odpowiedź zawiera obiekt przechowujący całkowitą ilość wyników w polu total, oraz listę użytkowników w polu data.

{
   "total":3,
   "data":[
      {
         "userName":"admin",
         "objectId":1000036,
         "firstName":"Default User",
         "lastName":"",
         "email":"",
         "active":true,
 		 "number":"122",
         "positions":null,
         "groups":null,
         "fullName":"Default User "
      },
      {
         "userName":"afd",
         "objectId":1001001,
         "firstName":"fdsfasd",
         "lastName":"sdfs",
         "email":"",
         "active":true,
         "positions":null,
		 "number":"124",
         "groups":null,
         "fullName":"fdsfasd sdfs"
      }
   ]
}

Pobieranie listy użytkowników po rolach

Ścieżka do servletu: api/users/by/roles

Metoda: POST

Request Content-Type: application/json

Treść zapytania:

Lista obiektów JSON zawierający parametry wyszukiwania ról. Definicja obiektu powinna zawierać następujące pole:

- packageId - Id pakietu w którym będą wyszukiwane role
- processDefId - Id procesu w którym będą wyszukiwane role
- roleIds - List id ról(id tekstowe)

Wszystkie parametry są opcjonalne. Jeżeli podamy processDefId to zostaną wyszukane również role globalne użyte w tym procesie. Warunki w obrębie pojedynczego elementu są połączone operatorem AND(np. jeżeli podamy packegeId i processDefId). Natomiast warunki poszczególnych elementów listy warunków są połączone operatorem OR np:

[  //Zapytanie znajdzie użytkowników o roli uczestnik_1 z pakietu suncode_api z procesu zapisformularza
   //oraz użytkowników o roli uczestnik_3 z pakietu suncode_api z procesu faktury
   {  
      "processDefId":"zapisformularza",
      "packageId":"suncode_api",
      "roleIds":[  
         "uczestnik_1"
      ]
   },
   {  
      "processDefId":"faktury",
      "packageId":"suncode_api",
      "roleIds":[  
         "uczestnik_3"
      ]
   }
]

Odpowiedź:

Odpowiedź zawiera listę użytkowników

[
      {
         "userName":"admin",
         "objectId":1000036,
         "firstName":"Default User",
         "lastName":"",
         "email":"",
         "active":true,
         "positions":null,
         "groups":null,
		 "number":"123",
         "fullName":"Default User "
      },
      {
         "userName":"afd",
         "objectId":1001001,
         "firstName":"fdsfasd",
         "lastName":"sdfs",
         "email":"",
         "active":true,
		 "number":"124",
         "positions":null,
         "groups":null,
         "fullName":"fdsfasd sdfs"
      }
]

Pobieranie informacji o użytkowniku po loginie

Ścieżka do servletu: api/users/by/login

Metoda: GET

Parametry:

username - login żądanego użytkownika

Odpowiedź:

Odpowiedź zwraca obiekt UserInfo z informacjami o użytkowniku

{
  "userName": "admin",
  "firstName": "Administrator",
  "lastName": "PlusWorkflow",
  "fullName": "Administrator PlusWorkflow",
  "email": "",
  "number": "",
  "groups": null,
  "positions": null
}

Pobieranie informacji o obecnie zalogowanym użytkowniku

Ścieżka do servletu: api/users/current

Metoda: GET

Odpowiedź:

Odpowiedź zwraca obiekt UserInfo z informacjami o obecnie zalogowanym użytkowniku

{
  "userName": "admin",
  "firstName": "Administrator",
  "lastName": "PlusWorkflow",
  "fullName": "Administrator PlusWorkflow",
  "email": "",
  "number": "",
  "groups": [
    {
      "name": "Administrators"
    }
  ],
  "positions": []
}