List Comment Threads

post/commentmanager.fetchthreads/{typedId}

Retrieves comment threads associated with the specified object. An empty request body returns all comment threads. To narrow down returned comment threads, employ a filter in the request body (see the request example).

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

typedId of the object you want to fetch comments for.

Example: 2147494376.Q
query Parameters
getMyComments
string

true - get only comments for "Items for Review" section
false - get "Other Items" section
null - get all comments

Request Body schema: application/json
endRow
integer
oldValues
object or null
operationType
string
startRow
integer
sortBy
Array of strings
textMatchStyle
string
object
operator
string
_constructor
string
Array of objects
Array
fieldName
string
operator
string
value
string
Responses
200

OK

Response Schema: application/json
object
node
string
startRow
integer
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
endRow
integer
totalRows
integer
status
integer
Request samples
application/json
{
  • "endRow": 2000,
  • "oldValues": null,
  • "operationType": "fetch",
  • "startRow": 0,
  • "sortBy": [
    • "-createDate"
    ],
  • "textMatchStyle": "exact",
  • "data": {
    • "operator": "and",
    • "_constructor": "AdvancedCriteria",
    • "criteria": [
      • {
        • "fieldName": "relations.relatedObjectIdentifier",
        • "operator": "equals",
        • "value": "bZWNHIYllshAzzR"
        }
      ]
    }
}
Response samples
application/json
{
  • "response": {
    • "node": "node",
    • "startRow": 0,
    • "data": [
      • {
        • "version": 0,
        • "typedId": "13.CMTRD",
        • "relatedObjects": [
          ],
        • "comments": [
          ],
        • "resolved": false,
        • "createDate": "2024-10-15T12:56:52",
        • "createdBy": 2147490698,
        • "lastUpdateDate": "2024-10-15T12:56:52",
        • "lastUpdateBy": 2147490698
        }
      ],
    • "endRow": 1,
    • "totalRows": 1,
    • "status": 0
    }
}