POST Search a Conversation

URL: http://{{server-url}}/api/v1/change/{change_id}/conversation/search/byqual

Example: http://{{server-url}}/api/v1/change/1/conversation/search/byqual

You can search a conversation (collaborate and note) within a change request by calling the above endpoint with the ticket ID.

You need the following key-values:

Header

Key	Description
Authorization	Bearer/API Key {access token obtained after authorization}

Body

{
    "qualDetails": {
        "type": "FlatQualificationRest",
        "quals": [
            {
                "type": "RelationalQualificationRest",
                "leftOperand": {
                    "type": "PropertyOperandRest",
                    "key": ".conversation.conversationType"
                },
                "operator": "equal",
                "rightOperand": {
                    "type": "ValueOperandRest",
                    "value": {
                        "type": "EnumValueRest",
                        "value": "note"
                    }
                }
            }
        ]
    }
}

note

To upload an attachment along with converation, first upload the attachment using the Upload Attachment API and then use its response in the body of this API.

Example (Request & Response)

Request

curl --location 'http://172.16.11.160/api//v1/change/1/conversation/search/byqual' \
--header 'Authorization: Apikey cuhEo6Av4WD6sShZ%40oyNkwV7KPlzyNjGMfyzwJO88JSMA3tkyrSmpl60iJIayOHvAHA9n' \
--header 'Content-Type: application/json' \
--data '{
    "qualDetails": {
        "type": "FlatQualificationRest",
        "quals": [
            {
                "type": "RelationalQualificationRest",
                "leftOperand": {
                    "type": "PropertyOperandRest",
                    "key": ".conversation.conversationType"
                },
                "operator": "equal",
                "rightOperand": {
                    "type": "ValueOperandRest",
                    "value": {
                        "type": "EnumValueRest",
                        "value": "note"
                    }
                }
            }
        ]
    }
}

Response

{
    "objectList": [
        {
            "id": 3,
            "conversationType": "note",
            "details": "<p>This is an internal note about the request progress.</p>",
            "createdByName": "Adam",
            "createdByEmail": "adam@motadata.com",
            "createdTime": "Thu, Jul 17, 2025 03:24 pm",
            "updatedTime": "Thu, Jul 17, 2025 03:24 pm",
            "subject": "Progress Update",
            "conversationState": "published",
            "emailIds": [],
            "ccEmailIds": [],
            "updatable": true,
            "deletable": true,
            "fileAttachments": []
        },
        {
            "id": 2,
            "conversationType": "note",
            "details": "<p>Please take this on priority.</p>",
            "createdByName": "Adam",
            "createdByEmail": "adam@motadata.com",
            "createdTime": "Thu, Jul 17, 2025 03:23 pm",
            "updatedTime": "Thu, Jul 17, 2025 03:23 pm",
            "subject": "[CHG-1]: Need to Change the Laptop",
            "conversationState": "published",
            "emailIds": [],
            "ccEmailIds": [],
            "updatable": true,
            "deletable": true,
            "fileAttachments": []
        }
    ],
    "totalCount": 2
}