SEservicechannel
Attachments

Get a work order attachment

Retrieves attachment(s) added to the specified work order.

get/odata/workorders({workorderId})/attachments

Request

Path parameters

workorderIdinteger required

Unique numeric identifier of the work order.

Query parameters

$expandstring

Expand a navigation property.

$selectstring

Select a set of properties to return.

$filterstring

Filter a collection of resources addressed by a request URL.

$orderbystring

Order resources by the specified property in the response.

$topinteger

Return the specified number of items in the response.

$skipinteger

Skip the specified number of items in the response.

$countboolean

Include the count of the matching resources in the response.

Response

Information about attachments is in the response.

Idinteger

Unique numeric identifier of the attachment.

Descriptionstring

Optional text that a user added when uploading the attachment. The maximum character count is 200.

Namestring

Attachment name.

TimeStampstring date-time

Date and time when the attachment was uploaded. The format is YYYY-MM-DDThh:mm:ss.sss±hh:mm, where ±hh:mm represents the time zone offset from UTC.

Uristring

Link address to the attachment in the ServiceChannel system.

NoteIdinteger

Unique numeric identifier of the note to which a user added the attachment.

Visibilityinteger

Visibility status of the attachment. Defines which parties can view the attachment. The PrivateProviderNotesAndAttachments feature should be enabled. For subscribers who are using Universal Connector, the PrivateClientNotesAndAttachments feature should be enabled. <br />Possible values:  • 0: No restrictions on visibility. Visible to everyone.  • 1: Not visible to the client. The subscriber deselected the “Visible to Client” checkmark when uploading an attachment or adding a note with an attachment.  • 2: Not visible to the provider. The subscriber deselected the “Visible to Provider” checkmark when uploading an attachment or adding a note with an attachment.  • 3: Visible to the subscriber only. The subscriber deselected the “Visible to Client” and “Visible to Provider” checkmarks when uploading an attachment or adding a note with an attachment.

IsInvoiceDigitalCopyboolean

Defines if the attachment is a digital copy of the provider’s invoice. According to subscriber configurations, some providers should attach digital copies of invoices. Possible values:  • true: The attachment is an invoice digital copy.  • false: The attachment is not an invoice digital copy. <br />Note: Subscribers can set the requirement of a digital invoice copy from providers when the InvoiceRequireDigitalCopy feature is turned on.

UploadBystring

User who uploaded the attachment.

Changes

No recorded changes to this operation across all 1 revision of this API.