# Get Details of a Casebase Release

## Overview
The Get Details of a Casebase Release API retrieves details of Casebase Release.

Endpoint: GET /portals/{portalID}/gh/casebasereleases/{casebaseReleaseID}
Security: oAuthUser, oAuthOnBehalfOfUser, oAuthCustomer, oAuthOnBehalfOfCustomer, oAuthAnonymousCustomer

## Path parameters:

  - `portalID` (string, required)
    The ID of the portal being accessed.<br><br>A portal ID is composed of a 2-4 letter prefix, followed by a dash and 4-15 digits.

  - `casebaseReleaseID` (string, required)
    The numerical ID of the Casebase Release for which details is to be fetched.

## Query parameters:

  - `$lang` (string)
    The language used for a resource. Resources available in different languages may differ from each other. 
If <code>$lang</code> is not passed, then the portal's default language is used.

  - `languages` (boolean)
    Display langages of Casebase Releases.

## Header parameters:

  - `Accept-Language` (string, required)
    The Language locale accepted by the client (used for locale specific fields in resource representation and in error responses).

  - `x-ext-integration-id` (string)
    The unique numeric identifier for a tenant, used in self-service functionality as well as third-party integrations.<br><br>*Note: The x-ext-integration-id and x-ext-interaction-id headers must always be provided together and cannot be supplied independently.<br><br>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.*

  - `x-egain-activity-id` (string)
    A unique numeric interaction identifier from eGain.

  - `x-ext-interaction-id` (string)
    A unique interaction identifier from other CRM applications.<br><br>*Note: The x-ext-integration-id and x-ext-interaction-id headers must always be provided together and cannot be supplied independently.<br><br>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.*

## Response 200 fields (application/json):

  - `casebase` (array)
    Casebase releases

  - `casebase.casebaseId` (string)
    The numerical ID of the Casebase.
    Example: 409601000000001

  - `casebase.name` (string)
    name of the Casebase Release.

  - `casebase.id` (string)
    The numerical ID of the Casebase Release.

  - `casebase.status` (string)
    status of the Casebase
    Enum: "author", "live", "qa"

  - `casebase.profiles` (array)
    All Guided Help Profiles associated with Casebase release

  - `casebase.profiles.profile` (array)
    profiles

  - `casebase.profiles.profile.id` (string, required)
    The ID of the guided help profile.
1 will always be the **system profile**.

  - `casebase.profiles.profile.name` (string, required)
    Name of the profile

  - `casebase.profiles.paginationInfo` (object)

  - `casebase.profiles.paginationInfo.count` (integer, required)
    The total number of items.

  - `casebase.profiles.paginationInfo.pagenum` (integer, required)
    The page number requested. Page numbers start from 1.

  - `casebase.profiles.paginationInfo.pagesize` (integer, required)
    The number of objects requested per page. The maximum number of objects per page is 75.

  - `casebase.profiles.paginationInfo.link` (array)
    Can include the *prev* and *next* link.

  - `casebase.profiles.paginationInfo.link.rel` (string)
    Defines the relationship between a linked resource and the current object.For example: *self*, *prev*, *next* or an object name such as *'user'*, *'folder'* etc.

  - `casebase.profiles.paginationInfo.link.href` (string)
    The URL that specifies the link's destination.

  - `casebase.searchSettings` (object)

  - `casebase.searchSettings.closeSessionOnAccept` (boolean)
    indicates whether to close the Guided Help session upon acceptance of answer

  - `casebase.searchSettings.closeSessionOnReject` (boolean)
    indicates wheather to reject the Guided Helo session upon rejection of answer

  - `casebase.languages` (object)
    KB languages

  - `casebase.languages.KbLanguage` (array)

  - `casebase.languages.KbLanguage.name` (string)
    Name of the language.
    Enum: "English (United States)", "English (United Kingdom)", "French (France)", "Spanish (Spain)", "Italian (Italy)", "German (Germany)", "Dutch (Netherlands)", "Portuguese (Brazil)", "Portuguese (Portugal)", "Danish (Denmark)", "Swedish (Sweden)", "Russian (Russia)", "French (Canada)", "Chinese (Simplified)", "Japanese (Japan)", "Korean (South Korea)"

  - `casebase.languages.KbLanguage.code` (string)
    IETF code of the language.
    Enum: "en-US", "en-GB", "fr-FR", "es-ES", "it-IT", "de-DE", "nl-NL", "pt-BR", "pt-PT", "da-DK", "sv-SE", "ru-RU", "fr-CA", "zh-CN", "ja-JP", "ko-KR"

## Response 400 fields (application/json):

  - `code` (string, required)
    A string that follows the pattern *{integer}-{integer}*.
The first *{integer}* is the http status code.  This code as a whole is unique.
* For example, error codes "400-101" and "404-101" are distinctly different.

  - `developerMessage` (string, required)
    A summary of the error.

  - `details` (array)

  - `details.key` (string, required)

  - `details.value` (string)

  - `userMessage` (string)
    UI friendly messages are only supported by some APIs.
* The client must explicitly request UI friendly messages by passing the *X-egain-error-message=yes* header.

## Response 401 fields (application/json):

  - `code` (string, required)
    A string that follows the pattern *{integer}-{integer}*.
The first *{integer}* is the http status code.  This code as a whole is unique.
* For example, error codes "400-101" and "404-101" are distinctly different.

  - `developerMessage` (string, required)
    A summary of the error.

  - `details` (array)

  - `details.key` (string, required)

  - `details.value` (string)

  - `userMessage` (string)
    UI friendly messages are only supported by some APIs.
* The client must explicitly request UI friendly messages by passing the *X-egain-error-message=yes* header.

## Response 403 fields (application/json):

  - `code` (string, required)
    A string that follows the pattern *{integer}-{integer}*.
The first *{integer}* is the http status code.  This code as a whole is unique.
* For example, error codes "400-101" and "404-101" are distinctly different.

  - `developerMessage` (string, required)
    A summary of the error.

  - `details` (array)

  - `details.key` (string, required)

  - `details.value` (string)

  - `userMessage` (string)
    UI friendly messages are only supported by some APIs.
* The client must explicitly request UI friendly messages by passing the *X-egain-error-message=yes* header.

## Response 404 fields (application/json):

  - `code` (string, required)
    A string that follows the pattern *{integer}-{integer}*.
The first *{integer}* is the http status code.  This code as a whole is unique.
* For example, error codes "400-101" and "404-101" are distinctly different.

  - `developerMessage` (string, required)
    A summary of the error.

  - `details` (array)

  - `details.key` (string, required)

  - `details.value` (string)

  - `userMessage` (string)
    UI friendly messages are only supported by some APIs.
* The client must explicitly request UI friendly messages by passing the *X-egain-error-message=yes* header.

## Response 406 fields (application/json):

  - `code` (string, required)
    A string that follows the pattern *{integer}-{integer}*.
The first *{integer}* is the http status code.  This code as a whole is unique.
* For example, error codes "400-101" and "404-101" are distinctly different.

  - `developerMessage` (string, required)
    A summary of the error.

  - `details` (array)

  - `details.key` (string, required)

  - `details.value` (string)

  - `userMessage` (string)
    UI friendly messages are only supported by some APIs.
* The client must explicitly request UI friendly messages by passing the *X-egain-error-message=yes* header.

## Response 412 fields (application/json):

  - `code` (string, required)
    A string that follows the pattern *{integer}-{integer}*.
The first *{integer}* is the http status code.  This code as a whole is unique.
* For example, error codes "400-101" and "404-101" are distinctly different.

  - `developerMessage` (string, required)
    A summary of the error.

  - `details` (array)

  - `details.key` (string, required)

  - `details.value` (string)

  - `userMessage` (string)
    UI friendly messages are only supported by some APIs.
* The client must explicitly request UI friendly messages by passing the *X-egain-error-message=yes* header.

## Response 500 fields (application/json):

  - `code` (string, required)
    A string that follows the pattern *{integer}-{integer}*.
The first *{integer}* is the http status code.  This code as a whole is unique.
* For example, error codes "400-101" and "404-101" are distinctly different.

  - `developerMessage` (string, required)
    A summary of the error.

  - `details` (array)

  - `details.key` (string, required)

  - `details.value` (string)

  - `userMessage` (string)
    UI friendly messages are only supported by some APIs.
* The client must explicitly request UI friendly messages by passing the *X-egain-error-message=yes* header.