Portal

Get All Portals

GET
/knowledge/portalmgr/v4/portals

Overview

The Get All Portals API returns all portals in a partition or department.

Authorization

accessToken
AuthorizationBearer <token>

JWT Bearer Token authentication for API access

In: header

Query Parameters

departmentID?string

The ID of the department.

Match^999$|^[1-9][0-9]{3,8}$
Length3 <= length <= 8
$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"
$pagenum?integer

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

Formatint64
Range1 <= value <= 999
Default1
$pagesize?integer

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

Formatint64
Range1 <= value <= 75
Default10

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" \  -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"
{  "portal": [    {      "id": "PZ-9999",      "name": "Master Portal",      "departmentId": "999",      "description": "Automatically created portal allowing access to all published articles",      "defaultContentLanguageId": "1",      "defaultContentLanguageCode": "en-US",      "createdBy": {        "id": "1004",        "firstName": "pa",        "middleName": "",        "lastName": "developer",        "userName": "pa_Developer"      },      "createdDate": "2022-03-09T00:22:14Z",      "modifiedBy": {        "id": "1004",        "firstName": "pa",        "middleName": "",        "lastName": "developer",        "userName": "pa_Developer"      },      "modifiedDate": "2023-10-18T16:13:53Z",      "isStructuredAuthoringEnabled": false,      "isManageDraftVisibilityEnabled": false,      "portalSettings": {        "isAnnoucementsEnabled": false,        "isAgentsSSOEnabled": false,        "isAgentsDelegatedAuthenticationEnabled": false,        "isPopularArticlesListEnabled": false,        "popularArticlesListInfluenceWeight": 10,        "popularArticlesListInfluencePeriod": 1,        "appendSessionJourneyToEmail": false,        "isArticleSuggestionsBeforeEscalationEnabled": false,        "isEscalationToEmailEnabled": false,        "numberOfSuggestedArticlesBeforeEscalation": 0,        "isGHInSearchResultsEnabled": false,        "webSearchDomain": "",        "intranetSearchURL": "",        "questionMatchingEngineURL": "",        "isCaptchaEnabled": false,        "captchaSiteKey": "",        "isArticleSharingEnabled": false,        "tagCategoriesForSearchFilter": {          "tagCategory": []        },        "maxWebSearchResults": 5,        "maxIntranetSearchResults": 5,        "isSearchAutocompleteEnabled": true,        "isWebSearchEnabled": false,        "isIntranetSearchEnabled": false,        "isCustomAttributesFilteringEnabled": true,        "isSpellcheckEnabled": true,        "searchLearningInclusionThreshold": 5,        "searchLearningInfluence": 0,        "searchLearningMaxInfluence": 300,        "searchLearningLevel": 0,        "searchRelatedTermsMinResultsThreshold": 10,        "searchRelatedTermWeight": 0.25,        "customAttributesForSearchFilter": [],        "isGHEnabled": false,        "isGHStartupQuestionsBeforeUnansweredQuestionsEnabled": true,        "isGHDetailsForSearchEnabled": false,        "isGHShortNameInSearchEnabled": false,        "GHFailureSuccessThreshold": 0,        "maxGHAnsweredQuestions": 10,        "maxGHUnansweredQuestions": 10,        "maxGHSearchResults": 0,        "isGHResultsShownOnSuccessfulSearch": false,        "isGHControlActionDiagnosticsEnabled": false,        "isGHClusterScopeDiagnosticsEnabled": false,        "isRelatedArticlesEnabled": true,        "isArticleFeedbackEnabled": true,        "isArticleFeedbackCommentsEnabled": false,        "isArticleFeedbackSummaryEnabled": false,        "isRelatedArticlesInSameTopicEnabled": true,        "isAuthenticationRequired": true,        "isArticleSuggestionsEnabled": true,        "isMySuggestionsEnabled": true,        "customerProfileAttributes": {          "attribute": [            {              "name": "firstName",              "mandatory": false,              "editable": true            },            {              "name": "lastName",              "mandatory": false,              "editable": true            },            {              "name": "emailAddress",              "mandatory": false,              "editable": true            }          ]        }      },      "kbLanguages": {        "kbLanguage": [          {            "name": "English (US)",            "code": "en-US"          }        ]      },      "link": {        "rel": "self",        "href": "/knowledge/portalmgr/v4/portals/PZ-9999?departmentId=999&%24lang=en-US"      }    }  ],  "paginationInfo": {    "count": 1,    "pagenum": 1,    "pagesize": 10  }}

Get Article List by ID GET

## Overview The Get Article Lists by ID API returns the details of a quick access Article list that is configured for a portal. Only those articles in the quick access list articles are returned and are: - Available for current user profile. - Tagged with at least one of the provided tags, if tags query parameter is provided. - Displayable. An Article is displayable if "Include in browse on portals" property is enable for the Article.

Get All Portals Accessible To User GET

## Overview The Get All Portals Accessible to User API allows a user to fetch all portals accessible to user across all department. * If no access tags are specified for a portal, then any user can access the portal. * If access tags are specified for a portal, users with a user profile that allows access have access to the portal. For users with multiple user profiles, the user profile that allows access does not need to be the active user profile. * All the global users(partition) cannot be assigned user profiles; their access is limited to portals without access restrictions. * The only articles returned are associated to an Article type when the parameter, “Include in browse on portals” is set to "Yes". * When the "shortUrlTemplate" query parameter is provided, the API filters accessible portals according to the specified language and template name. Portal Short URL specific to to the "shortUrlTemplate" query parameter value is returned in the response. * When there is no short URL available for a specific language, the API returns a portal object with an empty "shortURL" field.