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 |
curl -i -X GET \
'https://api.egain.cloud/knowledge/portalmgr/v4/articletypes?departmentID=999' \
-H 'Accept-Language: en-US' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'Success
Indicates whether structured authoring is enabled for this article type, requiring content to be created using predefined fields
The ID of the Article Type.
The URL of an image to be associated with the Article Type
Indicates whether articles of this type are displayed in portal browsing areas such as topics and lists
[ { "articleTypeId": "100100000000001", "typeName": "General", "description": "Knowledge", "imageURL": "https://hd.egain.com/images/km-for-dummies-24.jpg", "articleCategoryId": 0, "useStructuredAuthoring": true, "isSearchable": true, "isBrowsable": true }, { "articleTypeId": "100100000000002", "typeName": "General", "description": "FAQ", "articleCategoryId": 0, "useStructuredAuthoring": true, "isSearchable": true, "isBrowsable": true }, { "articleTypeId": "100100000000003", "typeName": "Suggestion", "description": "Suggestions", "articleCategoryId": 4, "useStructuredAuthoring": true, "isSearchable": true, "isBrowsable": true } ]
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.
The Language locale accepted by the client (used for locale specific fields in resource representation and in error responses).
An Article version's ID.
An Article edition's ID.
curl -i -X PUT \
https://api.egain.cloud/knowledge/portalmgr/v4/portals/PROD-1000/articles/PROD-2996/addtoreply \
-H 'Accept: application/json' \
-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 '{
"editionId": "PROD-13015",
"versionId": "PROD-12416",
"language": {
"code": "en-US"
}
}'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.
The Language locale accepted by the client (used for locale specific fields in resource representation and in error responses).
An Article version's ID.
An Article edition's ID.
curl -i -X PUT \
https://api.egain.cloud/knowledge/portalmgr/v4/portals/PROD-1000/articles/PROD-2996/addasreference \
-H 'Accept: application/json' \
-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 '{
"editionId": "PROD-13015",
"versionId": "PROD-12416",
"language": {
"code": "en-US"
}
}'