Chapter Contents:
Supported Methods
GET /User
Get a list of User objects. Filter to avoid huge amounts of data (see Filtering for search parameters).
GET /User/{key}
Get a single User object.
PUT /User/{key}
Update an existing User object. Users cannot update other users unless they belong to the security roles ADMIN or USER_PROVISIONING (since 3.13)
A user object can be disabled (since 3.13) setting the property isObjectActive : true. To enable a deactivated User it has to be set isObjectActive: false.
POST /User (since 3.13)
Create a new user object. An User object can be created by users that belong to the security roles ADMIN or USER_PROVISIONING.
If the user created is a user that must have access to VMS he/she must belong to the security role API. This is a JSON example to create a user (The userCode must be upper case, since 3.15 the userCode will be automatic convert to upper case):
{
"userCode": "VMSTEST",
"securityRoles": [
{
"roleName": "API"
}
],
"userName": "vmstest",
"userPassword":"xxxxxxxx"
}
The security role API will be assigned also if none security role is used in the JSON.
DELETE /User/{key}
To delete an User object it first has to be deactivated.
Properties
Property | Type | Length | Mandatory | Description | Comments |
|---|---|---|---|---|---|
| userCode | String | 30 | Yes | ||
| userName | String | 64 | Yes | ||
| company | /Company | ||||
| contactInfo | Array of /ContactInfo | ||||
| isObjectActive | Boolean | specify if the Uesr is active | since 3.13 | ||
| businessUnits | Array of /BusinessUnit | since 3.12 | |||
| legs | Array of /Leg | since 3.12 | |||
| securityRoles | Array of //SecurityRole | since 3.12 | |||
| userPassword | String | 64 | YES | Property to be used during POST and PUT, GET method does not return it | since 3.13 |
| office | since 3.21 |
Example Response Body
Updated for API version 2.0 using the new required date format yyyy-dd-MMThh:mi:ss to conform ISO 8601, (prior version has date format: yyyy-dd-MM hh:mi:ss)
GET /User/2410168
{
"key": 2410168,
"self": "http://localhost:8080/ws/rest/User/2410168",
"contactInfo": [
{
"phoneNo": null,
"mobileNo": null,
"faxNo": null,
"telexNo": null,
"email": "support@dataloy.com",
"key": 22618918,
"self": "http://localhost:8080/ws/rest/ContactInfo/22618918"
}
],
"userName": "Dataloy",
"securityRoles": [
{
"key": 335316636,
"self": "http://localhost:8080/ws/rest/SecurityRole/335316636",
"roleName": "API"
}
],
"legs": [],
"businessUnits": [],
"userCode": "DATALOY",
"createdById": 1000633,
"modifiedDate": "2017-09-26T09:21:25",
"createdDate": "2005-07-26T10:43:27",
"company": {
"key": 4600966,
"self": "http://localhost:8080/ws/rest/Company/4600966",
"companyName": "Dataloy",
"companyCode": "01"
},
"isObjectActive": true,
"remarks": []
}