Get All Cases of a Cluster in Release
Overview
The Get All Cases of a Cluster in Release API retrieves all cases in cluster of a Casebase Release. A Case is a group of Questions, Articles, and control actions that work together to guide users through a series of questions and scenarios in a Guided Help session.
Prerequisites
A Guided Help search session for the provided Casebase Release must be in progress before this API is invoked.
Authorization
accessToken JWT Bearer Token authentication for API access
In: header
Path Parameters
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.
^[a-zA-Z0-9]{2,4}-\d{4,15}$7 <= length <= 20The numerical ID of the Casebase Release for which details is to be fetched.
^[1-9]\d{14}$ID of Cluster.
^[1-9]\d*$10 <= length <= 10Query Parameters
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"
Pagination parameter that specifies the page number of results to be returned. Used in conjunction with $pagesize.
int641 <= value <= 9991Pagination parameter that specifies the number of results per page. Used in conjunction with $pagenum.
int641 <= value <= 7510Header Parameters
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"
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.
^[\w\W]+$length <= 40A unique numeric interaction identifier from eGain.
^[0-9]{4,9}$4 <= length <= 9A 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.
^[\w\W]+$length <= 40Response 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/clusters/1000000402/cases" \ -H "Accept-Language: en-US" \ -H "x-ext-integration-id: 3155180e-0c13-43e9-9c38-e9045bcbf176" \ -H "x-egain-activity-id: 59237" \ -H "x-ext-interaction-id: 3155180e-0c13-43e9-9c38-e9045bcbf176"{ "case": [ { "shortName": "Case55", "title": "Becoming a Member", "link": { "rel": "self", "href": "/knowledge/portalmgr/v4/portals/PROD-1000/gh/casebasereleases/202201000000002/cases/1000001085?%24lang=en-US" }, "id": "1000001085" }, { "shortName": "Case56", "title": "Member Benefits Information", "link": { "rel": "self", "href": "/knowledge/portalmgr/v4/portals/PROD-1000/gh/casebasereleases/202201000000002/cases/1000001087?%24lang=en-US" }, "id": "1000001087" }, { "shortName": "Case57", "title": "How to Discontinue Membership", "link": { "rel": "self", "href": "/knowledge/portalmgr/v4/portals/PROD-1000/gh/casebasereleases/202201000000002/cases/1000001089?%24lang=en-US" }, "id": "1000001089" } ], "paginationInfo": { "count": 3, "pagenum": 1, "pagesize": 10 }}Perform a Step in a Guided Help Search PUT
## Overview The Perform a Step in a Guided Help Search API can be used to answer one or more questions (perform a step) in Guided Help search. ## Prerequisites * A Guided Help session must be in progress before this API is invoked.
Get Details of a Case GET
## 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.

