Export Knowledge
Overview
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.
Permission
- Only a client application can invoke this API.
License
- This API requires a site license (SKU: EG-CL-RTKA-PT).
Authorization
accessToken JWT Bearer Token authentication for API access
In: header
Header Parameters
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"
Request Body
application/json
Category of articles to return. If all is selected, it includes both browsable and searchable articles.
"searchable"Value in
- "searchable"
- "all"
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-zA-Z0-9]{2,4}-\d{4,15}$7 <= length <= 20The 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.
falseTypes 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 Resource Type Attributes
| 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 Resource Type Attributes
| 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. |
Article Resource Type Attributes
Export article's attributes returned are aligned with the response of the Get Article By ID with Editions API.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/knowledge/portalmgr/v4/content/export" \ -H "Accept-Language: en-US" \ -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 } } }'Generate Signed URL to Upload API POST
## Overview The Generate Signed URL to Upload API produces a signature that is used to upload an attachment.
Get Export Job Status GET
## Overview The Content Export Status API provides real-time status information to monitor job progress and check completion status. ## Status Values - **Pending**: Job is pending start of processing - **In Progress**: Job is actively processing content - **Completed**: Job finished successfully - **Failed**: Job encountered errors and could not complete ## Response Information - **Current Status**: Real-time job status - **Progress Metrics**: Items processed, total items - **Error Details**: Specific errors encountered during processing - **Timing Information**: Start time, estimated completion, actual completion ## Permission * Only a client application can invoke this API. ## License * This API requires a site license (SKU: EG-CL-RTKA-PT).

