Skip to main content

Find 'Comment' entities using the specified (query) parameters

GET 
/comment

Same as POST /find, but serializing the query in the 'q' parameter instead of the request body

Request​

Query Parameters

    q string

    The DataReadParams query as JSON or base64-encoded JSON - See POST route

    Example: {"filter": {"id": 1}}

Responses​

Returns FindResult of type 'Comment' expanded with specified mapped values

Schema

    data

    object[]

    required

  • Array [

    • id integer

    The unique entity id - must be a positive integer

    is_deleted boolean

    If the entity has been soft-deleted this value is true

    created_at date-time

    The creation time for this entity or mapping value

    Example: 1970-01-01T00:00:00.000Z
    created_by number

    The creator user id of this entity or mapping value - or zero if created by the system

    Example: 0
    modified_at date-time

    The last modification time for this entity or mapping value

    Example: 1970-01-01T00:00:00.000Z
    modified_by number

    The id of the user who last modified or undeleted this entity or mapping value - or zero if modified by the system

    Example: 0
    deleted_at date-time

    The soft-deletion time for this entity or mapping value

    Example: 1970-01-01T00:00:00.000Z
    deleted_by number

    The id of the user who deleted this entity or mapping value - or zero if deleted by the system

    Example: 0
    project_id integer

    The project id this entity or mapping belongs to

    parent_id integer

    Reserved for future use

    status string

    Reserved for future use

    type string

    The type of comment. Either TEXT or ATTACHMENT.

    target string

    The target of the comment. Either TC or TRTC.

    text string

    The comment text

    Example:
    attachment string

    A blob reference

    Example:

  • ]

    • meta

    object

    required

    count integerrequired
    limit integer
    offset integerrequired
    totalCount integer
Loading...