Get Request Notes

This REST API allows users to retrieve the notes associated with a request, newest first. The response includes user comments as well as system and workflow notes.

Endpoint Details

URL Structure

http(s)://<EPMWARE_URL>/service/api/request/get_notes

Method

GET

Parameters

Parameter	Type	Required	Default	Description
`requestId`	Query	Yes		Filter by request ID
`userCommentFlag`	Query	No		`true` = user comments only; `false` = system/workflow notes only; omit for both
`startIndex`	Query	No	0	Paging offset
`pageSize`	Query	No	25	Page size
`sortBy`	Query	No	`requestNoteId`	Sort field
`sortType`	Query	No	desc	Sort direction (`asc` or `desc`)

Request Examples

Using curl

curl GET 'https://demo.epmwarecloud.com/service/api/request/get_notes?requestId=1438' \
  -H 'Authorization: Token 15388ad5-c9af-4cf3-af47-8021c1ab3fb7'

Response Format

Successful Response

{
  "startIndex": 0,
  "pageSize": 25,
  "totalCount": 2,
  "resultSize": 2,
  "vEWVRequestNotes": [
    {
      "createTime": "2026-08-13T15:33:58Z",
      "updateTime": "2026-08-13T15:33:58Z",
      "createdBy": 286,
      "updatedBy": 286,
      "requestNoteId": 90412,
      "requestId": 1438,
      "notes": "Please confirm the parent for NET_INCOME before approval.",
      "userCommentFlag": true,
      "hyperLinkFlag": false,
      "userName": "JSMITH",
      "firstName": "John",
      "lastName": "Smith"
    },
    {
      "createTime": "2026-08-12T13:40:05Z",
      "updateTime": "2026-08-12T13:40:05Z",
      "createdBy": 286,
      "updatedBy": 286,
      "requestNoteId": 90398,
      "requestId": 1438,
      "notes": "Request submitted to workflow Standard Approval.",
      "userCommentFlag": false,
      "hyperLinkFlag": false,
      "userName": "JSMITH",
      "firstName": "John",
      "lastName": "Smith"
    }
  ]
}

Response Fields

Field	Type	Description
`requestNoteId`	Long	Note ID
`requestId`	Long	Request ID
`notes`	String	Note text (up to 4000 chars)
`userCommentFlag`	Boolean	True if a user entered the note; false for system/workflow notes
`hyperLinkFlag`	Boolean	True if the note is a hyperlink
`userName`	String	User name of the note author
`firstName`	String	First name of the note author
`lastName`	String	Last name of the note author
`createTime`	Date	Date the note was created
`updateTime`	Date	Date the note was last updated
`createdBy`	Long	User ID that created the note
`updatedBy`	Long	User ID that last updated the note

Common Response Envelope

Field	Type	Description
`startIndex`	Integer	Offset of the first returned row
`pageSize`	Integer	Requested page size
`totalCount`	Long	Total matching rows
`resultSize`	Integer	Number of rows in this response
`sortBy`	String	Applied sort field
`sortType`	String	Applied sort direction

← Get Request Header | Get Request Workflow Stages →