Jump to

• Request
• Response

Read ActivityNotes

get

/activityNote

Reads ActivityNote objects from the database.

Request

Query Parameters

• Fields(required): string
  Fields to load

  Example:

  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 condition

  Example:

  ObjectId desc

Header Parameters

• Authorization(required):
  OAuth token

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK.

Body ()

Root Schema : List<ActivityNote>

Type: array

Title: List<ActivityNote>

Show Source

• Array of: object ActivityNote
  Title: ActivityNote

  ActivityNote Entity

{
    "title":"List<ActivityNote>",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ActivityNote"
    }
}

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.

{
    "title":"ActivityNote",
    "required":[
        "ActivityObjectId",
        "NotebookTopicObjectId"
    ],
    "type":"object",
    "properties":{
        "ActivityId":{
            "type":"string",
            "description":"The short ID that uniquely identifies the activity to which the activity note is assigned."
        },
        "ActivityName":{
            "type":"string",
            "description":"The name of the activity to which the activity note is assigned."
        },
        "ActivityObjectId":{
            "type":"integer",
            "description":"The unique ID of the activity to which the activity note is assigned.",
            "format":"int32"
        },
        "CreateDate":{
            "type":"string",
            "description":"The date this note was created.",
            "format":"date-time"
        },
        "CreateUser":{
            "type":"string",
            "description":"The name of the user that created this note."
        },
        "IsBaseline":{
            "type":"boolean",
            "description":"The boolean value indicating if this business object is related to a Project or Baseline"
        },
        "IsTemplate":{
            "type":"boolean",
            "description":"The boolean value indicating if this business object is related to a template Project."
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date this note was last updated.",
            "format":"date-time"
        },
        "LastUpdateUser":{
            "type":"string",
            "description":"The name of the user that last updated this note."
        },
        "Note":{
            "type":"string",
            "description":"The information that is associated with the notebook topic."
        },
        "NotebookTopicName":{
            "type":"string",
            "description":"The name of the associated notebook topic."
        },
        "NotebookTopicObjectId":{
            "type":"integer",
            "description":"The unique ID of the associated notebook topic.",
            "format":"int32"
        },
        "ObjectId":{
            "type":"integer",
            "description":"The unique ID generated by the system.",
            "format":"int32"
        },
        "ProjectId":{
            "type":"string",
            "description":"The short code that uniquely identifies the associated project."
        },
        "ProjectObjectId":{
            "type":"integer",
            "description":"The unique ID of the associated project.",
            "format":"int32"
        },
        "RawTextNote":{
            "type":"string",
            "description":"The information that is associated with the notebook topic, without any HTML."
        },
        "WBSObjectId":{
            "type":"integer",
            "description":"The unique ID of the WBS for the activity.",
            "format":"int32"
        }
    },
    "description":"ActivityNote Entity"
}

400 Response

Bad Request.

401 Response

Unauthorized.

403 Response

Forbidden.

404 Response

Not Found.

405 Response

Invalid Input.

500 Response

Internal Server Error.

Back to Top