Edit a Comment

post/commentmanager.edit/{typedId}

Edits the comment specified as the path param. Replaces the comment with the text provided in the request body.
With each edit, the version number is incremented by 1. The comment metadata includes timestamps for creation and last update, along with the author of each change. If a reply is added to a resolved thread, the thread automatically changes to an unresolved state.

Securitybasic or X-PriceFx-jwt
Request
path Parameters
typedId
required
string

typedId of the comment you want to edit.

Example: 12.CMNT
Request Body schema: application/json
object
body
string

Specify the new text content of the comm

Responses
200

OK

Response Schema: application/json
object
node
string
Array of objects (CommentThread)
Array
typedId
string
Array of objects (Comment)
createdBy
integer
lastUpdateDate
string <date-time>
version
integer
relatedObjects
Array of strings

A transient list of strings representing the identifiers of related objects. This attribute is derived from the relations attribute.

resolved
boolean
createDate
string <date-time>
lastUpdateBy
integer
status
integer
Request samples
application/json
{
  • "data": {
    • "body": "an edited comment"
    }
}
Response samples
application/json
{
  • "response": {
    • "node": "pricefx-cluster-app-frontend-6cbbff95d-th6wz",
    • "data": [
      • {
        • "version": 2,
        • "typedId": "2.CMTRD",
        • "relatedObjects": [
          ],
        • "comments": [
          ],
        • "resolved": false,
        • "createDate": "2025-02-28T11:02:57",
        • "createdBy": 2147490696,
        • "lastUpdateDate": "2025-02-28T11:03:12",
        • "lastUpdateBy": 2147490696
        }
      ],
    • "status": 0
    }
}