Create Validation Job

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

Permissions

Actor Permission
User
  • User must be a department user.
  • 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
Responses
202

Validation Job Accepted

The content validation job has been successfully created and queued for processing. The system will analyze your content structure, format, and compliance without making any changes to your existing data.

Validation Process:

  1. Content Analysis: System examines 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 with issues and recommendations

Expected Processing Time:

  • Small content sets (< 1,000 items): 2-10 minutes
  • Medium content sets (1,000-10,000 items): 10-30 minutes
  • Large content sets (> 10,000 items): 30-90 minutes

Next Steps:

  1. Use the returned job ID to monitor validation progress
  2. Review validation results and address any issues
  3. Proceed with import only after validation passes
400

Bad Request

401

Unauthorized

403

Forbidden

406

Not acceptable

412

Preconditions failed

500

Internal server error

post/import/content/validate
Request samples
application/json

Validate content from an S3 bucket before import

{
  • "dataSource": {
    }
}
Response samples
application/json
{
  • "code": "400-101",
  • "developerMessage": "Unsupported query parameter(s) supplied: '<query_parameter>'."
}