--- title: "Get a work order note by note ID" method: GET path: "/odata/workorders({workorderId})/notes({noteId})" tags: ["Notes"] --- # Get a work order note by note ID `GET /odata/workorders({workorderId})/notes({noteId})` ## Request - Base URL: `https://sb2api.servicechannel.com/v3` - URL: `https://sb2api.servicechannel.com/v3/odata/workorders({workorderId})/notes({noteId})` - Auth: OAuth 2 - Authorization code: `https://sb2login.servicechannel.com/oauth/authorize` - Token URL: `https://sb2login.servicechannel.com/oauth/token` - TypeScript: (a function with typed inputs; its response is checked against the schema) Returns a specific note that matches the entered work order ID and note ID.
Supports filtering and sorting within the response.  • **$expand:** Expand a navigation property. For example, `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:** Not applicable for this method.  • **$orderby:** Not applicable for this method.  • **$top:** Not applicable for this method.  • **$skip:** Not applicable for this method.  • **$count:** Include the count of the matching resources in the response. ## Path parameters - `noteId` integer, required - `workorderId` integer, required ## Query parameters - `$expand` string - `$select` string - `$filter` string - `$orderby` string - `$top` integer - `$skip` integer - `$count` boolean ## Response `200` The requested work order note is in the response. - ServiceChannelServicesMessagingNotesNote[] - `Id` integer: Unique numeric identifier of the work order note. - `DocumentId` string: UUID of the work order note. - `GroupId` string: 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). - `Number` integer: Sequential number of the note. - `NoteData` string: Content of the note. - `DateCreated` string, 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. - `ScheduledDate` string, 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. - `FollowUpDate` string, 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. - `ActionRequired` boolean: 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. - `MailedTo` string: Email address(es) to which the note has been sent. - `CreatedBy` string: Describes who created the note. - `CompanyName` string: Describes who created the note. Works as the `CreatedBy` parameter. ***Note:*** Obsolete parameter. - `Attachments` ServiceChannelServicesMessagingAttachmentsAttachment[]: Files added along with the note. - `Id` integer: Unique numeric identifier of the attachment. - `Description` string: Optional text that a user added when uploading the attachment. The maximum character count is 200. - `Name` string: Attachment name. - `TimeStamp` string, 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. - `Uri` string: Link address to the attachment in the ServiceChannel system. - `NoteId` integer: Unique numeric identifier of the note to which a user added the attachment. - `Visibility` integer: 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.
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. - `IsInvoiceDigitalCopy` boolean: 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.
***Note:*** Subscribers can set the requirement of a digital invoice copy from providers when the *InvoiceRequireDigitalCopy* feature is turned on. - `UploadBy` string: User who uploaded the attachment. - `IsPinned` boolean: 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.
Available with the *PinnedNotes* feature flag. - `Visibility` string, 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.
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. - `IsAttachmentNote` boolean: Specifies whether the WO note has attachments. Possible values: `true` and `false`. - `ActionResolveDetails` ServiceChannelServicesMessagingNotesActionResolveDetails: Details regarding the resolution status of an action-required note. - `IsResolved` boolean: Indicates whether the action has been resolved. Possible response values: `true` and `false`. Applicable to work order notes that were marked with the **Action Required** flag. - `ResolvedDate` string, date-time: Date and time when the action was resolved. The format is `YYYY-MM-DDThh:mm:ss.sssss±hh:mm`, where `±hh:mm` represents the time zone offset from UTC. ## Other responses - `400`: The request was not accepted due to bad syntax, missing parameters, insufficient data, etc. - `404`: The resource you are looking for has been removed, had its name changed, or is temporarily unavailable.
Error codes: 502 — Work order is not found --- [API](https://skmtc.dev/servicechannel/apis/servicechannel-api-v-3.md) - [All operations](https://skmtc.dev/servicechannel/apis/servicechannel-api-v-3/llms.txt) - [OpenAPI document](https://skmtc.dev/servicechannel/apis/servicechannel-api-v-3/revisions/d490d6596809?raw)