Guided Help

Get Details of a Case

GET
/knowledge/portalmgr/v4/portals/{portalID}/gh/casebasereleases/{casebaseReleaseID}/cases/{caseID}

Overview

The Get Details of a Case API retrieves details of a case in a release.

Prerequisites

  • A Guided Help search session for the provided Casebase Release must be in progress before this API is invoked.

Authorization

accessToken
AuthorizationBearer <token>

JWT Bearer Token authentication for API access

In: header

Path Parameters

portalID*string

The ID of the portal being accessed.A portal ID is composed of a 2-4 letter prefix, followed by a dash and 4-15 digits.

Match^[a-zA-Z0-9]{2,4}-\d{4,15}$
Length7 <= length <= 20
casebaseReleaseID*string

The numerical ID of the Casebase Release for which details is to be fetched.

Match^[1-9]\d{14}$
caseID*string

The numerical ID of the Case for which details is to be fetched.

Match^[1-9]\d*$
Length10 <= length <= 15

Query Parameters

$lang?string

The language that describes the details of a resource. Resources available in different languages may differ from each other.If lang is not passed, then the portal's default language is used.

Value in

  • "en-US"
  • "fr-FR"
  • "en-GB"
  • "es-ES"
  • "it-IT"
  • "nl-NL"
  • "da-DA"
  • "sv-SE"
  • "pt-PT"
  • "fi-FI"
  • "no-NB"
  • "no-NN"
  • "ja-JA"
  • "de-DE"
  • "pt-BR"
  • "zh-CN"
  • "zh-TW"
  • "ko-KO"
  • "ru-RU"
  • "el-EL"
  • "tr-TR"
  • "pl-PL"
  • "cs-CS"
  • "sk-SK"
  • "hu-HU"
  • "sr-SR"
  • "ar-SA"
  • "hr-HR"
  • "ro-RO"
  • "th-TH"
  • "de-AT"
  • "vi-VN"
  • "id-ID"
  • "ms-MY"
  • "fil-PH"
  • "fr-CA"
  • "hi-IN"
  • "uk-UA"
  • "bg-BG"
  • "sl-SI"
  • "xx-XX"
caseAdditionalAttributes?array<>

Additional case attributes to be fetched.

Header Parameters

x-egain-activity-id?string

A unique numeric interaction identifier from eGain.

Match^[0-9]{4,9}$
Length4 <= length <= 9
x-ext-integration-id?string

The unique numeric identifier for a tenant, used in self-service functionality as well as third-party integrations.Note: The x-ext-integration-id and x-ext-interaction-id headers must always be provided together and cannot be supplied independently.The x-egain-activity-id may be provided on its own, or it may be provided along with both x-ext-integration-id and x-ext-interaction-id.

Match^[\w\W]+$
Lengthlength <= 40
x-ext-interaction-id?string

A unique interaction identifier from other CRM applications.Note: The x-ext-integration-id and x-ext-interaction-id headers must always be provided together and cannot be supplied independently.The x-egain-activity-id may be provided on its own, or it may be provided along with both x-ext-integration-id and x-ext-interaction-id.

Match^[\w\W]+$
Lengthlength <= 40
Accept-Language*string

The Language locale accepted by the client (used for locale specific fields in resource representation and in error responses).

Value in

  • "en-US"
  • "es-ES"
  • "fr-FR"
  • "it-IT"
  • "de-DE"
  • "nl-NL"
  • "pt-BR"
  • "pt-PT"
  • "da-DK"
  • "ru-RU"
  • "fr-CA"
  • "zh-CN"
  • "ja-JP"
  • "ko-KR"
  • "sv-SE"

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/knowledge/portalmgr/v4/portals/PROD-1000/gh/casebasereleases/202201000000002/cases/1000001085?caseAdditionalAttributes=actions" \  -H "x-egain-activity-id: 59237" \  -H "x-ext-integration-id: 3155180e-0c13-43e9-9c38-e9045bcbf176" \  -H "x-ext-interaction-id: 3155180e-0c13-43e9-9c38-e9045bcbf176" \  -H "Accept-Language: en-US"

{  "shortName": "Case55",  "title": "Becoming a Member",  "acceptCount": 0,  "rejectCount": 0,  "comments": "",  "profileId": "1",  "releaseId": "202201000000002",  "clusterId": "1000000402",  "isVisible": true,  "thresholdValue": 50,  "thresholdType": "Default",  "caseType": "Content",  "createdBy": {    "id": "1013",    "firstName": "John",    "middleName": "",    "lastName": "Doe"  },  "createdDate": "2022-06-26T11:11:00Z",  "modifiedBy": {    "id": "1013",    "firstName": "John",    "middleName": "",    "lastName": "Doe"  },  "modifiedDate": "2022-06-26T11:11:00Z",  "thresholdValueFromCluster": 90,  "metadata": [    {      "title": "",      "additionalInformation": "",      "action": ""    }  ],  "link": {    "rel": "self",    "href": "/knowledge/portalmgr/v4/portals/PROD-1000/gh/casebasereleases/202201000000002/cases/1000001085?%24lang=en-US"  },  "id": "1000001085"}