Content Import

Get Job Status

GET
/knowledge/contentmgr/v4/import/content/{job_id}/status

Get Import Job Status

Overview

This API provides real-time status information for content import and validation operations. Use this endpoint to monitor job progress, check completion status, and access detailed logs and error information.

Status Values

  • Scheduled: Job is queued and waiting for scheduled execution time
  • In Progress: Job is actively processing content
  • Completed: Job finished successfully
  • Failed: Job encountered errors and could not complete
  • Cancelled: Job was manually cancelled by user

Response Information

  • Current Status: Real-time job status
  • Progress Metrics: Items processed, total items, completion percentage
  • Log Files: Location of detailed operation logs
  • Error Details: Specific errors encountered during processing
  • Timing Information: Start time, estimated completion, actual completion

Log File Access

Log files contain detailed information about:

  • Content processing steps
  • Validation results
  • Error details with context

Authorization

accessToken
AuthorizationBearer <token>

JWT Bearer Token authentication for API access

In: header

Path Parameters

job_id*string

Job ID Parameter

The unique identifier for the import or validation job. This ID was returned when the job was created via the Import or Validate API.

Format: UUID v4 (e.g., 7A84B875-6F75-4C7B-B137-0632B62DB0BD)

Example Usage:

GET /import/content/7A84B875-6F75-4C7B-B137-0632B62DB0BD/status
Match^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/knowledge/contentmgr/v4/import/content/7A84B875-6F75-4C7B-B137-0632B62DB0BD/status"

Shows an import job that is currently processing content

{  "status": "In Progress",  "jobType": "Import",  "progress": {    "processed": 1250,    "total": 5000,    "percentage": 25  },  "logFileLocation": "s3://mybucket/logs/import-logs-7A84B875-6F75-4C7B-B137-0632B62DB0BD.txt",  "startTime": "2024-03-01T10:00:00.000Z",  "scheduledStopTime": "2024-03-01T14:00:00.000Z",  "estimatedCompletion": "2024-03-01T11:30:00.000Z",  "currentOperation": "Processing content items"}

Get validation hook version details GET

Get details and content URL for a specific version of a hook.

Create Validation Job POST

# Validate Import Content ## Overview This API enables users to validate content structure, format, and compliance before importing it into the production knowledge base. Validation is a non-destructive operation that checks content without making any changes to your existing data. ## What Validation Checks - **Content Structure**: Verifies required fields and data types - **Format Compliance**: Ensures content meets platform requirements - **Language Support**: Validates content against supported languages - **Metadata Mapping**: Checks field mappings and transformations - **Business Rules**: Validates against department-specific rules ## Validation Benefits - **Risk Mitigation**: Identify issues before affecting production data - **Quality Assurance**: Ensure content meets organizational standards - **Cost Savings**: Avoid failed imports that waste processing time - **Compliance**: Meet regulatory and internal content requirements ## Validation Process 1. **Content Analysis**: System analyzes content structure and format 2. **Rule Validation**: Applies business rules and validation logic 3. **Quality Assessment**: Evaluates content quality and completeness 4. **Report Generation**: Creates detailed validation report 5. **Issue Categorization**: Classifies issues by severity and type ## Common Validation Issues - **Missing Required Fields**: Title, description, category, etc. - **Invalid Data Types**: Incorrect field formats (dates, numbers, etc.) - **Language Mismatches**: Content language not supported by department ## Best Practices - **Always Validate First**: Run validation before any import operation - **Review Reports**: Carefully examine validation results and warnings - **Fix Issues**: Address validation errors before proceeding with import - **Test Small Batches**: Validate with small content samples first - **Iterate**: Use validation feedback to improve content quality