TEtestiny
Comment

Create a new 'Comment' entity

Creates a new 'Comment' entity. Returns full entity with new id and (optional) creation metadata.

post/comment

Request

Request body

idinteger

The unique entity id - must be a positive integer

is_deletedboolean

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

created_atstring date-time

The creation time for this entity or mapping value

created_bynumber

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

modified_atstring date-time

The last modification time for this entity or mapping value

modified_bynumber

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

deleted_atstring date-time

The soft-deletion time for this entity or mapping value

deleted_bynumber

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

project_idinteger

The project id this entity or mapping belongs to

parent_idinteger

Reserved for future use

statusstring

Reserved for future use

typestring

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!

targetstring

The target of the comment. Either TC, TRTC or AR.

textstring

The comment text (can be a rich text document, i.e. markdown with header line <!--markdown--> or Testiny JSON format)

Example request

{
  "created_at": "1970-01-01T00:00:00.000Z",
  "modified_at": "1970-01-01T00:00:00.000Z",
  "deleted_at": "1970-01-01T00:00:00.000Z"
}

Response

Returns a single Comment

idinteger

The unique entity id - must be a positive integer

is_deletedboolean

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

created_atstring date-time

The creation time for this entity or mapping value

created_bynumber

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

modified_atstring date-time

The last modification time for this entity or mapping value

modified_bynumber

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

deleted_atstring date-time

The soft-deletion time for this entity or mapping value

deleted_bynumber

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

project_idinteger

The project id this entity or mapping belongs to

parent_idinteger

Reserved for future use

statusstring

Reserved for future use

typestring

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!

targetstring

The target of the comment. Either TC, TRTC or AR.

textstring

The comment text (can be a rich text document, i.e. markdown with header line <!--markdown--> or Testiny JSON format)

Example response

{
  "created_at": "1970-01-01T00:00:00.000Z",
  "modified_at": "1970-01-01T00:00:00.000Z",
  "deleted_at": "1970-01-01T00:00:00.000Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.