...
Non Patchable Fields :
- Login Name
- Domain Name
Parameter | Details | |
|---|---|---|
| userId | User id Id of the Useruser | |
| firstName | First name of the user | |
| middleName | Middle name of the user | |
| domainName | Name It is the name of the authentication domain. You cannot able to change domain of the user once user has been 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 userSiteNames[Optional] | Collection of the sites site names to which the user belongs |
| roleNames | Name if the roles which user has. It can be one or many. By default its scientist in application | |
| cpTitles | Name of the collection protocols to which user belongs. By default it will be none. i.e. Blank collection | |
| userCPRoles[Optional] | Collection of the Collection Protocol titles and their role names to which user belongs. By default it will be none. i.e. Blank collection. Mainly contains following parameters : roleName : Role of user like Scientist, Admin etc. For this attribute role must be present in application. cpTitle : Collection Protocol title. For this attribute CP must be present in application. | |
| 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 | Zip Code ZipCode of the user | |
| phoneNumber [optional] | Phone number of the user | |
| faxNumber [optional] | Fax number of the user |
http[s]:<host>:<port>/catissuecore/rest/ng/users/{userId}
...
Method | URL |
|---|---|
| URL | catissuecore/rest/ng/users/{userId} |
| Method | PATCH |
| Request | application/json |
| json | { "lastName":"Piterson", "firstName":"Sam" } |
Response | { "id" : 1, "lastName":"Piterson", "firstName":"Sam", "domainName":"catissue", "emailAddress":"sam.piterson@live.com", "loginName":"samPiterson", "siteNamesuserSiteNames":["My group", "New Site"], "roleNamesuserCPRoles":[{"roleName":"adminstratorScientiest1"], "cpTitlescpTitle":["MyCp", "Test Cp"My Cp1"}], "activityStatus":"Active", "deptName":"Department of onchology", "comments":"bla bla bla", "city":"Jalgaon", "state":"Maharashtra", "country":"India", "zipCode":"425022", "faxNumber":"434343AS", "phoneNumber":"654323" } |
...