SEservicechannel
Notes

Retrieve work order notes

Returns work order notes and attachments for the specified WO ID. <br />Supports filtering and sorting within the response.  • $expand: Expand a navigation property. For example, enter attachments. To include specific fields for the expanded property, combine with the $select query option, for example, attachments($select=Id,Name).  • $select: Select a set of properties to return. For example, Id,NoteData,CompanyName,CreatedBy.  • $filter: Filter notes by the specified property in the response. For example, NoteType eq 'UsersNote'.  • $orderby: Order notes by the specified property in the response — in ascending asc or descending desc order. For example, DateCreated asc or DateCreated desc.  • $top: Return the specified number of notes in the response.  • $skip: Skip the specified number of notes in the response.  • $count: Include the count of the matching notes in the response.

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

Request

Path parameters

workorderIdinteger required

Tracking number 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

Notes associated with the work order are in the response.

Idinteger

Unique numeric identifier of the work order note.

DocumentIdstring

UUID of the work order note.

GroupIdstring

Numeric identifier of the note group. Some notes can have the same GroupId. For example, when a user note is posted along with a WO status change, the GroupId will be identical for these two notes. Referring to the GroupId helps you easily find the user note associated with the status change. Can be null (for example, for historical notes).

Numberinteger

Sequential number of the note.

NoteDatastring

Content of the note.

DateCreatedstring date-time

Date and time when the note was added to the work order. The format is YYYY-MM-DDThh:mm:ss.sssssss±hh:mm, where ±hh:mm represents the time zone offset from UTC.

ScheduledDatestring date-time

Scheduled date of the work order. The format is YYYY-MM-DDThh:mm:ss±hh:mm, where ±hh:mm represents the time zone offset from UTC.

FollowUpDatestring date-time

Follow-up date specified on the note is used to revisit a work order at a later time, for example, to ensure the provider clocked in or updated the work order by the specified date. The format is YYYY-MM-DDThh:mm:ss±hh:mm, where ±hh:mm represents the time zone offset from UTC.

ActionRequiredboolean

Indicates whether the recipient of the note is required to take further action on a work order. Check also the ActionResolveDetails parameter to see if the issue has been resolved.

MailedTostring

Email address(es) to which the note has been sent.

CreatedBystring

Describes who created the note.

CompanyNamestring

Describes who created the note. Works as the CreatedBy parameter. Note: Obsolete parameter.

IsPinnedboolean

Indicates whether the note is pinned to the top of the notes list. Possible response values:  • true: The note is pinned, signifying the most important or pressing note right now for this work order. Only one note can be pinned on a single work order.  • false: The note isn’t pinned. <br />Available with the PinnedNotes feature flag.

Visibilitystring byte

Defines which parties can view the note. Visibility also works in Universal Connector, where there are three primary parties: Subscriber, External Subscriber, and Provider. Possible response values:  • 0: Visible to everyone (subscriber, external subscriber, provider).  • 1: Visible to the subscriber and the provider. Not visible to the external subscriber.  • 2: Visible to the subscriber and the external subscriber. Not visible to the provider.  • 3: Visible to the subscriber only. <br />Available with the PrivateProviderNotesAndAttachments feature flag. For Universal Connector clients, the PrivateClientNotesAndAttachments feature should be turned on.

NoteType'SystemNote' | 'UsersNote'

Type of the note. Possible response values:  • SystemNote: Notes added automatically by the system.  • UsersNote: Notes posted by users.

IsAttachmentNoteboolean

Specifies whether the WO note has attachments. Possible values: true and false.

Changes

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