Attachment Class - quandis/qbo3-Documentation GitHub Wiki

The Attachment module's Attachment table is based on the MISMO data dictionary standard.

Attachment properties

Column Type Required Description
Active string
ActiveStatus string
ArchivalDate dateTime Date this attachment was archived
ArchiveScheduled dateTime Date this attachment is scheduled to be archived
Attachment string yes Label for the table.
AttachmentID integer yes Identity column and primary key for the table.
AttachmentTemplateID integer Foreign key to AttachmentTemplate. This identifies which template the Attachment is based upon.
AttachmentType string Enumerated values; set by power user in ObjectType table.
Batch integer
CanDelete string
CanInsert string
CanUpdate string
CheckInComment string Most recent checkin comment.
CheckInDate dateTime DateTime of the most recent checkin.
CheckOutDate dateTime If currently checked out, the date the attachment was checked out.
CheckOutExpiration dateTime DateTime indicating expiration of the checkout. When passed, the checkout will be undone.
CheckOutPersonID integer User (PersonID) that checked the file out.
Compression boolean Indicates whether the attachment is compress in the FileObject storage.
CreatedDate dateTime
CreatedPersonID integer
Description string Description of the attachment.
ExpirationDate dateTime Expiration date of the attachment. Upon expiration, the underlying file will be deleted.
ExpirationScheduled dateTime Date this attachment is scheduled to be expired
Extranet string
FileContent string Byte array containing file content.
FileName string FileName. E.g. MyPhoto.jpeg. This is typically automatically set to match an uploaded file name, or from AttachmentTemplate.FileNameFormat for generated attachments.
FileObjectAssembly string An entry from FileObject.config specifying what backing store to use for an attachment. E.g. AmazonS3, UNC, WebDAV, etc.
FinalStatus string
Form string
HashAlgorithm string The algorithm used to determine the hash value of the Attachment's file.
HashValue binary The result of hashing the Attachment's file.
HashDate datetime The date when the Attachment's file was hashed.
InDecisionID string
InImportFileID string
Length integer Size of the attachment file. This is returned via the IFileObject interface, and can be used to estimate total disk storage.
LengthCompressed integer Size of the compressed attachment file. This is returned via the IFileObject interface, and can be used to estimate compressed disk storage.
LinkedFrom string
LinkedTo string
MetaXML string This field is deprecated; use the ImportFormObject class instead to stored extended properties.
MetaXSD string This field is deprecated; use the ImportFormObject class instead to stored extended properties.
NotLinkedFrom string
NotLinkedTo string
Object string
ObjectID integer
OutboundDue dateTime Expected delivery date for an outbound attachment.
OutboundReceived dateTime Actual delivery date for an outbound attachment.
OutboundService string Delivery service (from Delivery.config) to use when calling Attachment.Deliver(). E.g. Fedex, UPS, Certified, or other plugins.
OutboundTrackingID string Unique id returned by the outbound delivery service.
OwnerID integer User that is assigned ownership of the document.
PathURL string Relative path to the file within the FileObject store.
PrivateKey string Private key used to encrypt / decrypt the attachment file.
PublicKey string PublicKey used to encrypt / decrypt the attachment file.
ReturnDue dateTime Expected return date.
ReturnReceived dateTime Actual return date.
ReturnService string Return delivery service (from Delivery.config). E.g. Fedex, UPS, Certified, or other plugins.
ReturnTrackingID string Unique id used by return service provider.
Status string
Tags string
UnreadNotifications string
UpdatedDate dateTime
UpdatedPersonID integer
ViewAsRole string
Worklist string

Related modules

Related Objects Module Relationship
Access Child
AttachmentTemplate qbo.Attachment.AttachmentTemplateObject Foreign Key
Collections CollectionMember Child
ConfigurationEntryCollection ConfigurationEntry Child
Contacts Contact Child
Decisions Decision Child
Forms ImportForm Child
Labels CollectionMember Child
Ledgers Ledger Child
Messages Message Child
Regions Geography Child
Scores Score Child
SearchIndexes SearchIndex Child
Worklists SmartWorklistMember Child

Method signatures

Attachment/Attachment.ashx/Search?{Parameters}

The search method will return all records matching the {Parameters} criteria. For searches, {Parameters} may include any property listed in the table above. The following standard optional parameters also apply:

  • Output: determines the formatting of the returned data. Valid values are Xml, Json, JsonP. If omitted, XHTML is returns based on the Attachment.Search.xslt template.
  • DisplaySize: determines the maximum number of rows returned. Default is 25. DisplaySize=0 will return all matching rows.
  • RecordStart: the starting record to return; defaults to 0. Used for pagination.
  • OrderBy: a series of properties to order by.
  • Request: Attachment.ashx/Search?Attachment=ABC123
  • Response:
<AttachmentCollection>
  <AttachmentItem>
    <AttachmentID>10427</AttachmentID>
    <Attachment>
    </Attachment>
    <AttachmentType>
    </AttachmentType>
    <AttachmentTemplateID>
    </AttachmentTemplateID>
    <OwnerID>
    </OwnerID>
    <PathURL>/{Guid}/</PathURL>
    <Description>
    </Description>
    <CheckOutDate>
    </CheckOutDate>
    <CheckOutPersonID>
    </CheckOutPersonID>
    <CheckOutExpiration>
    </CheckOutExpiration>
    <CheckInDate>
    </CheckInDate>
    <CheckInComment>
    </CheckInComment>
    <ExpirationDate>
    </ExpirationDate>
    <OutboundService>
    </OutboundService>
    <OutboundTrackingID>
    </OutboundTrackingID>
    <OutboundDue>
    </OutboundDue>
    <OutboundReceived>
    </OutboundReceived>
    <ReturnService>
    </ReturnService>
    <ReturnTrackingID>
    </ReturnTrackingID>
    <ReturnDue>
    </ReturnDue>
    <ReturnReceived>
    </ReturnReceived>
    <MetaXSD>
    </MetaXSD>
    <MetaXML>
    </MetaXML>
    <FileContent>
    </FileContent>
    <FileObjectAssembly>AmazonS3</FileObjectAssembly>
    <FileName>
    </FileName>
    <Length>0</Length>
    <LengthCompressed>0</LengthCompressed>
    <Compression>True</Compression>
    <PublicKey>
    </PublicKey>
    <PrivateKey>
    </PrivateKey>
    <ExpirationScheduled>
    </ExpirationScheduled>
    <ArchiveScheduled>
    </ArchiveScheduled>
    <ArchivalDate>
    </ArchivalDate>
    <Object>
    </Object>
    <ObjectID>
    </ObjectID>
    <Status>
    </Status>
    <CreatedPersonID>646</CreatedPersonID>
    <CreatedDate>2015-04-10T15:47:17.797-07:00</CreatedDate>
    <UpdatedPersonID>646</UpdatedPersonID>
    <UpdatedDate>2015-04-10T15:47:17.797-07:00</UpdatedDate>
    <AttachmentTemplate>
    </AttachmentTemplate>
    <CreatedPerson>[email protected]</CreatedPerson>
    <UpdatedPerson>[email protected]</UpdatedPerson>
    <CheckOutPerson>
    </CheckOutPerson>
    <RecordCount>500</RecordCount>
  </AttachmentItem>
  <AttachmentItem>
    <AttachmentID>6924</AttachmentID>
    <Attachment>{CaseType}.2013.09.30.09.45.10.csv</Attachment>
    <AttachmentType>
    </AttachmentType>
    <AttachmentTemplateID>140</AttachmentTemplateID>
    <OwnerID>
    </OwnerID>
    <PathURL>LitigationHold.2013.09.30.09.45.08.txt</PathURL>
    <Description>
    </Description>
    <CheckOutDate>
    </CheckOutDate>
    <CheckOutPersonID>
    </CheckOutPersonID>
    <CheckOutExpiration>
    </CheckOutExpiration>
    <CheckInDate>
    </CheckInDate>
    <CheckInComment>
    </CheckInComment>
    <ExpirationDate>
    </ExpirationDate>
    <OutboundService>
    </OutboundService>
    <OutboundTrackingID>
    </OutboundTrackingID>
    <OutboundDue>
    </OutboundDue>
    <OutboundReceived>
    </OutboundReceived>
    <ReturnService>
    </ReturnService>
    <ReturnTrackingID>
    </ReturnTrackingID>
    <ReturnDue>
    </ReturnDue>
    <ReturnReceived>
    </ReturnReceived>
    <MetaXSD>
    </MetaXSD>
    <MetaXML>
    </MetaXML>
    <FileContent>
    </FileContent>
    <FileObjectAssembly>AmazonS3</FileObjectAssembly>
    <FileName>LitigationHold.2013.09.30.09.45.08.txt</FileName>
    <Length>787</Length>
    <LengthCompressed>502</LengthCompressed>
    <Compression>True</Compression>
    <PublicKey>
    </PublicKey>
    <PrivateKey>
    </PrivateKey>
    <ExpirationScheduled>
    </ExpirationScheduled>
    <ArchiveScheduled>
    </ArchiveScheduled>
    <ArchivalDate>
    </ArchivalDate>
    <Object>ReportRequest</Object>
    <ObjectID>670</ObjectID>
    <Status>
    </Status>
    <CreatedPersonID>577</CreatedPersonID>
    <CreatedDate>2013-09-30T09:45:08.727-07:00</CreatedDate>
    <UpdatedPersonID>577</UpdatedPersonID>
    <UpdatedDate>2013-09-30T09:45:14.313-07:00</UpdatedDate>
    <AttachmentTemplate>SFDML Litigation</AttachmentTemplate>
    <CreatedPerson>[email protected]</CreatedPerson>
    <UpdatedPerson>[email protected]</UpdatedPerson>
    <CheckOutPerson>
    </CheckOutPerson>
    <RecordCount>500</RecordCount>
  </AttachmentItem>
</AttachmentCollection>

Attachment/Attachment.ashx/Save?{Parameters}

The save method will return all records matching the {Parameters} criteria. {Parameters} may include any property listed in the table above along with child classes.

  • Output: determines the formatting of the returned data. Valid values are Xml, Json, JsonP.
  • Response: included in the response is {Table}ID; this is the primary key of the {Table} row created
  • With the same Save method, you can also save data to related tables. By using a {Parent}_{Column} pattern, you can update the parent table's data in the same call.
  • Child records may also be updated using a {Child}_{Index}_{Column} pattern.
  • For child records that are templated, you may use the template name in lieu of an index.

Attachment/Attachment.ashx/Delete?ID={Where.IdList}

The delete method will delete all records where ID={comma-delimited list of identifiers} criteria.

Attachment/Attachment.ashx/ListWhere?{Parameters}

The ListWhere method will return all records matching the {Parameters} criteria. {Parameters} may include any property listed in the table.

  • Output: determines the formatting of the returned data. Valid values are Xml, Json, JsonP.
  • Response: 2 columns are returned - {Table}ID and {Table} columns.
  • Request: Attachment.ashx/ListWhere?AttachmentID=1,2,3
  • Response:
<AttachmentCollection>
  <AttachmentItem>
    <AttachmentID>5592</AttachmentID>
	<Attachment>Final.txt</Attachment>
  </AttachmentItem>
  <AttachmentItem>
	<AttachmentID>300</AttachmentID>
	<Attachment>ImportResult.xml</Attachment>
  </AttachmentItem>
  <AttachmentItem>
	<AttachmentID>301</AttachmentID>
	<Attachment>Pacer.Search.112-bk-11655.Native.html</Attachment>
  </AttachmentItem>
</AttachmentCollection>
⚠️ **GitHub.com Fallback** ⚠️