Logo
Submit a request
Follow

Attachments

Retrieving a List of Attachments

URL

https://app.bluefolder.com/api/2.0/attachments/list.aspx

Request

<request>
  <attachmentList>
    <type></type>
    <contractId></contractId>
    <customerId></customerId>
    <equipmentId></equipmentId>
    <serviceRequestId></serviceRequestId>
    <includeExternalLinks></includeExternalLinks>
    <page></page>
    <perPage></perPage>
    <postedOn></postedOn>
  </attachmentList>
</request>
  • type - (Contract, Customer, Equipment, ServiceRequest) the type of object that this document is attached to
  • contractId - GUID, which is the unique Id for the contract that the items are attached to
  • customerId - numeric indicating the customer that the items are attached to
  • equipmentId - GUID, which is the unique Id for the equipment item that the items are attached to
  • serviceRequestId - numeric, unique service request identifier that the items are attached to
  • includeExternalLinks - boolean, (true/false, defaults to false)
  • page - numeric, indicating the page of data to return (defaults to page 1)
  • perPage - numeric, indicating the number of items to return per page (defaults to 100)
  • postedOn - date, indicating the date after which the item was uploaded

Response

<response status="ok">
  <attachments page="1" perPage="10" totalCount="148">
    <attachment>
      <attachmentId></attachmentId>
      <isExternalLink></isExternalLink>
      <fileName></fileName>
      <linkUrl></linkUrl>
      <parentType></parentType>
      <parentId></parentId>
      <postedOn></postedOn>
      <postedBy></postedBy>
      <private></private>
      <token></token>
    </attachment>
    …
  </attachments>
</response>
            

Downloading an Attachment

URL

https://app.bluefolder.com/api/2.0/attachments/download.aspx

Request

<request>
    <attachmentDownload>
        <attachmentId>xxxxxx</attachmentId>
    </attachmentDownload>
</request>
            
  • attachmentToken - (required) GUID, which is the unique token for the attachment

Response

The response for this endpoint is a redirect to a link to download the requested attachment securely

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request