The following licenses are required to use the Knowledge Access APIs:
| Tier | Tier Name | Named Users | Description |
|---|---|---|---|
| Tier 1 | Starter | Up to 10 | Designed for small-scale implementations or pilot environments |
| Tier 2 | Growth | Up to 1000 | Suitable for mid-scale deployments requiring moderate scalability |
| Tier 3 | Enterprise | Greater than 1000 | Supports large-scale environments with extended configuration options |
The following Resources have predefined limits for specific access attributes for Starter, Growth and Enterprise use.
| Resource | Limits | Starter | Growth | Enterprise |
|---|---|---|---|---|
| Article Reference | Number of attachments used in any article | 25 | 50 | 50 |
| Number of custom attributes in an article | 10 | 25 | 50 | |
| Number of publish views used in an article version | 20 | 20 | 20 | |
| Topic Reference | User-defined topics in a department | 1000 | 5000 | 50000 |
| Depth of topics | 5 | 20 | 20 | |
| Topics at any level | 500 | 2500 | 2500 | |
| Number of custom attributes in a topic | 10 | 10 | 10 | |
| Portal Reference | Tag categories in a portal | 15 | 15 | 15 |
| Topics to be included in a portal | 100 | 500 | 5000 | |
| Number of articles to display in announcements | 10 | 25 | 25 | |
| Usage links and link groups setup for a portal | 5 | 10 | 25 |
A unique numeric interaction identifier from eGain.
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.
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.
The media type sent by the client.
The ID of the article or topic associated with this bookmark. A case ID or an article ID is composed of a 2-4 letter prefix, followed by a dash and 15 digits.
This attribute must be provided if resourceType is set to "1 - Article" or "2 - Topic".
The ID of the user associated with the bookmark.
Determines the type of resource:
The name of the resource associated with the bookmark.
This attribute is only available for article and topic bookmarks.
curl -i -X POST \
https://api.egain.cloud/knowledge/portalmgr/v4/portals/PROD-1000/bookmarks \
-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 '{
"resourceId": "PROD-9274782",
"resourceType": 2,
"bookmarkName": "DemoBookmark"
}'The Get All Bookmarks for a Portal API returns all bookmarks for a portal. Only the topic bookmarks that are available in the scope of the portal are returned.
A unique numeric interaction identifier from eGain.
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.
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.
curl -i -X GET \
https://api.egain.cloud/knowledge/portalmgr/v4/portals/PROD-1000/bookmarks \
-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'{ "bookmark": [ { … } ], "paginationInfo": { "count": 1, "pagenum": 1, "pagesize": 10 } }
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.
A unique numeric interaction identifier from eGain.
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.
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.
curl -i -X DELETE \
https://api.egain.cloud/knowledge/portalmgr/v4/portals/PROD-1000/bookmarks/4759 \
-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'