Jump to

• Request
• Response

Read ActivityComments

get

/activityComment

Reads ActivityComment 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<ActivityComment>

Type: array

Title: List<ActivityComment>

Show Source

• Array of: object ActivityComment
  Title: ActivityComment

  ActivityComment Entity

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

Nested Schema : ActivityComment

Type: object

Title: ActivityComment

ActivityComment Entity

Show Source

• ActivityObjectId(required): integer (int32)
  The unique ID of the activity to which this comment is added.
• AssignmentObjectId: integer (int32)
• CommentDate: string (date-time)
  The date on which this comment was added.
• CommentText(required): string
  The comment.
• CreateDate: string (date-time)
  The date this comment was created.
• CreateUser: string
  The name of the user that created this comment.
• DeleteDate: string (date-time)
• DeleteUser: string
• IsRejected: boolean
• LastUpdateDate: string (date-time)
  The date this comment was last updated.
• LastUpdateUser: string
  The name of the user that last updated this comment.
• ObjectId: integer (int32)
  The unique ID generated by the system.
• PersonalName: string
  The commented user's personal or actual name.
• ReadFlag: boolean
  The flag that identifies whether a comment is read by a particular user.
• RejectionComments: string
• TimeDiff: string
  This field gives the time difference between current and createdate.
• UserObjectId(required): integer (int32)
  The unique ID of the user who added this comment.

{
    "title":"ActivityComment",
    "required":[
        "ActivityObjectId",
        "CommentText",
        "UserObjectId"
    ],
    "type":"object",
    "properties":{
        "ActivityObjectId":{
            "type":"integer",
            "description":"The unique ID of the activity to which this comment is added.",
            "format":"int32"
        },
        "AssignmentObjectId":{
            "type":"integer",
            "format":"int32"
        },
        "CommentDate":{
            "type":"string",
            "description":"The date on which this comment was added.",
            "format":"date-time"
        },
        "CommentText":{
            "type":"string",
            "description":"The comment."
        },
        "CreateDate":{
            "type":"string",
            "description":"The date this comment was created.",
            "format":"date-time"
        },
        "CreateUser":{
            "type":"string",
            "description":"The name of the user that created this comment."
        },
        "DeleteDate":{
            "type":"string",
            "format":"date-time"
        },
        "DeleteUser":{
            "type":"string"
        },
        "IsRejected":{
            "type":"boolean"
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date this comment was last updated.",
            "format":"date-time"
        },
        "LastUpdateUser":{
            "type":"string",
            "description":"The name of the user that last updated this comment."
        },
        "ObjectId":{
            "type":"integer",
            "description":"The unique ID generated by the system.",
            "format":"int32"
        },
        "PersonalName":{
            "type":"string",
            "description":"The commented user's personal or actual name."
        },
        "ReadFlag":{
            "type":"boolean",
            "description":"The flag that identifies whether a comment is read by a particular user."
        },
        "RejectionComments":{
            "type":"string"
        },
        "TimeDiff":{
            "type":"string",
            "description":"This field gives the time difference between current and createdate."
        },
        "UserObjectId":{
            "type":"integer",
            "description":"The unique ID of the user who added this comment.",
            "format":"int32"
        }
    },
    "description":"ActivityComment 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