API ReferenceGuides
Guides
Home

Read Ticket

Retrieves the details of a Ticket object that has been previously created.

Parameters

Path Params
yourCompany:string
The Company name need to passed in the base URL.For eg. if you enter xyzcompany name, the url https://{yourCompany}.agiliron.net/agiliron/api-40.php/Ticket will change to https://xyzcompany.agiliron.net/agiliron/api-40.php/Ticket
Query Params
filter:string
In this parameter fieldname needs to be provided with condition and value
to fetch related details.for eg. Title,eq,Ticket title
  1. To fetch Ticket with subject equal to New ticket and custom field(Test CheckBox) value is no or off, the following url must be used
https://xyzcompany.agiliron.net/agiliron/api-40/Ticket?filter=Title,eq,New ticket;Test CheckBox,eq,no&key=xyzkey
  1. To fetch Ticket with created date between 01-15-2020 to 01-31-2020 (Use | between two dates), the following url must be used
https://xyzcompany.agiliron.net/agiliron/api-40/Ticket?filter=CreatedTime,bt,01-15-2020 | 01-31-2020&key=xyzkey
  1. To fetch Ticket with created datetime between 01-15-2020 01:03:10 to 01-31-2020 20:00:00 (Use | between two dates), the following url must be used
https://xyzcompany.agiliron.net/agiliron/api-40/Ticket?filter=CreatedTime,bt,01-15-2020 01:03:10| 01-31-2020 20:00:00&key=xyzkey
  1. To fetch Ticket with Status 'Open' OR 'In Progress' (Use OR between two values), the following url must be used
https://xyzcompany.agiliron.net/agiliron/api-40/Ticket?filter=Status,eq,Open OR In Progress&key=xyzkey
  1. To fetch Ticket with TicketId equal to 3422, the following url must be used
https://xyzcompany.agiliron.net/agiliron/api-40/Ticket?filter=TicketId,eq,3422&key=xyzkey

List of condition abbrevations to be used:
"cs": contain string (string contains value)
"sw": start with (string starts with value)
"ew": end with (string end with value)
"neq": not equal (string or number should not match)
"eq": equal (string or number matches exactly)
"lt": lower than (number is lower than value)
"le": lower or equal (number is lower than or equal to value)
"ge": greater or equal (number is higher than or equal to value)
"gt": greater than (number is higher than value)
"bt": between (number is between two comma separated values)

Header Params
key:string
API key needs to be passed in this variable.The option to enter API key will appear when you click on Try it button.
Query Auth
key:string
API key needs to be passed in this variable.The option to enter API key will appear when you click on Try it button.This will be the first option in AUTHENTICATION block.Default is SET to 0.
Header Auth
apiKey:string
Dedicated API key needs to be passed in this variable via header.The option to enter API key will appear when you click on Try it button.This will be the second option in AUTHENTICATION block.Default is SET to 0.

Sample Code

{
	"Tickets": {
		"Ticket": [{
			"TicketId": "200562",
			"Title": "Test New ticket",
			"AssignedTo": "User",
			"AssignedToName": "admin",
			"RelatedToType": "Accounts",
			"RelatedToValue": "Joh doe",
			"ProductName": "",
			"ProductCode": "",
			"Priority": "Low",
			"Severity": "Minor",
			"Status": "Open",
			"Category": "Big Problem",
			"CreatedTime": "12-11-2020 05:51:13",
			"CreatedTimeUTC": "01-24-2020 15:01:35",
			"ModifiedTime": "12-11-2020 05:55:29",
			"ModifiedTimeUTC": "01-24-2020 15:05:56",
			"Description": "",
			"Solution": "",
			"Comments": "",
			"TicketCustomFields": {
				"CustomField": [{
						"Name": "CustomFied1",
						"Value": "Custom info 1"
					},
					{
						"Name": "CustomFied2",
						"Value": "Custom info 2"
					}
				]
			}
		}],
		"TotalRecords": "1",
		"CurrentPage": "1",
		"TotalPages": "1",
		"PageSize": "50"
	}
}
<Tickets>
    <Ticket>
        <TicketId>200562</TicketId>
        <Title>Test New ticket</Title>
        <AssignedTo>User</AssignedTo>
        <AssignedToName>admin</AssignedToName>
        <RelatedToType>Accounts</RelatedToType>
        <RelatedToValue>Joh doe</RelatedToValue>
        <ProductName></ProductName>
        <ProductCode></ProductCode>
        <Priority>Low</Priority>
        <Severity>Minor</Severity>
        <Status>Open</Status>
        <Category>Big Problem</Category>
        <CreatedTime>12-11-2020 05:51:13</CreatedTime>
      	<CreatedTimeUTC>01-24-2020 15:01:35</CreatedTimeUTC>
        <ModifiedTime>12-11-2020 05:55:29</ModifiedTime>
      	<ModifiedTimeUTC>01-24-2020 15:05:56</ModifiedTimeUTC>
        <Description></Description>
        <Solution></Solution>
        <Comments></Comments>
        <TicketCustomFields>
            <CustomField>
                <Name>CustomFied1</Name>
                <Value>Custom info 1</Value>
            </CustomField>
            <CustomField>
                <Name>CustomFied2</Name>
                <Value>Custom info 2</Value>
            </CustomField>
        </TicketCustomFields>
    </Ticket>
    <TotalRecords>1</TotalRecords>
    <CurrentPage>1</CurrentPage>
    <TotalPages>1</TotalPages>
    <PageSize>50</PageSize>
</Tickets>

WADL

<?xml version="1.0" encoding="utf-8"?>
<application>
   <resources base="https://{yourCompany}.agiliron.net/agiliron/api-40/">
     <resource path="Ticket"> 
       <method name="GET">
         <request>
           <param name="key" type="xsd:string" style="query" required="true"/>
           <param name="Filter" type="xsd:string" style="query"/>			
         </request> 
         <response status="200"> 
            <representation mediaType="application/xml" element="yn:ResultSet"/> 
         </response> 
         <response status="400"> 
            <representation mediaType="application/xml" element="ya:Error"/> 
         </response> 
       </method> 
     </resource> 
   </resources>
 </application>
© Copyright 2022 Agiliron - All Rights Reserved.