Version: 8.5.X

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.
companyName	String	Requester	Company name to which the requester belongs.
email	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.
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
vipRequester	Boolean	Requester
isBlock	Boolean	Technician, Requester	Only For Get API
block	Boolean	Technician, Requester	Only For Get API
customField	Key-Value Pair	Technician, Requester

Post Create Requester

Create (Post Method) : http://{{server-url}}/api/v1/requester

Request

curl --location 'http://172.16.11.148/api/v1/requester' \
--header 'Authorization: Apikey EV4091bfWjJrceeu%40DK1i%2FiamCrFa913LNO9ks1lfodXaZTm244wlj00btjboLA%3D%3D' \
--header 'Content-Type: application/json' \
--data-raw '{
"name": "Savy",
"email": "savy@motadata.com",
"userLogOnName": "Savy",
"contactNo": "8905063002",
"locationName": "Asia",
"departmentName": "HR",
"manager": "savy@motadata.com",
"altContactNo1":"7816093148",
"altContactNo2":"9781943310",
"allowToLogin": true,
"verified": false,
"vipRequester": true,
"customField": {
"Nickname": "Sav",
"City": "Ahmedabad"
}
}'

Response

{
    "id": 23,
    "email": "savy@motadata.com",
    "locationName": "Asia",
    "contactNo": "8905063002",
    "altContactNo1": "7816093148",
    "altContactNo2": "9781943310",
    "departmentName": "HR",
    "userLogOnName": "Savy",
    "vipRequester": true,
    "technician": false,
    "verified": false,
    "customField": {
    "Nickname": "Sav",
    "City": "Ahmedabad"
    },
    "isBlock": false,
    "block": false,
    "name": "Savy"
}

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,
"isBlock": false,
"block": 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,
"isBlock": false,
"block": 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 'http://172.16.11.148/api/v1/requester/search' \
--header 'Authorization: Apikey EV4091bfWjJrceeu%40DK1i%2FiamCrFa913LNO9ks1lfodXaZTm244wlj00btjboLA%3D%3D' \
--header 'Content-Type: application/json' \
--data '{
   "name": "James"
}'

Response

{
    "objectList": [
        {
            "id": 12,
            "companyName": "Stark Industries",
            "email": "james@motadata.com",
            "vipRequester": false,
            "technician": false,
            "verified": false,
            "customField": {
                "New Text Input": ""
            },
            "isBlock": false,
            "block": false,
            "name": "James"
        }
    ],
    "totalCount": 1
}

Post Search a Requester based on Custom Field

URL: http://{{server-url}}/api/v1/requester/search

For example, here requester is searched based on the values of the custom fields like Text Input, Multi-Select Dropdown, Checkbox, and Number.

Request

{
    "name": "jack",
    "fieldValueDetails": {
        "New Text Input": "requester",
        "New Multi-Select Dropdown": [
            "Option 1" // In the case of system as custom field need to give ID as value
        ],
        "New Checkbox": [
            "ch1"
        ],
        "New Number": 2 
    }

}

Response

{
    "objectList": [
        {
            "id": 20,
            "email": "jack@motadata.com",
            "vipRequester": false,
            "technician": false,
            "verified": false,
            "customField": {
                "New Checkbox": [
                    "ch1"
                ],
                "New Dropdown": "drp1",
                "New Number": 2.0,
                "New Datetime": 1720422240000,
                "New Text Input": "requester",
                "New Multi-Select Dropdown": [
                    "Option 1"
                ]
            },
            "isBlock": false,
            "block": false,
            "name": "jack"
        }
    ],
    "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
}

Requester Rest API

Post Create Requester​

Patch Update Requester​

GET Requester​

Convert Requester to Technician​

Post Search a Requester​

Post Search a Requester based on Custom Field​

Delete a Requester​

Post Create Requester

Patch Update Requester

GET Requester

Convert Requester to Technician

Post Search a Requester

Post Search a Requester based on Custom Field

Delete a Requester