Technician Rest API
The page provides the APIs related to the technician.
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, global_restricted. |
| assetAccessLevel | String | Technician | Asset Access Level , Possible Values: global_access, group_access, restricted, global_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 |
| allowToLogin | Boolean | True or False | |
| verified | Boolean | Technician, Requester | Only For Get API |
| isBlock | Boolean | Technician, Requester | Only For Get API |
| companyNames | String | Technician | Company names to which the technician belongs. |
| block | Boolean | Technician, Requester | Only For Get API |
| customField | Key-Value Pair | Technician, Requester |
Get Technician
URL: http://{{server-url}}/api/v1/technician/4
Request
curl --location 'https://172.16.12.135/api/v1/technician/1' \
--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJsb2dpbl9zc29faWQiOjAsInVzZXJfbmFtZSI6ImpvaG5AbW90YWRhdGEuY29tIiwic2NvcGUiOlsib3RoZXItYXBpLXNjb3BlIl0sImxvZ2luX3NvdXJjZSI6Im5vcm1hbF9sb2dpbiIsImV4cCI6MTY4NjEzNzQ4NywibG9naW5fbXNwX3BvcnRhbF9pZCI6MCwianRpIjoiOGExMDc1MTEtY2YzMC00ODcxLWIzZmQtZjY1NmJhNDUyZTRiIiwiY2xpZW50X2lkIjoiUG9zdG1hbkludGVncmF0aW9uLWNsaWVudCIsInRlbmFudElkZW50aWZpZXIiOiJhcG9sbyJ9.RJg1Xb7rVs6s-H6qItcZmwkLAaV95AgbaY813PTn4U7fDz7GV0gpVsMgWAcHOnSV9J-KGsdyw2vHf4rIfH3h8dt3SrJq8B7TPpMNoccXCarBEIGxxMHAKxs9cPcuw7cNY2K5NtfKj8voRl0vRzBHxuQS8h7J6hYnLcOFIMK6B-hZQKBbYL7lgOY86l22ghjcyY9pzwaxjNgtD922f3ru998Vyh_shJOiIb12QEqYxXzle-hxrOkB4hF_KVoNXi0w3WhO09i_aOX16eAfYo2neXd-hZ2TyFqQsKGNy83ZDkwCeeV2Y6Yxck_tMTBVrH6YaAc4NDtEHpA591vImBWtwg'
Response
{
"id": 1,
"email": "john@motadata.com",
"roles": [
"Super Admin"
],
"accessLevel": "global_access",
"contactNo": "123123123",
"supportLevel": [],
"allowToLogin": true,
"verified": true,
"isBlock": false,
"block": false,
"name": "john"
}
Post Create Technician
Create (Post Method) : http://{{server-url}}/api/v1/technician
Request
curl --location --request POST 'http://172.16.8.220/api/v1/technician' \
--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,
"supportLevel": [
"tier4"
],
"roles": [
"Super Admin"
],
"accessLevel": "global\_access",
"customField": {
"Nickname": "Harsh",
"City": "Ahmedabad"
}
}'
Response
{
"id": 18,
"email": "harsh.bhatia1@motadata.com",
"roles": [
"Super Admin"
],
"locationName": "Asia",
"contactNo": "8905063002",
"altContactNo1": "7816093148",
"altContactNo2": "9781943310",
"departmentName": "HR",
"supportLevel": [
"tier4"
],
"userLogOnName": "Logon101",
"verified": false,
"isBlock": false,
"block": false,
"name": "Harsh Bhatia"
}
Patch Update Technician
http://{{server-url}}/api/v1/technician/{id}
Request
curl --location --request PATCH 'http://172.16.8.220/api/v1/technician/18' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX25hbWUiOiJoYXJzaC5iaGF0aWFAbW90YWRhdGEuY29tIiwic2NvcGUiOlsib3RoZXItYXBpLXNjb3BlIl0sImxvZ2luX3NvdXJjZSI6Im5vcm1hbF9sb2dpbiIsImV4cCI6MTYwMzI1NTI5MiwianRpIjoiOTNlNDQ1MGMtNjBhZC00NjE0LTg5OTItOTU1OWIxZWUwYTM1IiwiY2xpZW50X2lkIjoiSEItY2xpZW50IiwidGVuYW50SWRlbnRpZmllciI6ImFwb2xvIn0.QOvpxH8Vde9EZbPjbTTtdMUS9sR7Xk8KMTjZYg3HPm4' \
--header 'Content-Type: application/json' \
--data-raw '{
"name": "Update"
}'
Response
{
"id": 18,
"email": "john@motadata.com",
"roles": [
"Super Admin"
],
"locationName": "Asia",
"contactNo": "8905063002",
"altContactNo1": "7816093148",
"altContactNo2": "9781943310",
"departmentName": "HR",
"supportLevel": [
"tier4"
],
"userLogOnName": "john",
"verified": false,
"isBlock": false,
"block": false,
"name": "Update"
}
Convert Technician to Requester
http://{{server-url}}/api/v1/technician/converttorequester/{id}
Request
curl --location --request GET 'http://172.16.8.220/api/v1/technician/converttorequester/18' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX25hbWUiOiJoYXJzaC5iaGF0aWFAbW90YWRhdGEuY29tIiwic2NvcGUiOlsib3RoZXItYXBpLXNjb3BlIl0sImxvZ2luX3NvdXJjZSI6Im5vcm1hbF9sb2dpbiIsImV4cCI6MTYwMzI1NTI5MiwianRpIjoiOTNlNDQ1MGMtNjBhZC00NjE0LTg5OTItOTU1OWIxZWUwYTM1IiwiY2xpZW50X2lkIjoiSEItY2xpZW50IiwidGVuYW50SWRlbnRpZmllciI6ImFwb2xvIn0.QOvpxH8Vde9EZbPjbTTtdMUS9sR7Xk8KMTjZYg3HPm4' \
--data-raw ''
Response
{
"id": 18,
"email": "1tech3motadata@yopmail.com",
"locationName": "Asia",
"contactNo": "8905003003",
"altContactNo1": "1905003203",
"altContactNo2": "2905003203",
"departmentName": "HR",
"manager": "harsh.bhatia@motadata.com",
"userLogOnName": "t3",
"vipRequester": false,
"technician": false,
"verified": false,
"isBlock": false,
"block": false,
"name": "Tech 3 T"
}
Post Search a Technician
http://{{server-url}}/api/v1/technician/search
Request
curl --location 'http://172.16.11.148/api/v1/technician/search' \
--header 'Authorization: Apikey EV4091bfWjJrceeu%40DK1i%2FiamCrFa913LNO9ks1lfodXaZTm244wlj00btjboLA%3D%3D' \
--header 'Content-Type: application/json' \
--data-raw '{
"manager": "mary@motadata.com"
}'
Response
{
"objectList": [
{
"id": 22,
"email": "milly@motadata.com",
"roles": [
"Service Desk Technician"
],
"accessLevel": "global_restricted",
"assetAccessLevel": "global_restricted",
"supportLevel": [],
"manager": "mary@motadata.com",
"userLogOnName": "milly",
"allowToLogin": true,
"customField": {
"New Text Input": ""
},
"verified": false,
"isBlock": false,
"block": false,
"name": "Milly"
},
{
"id": 7,
"email": "rosy.cordeiro@motadata.com",
"roles": [
"Service Desk Technician"
],
"accessLevel": "global_access",
"assetAccessLevel": "global_access",
"supportLevel": [],
"allowToLogin": true,
"customField": {
"New Text Input": ""
},
"verified": true,
"isBlock": false,
"block": false,
"name": "Rosy"
},
{
"id": 1,
"email": "jerry@motadata.com",
"roles": [
"Super Admin"
],
"accessLevel": "global_access",
"assetAccessLevel": "global_access",
"contactNo": "7318713783",
"supportLevel": [],
"manager": "milly@motadata.com",
"allowToLogin": true,
"customField": {
"New Text Input": ""
},
"verified": true,
"isBlock": false,
"block": false,
"name": "jerry"
}
],
"totalCount": 3
}
Post Search a Technician based on Custom Field
URL: http://{{server-url}}/api/v1/requester/search
For example, here technician is searched based on the values of the custom fields like Text Input, Checkbox, and Number.
Custom fields Text Input, Checkbox, Multi-Select, Multi-Select Dropdown, DateTime, Dropdown, Radio, Dependent, and Number
Request
{
"name": "Jerry",
"fieldValueDetails": {
"New Text Input": "technician",
"New Checkbox": [
"ch1"
],
"New Number": 2
}
}
Response
{
"objectList": [
{
"id": 19,
"email": "jerry@motadata.com",
"roles": [
"Super Admin"
],
"accessLevel": "global_access",
"assetAccessLevel": "global_access",
"supportLevel": [],
"allowToLogin": true,
"customField": {
"New Checkbox": [
"ch1"
],
"New Dropdown": "drp1",
"New Number": 2.0,
"New Datetime": 0,
"New Text Input": "technician",
"New Multi-Select Dropdown": []
},
"verified": false,
"isBlock": false,
"block": false,
"name": "Jerry"
}
],
"totalCount": 1
}
Delete a Technician
http://{{server-url}}/api/v1/technician/{id}
Request
curl --location --request DELETE 'http://172.16.8.220/api/v1/technician/24' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX25hbWUiOiJoYXJzaC5iaGF0aWFAbW90YWRhdGEuY29tIiwic2NvcGUiOlsib3RoZXItYXBpLXNjb3BlIl0sImxvZ2luX3NvdXJjZSI6Im5vcm1hbF9sb2dpbiIsImV4cCI6MTYwMzI3NzY1MiwianRpIjoiODJmZGQzN2UtNWI2Zi00OTlhLWIzZTAtZTRhNDBmZGVlNWNkIiwiY2xpZW50X2lkIjoiSEItY2xpZW50IiwidGVuYW50SWRlbnRpZmllciI6ImFwb2xvIn0.mtAGKGyadGeSu4IRQCZ0rh6O4b-jHFCX-pX51P2cmxY' \
--data-raw ''
Response
{
"userMessage": "Technician has been Archived Successfully.",
"warningMessage": null,
"id": 24
}