Read ActivityNotes
get
/activityNote
Reads ActivityNote 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<ActivityNote>
Type:
array
Title:
Show Source
List<ActivityNote>
-
Array of:
object ActivityNote
Title:
ActivityNote
ActivityNote Entity
Nested Schema : ActivityNote
Type:
object
Title:
ActivityNote
ActivityNote Entity
Show Source
-
ActivityId: string
The short ID that uniquely identifies the activity to which the activity note is assigned.
-
ActivityName: string
The name of the activity to which the activity note is assigned.
-
ActivityObjectId(required): integer
(int32)
The unique ID of the activity to which the activity note is assigned.
-
CreateDate: string
(date-time)
The date this note was created.
-
CreateUser: string
The name of the user that created this note.
-
IsBaseline: boolean
The boolean value indicating if this business object is related to a Project or Baseline
-
IsTemplate: boolean
The boolean value indicating if this business object is related to a template Project.
-
LastUpdateDate: string
(date-time)
The date this note was last updated.
-
LastUpdateUser: string
The name of the user that last updated this 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.
-
ProjectId: string
The short code that uniquely identifies the associated project.
-
ProjectObjectId: integer
(int32)
The unique ID of the associated project.
-
RawTextNote: string
The information that is associated with the notebook topic, without any HTML.
-
WBSObjectId: integer
(int32)
The unique ID of the WBS for the activity.
400 Response
Bad Request.
401 Response
Unauthorized.
403 Response
Forbidden.
404 Response
Not Found.
405 Response
Invalid Input.
500 Response
Internal Server Error.