Skip to main content
Version: 8.4

POST Create a Request

URL: {{server-url}}/api/v1/request

In order to create a new request, you have to call the above endpoint with the following key-values:

Header

KeyDescription
AuthorizationBearer {access token obtained after authorization}
Content-Typeapplication/json

Body

You would be sending a JSON request that will create a ticket and populate its details. Some of the key-value pairs are compulsory, notice the description of each.

note

Keys with asterisk are compulsory.

KeyValue TypeDescription
subject*StringSubject of the ticket.
categoryNameStringCategory Name of a Request. Set to ‘Request’ as it is default to ‘Service Request’.
requesterEmail*StringEmail address of the user registered for the client.
ccEmailSetString ArrayEmail Address of People to whom notification is to be sent for certain events on Request.
tagsString ArrayThese are additional identifiers attached to a ticket. Its a list that can contain n number of STRINGS.
impactNameStringDescribes the effect of the Request. Possible values are: Low, On User , On department, Or On Business.
priorityNameStringShows the importance of the Request. Possible values are: Low, Medium, High, or Urgent.
urgencyNameStringMarks the request as urgent. Possible values are: Low, Medium, High, or Urgent.
departmentNameStringAdditional information about the ticket.
locationNameStringName of the Location where Request happened. Note that Location Must Exist with same name.
supportLevelStringDescribes the level of the provisioned support. Possible Values are: Tier1, Tier2, Tier3, or Tier 4.
spamBooleanPossible Values are True or False.
assigneeEmailStringName of the Assignee.
Technician Group NameStringName of the group to which the Technician belongs.
sourceStringIt shows the origin of the ticket. The Source can be either Support Portal or the Technician portal. Default source for Rest API is ‘External’.
fileAttachmentsObject ArrayReference File Name of attachments for a Request. For example:[ { “refFileName” : “abc”, “realName” : “xyz.pdf” } ]
statusNameStringPossible values are Open, In Progress, Pending, Resolved, and Closed.
linkAssetIdsObject ArrayAdd asset id with model name. For example :”linkAssetIds”: [{“assetModel”: “asset_hardware”,”assetId”: 1}].
customFieldMAP:{key: STRING, value: OBJECT}This key is related to custom fields. Example “customField”: {“New Dropdown”: “1”, “New Number”: 110.1,”New Text Area”: “a11”, “New Text Input”: “111”}

Example (Request & Response)

Request

curl --request POST
--url 'http://{Server-url}/api/v1/request'\
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE1ODUxNTk0MTksInVzZXJfbmFtZSI6Im5pcmF2LnBhdGVsQG1vdGFkYXRhLmNvbSIsImp0aSI6ImZhZTY2YTdiLTY0NDQtNGY4OS1hNGNmLWZmOGY3NDIyMThhZiIsImNsaWVudF9pZCI6ImZsb3RvLXdlYi1hcHAiLCJzY29wZSI6WyJOTy1TQ09QRSJdLCJ0ZW5hbnRJZGVudGlmaWVyIjoiYXBvbG8ifQ.i65Huu91E5xP2fXk7hY45VBN1wZSRhvDAT1WRCqcuRw'
--header "Content-type: application/json"
--data '{
"requesterEmail": "a@b.com",
"ccEmailSet": [
"a@b.com"
],
"subject": "asdasd",
"impactName": "Low",
"priorityName": "Low",
"statusName": "Open",
"urgencyName": "Low",
"departmentName":"IT",
"spam":false,
"supportLevel":"tier2",
"customField": {
"New Dropdown": "1",
"New Number": 110.1,
"New Text Area": "a11",
"New Text Input": "111"
},
"name": "INC-1",
"tags": ["asdasd"]
}'

Response

{
"id": 1,
"createdTime": 1584699527485,
"updatedTime": 1584699528033,
"requesterEmail": "a@b.com",
"requesterName": "utsav",
"ccEmailSet": [
"a@b.com"
],
"subject": "asdasd",
"impactName": "Low",
"priorityName": "Low",
"statusName": "Open",
"urgencyName": "Low",
"tags": [],
"customField": {},
"source": "Technician Portal",
"spam": false,
"departmentName": "IT",
"supportLevel": "tier1",
"name": "INC-1"
}