Read Attachment
Retrieves the details of a Attachment object that has been previously created.
Parameters
Path Params | |
---|---|
yourCompany: | string |
Query Params | |
---|---|
filter: | string
https://xyzcompany.agiliron.net/agiliron/api-40/Attachment?filter=CreatedTime,bt,01-15-2020 | 01-31-2020&key=xyzkey
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
https://xyzcompany.agiliron.net/agiliron/api-40/Attachment?filter=AttachmentId,eq,3422&key=xyzkey List of condition abbrevations to be used: |
Header Params | |
---|---|
key: | string |
Query Auth | |
---|---|
key: | string |
Header Auth | |
---|---|
apiKey: | string |
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>
Updated about 21 hours ago