Requester Rest API
The page provides the APIs related to the requester.
Date Format : dd-MM-yyyy HH:mm
| Field Name | Field Type | Field Applicable For | Detail Specification |
|---|---|---|---|
| name | String | Technician, Requester | Name of user. |
| String | Technician, Requester | Email of user. | |
| departmentName | String | Technician, Requester | |
| locationName | String | Technician, Requester | |
| roles | String Array | Technician | User Roles |
| accessLevel | String | Technician | User Access Level , Possible Values: global_access, group_access, restricted. |
| contactNo | String | Technician, Requester | |
| altContactNo1 | String | Technician, Requester | |
| altContactNo2 | String | Technician, Requester | |
| supportLevel | String | Technician | Describes the level of the provisioned support. Possible Values: Tier1, Tier2, Tier3, or Tier 4. |
| userLogOnName | String | Technician, Requester | User Log On Name |
| verified | Boolean | Technician, Requester | Only For Get API |
| vipRequester | Boolean | Requester | |
| customField | Key-Value Pair | Technician, Requester |
Post Create Requester
Create (Post Method) : http://{{server-url}}/api/v1/requester
Request
curl --location --request POST 'http://172.16.8.220/api/v1/requester' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX25hbWUiOiJoYXJzaC5iaGF0aWFAbW90YWRhdGEuY29tIiwic2NvcGUiOlsib3RoZXItYXBpLXNjb3BlIl0sImxvZ2luX3NvdXJjZSI6Im5vcm1hbF9sb2dpbiIsImV4cCI6MTYwMzI1NTI5MiwianRpIjoiOTNlNDQ1MGMtNjBhZC00NjE0LTg5OTItOTU1OWIxZWUwYTM1IiwiY2xpZW50X2lkIjoiSEItY2xpZW50IiwidGVuYW50SWRlbnRpZmllciI6ImFwb2xvIn0.QOvpxH8Vde9EZbPjbTTtdMUS9sR7Xk8KMTjZYg3HPm4' \
--header 'Content-Type: application/json' \
--data-raw '{
"name": "Harsh Bhatia",
"email": "harsh.bhatia1@motadata.com",
"userLogOnName": "Logon101",
"contactNo": "8905063002",
"locationName": "Asia",
"departmentName": "HR",
"manager": "raghav.bhatia@motadata.com",
"altContactNo1":"7816093148",
"altContactNo2":"9781943310",
"verified": false,
"vipRequester": true,
"customField": {
"Nickname": "Harsh",
"City": "Ahmedabad"
}
}'
Response
{
"id": 17,
"email": "harsh.bhatia1@motadata.com",
"locationName": "Asia",
"contactNo": "8905063002",
"altContactNo1": "7816093148",
"altContactNo2": "9781943310",
"departmentName": "HR",
"userLogOnName": "Logon101",
"vipRequester": true,
"technician": false,
"verified": false,
"name": "Harsh Bhatia"
}
Patch Update Requester
http://{{server-url}}/api/v1/requester/{id}
Request
curl --location --request PATCH 'http://172.16.8.220/api/v1/requester/16' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX25hbWUiOiJoYXJzaC5iaGF0aWFAbW90YWRhdGEuY29tIiwic2NvcGUiOlsib3RoZXItYXBpLXNjb3BlIl0sImxvZ2luX3NvdXJjZSI6Im5vcm1hbF9sb2dpbiIsImV4cCI6MTYwMzI1NTI5MiwianRpIjoiOTNlNDQ1MGMtNjBhZC00NjE0LTg5OTItOTU1OWIxZWUwYTM1IiwiY2xpZW50X2lkIjoiSEItY2xpZW50IiwidGVuYW50SWRlbnRpZmllciI6ImFwb2xvIn0.QOvpxH8Vde9EZbPjbTTtdMUS9sR7Xk8KMTjZYg3HPm4' \
--header 'Content-Type: application/json' \
--data-raw '{
"name": "API UPD 102 13"
}'
Response
{
"id": 16,
"email": "harsh.tech@motadata.com",
"locationName": "Asia",
"contactNo": "8905003002",
"altContactNo1": "7816091148",
"altContactNo2": "9781944310",
"departmentName": "HR",
"manager": "harsh.bhatia@motadata.com",
"userLogOnName": "LogonTech01",
"vipRequester": false,
"technician": true,
"verified": false,
"name": "API UPD 102 13"
}
GET Requester
http://{{server-url}}/api/v1/requester/{id}
Request
curl --location --request GET 'http://172.16.8.220/api/v1/requester/16' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX25hbWUiOiJoYXJzaC5iaGF0aWFAbW90YWRhdGEuY29tIiwic2NvcGUiOlsib3RoZXItYXBpLXNjb3BlIl0sImxvZ2luX3NvdXJjZSI6Im5vcm1hbF9sb2dpbiIsImV4cCI6MTYwMzI1NTI5MiwianRpIjoiOTNlNDQ1MGMtNjBhZC00NjE0LTg5OTItOTU1OWIxZWUwYTM1IiwiY2xpZW50X2lkIjoiSEItY2xpZW50IiwidGVuYW50SWRlbnRpZmllciI6ImFwb2xvIn0.QOvpxH8Vde9EZbPjbTTtdMUS9sR7Xk8KMTjZYg3HPm4' \
--data-raw ''
Response
{
"id": 16,
"email": "harsh.tech@motadata.com",
"locationName": "Asia",
"contactNo": "8905003002",
"altContactNo1": "7816091148",
"altContactNo2": "9781944310",
"departmentName": "HR",
"manager": "harsh.bhatia@motadata.com",
"userLogOnName": "LogonTech01",
"vipRequester": false,
"technician": true,
"verified": false,
"name": "API UPD 102 13"
}
Convert Requester to Technician
http://{{server-url}}/api/v1/requester/converttotechnician/{id}
Request
curl --location --request GET 'http://172.16.8.220/api/v1/requester/converttotechnician/17' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX25hbWUiOiJoYXJzaC5iaGF0aWFAbW90YWRhdGEuY29tIiwic2NvcGUiOlsib3RoZXItYXBpLXNjb3BlIl0sImxvZ2luX3NvdXJjZSI6Im5vcm1hbF9sb2dpbiIsImV4cCI6MTYwMzI1NTI5MiwianRpIjoiOTNlNDQ1MGMtNjBhZC00NjE0LTg5OTItOTU1OWIxZWUwYTM1IiwiY2xpZW50X2lkIjoiSEItY2xpZW50IiwidGVuYW50SWRlbnRpZmllciI6ImFwb2xvIn0.QOvpxH8Vde9EZbPjbTTtdMUS9sR7Xk8KMTjZYg3HPm4' \
--data-raw ''
Response
{
"id": 17,
"email": "harsh.bhatia1@motadata.com",
"roles": [
"Request Specialist Technician"
],
"accessLevel": "global\_access",
"locationName": "Asia",
"contactNo": "8905063002",
"altContactNo1": "7816093148",
"altContactNo2": "9781943310",
"departmentName": "HR",
"supportLevel": [],
"userLogOnName": "Logon101",
"verified": false,
"name": "Harsh Bhatia"
}
Post Search a Requester
http://{{server-url}}/api/v1/requester/search
Request
curl --location --request POST 'http://172.16.8.220/api/v1/requester/search' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX25hbWUiOiJoYXJzaC5iaGF0aWFAbW90YWRhdGEuY29tIiwic2NvcGUiOlsib3RoZXItYXBpLXNjb3BlIl0sImxvZ2luX3NvdXJjZSI6Im5vcm1hbF9sb2dpbiIsImV4cCI6MTYwMzI1NTI5MiwianRpIjoiOTNlNDQ1MGMtNjBhZC00NjE0LTg5OTItOTU1OWIxZWUwYTM1IiwiY2xpZW50X2lkIjoiSEItY2xpZW50IiwidGVuYW50SWRlbnRpZmllciI6ImFwb2xvIn0.QOvpxH8Vde9EZbPjbTTtdMUS9sR7Xk8KMTjZYg3HPm4' \
--header 'Content-Type: application/json' \
--data-raw '{
"manager": "harsh.bhatia@motadata.com",
"name": "Req11"
}'
Response
{
"objectList": [
{
"id": 15,
"email": "api11motadata@yopmail.com",
"contactNo": "89050032011",
"altContactNo1": "12050032011",
"altContactNo2": "22050032011",
"manager": "harsh.bhatia@motadata.com",
"userLogOnName": "Logon11",
"vipRequester": true,
"technician": false,
"verified": false,
"name": "Req11"
}
],
"totalCount": 1
}
Delete a Requester
http://{{server-url}}/api/v1/requester/{id}
Request
curl --location --request DELETE 'http://172.16.8.220/api/v1/requester/24' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX25hbWUiOiJoYXJzaC5iaGF0aWFAbW90YWRhdGEuY29tIiwic2NvcGUiOlsib3RoZXItYXBpLXNjb3BlIl0sImxvZ2luX3NvdXJjZSI6Im5vcm1hbF9sb2dpbiIsImV4cCI6MTYwMzI3NzY1MiwianRpIjoiODJmZGQzN2UtNWI2Zi00OTlhLWIzZTAtZTRhNDBmZGVlNWNkIiwiY2xpZW50X2lkIjoiSEItY2xpZW50IiwidGVuYW50SWRlbnRpZmllciI6ImFwb2xvIn0.mtAGKGyadGeSu4IRQCZ0rh6O4b-jHFCX-pX51P2cmxY' \
--data-raw ''
Response
{
"userMessage": "Requester has been Archived Successfully.",
"warningMessage": null,
"id": 24
}