Attachments

Updated on 06 Jun 2024

Article summary

Did you find this summary helpful?

Thank you for your feedback

A document or image file attached to a description or message in Aspire. Applies to Activities, Contacts, Properties, Opportunities, Site Audits, Emails, Receipts, Equipment, Employee Incident, Work Ticket, Invoice, and Visits. Click Manage Attachments for more information.

Resource Overview

Endpoint	Definition
GET/Attachments	Retrieve a list of information related to attachments.
GET/Attachments/AttachFileData	Retrieve a list of information related to an attached file.
POST/Attachments	Add an attachment.

Attributes

Attribute	Description	Data Type	Notes
ActivityID	unique identifier for an activity	integer(int32)
ActivityNumber	an identifying number assigned to an activity used to search for a saved activity in Aspire	integer(int32)
AttachmentID	unique identifier for an attachment	integer(int32)
AttachmentName	file name of the attachment	string	Max Length:255
AttachmentTypeID	unique identifier for attachment type	integer(int32)
AttachmentTypeName	descriptive title of the attachment	string	Max Length: 50
AttachToInvoice	indicates if the attachment should be linked to invoice when emailed to the customer	boolean
ContactID	unique identifier for a contact	integer(int32)	Max Length:101
CreatedDate	activity creation date	DateTime
ContactName	full name of the contact	string	Max Length: 100
DateUploaded	date and time when attachment is uploaded	DateTime
EmployeeIncidentID	unique identifier for an employee incident	integer(int32)
EquipmentDescription	additional details added to an equipment entry	string	Max Length: 250
EquipmentID	unique identifier for an equipment entry	integer(int32)
ExposeToCrew	indicates if the information should be available to crew leader(s) associated with attachment	boolean
ExternalContentID	unique identifier for content hosted outside Aspire system	string	Max Length: 255
FileData	Base64 encoded filed content	string	Min Length: 1
FileExtension	extension type of the file	string	Max Length: 10
FileName	description of file	string	Min Length: 1
Note	additional details or comments	string	Max Length: 500
NotificationTemplateID	unique identifier for a notification template	integer(int32)
ObjectCode	code associated with object	string	Min Length: 1
ObjectId	unique identifier for object	integer(int32)
OpportunityID	unique identifier for an opportunity	integer(int32)
OpportunityNumber	number assigned to an opportunity within Aspire system	integer(int32)
OriginalFileName	the original name of the uploaded file	string	Max Length: 255
PropertyID	unique identifier for a property	integer (int32)
PropertyName	name listed for the property	string	Max Length: 100
PropertyQACategoryID	identifier for the property's QA category	integer(int32)
ReciptID	unique identifier for a receipt	integer(int32)	Max Length: 15
ReciptNumber	numeric code representing a receipt	integer(int32)	Max Length: 200
ShowCustomer	flag indicating if customer can view the item	boolean
WorkTicketID	unique identifier for work ticket	integer(int32)
WorkTicketNumber	numerical code representing a work ticket	integer(int32)
WorkTicketVisitID	unique identifier for work ticket visit	integer(int32)

Was this article helpful?

What's Next

/Attachments

Table of contents

Resource Overview 
Attributes