- Home
- Resources
- NoteResource
The Notes resource provides read/write access to notes objects in InService.
a note object can be created in the context of the following:
- Product
- Product Instance
- Topic
- Publication
- Information Element
- Part
- Parts List Item
Data Model Objects:
The following resources are applicable:
POST /notes
Creates a new Note.
Request Body
| media type |
data type |
description |
| application/vnd.ptc.sc+json |
SCItem
(JSON) |
The SCItem representing the note to create. |
Response Codes
| code |
condition |
| 400 |
Returned when the content does not contain data. or data does not
have a notable context id |
| 415 |
Returned if the Content-Type is not
application/vnd.ptc.sc+json;version=n |
Response Body
| media type |
data type |
| application/vnd.ptc.sc+json |
SCItem
(JSON) |
- Available Since
- InService 6.0
GET /notes/{noteId}
Retrieves a specific note by the given note ID.
- Available Since
- InService 6.0
Request Parameters
| name |
type |
description |
default |
| noteId |
path |
the ID of the note to retrieve |
n/a |
| $expand |
query |
the OData expand clause used to expand attribute objects
and collections. To expand the items collection when
requesting the note use: $expand=items |
n/a |
| $filter |
query |
-- Reserved for future use. -- |
n/a |
| $orderby |
query |
the ordering of note items when expanding items |
n/a |
| $skip |
query |
the number of note items to skip for paging when expanding items |
n/a |
| $top |
query |
the number of note items to return in a page when expanding items |
n/a |
Response Codes
| code |
condition |
| 400 |
returned when the noteId is not of valid ID for a note |
| 404 |
returned when a note is not found for the given note ID |
Response Body
| media type |
data type |
| application/vnd.ptc.sc+json |
SCItem
(JSON) |
GET /notes
Request Parameters
| name |
type |
description |
default |
| $expand |
query |
|
n/a |
| $filter |
query |
|
n/a |
| $orderby |
query |
|
n/a |
| $skip |
query |
|
n/a |
| $top |
query |
|
n/a |
| context |
query |
|
n/a |
| effectivity |
query |
|
n/a |
| exactMatch |
query |
|
n/a |
| itemId |
query |
|
n/a |
Response Body
| media type |
data type |
| application/vnd.ptc.sc+json |
SCList
(JSON) |
GET /notes/getNotesOnPartsListItem
Request Parameters
| name |
type |
description |
default |
| $expand |
query |
|
n/a |
| $filter |
query |
|
n/a |
| $orderby |
query |
|
n/a |
| $skip |
query |
|
n/a |
| $top |
query |
|
n/a |
| context |
query |
|
n/a |
| effectivity |
query |
|
n/a |
| exactMatch |
query |
|
n/a |
| itemId |
query |
|
n/a |
| partsListItemId |
query |
|
n/a |
Response Body
| media type |
data type |
| application/vnd.ptc.sc+json |
SCList
(JSON) |
GET /notes/getSNNotes
Request Parameters
| name |
type |
description |
default |
| $expand |
query |
|
n/a |
| $filter |
query |
|
n/a |
| $orderby |
query |
|
n/a |
| $skip |
query |
|
n/a |
| $top |
query |
|
n/a |
| SNDisplayName |
query |
|
n/a |
| effectivity |
query |
|
n/a |
| exactMatch |
query |
|
n/a |
Response Body
| media type |
data type |
| application/vnd.ptc.sc+json |
SCList
(JSON) |
GET /notes/get_all_ids
Retrieves all note ids for the given user. This does not return serialized
notes, it returns an SCList of ids.
Response Body
| media type |
data type |
| application/vnd.ptc.sc+json |
array of object
(JSON) |
PUT /notes/{noteId}
Updates an existing note.
Request Parameters
| name |
type |
description |
default |
| noteId |
path |
The ID of the note to be updated. |
n/a |
Request Body
| media type |
data type |
description |
| application/vnd.ptc.sc+json |
SCItem
(JSON) |
The note to be updated. |
Response Codes
| code |
condition |
| 400 |
Returned when the content does not contain the correct note
data for the update or the noteId is not of valid ID format. |
| 404 |
Returned when a note is not found for the given note ID. |
| 415 |
Returned if the Content-Type is not
application/vnd.ptc.sc+json;version=n |
Response Body
| media type |
data type |
| application/vnd.ptc.sc+json |
SCItem
(JSON) |
DELETE /notes/{noteId}
Deletes the specified note.
Request Parameters
| name |
type |
description |
default |
| noteId |
path |
The ID of the note to be deleted. |
n/a |
Response Codes
| code |
condition |
| 204 |
Returned if the note was successfully deleted. |
| 400 |
Returned when a noteId is not of valid ID format. |
| 404 |
Returned when a note is not found for the given note ID. |
Response Body
| media type |
data type |
| application/vnd.ptc.sc+json |
SCList
(JSON) |
POST /notes/remove
Delete a list of given notes.
Request Body
| media type |
data type |
description |
| application/vnd.ptc.sc+json |
SCList
(JSON) |
The SCList of notes to be deleted. |
Response Codes
| code |
condition |
| 204 |
Returned if a list of notes were successfully deleted. |
| 400 |
Returned when the content does not contain data or the cartId
of any item in the SCList is not of valid ID format. |
| 404 |
Returned when none of the notes is found |
| 415 |
Returned if the Content-Type is not
application/vnd.ptc.sc+json;version=n |
Response Body
| media type |
data type |
| application/vnd.ptc.sc+json |
SCList
(JSON) |
GET /notes/notesCount
Request Parameters
| name |
type |
description |
default |
| context |
query |
|
n/a |
| itemId |
query |
|
n/a |
Response Body
| media type |
data type |
| application/vnd.ptc.sc+json |
number
(JSON) |
GET /notes/getCountOnPartsListItem
Retrieves count of the notes on each partlist item
Request Parameters
| name |
type |
description |
default |
| itemId |
query |
|
n/a |
| pliIds |
query |
|
n/a |
Response Body
| media type |
data type |
| application/vnd.ptc.sc+json |
object
(JSON) |
GET /notes/notesSNCount
Request Parameters
| name |
type |
description |
default |
| SNDisplayName |
query |
|
n/a |
Response Body
| media type |
data type |
| application/vnd.ptc.sc+json |
number
(JSON) |