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 |
The Content Export API initiates a bulk export of the Knowledge Hub to a client-provided Amazon S3 bucket or SFTP server path. It returns a URL with a Job ID to enable tracking the status of this asynchronous operation.
Each export job can send multiple JSON files, depending on the total number of items to process. More than one bulk export can take place, as needed, one per portal.
Category of articles to return. If all is selected, it includes both browsable and searchable articles.
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.
The Knowledge Base language in which the content is created.
Determines which article version to export. If true, the latest unpublished version will be exported for each article where available, and articles that do not have an unpublished version will be omitted from the export. If this property is false or omitted, the latest published version will be exported for each article where available. Each request exports either all published or all unpublished article versions in a portal; never both.
Types of Knowledge Hub resources to export. Use 'all' to specify all resource types at once.
Below are the attributes that are returned for each resource type specified.
| Portal Attribute Name | Description |
|---|---|
| id | The ID of the Portal in Readable format. |
| alternateId | The system-generated ID of the Portal in long format. |
| name | The name of the Portal. |
| description | The Portal's description. |
| departmentId | ID of the department this Portal belongs to. |
| defaultContentLanguageId | The default ID of the language for the portal content. |
| Topic Attribute Name | Description |
|---|---|
| id | The ID of the Topic in Readable form. |
| alternateId | The system-generated ID of the Topic in long form. |
| name | The name of the Topic. |
| departmentId | ID of the department this Topic belongs to. |
| modifiedDate | The date when the Topic was last modified on. |
| topicHomeArticleId | The ID of the Article used as the home page of this Topic. |
| childCount | Total number of children sub-topis below the current Topic. |
| subTopicIds | Array with the list of sub-topics (all levels of the topic hierarchy). |
| parentTopicId | ID of the parent Topic. -1 if it is the root Topic. |
| imageURL | URL of the inline Topic image. |
| customAttributes | One or more comma-separated names for Topic custom attributes defined by the user to be returned. |
Export article's attributes returned are aligned with the response of the Get Article By ID with Editions API.
Type of data destination
Path of the data destination. For S3 bucket, it can be root or a folder. For SFTP, it can be target directory on the server.
Examples:
"s3://amzn-s3-demo-bucket/mydeptfolder""exports/mydeptfolder"curl -i -X POST \
https://api.egain.cloud/knowledge/portalmgr/v4/content/export \
-H 'Accept-Language: en-US' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"articleCategories": "searchable",
"portalID": "PROD-1000",
"language": {
"code": "en-US"
},
"resourceTypes": [
"articles"
],
"dataDestination": {
"destinationType": "SFTP server",
"path": "exports/mydeptfolder",
"sftpDetails": {
"username": "rtka-user",
"password": "xyz1234",
"host": "sftp.yourcompany.com",
"port": 22
}
}
}'No contentThe Content Export Status API provides real-time status information to monitor job progress and check completion status.
curl -i -X GET \
https://api.egain.cloud/knowledge/portalmgr/v4/content/export/7A84B875-6F75-4C7B-B137-0632B62DB0BD/status \
-H 'Accept-Language: en-US' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'The current status and progress information for the specified export job.
Response Details:
The estimated timestamp when the job is expected to finish.
The timestamp when the job completed.
{ "status": "Pending" }