Read Attachment

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/Attachment will change to https://xyzcompany.agiliron.net/agiliron/api-40.php/Attachment

Query Params
filter:	string In this parameter fieldname needs to be provided with condition and value to fetch related details.for eg. Name,eq,Attachment name To fetch Attachment with name equal to New Attachment, the following url must be used https://xyzcompany.agiliron.net/agiliron/api-40/Attachment?filter=Name,eq,Attachment name To fetch Attachment 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/Attachment?filter=CreatedTime,bt,01-15-2020 \| 01-31-2020&key=xyzkey* To fetch Attachment 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/Attachment?filter=CreatedTime,bt,01-15-2020 01:03:10\| 01-31-2020 20:00:00&key=xyzkey To fetch Attachment with AttachmentId equal to 3422, the following url must be used https://xyzcompany.agiliron.net/agiliron/api-40/Attachment?filter=AttachmentId,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)

Query Params

filter:

string
In this parameter fieldname needs to be provided with condition and value
to fetch related details.for eg. Name,eq,Attachment name

To fetch Attachment with name equal to New Attachment, the following url must be used

*https://xyzcompany.agiliron.net/agiliron/api-40/Attachment?filter=Name,eq,Attachment name

To fetch Attachment 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/Attachment?filter=CreatedTime,bt,01-15-2020 | 01-31-2020&key=xyzkey

To fetch Attachment 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/Attachment?filter=CreatedTime,bt,01-15-2020 01:03:10| 01-31-2020 20:00:00&key=xyzkey

To fetch Attachment with AttachmentId equal to 3422, the following url must be used

https://xyzcompany.agiliron.net/agiliron/api-40/Attachment?filter=AttachmentId,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

{
	"Attachments": {
		"Attachment": [{
			"AttachmentId": "36189",
			"Name": "Chrysanthemum.jpg",
			"Type": "image/jpeg",
			"RelatedTo": "Orders",
			"RelatedId": "25761",
			"AttachmentContent": "R0lGODlhAQABAIAAAP///wAAACH5BAEAAAAALAAAAAABAAEAAAICRAEAOw==",
			"CreatedTime": "12-14-2020 19:25:24",
			"CreatedTimeUTC": "01-24-2020 15:01:35",
			"ModifiedTime": "12-14-2020 19:25:24",
			"ModifiedTimeUTC": "01-24-2020 15:05:56",
			"Description": "Test SO image"
		}],
		"TotalRecords": "",
		"CurrentPage": "1",
		"TotalPages": "0",
		"PageSize": "50"
	}
}

<Attachments>
    <Attachment>
        <AttachmentId>36189</AttachmentId>
        <Name>Chrysanthemum.jpg</Name>
        <Type>image/jpeg</Type>
        <RelatedTo>Orders</RelatedTo>
        <RelatedId>25761</RelatedId>
        <AttachmentContent>R0lGODlhAQABAIAAAP///wAAACH5BAEAAAAALAAAAAABAAEAAAICRAEAOw==</AttachmentContent>
        <CreatedTime>12-14-2020 19:25:24</CreatedTime>
      	<CreatedTimeUTC>01-24-2020 15:01:35</CreatedTimeUTC>
        <ModifiedTime>12-14-2020 19:25:24</ModifiedTime>
      	<ModifiedTimeUTC>01-24-2020 15:05:56</ModifiedTimeUTC>
        <Description>Test SO image</Description>
    </Attachment>
    <TotalRecords></TotalRecords>
    <CurrentPage>1</CurrentPage>
    <TotalPages>0</TotalPages>
    <PageSize>50</PageSize>
</Attachments>

WADL

<?xml version="1.0" encoding="utf-8"?>
<application>
   <resources base="https://{yourCompany}.agiliron.net/agiliron/api-40/">
     <resource path="Attachment"> 
       <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>