Skip to content

Knowledge Portal Manager APIs

License

The following licenses are required to use the Knowledge Access APIs:

  • If the user is an agent, then the Knowledge + AI license is required.
  • If the user is a customer, the Self-Service and Advanced Self-Service licenses must be available.

Tiers

TierTier NameNamed UsersDescription
Tier 1StarterUp to 10Designed for small-scale implementations or pilot environments
Tier 2GrowthUp to 1000Suitable for mid-scale deployments requiring moderate scalability
Tier 3EnterpriseGreater than 1000Supports large-scale environments with extended configuration options

API Resource Limits

The following Resources have predefined limits for specific access attributes for Starter, Growth and Enterprise use.

ResourceLimitsStarterGrowthEnterprise
Article ReferenceNumber of attachments used in any article255050
Number of custom attributes in an article102550
Number of publish views used in an article version202020
Topic ReferenceUser-defined topics in a department1000500050000
Depth of topics52020
Topics at any level50025002500
Number of custom attributes in a topic101010
Portal ReferenceTag categories in a portal151515
Topics to be included in a portal1005005000
Number of articles to display in announcements102525
Usage links and link groups setup for a portal51025
Download OpenAPI description
Languages
Servers
Production Server
https://api.egain.cloud/knowledge/portalmgr/v4

Article

Article APIs

Operations

Article Lists

Article List APIs

Operations

Bookmark

Bookmark APIs

Operations

Guided Help

Guided Help APIs

Operations

Get Available Casebases Releases

Request

Overview

The Get Available Casebases Releases API retrieves all Casebase Releases associated with a portal.

Security
oAuthUser(Required scopes:
https://api.egain.cloud/auth/kno...
)
or oAuthOnBehalfOfUser(Required scopes:
https://api.egain.cloud/auth/kno...
)
or oAuthCustomer(Required scopes:
https://api.egain.cloud/auth/kno...
)
or oAuthOnBehalfOfCustomer(Required scopes:
https://api.egain.cloud/auth/kno...
)
or oAuthAnonymousCustomer(Required scopes:
https://api.egain.cloud/auth/kno...
)
Path
portalIDstring[ 7 .. 20 ] characters^[a-zA-Z0-9]{2,4}-\d{4,15}$required

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
Query
$langstring

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"
    Example: $lang=en-US
    $pagenuminteger(int64)[ 1 .. 999 ]

    Pagination parameter that specifies the page number of results to be returned. Used in conjunction with $pagesize.

    Default 1
    $pagesizeinteger(int64)[ 1 .. 75 ]

    Pagination parameter that specifies the number of results per page. Used in conjunction with $pagenum.

    Default 10
    Headers
    x-egain-activity-idstring[ 4 .. 9 ] characters^[0-9]{4,9}$

    A unique numeric interaction identifier from eGain.

    Example: 59237
    x-ext-integration-idstring<= 40 characters^[\w\W]+$

    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.

    Examples:
    3155180e-0c13-43e9-9c38-e9045bcbf176
    00Dbn00000IxGnx
    x-ext-interaction-idstring<= 40 characters^[\w\W]+$

    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.

    Examples:
    3155180e-0c13-43e9-9c38-e9045bcbf176
    00Dbn00000IxGnx
    Accept-Languagestringrequired

    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"
    Example: en-US
    curl -i -X GET \
      'https://api.egain.cloud/knowledge/portalmgr/v4/portals/PROD-1000/gh/casebasereleases?%24lang=en-US&%24pagenum=1&%24pagesize=10' \
      -H 'Accept-Language: en-US' \
      -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
      -H 'x-egain-activity-id: 59237' \
      -H 'x-ext-integration-id: string' \
      -H 'x-ext-interaction-id: string'

    Responses

    Success

    Bodyapplication/json
    casebaseArray of objects(Casebase Release)

    Casebase releases

    paginationInfoobject(PaginationInfo)
    Response
    application/json
    { "casebase": [ {} ], "paginationInfo": { "count": 1, "pagenum": 1, "pagesize": 10 } }

    Get Details of a Casebase Release

    Request

    Overview

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

    Security
    oAuthUser(Required scopes:
    https://api.egain.cloud/auth/kno...
    )
    or oAuthOnBehalfOfUser(Required scopes:
    https://api.egain.cloud/auth/kno...
    )
    or oAuthCustomer(Required scopes:
    https://api.egain.cloud/auth/kno...
    )
    or oAuthOnBehalfOfCustomer(Required scopes:
    https://api.egain.cloud/auth/kno...
    )
    or oAuthAnonymousCustomer(Required scopes:
    https://api.egain.cloud/auth/kno...
    )
    Path
    portalIDstring[ 7 .. 20 ] characters^[a-zA-Z0-9]{2,4}-\d{4,15}$required

    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
    casebaseReleaseIDstring^[1-9]\d{14}$required

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

    Example: 202201000000002
    Query
    $langstring

    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"
    Example: $lang=en-US
    languagesboolean

    Display langages of Casebase Releases.

    Default true
    Headers
    Accept-Languagestringrequired

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

    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.

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

    A unique numeric interaction identifier from eGain.

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

    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.

    Examples:
    3155180e-0c13-43e9-9c38-e9045bcbf176
    00Dbn00000IxGnx
    curl -i -X GET \
      'https://api.egain.cloud/knowledge/portalmgr/v4/portals/PROD-1000/gh/casebasereleases/202201000000002?%24lang=en-US&languages=true' \
      -H 'Accept-Language: en-US' \
      -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
      -H 'x-egain-activity-id: 59237' \
      -H 'x-ext-integration-id: string' \
      -H 'x-ext-interaction-id: string'

    Responses

    Success

    Bodyapplication/json
    casebaseArray of objects(Casebase Release)

    Casebase releases

    paginationInfoobject(PaginationInfo)
    Response
    application/json
    { "casebase": [ {}, {} ] }

    Get Cluster Details of a Casebase Release

    Request

    Overview

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

    Security
    oAuthUser(Required scopes:
    https://api.egain.cloud/auth/kno...
    )
    or oAuthOnBehalfOfUser(Required scopes:
    https://api.egain.cloud/auth/kno...
    )
    or oAuthCustomer(Required scopes:
    https://api.egain.cloud/auth/kno...
    )
    or oAuthOnBehalfOfCustomer(Required scopes:
    https://api.egain.cloud/auth/kno...
    )
    or oAuthAnonymousCustomer(Required scopes:
    https://api.egain.cloud/auth/kno...
    )
    Path
    portalIDstring[ 7 .. 20 ] characters^[a-zA-Z0-9]{2,4}-\d{4,15}$required

    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
    casebaseReleaseIDstring^[1-9]\d{14}$required

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

    Example: 202201000000002
    Query
    $langstring

    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"
    Example: $lang=en-US
    $pagenuminteger(int64)[ 1 .. 999 ]

    Pagination parameter that specifies the page number of results to be returned. Used in conjunction with $pagesize.

    Default 1
    $pagesizeinteger(int64)[ 1 .. 75 ]

    Pagination parameter that specifies the number of results per page. Used in conjunction with $pagenum.

    Default 10
    Headers
    Accept-Languagestringrequired

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

    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.

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

    A unique numeric interaction identifier from eGain.

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

    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.

    Examples:
    3155180e-0c13-43e9-9c38-e9045bcbf176
    00Dbn00000IxGnx
    curl -i -X GET \
      'https://api.egain.cloud/knowledge/portalmgr/v4/portals/PROD-1000/gh/casebasereleases/202201000000002/clusters?%24lang=en-US&%24pagenum=1&%24pagesize=10' \
      -H 'Accept-Language: en-US' \
      -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
      -H 'x-egain-activity-id: 59237' \
      -H 'x-ext-integration-id: string' \
      -H 'x-ext-interaction-id: string'

    Responses

    Success

    Bodyapplication/json
    clusterArray of objects(ClusterResult)

    Clusters

    paginationInfoobject(PaginationInfo)
    Response
    application/json
    { "cluster": [ {}, {}, {}, {}, {}, {}, {}, {}, {}, {} ], "paginationInfo": { "count": 13, "pagenum": 1, "pagesize": 10, "link": [] } }

    Get All Profiles Available in Portal

    Request

    Overview

    The Get All Profiles Available in Portal API retrieves all Guided Help profiles associated with a portal.

    Security
    oAuthUser(Required scopes:
    https://api.egain.cloud/auth/kno...
    )
    or oAuthOnBehalfOfUser(Required scopes:
    https://api.egain.cloud/auth/kno...
    )
    or oAuthCustomer(Required scopes:
    https://api.egain.cloud/auth/kno...
    )
    or oAuthOnBehalfOfCustomer(Required scopes:
    https://api.egain.cloud/auth/kno...
    )
    or oAuthAnonymousCustomer(Required scopes:
    https://api.egain.cloud/auth/kno...
    )
    Path
    portalIDstring[ 7 .. 20 ] characters^[a-zA-Z0-9]{2,4}-\d{4,15}$required

    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
    Query
    filter[casebaseRelease]string^[1-9]\d{14}$

    Filter by Casebase Release

    Example: filter[casebaseRelease]=202201000000002
    $pagenuminteger(int64)[ 1 .. 999 ]

    Pagination parameter that specifies the page number of results to be returned. Used in conjunction with $pagesize.

    Default 1
    $pagesizeinteger(int64)[ 1 .. 75 ]

    Pagination parameter that specifies the number of results per page. Used in conjunction with $pagenum.

    Default 10
    Headers
    Accept-Languagestringrequired

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

    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.

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

    A unique numeric interaction identifier from eGain.

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

    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.

    Examples:
    3155180e-0c13-43e9-9c38-e9045bcbf176
    00Dbn00000IxGnx
    curl -i -X GET \
      'https://api.egain.cloud/knowledge/portalmgr/v4/portals/PROD-1000/gh/profiles?filter%5BcasebaseRelease%5D=202201000000002&%24pagenum=1&%24pagesize=10' \
      -H 'Accept-Language: en-US' \
      -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
      -H 'x-egain-activity-id: 59237' \
      -H 'x-ext-integration-id: string' \
      -H 'x-ext-interaction-id: string'

    Responses

    Success

    Bodyapplication/json
    profileArray of objects(Guided Help Profile)

    profiles

    paginationInfoobject(PaginationInfo)
    Response
    application/json
    { "profile": [ {} ], "paginationInfo": { "count": 1, "pagenum": 1, "pagesize": 10 } }

    Start a Guided Help Search

    Request

    Overview

    The Start a Guided Help search can be used to start a search session in the Guided Help.

    A Guided Help profile can also be specified while starting the session and it is used to filter the results of search. If this is not passed in the request, the default profile of the portal is used. Questions can also be answered at time of starting the search session.

    A Guided Help search session can be started in following ways:

    • Launch session for a specific Casebase Release.
    • Launch session for a Casebase and specify the release type.
    • Use a Guided Help session Article and pass the required session parameters.

    Prerequisites

    • A Guided Help profile must be assigned to the user.
    • Casebase Release passed in the request must be associated with the portal passed in URI.
    Security
    oAuthUser(Required scopes:
    https://api.egain.cloud/auth/kno...
    )
    or oAuthOnBehalfOfUser(Required scopes:
    https://api.egain.cloud/auth/kno...
    )
    or oAuthCustomer(Required scopes:
    https://api.egain.cloud/auth/kno...
    )
    or oAuthOnBehalfOfCustomer(Required scopes:
    https://api.egain.cloud/auth/kno...
    )
    or oAuthAnonymousCustomer(Required scopes:
    https://api.egain.cloud/auth/kno...
    )
    Path
    portalIDstring[ 7 .. 20 ] characters^[a-zA-Z0-9]{2,4}-\d{4,15}$required

    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
    Query
    $langstring

    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"
    Example: $lang=en-US
    ghCustomAdditionalAttributesstring[ 1 .. 4000 ] characters^question\.custom\.[^,]+(?:,question\.custom\...

    Custom attributes to be fetched.

    Possible values are:

    • question.custom.<name> where <name> is the internal name of custom attribute of question. 'question' is used as a prefix to distinguish question's custom attribute from other objects custom attributes.
    Examples:

    A user-defined custom attribute.

    ghCustomAdditionalAttributes=question.custom.score

    Multiple user-defined custom attributes.

    ghCustomAdditionalAttributes=question.custom.score,question.custom.test
    Headers
    x-egain-activity-idstring[ 4 .. 9 ] characters^[0-9]{4,9}$

    A unique numeric interaction identifier from eGain.

    Example: 59237
    x-ext-integration-idstring<= 40 characters^[\w\W]+$

    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.

    Examples:
    3155180e-0c13-43e9-9c38-e9045bcbf176
    00Dbn00000IxGnx
    x-ext-interaction-idstring<= 40 characters^[\w\W]+$

    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.

    Examples:
    3155180e-0c13-43e9-9c38-e9045bcbf176
    00Dbn00000IxGnx
    Accept-Languagestringrequired

    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"
    Example: en-US
    Content-Typestringrequired

    The media type sent by the client.

    Default application/json
    Value"application/json"
    Bodyapplication/jsonrequired
    casebaseIdstring(CasebaseId)= 15 characters^[1-9]\d*$required

    The numerical ID of the Casebase.

    Example: "409601000000001"
    questionsArray of objects(Question and Answers)[ 0 .. 500 ] items

    Pre-answered Questions in Guided Help search

    profileIdstring[ 1 .. 15 ] characters^1$|^[1-9]\d{9,15}$

    The ID of the guided help profile. 1 will always be the system profile.

    sessionVariableArray of objects(SessionContextVariable)

    Session variables used to give Guided Help additional context.

    startOverboolean

    Restart the current Guided Help search with the existing context along with session variable context.

    useLiveReleaseboolean

    Use current live release snapshot of the Casebase otherwise use the authoring release.

    ghsArticleIdstring= 15 characters^[1-9]\d*$

    Numeric ID of the guided help session article used for starting search.

    Example: "100000000001035"
    curl -i -X POST \
      'https://api.egain.cloud/knowledge/portalmgr/v4/portals/PROD-1000/gh/search?%24lang=en-US&ghCustomAdditionalAttributes=string' \
      -H 'Accept-Language: en-US' \
      -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
      -H 'Content-Type: application/json' \
      -H 'x-egain-activity-id: 59237' \
      -H 'x-ext-integration-id: string' \
      -H 'x-ext-interaction-id: string' \
      -d '{
        "casebaseId": "202201000000002"
      }'

    Responses

    Success

    Bodyapplication/json
    casebaseobject(Casebase Release)
    actionSearchArray of objects(Action Search)

    actions in the search

    answeredQuestionArray of objects(Question)

    questions answered in the search

    caseSearchArray of objects(Case Search)

    cases in the search

    dynamicSearchArray of objects(Dynamic Search)

    dynamic cases in the search

    unansweredQuestionArray of objects(Question)

    unanswered questions in the search

    startupQuestionArray of objects(Question)

    startup questions in the search

    targetClustersArray of objects(Cluster id)

    active clusters in the search

    Response
    application/json
    { "casebase": { "name": "Financial Vertical Bot", "status": "author", "casebaseId": "202201000000002", "profiles": [], "id": "202201000000002", "searchSettings": {} }, "actionSearch": [], "answeredQuestion": [], "caseSearch": [], "dynamicSearch": [], "unansweredQuestion": [ {}, {} ], "startupQuestion": [ {}, {} ], "targetClusters": [ {} ] }

    Perform a Step in a Guided Help Search

    Request

    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.
    Security
    oAuthUser(Required scopes:
    https://api.egain.cloud/auth/kno...
    )
    or oAuthOnBehalfOfUser(Required scopes:
    https://api.egain.cloud/auth/kno...
    )
    or oAuthCustomer(Required scopes:
    https://api.egain.cloud/auth/kno...
    )
    or oAuthOnBehalfOfCustomer(Required scopes:
    https://api.egain.cloud/auth/kno...
    )
    or oAuthAnonymousCustomer(Required scopes:
    https://api.egain.cloud/auth/kno...
    )
    Path
    portalIDstring[ 7 .. 20 ] characters^[a-zA-Z0-9]{2,4}-\d{4,15}$required

    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
    Query
    $langstring

    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"
    Example: $lang=en-US
    ghCustomAdditionalAttributesstring[ 1 .. 4000 ] characters^question\.custom\.[^,]+(?:,question\.custom\...

    Custom attributes to be fetched.

    Possible values are:

    • question.custom.<name> where <name> is the internal name of custom attribute of question. 'question' is used as a prefix to distinguish question's custom attribute from other objects custom attributes.
    Examples:

    A user-defined custom attribute.

    ghCustomAdditionalAttributes=question.custom.score

    Multiple user-defined custom attributes.

    ghCustomAdditionalAttributes=question.custom.score,question.custom.test
    Headers
    x-egain-activity-idstring[ 4 .. 9 ] characters^[0-9]{4,9}$

    A unique numeric interaction identifier from eGain.

    Example: 59237
    x-ext-integration-idstring<= 40 characters^[\w\W]+$

    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.

    Examples:
    3155180e-0c13-43e9-9c38-e9045bcbf176
    00Dbn00000IxGnx
    x-ext-interaction-idstring<= 40 characters^[\w\W]+$

    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.

    Examples:
    3155180e-0c13-43e9-9c38-e9045bcbf176
    00Dbn00000IxGnx
    Content-Typestringrequired

    The media type sent by the client.

    Default application/json
    Value"application/json"
    Accept-Languagestringrequired

    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"
    Example: en-US
    Bodyapplication/jsonrequired
    casebaseIdstring(CasebaseId)= 15 characters^[1-9]\d*$required

    The numerical ID of the Casebase.

    Example: "409601000000001"
    questionsArray of objects(Question and Answers)[ 1 .. 500 ] itemsrequired

    Pre-answered Questions in Guided Help search

    questions[].​idstring[ 6 .. 20 ] characters^[0-9]+$required

    ID of question

    Example: "1000003852"
    questions[].​answersArray of objects(Answer)[ 1 .. 100 ] items

    Answers of question

    profileIdstring(ProfileId)[ 1 .. 15 ] characters^1$|^[1-9]\d{9,15}$

    The ID of the guided help profile.
    1 will always be the system profile.

    sessionVariableArray of objects(SessionContextVariable)

    Session variables used to give Guided Help additional context.

    startOverboolean

    Restart the current Guided Help search with the existing context along with session variable context.

    useLiveReleaseboolean

    Use current live release snapshot of the Casebase otherwise use the authoring release.

    ghsArticleIdstring= 15 characters^[1-9]\d*$

    Numeric ID of the guided help session article used for starting search.

    Example: "100000000001035"
    curl -i -X PUT \
      'https://api.egain.cloud/knowledge/portalmgr/v4/portals/PROD-1000/gh/search?%24lang=en-US&ghCustomAdditionalAttributes=string' \
      -H 'Accept-Language: en-US' \
      -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
      -H 'Content-Type: application/json' \
      -H 'x-egain-activity-id: 59237' \
      -H 'x-ext-integration-id: string' \
      -H 'x-ext-interaction-id: string' \
      -d '{
        "casebaseId": "202201000000002",
        "questions": [
          {
            "id": "1000000322",
            "answers": [
              {
                "id": "1000000303"
              }
            ]
          },
          {
            "id": "1000000327",
            "answers": [
              {
                "id": "1000000842"
              }
            ]
          },
          {
            "id": "1000001006",
            "answers": [
              {
                "id": "1000001001"
              }
            ]
          }
        ],
        "useLiveRelease": true
      }'

    Responses

    Success

    Bodyapplication/json
    casebaseobject(Casebase Release)
    actionSearchArray of objects(Action Search)

    actions in the search

    answeredQuestionArray of objects(Question)

    questions answered in the search

    caseSearchArray of objects(Case Search)

    cases in the search

    dynamicSearchArray of objects(Dynamic Search)

    dynamic cases in the search

    unansweredQuestionArray of objects(Question)

    unanswered questions in the search

    startupQuestionArray of objects(Question)

    startup questions in the search

    targetClustersArray of objects(Cluster id)

    active clusters in the search

    Response
    application/json
    { "casebase": { "name": "Financial Vertical Bot", "status": "author", "casebaseId": "202201000000002", "profiles": [], "id": "202201000000002", "searchSettings": {} }, "actionSearch": [ {}, {}, {} ], "answeredQuestion": [ {}, {}, {} ], "caseSearch": [ {} ], "dynamicSearch": [], "unansweredQuestion": [], "startupQuestion": [], "targetClusters": [ {}, {}, {} ] }

    Get All Cases of a Cluster in Release

    Request

    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.

    Security
    oAuthUser(Required scopes:
    https://api.egain.cloud/auth/kno...
    )
    or oAuthOnBehalfOfUser(Required scopes:
    https://api.egain.cloud/auth/kno...
    )
    or oAuthCustomer(Required scopes:
    https://api.egain.cloud/auth/kno...
    )
    or oAuthOnBehalfOfCustomer(Required scopes:
    https://api.egain.cloud/auth/kno...
    )
    or oAuthAnonymousCustomer(Required scopes:
    https://api.egain.cloud/auth/kno...
    )
    Path
    portalIDstring[ 7 .. 20 ] characters^[a-zA-Z0-9]{2,4}-\d{4,15}$required

    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
    casebaseReleaseIDstring^[1-9]\d{14}$required

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

    Example: 202201000000002
    clusterIDstring= 10 characters^[1-9]\d*$required

    ID of Cluster.

    Example: 1000000402
    Query
    $langstring

    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"
    Example: $lang=en-US
    $pagenuminteger(int64)[ 1 .. 999 ]

    Pagination parameter that specifies the page number of results to be returned. Used in conjunction with $pagesize.

    Default 1
    $pagesizeinteger(int64)[ 1 .. 75 ]

    Pagination parameter that specifies the number of results per page. Used in conjunction with $pagenum.

    Default 10
    Headers
    Accept-Languagestringrequired

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

    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.

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

    A unique numeric interaction identifier from eGain.

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

    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.

    Examples:
    3155180e-0c13-43e9-9c38-e9045bcbf176
    00Dbn00000IxGnx
    curl -i -X GET \
      'https://api.egain.cloud/knowledge/portalmgr/v4/portals/PROD-1000/gh/casebasereleases/202201000000002/clusters/1000000402/cases?%24lang=en-US&%24pagenum=1&%24pagesize=10' \
      -H 'Accept-Language: en-US' \
      -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
      -H 'x-egain-activity-id: 59237' \
      -H 'x-ext-integration-id: string' \
      -H 'x-ext-interaction-id: string'

    Responses

    Success

    Bodyapplication/json
    caseArray of objects(Case)

    Cases

    paginationInfoobject(PaginationInfo)
    Response
    application/json
    { "case": [ {}, {}, {} ], "paginationInfo": { "count": 3, "pagenum": 1, "pagesize": 10 } }

    Get Details of a Case

    Request

    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.
    Security
    oAuthUser(Required scopes:
    https://api.egain.cloud/auth/kno...
    )
    or oAuthOnBehalfOfUser(Required scopes:
    https://api.egain.cloud/auth/kno...
    )
    or oAuthCustomer(Required scopes:
    https://api.egain.cloud/auth/kno...
    )
    or oAuthOnBehalfOfCustomer(Required scopes:
    https://api.egain.cloud/auth/kno...
    )
    or oAuthAnonymousCustomer(Required scopes:
    https://api.egain.cloud/auth/kno...
    )
    Path
    portalIDstring[ 7 .. 20 ] characters^[a-zA-Z0-9]{2,4}-\d{4,15}$required

    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
    casebaseReleaseIDstring^[1-9]\d{14}$required

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

    Example: 202201000000002
    caseIDstring[ 10 .. 15 ] characters^[1-9]\d*$required

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

    Example: 1000001085
    Query
    $langstring

    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"
    Example: $lang=en-US
    caseAdditionalAttributesArray of strings

    Additional case attributes to be fetched.

    Items Enum"questionDetail""actions""all"
    Examples:

    An additional attributes to be returned.

    caseAdditionalAttributes=actions

    Additional attributes to be returned.

    caseAdditionalAttributes=questionDetail,actions

    All additional attributes to be returned.

    caseAdditionalAttributes=all
    Headers
    x-egain-activity-idstring[ 4 .. 9 ] characters^[0-9]{4,9}$

    A unique numeric interaction identifier from eGain.

    Example: 59237
    x-ext-integration-idstring<= 40 characters^[\w\W]+$

    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.

    Examples:
    3155180e-0c13-43e9-9c38-e9045bcbf176
    00Dbn00000IxGnx
    x-ext-interaction-idstring<= 40 characters^[\w\W]+$

    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.

    Examples:
    3155180e-0c13-43e9-9c38-e9045bcbf176
    00Dbn00000IxGnx
    Accept-Languagestringrequired

    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"
    Example: en-US
    curl -i -X GET \
      'https://api.egain.cloud/knowledge/portalmgr/v4/portals/PROD-1000/gh/casebasereleases/202201000000002/cases/1000001085?%24lang=en-US&caseAdditionalAttributes=all' \
      -H 'Accept-Language: en-US' \
      -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
      -H 'x-egain-activity-id: 59237' \
      -H 'x-ext-integration-id: string' \
      -H 'x-ext-interaction-id: string'

    Responses

    Success

    Bodyapplication/json
    idstring[ 10 .. 15 ] characters^[1-9]\d*$

    The numerical ID of the case.

    Example: "100000000001035"
    shortNamestring[ 1 .. 255 ] characters^[\w\W]+$

    short name of the case.

    titlestring[ 1 .. 255 ] characters^[\w\W]+$

    title of the case

    commentsstring[ 0 .. 255 ] characters^[\w\W]*$

    comments on the case

    profileIdstring(ProfileId)[ 1 .. 15 ] characters^1$|^[1-9]\d{9,15}$

    The ID of the guided help profile.
    1 will always be the system profile.

    releaseIdstring= 15 characters^[1-9]\d*$

    The numerical ID of the Casebase Release in which case in created

    Example: "100000000001035"
    clusterIdstring[ 10 .. 15 ] characters^[1-9]\d*$

    ID of the cluster in which case is created

    Example: "100000000001035"
    createdDatestring(DateAndTime)[ 20 .. 25 ] characters^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{3})...

    The date on which the Case was created.

    createdByobject(createdBy)
    modifiedByobject(modifiedBy)
    modifiedDatestring(DateAndTime)[ 20 .. 25 ] characters^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{3})...

    The date on which the Case was last modified.

    isVisibleboolean

    Flag indicating if the case is visible

    rejectCountinteger(int64)[ 0 .. 9999999999 ]

    number of times case was rejected.

    acceptCountinteger(int64)[ 0 .. 9999999999 ]

    number of times case was accepted.

    actionArray of objects(Action)

    actions in the case

    metadataArray of objects(Metadata)

    Metadata of the case

    thresholdValueinteger(int32)[ 0 .. 100 ]

    Threshold value of the case

    thresholdTypestring

    Threshold type indicating if thresholdValue is default or custom.

    Enum"Default""Custom"
    thresholdValueFromClusternumber(double)[ 0 .. 100 ]

    Threshold value of the cluster in which case is created

    caseTypestring

    Type of the case. Control or Content type

    Enum"Control""Content"
    questionDetailArray of objects(Question Detail)

    Questions in the case

    linkobject(Link)

    Defines the relationship between this resource and another object.

    Response
    application/json
    { "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": [ {} ], "link": { "rel": "self", "href": "/knowledge/portalmgr/v4/portals/PROD-1000/gh/casebasereleases/202201000000002/cases/1000001085?%24lang=en-US" }, "id": "1000001085" }

    Accept Solution

    Request

    Overview

    The Accept Solution API can be used to accept and add positive score to a solution of a Guided Help case.

    Prerequisites

    • A Guided Help search session must be started before invoking this API.
    Security
    oAuthUser(Required scopes:
    https://api.egain.cloud/auth/kno...
    )
    or oAuthOnBehalfOfUser(Required scopes:
    https://api.egain.cloud/auth/kno...
    )
    or oAuthCustomer(Required scopes:
    https://api.egain.cloud/auth/kno...
    )
    or oAuthOnBehalfOfCustomer(Required scopes:
    https://api.egain.cloud/auth/kno...
    )
    or oAuthAnonymousCustomer(Required scopes:
    https://api.egain.cloud/auth/kno...
    )
    Path
    portalIDstring[ 7 .. 20 ] characters^[a-zA-Z0-9]{2,4}-\d{4,15}$required

    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
    caseIDstring[ 10 .. 15 ] characters^[1-9]\d*$required

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

    Example: 1000001085
    Headers
    x-egain-activity-idstring[ 4 .. 9 ] characters^[0-9]{4,9}$

    A unique numeric interaction identifier from eGain.

    Example: 59237
    x-ext-integration-idstring<= 40 characters^[\w\W]+$

    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.

    Examples:
    3155180e-0c13-43e9-9c38-e9045bcbf176
    00Dbn00000IxGnx
    x-ext-interaction-idstring<= 40 characters^[\w\W]+$

    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.

    Examples:
    3155180e-0c13-43e9-9c38-e9045bcbf176
    00Dbn00000IxGnx
    Accept-Languagestringrequired

    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"
    Example: en-US
    Bodyapplication/jsonrequired
    idstring(CasebaseReleaseId)= 15 characters^[1-9]\d*$required

    The numerical ID of the Casebase Release.

    Example: "409601000000001"
    namestring[ 1 .. 255 ] characters^[\w\W]+$required

    name of the case or article

    profileIdstring(ProfileId)[ 1 .. 15 ] characters^1$|^[1-9]\d{9,15}$required

    The ID of the guided help profile.
    1 will always be the system profile.

    curl -i -X POST \
      https://api.egain.cloud/knowledge/portalmgr/v4/portals/PROD-1000/gh/cases/1000001085/accept \
      -H 'Accept-Language: en-US' \
      -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
      -H 'Content-Type: application/json' \
      -H 'x-egain-activity-id: 59237' \
      -H 'x-ext-integration-id: string' \
      -H 'x-ext-interaction-id: string' \
      -d '{
        "id": "120000001201010",
        "name": "HPE Solution Article",
        "profileId": "120450120000001"
      }'

    Responses

    Rating accepted

    Response
    No content

    Reject Solution

    Request

    Overview

    The Reject Solution API can be used to reject and add negative score to a solution of a Guided Help case.

    Prerequisites

    • A Guided Help search session must be started before invoking this API.
    Security
    oAuthUser(Required scopes:
    https://api.egain.cloud/auth/kno...
    )
    or oAuthOnBehalfOfUser(Required scopes:
    https://api.egain.cloud/auth/kno...
    )
    or oAuthCustomer(Required scopes:
    https://api.egain.cloud/auth/kno...
    )
    or oAuthOnBehalfOfCustomer(Required scopes:
    https://api.egain.cloud/auth/kno...
    )
    or oAuthAnonymousCustomer(Required scopes:
    https://api.egain.cloud/auth/kno...
    )
    Path
    portalIDstring[ 7 .. 20 ] characters^[a-zA-Z0-9]{2,4}-\d{4,15}$required

    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
    caseIDstring[ 10 .. 15 ] characters^[1-9]\d*$required

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

    Example: 1000001085
    Headers
    x-egain-activity-idstring[ 4 .. 9 ] characters^[0-9]{4,9}$

    A unique numeric interaction identifier from eGain.

    Example: 59237
    x-ext-integration-idstring<= 40 characters^[\w\W]+$

    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.

    Examples:
    3155180e-0c13-43e9-9c38-e9045bcbf176
    00Dbn00000IxGnx
    x-ext-interaction-idstring<= 40 characters^[\w\W]+$

    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.

    Examples:
    3155180e-0c13-43e9-9c38-e9045bcbf176
    00Dbn00000IxGnx
    Accept-Languagestringrequired

    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"
    Example: en-US
    Bodyapplication/jsonrequired
    idstring(CasebaseReleaseId)= 15 characters^[1-9]\d*$required

    The numerical ID of the Casebase Release.

    Example: "409601000000001"
    namestring[ 1 .. 255 ] characters^[\w\W]+$required

    name of the case or article

    profileIdstring(ProfileId)[ 1 .. 15 ] characters^1$|^[1-9]\d{9,15}$required

    The ID of the guided help profile.
    1 will always be the system profile.

    curl -i -X POST \
      https://api.egain.cloud/knowledge/portalmgr/v4/portals/PROD-1000/gh/cases/1000001085/reject \
      -H 'Accept-Language: en-US' \
      -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
      -H 'Content-Type: application/json' \
      -H 'x-egain-activity-id: 59237' \
      -H 'x-ext-integration-id: string' \
      -H 'x-ext-interaction-id: string' \
      -d '{
        "id": "123101210000102",
        "name": "HPE Solution Article",
        "profileId": "100101210000002"
      }'

    Responses

    Rating accepted

    Response
    No content

    Create Quickpick

    Request

    Overview

    The Create Quickpick API can be used to create a new quickpick(bookmark) for current Guided Help search session.

    Note: If "linkToActivity" attribute is passed as true in request body then one of below must be passed in header

    • XEgainTenantId
    • xEgainActivityId
    • XInteractionId

    Prerequisites

    • A Guided Help search session must be in progress before this API is invoked.
    • QuickPick can only be created for a live release of a Casebase.
    Security
    oAuthUser(Required scopes:
    https://api.egain.cloud/auth/kno...
    )
    or oAuthOnBehalfOfUser(Required scopes:
    https://api.egain.cloud/auth/kno...
    )
    or oAuthCustomer(Required scopes:
    https://api.egain.cloud/auth/kno...
    )
    or oAuthOnBehalfOfCustomer(Required scopes:
    https://api.egain.cloud/auth/kno...
    )
    Path
    portalIDstring[ 7 .. 20 ] characters^[a-zA-Z0-9]{2,4}-\d{4,15}$required

    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
    Query
    $langstring

    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"
    Example: $lang=en-US
    Headers
    Accept-Languagestringrequired

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

    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.

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

    A unique numeric interaction identifier from eGain.

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

    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.

    Examples:
    3155180e-0c13-43e9-9c38-e9045bcbf176
    00Dbn00000IxGnx
    Bodyapplication/jsonrequired
    namestring[ 1 .. 255 ] characters^[\w\W]+$

    name of the quick pick

    commentstring[ 1 .. 255 ] characters^[\w\W]+$

    comment about quick pick

    casebaseReleaseIdstring= 15 characters^[1-9]\d*$required

    The numerical ID of Live release of the Casebase.

    Example: "409601000000001"
    linkToActivityboolean

    indicates if quickpick is to be linked with activity

    curl -i -X POST \
      'https://api.egain.cloud/knowledge/portalmgr/v4/portals/PROD-1000/gh/quickpicks?%24lang=en-US' \
      -H 'Accept-Language: en-US' \
      -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
      -H 'Content-Type: application/json' \
      -H 'x-egain-activity-id: 59237' \
      -H 'x-ext-integration-id: string' \
      -H 'x-ext-interaction-id: string' \
      -d '{
        "casebaseReleaseId": "102312010000000",
        "name": "QuickPick82700245",
        "comment": "demo quickpick",
        "linkToActivity": false
      }'

    Responses

    Quickpick Created Successfully.

    Response
    No content

    Get All Quickpicks for a Portal

    Request

    Overview

    The Get All Quickpicks for a Portal API retrieves details of quickpicks created for the Casebase.

    Conditions

    If "getLastSavedQuickPickForInteraction" query parameter is passed as "Yes" then one of below must be passed in request header.

    • X-ext-integration-id
    • X-egain-activity-id
    • X-ext-interaction-id Either casebaseID or getLastSavedQuickPickForInteraction must be passed in request.
    Security
    oAuthUser(Required scopes:
    https://api.egain.cloud/auth/kno...
    )
    or oAuthOnBehalfOfUser(Required scopes:
    https://api.egain.cloud/auth/kno...
    )
    or oAuthCustomer(Required scopes:
    https://api.egain.cloud/auth/kno...
    )
    or oAuthOnBehalfOfCustomer(Required scopes:
    https://api.egain.cloud/auth/kno...
    )
    Path
    portalIDstring[ 7 .. 20 ] characters^[a-zA-Z0-9]{2,4}-\d{4,15}$required

    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
    Query
    casebaseReleaseIDstring^[1-9]\d{14}$required

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

    Example: casebaseReleaseID=202201000000002
    $langstring

    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"
    Example: $lang=en-US
    $pagenuminteger(int64)[ 1 .. 999 ]

    Pagination parameter that specifies the page number of results to be returned. Used in conjunction with $pagesize.

    Default 1
    $pagesizeinteger(int64)[ 1 .. 75 ]

    Pagination parameter that specifies the number of results per page. Used in conjunction with $pagenum.

    Default 10
    getLastSavedQuickPickForInteractionboolean

    To be passed retrieve quickpick associated with interaction.

    Headers
    Accept-Languagestringrequired

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

    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.

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

    A unique numeric interaction identifier from eGain.

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

    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.

    Examples:
    3155180e-0c13-43e9-9c38-e9045bcbf176
    00Dbn00000IxGnx
    curl -i -X GET \
      'https://api.egain.cloud/knowledge/portalmgr/v4/portals/PROD-1000/gh/quickpicks?casebaseReleaseID=202201000000002&%24lang=en-US&%24pagenum=1&%24pagesize=10&getLastSavedQuickPickForInteraction=true' \
      -H 'Accept-Language: en-US' \
      -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
      -H 'x-egain-activity-id: 59237' \
      -H 'x-ext-integration-id: string' \
      -H 'x-ext-interaction-id: string'

    Responses

    Success

    Bodyapplication/json
    quickpickArray of objects(Quickpick)

    quick picks

    paginationInfoobject(PaginationInfo)
    Response
    application/json
    { "quickpick": [ {} ], "paginationInfo": { "count": 1, "pagenum": 1, "pagesize": 10 } }

    Resume a Quickpick

    Request

    Overview

    The Resume a Quickpick API can be used to restore (resume) a specific quickpick.

    Prerequisites

    • A Guided Help session for the Casebase must be started before invoking this API.
    Security
    oAuthUser(Required scopes:
    https://api.egain.cloud/auth/kno...
    )
    or oAuthOnBehalfOfUser(Required scopes:
    https://api.egain.cloud/auth/kno...
    )
    or oAuthCustomer(Required scopes:
    https://api.egain.cloud/auth/kno...
    )
    or oAuthOnBehalfOfCustomer(Required scopes:
    https://api.egain.cloud/auth/kno...
    )
    Path
    portalIDstring[ 7 .. 20 ] characters^[a-zA-Z0-9]{2,4}-\d{4,15}$required

    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
    quickpickIDstring[ 1 .. 19 ] characters^[1-9]\d*$required

    The ID of the quickpick.

    Example: 11
    Query
    $langstring

    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"
    Example: $lang=en-US
    ghCustomAdditionalAttributesstring[ 1 .. 4000 ] characters^question\.custom\.[^,]+(?:,question\.custom\...

    Custom attributes to be fetched.

    Possible values are:

    • question.custom.<name> where <name> is the internal name of custom attribute of question. 'question' is used as a prefix to distinguish question's custom attribute from other objects custom attributes.
    Examples:

    A user-defined custom attribute.

    ghCustomAdditionalAttributes=question.custom.score

    Multiple user-defined custom attributes.

    ghCustomAdditionalAttributes=question.custom.score,question.custom.test
    Headers
    x-egain-activity-idstring[ 4 .. 9 ] characters^[0-9]{4,9}$

    A unique numeric interaction identifier from eGain.

    Example: 59237
    x-ext-integration-idstring<= 40 characters^[\w\W]+$

    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.

    Examples:
    3155180e-0c13-43e9-9c38-e9045bcbf176
    00Dbn00000IxGnx
    x-ext-interaction-idstring<= 40 characters^[\w\W]+$

    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.

    Examples:
    3155180e-0c13-43e9-9c38-e9045bcbf176
    00Dbn00000IxGnx
    Accept-Languagestringrequired

    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"
    Example: en-US
    curl -i -X POST \
      'https://api.egain.cloud/knowledge/portalmgr/v4/portals/PROD-1000/gh/quickpicks/11?%24lang=en-US&ghCustomAdditionalAttributes=string' \
      -H 'Accept-Language: en-US' \
      -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
      -H 'x-egain-activity-id: 59237' \
      -H 'x-ext-integration-id: string' \
      -H 'x-ext-interaction-id: string'

    Responses

    Success

    Bodyapplication/json
    casebaseobject(Casebase Release)
    actionSearchArray of objects(Action Search)

    actions in the search

    answeredQuestionArray of objects(Question)

    questions answered in the search

    caseSearchArray of objects(Case Search)

    cases in the search

    dynamicSearchArray of objects(Dynamic Search)

    dynamic cases in the search

    unansweredQuestionArray of objects(Question)

    unanswered questions in the search

    startupQuestionArray of objects(Question)

    startup questions in the search

    targetClustersArray of objects(Cluster id)

    active clusters in the search

    Response
    application/json
    { "casebase": { "name": "Financial Vertical Bot", "id": "202201000000002", "status": "live", "casebaseId": "202201000000002", "profiles": [] }, "actionSearch": [ {}, {} ], "answeredQuestion": [ {} ], "caseSearch": [ {}, {} ], "dynamicSearch": [], "unansweredQuestion": [ {} ], "startupQuestion": [], "targetClusters": [ {}, {} ] }

    Portal

    Portal API

    Operations

    Suggestion

    Suggestion APIs

    Operations

    Topic

    Topic APIs

    Operations

    User Details

    User Details APIs

    Operations

    User Milestones

    User Milestones APIs

    Operations

    User Profile

    UserProfile APIs

    Operations

    Federated Search Event

    Federated Search Event API

    Operations

    Connectors Search Events

    Connectors Search Event APIs

    Operations

    Attachment

    Attachment Upload API

    Operations

    Export

    Content Export APIs

    Operations