This API available for patch the user object. You can patch user through the HTTP PATCH URL http://<host>:<port>/catissuecore/rest/ng/users/{userId}
Below are the attributes which need to be sent in the request body:
Mandatory Fields :
- User Id
Non Patchable Fields :
- Login Name
- Domain Name
Parameter | Details |
|---|---|
| userId | User id of the User |
| firstName | First name of the user |
| middleName | Middle name of the user |
| domainName | Name of the authentication domain. You cannot able to change domain of the user once user created |
| emailAddress | Email Address of the user. This attribute should be unique in catissue application |
| loginName | Login Name through which user can login to catissue application, should be unique in authentication domains. You cannot able to change domain of the user once user created |
| siteNames | Name of the sites to which the user belongs |
| cpTitles | Name of the collection protocols to which user belongs. |
| activityStatus | Activity status of the user, permissible values are {active, closed, pending, disabled} |
| deptName | Name of department to which user belongs |
| comments [optional] | comments on user given by admin while approval |
| country | Country of the user |
| state [optional] | state of the user |
| city [optional] | city of the user |
| zipCode | zipCode of the user |
| phoneNumber [optional] | Phone number of the user |
| faxNumber [optional] | Fax number of the user |
API Example :
Method | URL |
|---|---|
| URL | catissuecore/rest/ng/users/{userId} |
| Method | PATCH |
| Request | application/json |
| json | { "lastName":"Piterson", "firstName":"Sam" } |
Response | { "id" : "1",
|
Error Cases :
code | Applies to | Status Message |
|---|---|---|
| 200 | All resources | User has been updated successfully |
| 400 | All requests | Invalid parameters, e.g duplicate Login Name, duplicate Email Address, blank First Name etc |
| 401 | All requests | Authorization failed, User doesn’t have Authority |
| 404 | All requests | User not found, User with given details not present in the system |
| 500 | All requests | Internal server error, Encountered server error while performing operations |