Get Details of a Casebase Release

Overview

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

SecurityoAuthUser or oAuthOnBehalfOfUser or oAuthCustomer or oAuthOnBehalfOfCustomer or oAuthAnonymousCustomer
Request
path Parameters
portalID
required
string [ 7 .. 20 ] characters ^[a-zA-Z0-9]{2,4}-\d{4,15}$

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.

Example: PROD-1000
casebaseReleaseID
required
string^[1-9]\d{14}$

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

Example: 202201000000002
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.

    • Enum: "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" "sr-RS" "xx-XX"
    Example: $lang=en-US
    languages
    boolean
    Default: true

    Display langages of Casebase Releases.

    header Parameters
    Accept-Language
    required
    string

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

    Enum: "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"
    Example: en-US
    x-ext-integration-id
    string <= 40 characters ^[\w\W]+$

    The unique numeric identifier for a tenant, used in self-service functionality as well as third-party integrations.

    Note: If x-egain-activity-id is not provided, then this must be passed along with x-ext-interaction-id.

    Examples:
    3155180e-0c13-43e9-9c38-e9045bcbf176
    00Dbn00000IxGnx
    x-egain-activity-id
    string [ 4 .. 9 ] characters ^[0-9]{4,9}$

    A unique numeric interaction identifier from eGain.

    Example: 59237
    x-ext-interaction-id
    string <= 40 characters ^[\w\W]+$

    A unique interaction identifier from other CRM applications.

    Note: If x-egain-activity-id is not provided, then this must be passed along with x-ext-integration-id.

    Examples:
    3155180e-0c13-43e9-9c38-e9045bcbf176
    00Dbn00000IxGnx
    Responses
    200

    Success

    204

    No Content

    400

    Bad Request

    401

    Unauthorized

    403

    Forbidden

    404

    Not Found

    406

    Not acceptable

    500

    Internal server error

    get/portals/{portalID}/gh/casebasereleases/{casebaseReleaseID}
    Request samples
    Response samples
    application/json
    {
    • "casebase": [
      ]
    }