SupportCases

Sets a support case to Mpt.Helpdesk.Models.Cases.SupportCaseStatus.Querying status.

The support case ID is provided in the route. The Payload must contain only the Mpt.Helpdesk.Models.Cases.SupportCase.QueryPrompt property.

post/public/v1/helpdesk/cases/{id}/query

Request

  • Base URL: https://api.platform.softwareone.com
  • URL: https://api.platform.softwareone.com/public/v1/helpdesk/cases/{id}/query
  • Auth: none declared

Path parameters

idstring required

The support case ID.

Request body

idstring
revisioninteger
status'Processing' | 'Querying' | 'Completed'
queryPromptstring nullable

The prompt that is set along with setting the Mpt.Helpdesk.Models.Cases.SupportCase.Status to Mpt.Helpdesk.Models.Cases.SupportCaseStatus.Querying

Example request

{
  "chat": {
    "attachments": [
      {
        "file": {
          "filename": "report.pdf",
          "size": 102400,
          "contentType": "application/pdf"
        }
      }
    ]
  }
}

Response

OK

idstring
revisioninteger
status'Processing' | 'Querying' | 'Completed'
queryPromptstring nullable

The prompt that is set along with setting the Mpt.Helpdesk.Models.Cases.SupportCase.Status to Mpt.Helpdesk.Models.Cases.SupportCaseStatus.Querying

Example response

{
  "chat": {
    "attachments": [
      {
        "file": {
          "filename": "report.pdf",
          "size": 102400,
          "contentType": "application/pdf"
        }
      }
    ]
  }
}

Changes

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