Portal

Get All Portals Accessible To User

GET
/knowledge/portalmgr/v4/myportals

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.

Authorization

accessToken
AuthorizationBearer <token>

JWT Bearer Token authentication for API access

In: header

Query Parameters

$lang*string

The language used for fetching the details of a resource. Resources available in different languages may differ from each other.

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"
department?string

The Name of the department for which portals are to be fetched

Match^[\w\W]+$
Lengthlength <= 255
filterText?string

Portal name starting with a specific character are considered to filter the result.

Match^[\w\W]+$
Lengthlength <= 255
shortUrlTemplate?string

The Name of the template used while creating Short URL.

Match^[\w\W]+$
Lengthlength <= 255
$sort?string

Objects returned in server response are sorted based on the attribute supplied under $sort. Default value: name.

Value in

  • "id"
  • "name"
  • "departmentName"
$order?string

Common query parameter $order.Default value: asc

Value in

  • "asc"
  • "desc"
$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.Valid range of 5-75Default value: 25

Formatint64
Range1 <= value <= 75
Default25

Header Parameters

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/myportals?%24lang=en-US" \  -H "Accept-Language: en-US"

By default, shortURL only contains single object

{  "portal": [    {      "name": "Master Portal",      "description": "Automatically created portal allowing access to all published articles",      "department": {        "name": "Service",        "id": "999"      },      "shortURL": [        {          "id": "PROD-1000",          "templateName": "silver",          "shortURLName": "9BAED8",          "isDefault": true        }      ],      "link": {        "rel": "self",        "href": "/knowledge/portalmgr/v4/portals/PZ-9999?filterText=master&department=service&shortUrlTemplate=silver&%24lang=en-US"      },      "id": "PZ-9999"    }  ],  "paginationInfo": {    "count": 1,    "pagenum": 1,    "pagesize": 25  }}