Skip to main content

Find a single 'Comment' entity with the given id

GET 
/comment/:id

Fetch a single entity by id - If the entity does not exist, returns a 404 error.

Request​

Path Parameters

    id integerrequired

    The id of the entity to find

Responses​

Returns a single Comment

Schema

    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. For attachments, please use the specialized API to 'Upload blob data as an attachment to the given test case' instead of creating comments directly!

    target string

    The target of the comment. Either TC or TRTC.

    text string

    The comment text (can be a rich text document)

    Example: Plain text or rich text document
    attachment string

    References to blobs shown as attachments

    Example: [{ "id": 1234, "blobId": "8be23b94bb52d5866f2b34abfac565f2", "filename": "my_file.txt", "mimeType": "text/plain", "size": 123, "title": "Optional title for my file" }]
Loading...