General Information
Responses
The response when there are no errors is HTTP 200. When there is data to be returned, UTF-8 encoded JSON text will be included in the body of the response. For errors regarding user authentication an HTTP 401 error (Unauthorized) will be returned, and when an authenticated user does not have authorization to perform an operation an HTTP 403 error (Forbidden) will be returned. Other errors will result in an HTTP 400 response with the error details included in the body in JSON text.
Response Objects
When data is returned, the response data will be one of the following objects or a list of these objects.
| Type of object |
Description |
QuserEntry |
Object indicating a user |
QgroupEntry |
Object indicating a organization |
MembershipEntry |
Object indicating organization members |
For further details please refer to the User Management API page.
Error Response Object
When error response is returned as JSON text, an ErrorEntry sequence is always sent under the name "errors." For details on ErrorEntry attributes and error types, please refer to the User Management API page.
List of Operations
Operations that can be handled by User Search API are listed below. Replace <ContextRoot> in the URLs with the Questetra BPM Suite context root you are connecting to.
| Operation |
URL |
| Acquire the user's own information |
<ContextRoot>/API/User/Quser/self |
| Acquire user list |
<ContextRoot>/API/User/Quser/list |
| Acquire organization list |
<ContextRoot>/API/User/Qgroup/list |
| Search user |
<ContextRoot>/API/User/Quser/find |
| Search organization |
<ContextRoot>/API/User/Qgroup/find |
Acquire User's Own Information
This returns information on the user him/herself authenticated to API access.
Available Version
7.4.0
URL
<ContextRoot>/API/User/Quser/self
Parameter
None
Response
| Object |
Description |
quser |
QuserEntry of the user him/herself |
Possible Errors
None
Acquire User List
This returns a list of all users within the system. User name and email address can be used to make a search. The list will be sorted in ascending order.
Available Version
7.4.0
URL
<ContextRoot>/API/User/Quser/list
Parameter
| Parameter name |
Description |
limit |
Maximum number of users to acquire. When this is not specified, the default value is 1. |
start |
Starting point of user list to acquire. The minimum value is 0. When this is not specified, the default value is 0.
(Ex) When the number of targeted items is 100, start is specified as 10 and limit as 50, of all 100 items the 11th to 60th items will be acquired. |
query |
Text to be searched. When this is specified, the system will search users with email addresses or names that include the specified value. This can be combined with qgroupId.
|
qgroupId |
Specifies the organization ID. When this is specified, the system will search users that belong to that organization. This can be combined with query. |
Response
| Object |
Description |
qusers |
List of all users' QuserEntry |
Possible Errors
ValidationInvalidQgroupId
Acquire Organization List
This returns a list of all organizations within the system. Organization name and email address can be used to make a search. The list will be sorted in ascending order.
Available Version
7.4.0
URL
<ContextRoot>/API/User/Qgroup/list
Parameter
| Parameter name |
Description |
limit |
Maximum number of organizations to acquire. When this is not specified, the default value is 1. |
start |
Starting point of organization list to acquire. The minimum value is 0. When this is not specified, the default value is 0.
(Ex) When the number of targeted items is 100, start is specified as 10 and limit as 50, of all 100 items the 11th to 60th items will be acquired. |
query |
Text to be searched. When this is specified, the system will search organizations with email addresses or names that include the specified value.
|
Response
| Object |
Description |
qgroups |
List of all organizations' QgroupEntry |
Possible Errors
Search User
This searches a user. If the user does not exist, the system will return the error QuserDoesNotExist.
Available Version
7.4.0
URL
><ContextRoot>/API/User/Quser/find
Parameters
| Parameter name |
Description |
id |
When this is specified, the system searches the user with this ID. |
email |
When this is specified, the system searches the user with this email address.
When both are specified, only id will be used in the search. |
Response
| Object |
Description |
quser |
QuserEntry of user |
Possible Errors
InvalidIdInvalidEmailQuserDoesNotExist
Search Organization
This searches a organization. If the organization does not exist, the system will return the error QgroupDoesNotExist.
Available Version
7.4.0
URL
<ContextRoot>/API/User/Qgroup/find
Parameter
| Parameter name |
Description |
id |
When this is specified, the system searches the organization with this ID. |
name |
When this is specified, the system searches the organization with this email address.
When both are specified, only id will be used in the search. |
Response
| Object |
Description |
qgroup |
QgroupEntry of organization |
Possible Errors
InvalidIdInvalidNameQgroupDoesNotExist
