Create Import Job

Import Content

Overview

This API initiates a bulk content import operation from Data Sources. It creates an asynchronous import job that processes content in the background, allowing you to import large volumes of content without blocking your application.

Pre-requisties

  1. Content in Data Source needs to be in this format: Guide to Data Import Format

How It Works

  1. Job Creation: The API creates an import job and returns a unique job ID
  2. Content Processing: Content is processed asynchronously in the background
  3. Status Monitoring: Use the job ID to monitor progress via the Status API
  4. Completion: Job completes when all content is processed or errors occur

Note: After a successful import, please allow for a brief delay before the content is fully available for use. The system's search service synchronizes all new and updated content every 30 minutes.

Supported Operations

  • Import: Add new content to the knowledge base
  • Update: Modify existing content

Data Source Types

  • AWS S3 bucket
  • Shared file path

Best Practices

  • Scheduling: Use scheduleTime for off-peak imports to minimize system impact
  • Monitoring: Regularly check job status and logs for any issues
  • Error Handling: Review failed items and retry with corrections

Permissions

Actor Permission
User
  • User must be a department user.
  • Content can only be imported in user's home department.
  • User must have 'Author' role.
  • Content can only be imported if the user has all the required languages assigned.
SecurityoAuthUser
Request
Request Body schema: application/json
required
object
operation
required
string
Enum: "import" "reimport"
object
Responses
202

Import Job Accepted

The import job has been successfully created and queued for processing. The job will begin execution according to the specified schedule or immediately if no schedule is provided.

Next Steps:

  1. Use the returned job ID to monitor progress via the Status API
  2. Check job logs for any validation warnings or errors
  3. Monitor job completion and review results

Expected Processing Time:

  • Small jobs (< 1,000 items): 5-15 minutes
  • Medium jobs (1,000-10,000 items): 15-60 minutes
  • Large jobs (> 10,000 items): 1-4 hours (depending on content complexity)
400

Bad Request

401

Unauthorized

403

Forbidden

406

Not acceptable

412

Preconditions failed

500

Internal server error

post/import/content
Request samples
application/json

Import content from an S3 bucket with scheduled execution

{
  • "dataSource": {
    },
  • "operation": "import",
  • "scheduleTime": {
    }
}
Response samples
application/json
{
  • "code": "400-10424",
  • "developerMessage": "Limit exceeded. The allowed limit for '{0}' is '{1}'."
}