Update one 'Comment' entity

PUT 
/comment/:id

Update a single existing 'Comment' entity. Returns a full updated entity including (optional) modification metadata.

Request

Path Parameters

id integerrequired

The id tof the object to update

Query Parameters

force boolean

Forces the update even if '_etag' is missing or not matching.

application/json

Body

required

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:

Responses

200

Returns a single Comment

application/json

Schema

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.

target string

The target of the comment. Either TC or TRTC.

text string
The comment text
Example:
attachment string
A blob reference
Example:

Example (from schema)

{
  "id": 0,
  "is_deleted": true,
  "created_at": "1970-01-01T00:00:00.000Z",
  "created_by": 0,
  "modified_at": "1970-01-01T00:00:00.000Z",
  "modified_by": 0,
  "deleted_at": "1970-01-01T00:00:00.000Z",
  "deleted_by": 0,
  "project_id": 0,
  "parent_id": 0,
  "status": "string",
  "type": "string",
  "target": "string",
  "text": "",
  "attachment": ""
}

4XX

The request failed because invalid request parameters or data were supplied or access was denied.

application/json

Schema

Schema

code string
The error code describing the general error category.
Example: API_INVALID_INPUT_DATA
status integer

The HTTP status code.

message stringrequired

The actual error message describing the error in more detail.

reqid string

The request id for following up on specific errors.

Example (from schema)

{
  "code": "API_INVALID_INPUT_DATA",
  "status": 0,
  "message": "string",
  "reqid": "string"
}

5XX

The request failed because an error occurred during processing of the request.

application/json

Schema

Schema

code string
The error code describing the general error category.
Example: API_INVALID_INPUT_DATA
status integer

The HTTP status code.

message stringrequired

The actual error message describing the error in more detail.

reqid string

The request id for following up on specific errors.

Example (from schema)

{
  "code": "API_INVALID_INPUT_DATA",
  "status": 0,
  "message": "string",
  "reqid": "string"
}

Loading...