Read EPSNote
get
/epsNote
Reads EPSNote objects from the database.
Request
Query Parameters
-
Fields(required): string
Fields to loadExample:
Name,ObjectId
-
Filter(required): string
Supported Filter Operators - :gt:, :lt:, :eq:, :gte:, :lte:, :and:, :or:Example:
ObjectId IN(1,2) :and: CreateDate:gte:'2021-04-20' :and: LastUpdateDate:lt:'2022-04-20' :and: Name :like: 'abc%'
-
OrderBy(required): string
OrderBy conditionExample:
ObjectId desc
Header Parameters
-
Authorization(required):
OAuth token
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
OK.
Root Schema : List<EPSNote>
Type:
array
Title:
Show Source
List<EPSNote>
-
Array of:
object EPSNote
Title:
EPSNote
EPSNote Entity
Nested Schema : EPSNote
Type:
object
Title:
EPSNote
EPSNote Entity
Show Source
-
CreateDate: string
(date-time)
The date this EPS Note was created.
-
CreateUser: string
The name of the user that created this EPS Note.
-
EPSId: string
The short code assigned to the associated EPS.
-
EPSName: string
The name of the EPS element associated with this note.
-
EPSObjectId(required): integer
(int32)
The unique ID of the associated EPS.
-
LastUpdateDate: string
(date-time)
The date this EPS Note was last updated.
-
LastUpdateUser: string
The name of the user that last updated this EPS Note.
-
Note: string
The information that is associated with the notebook topic.
-
NotebookTopicName: string
The name of the associated notebook topic.
-
NotebookTopicObjectId(required): integer
(int32)
The unique ID of the associated notebook topic.
-
ObjectId: integer
(int32)
The unique ID generated by the system.
-
RawTextNote: string
The information that is associated with the notebook topic, without any HTML.
400 Response
Bad Request.
401 Response
Unauthorized.
403 Response
Forbidden.
404 Response
Not Found.
405 Response
Invalid Input.
500 Response
Internal Server Error.