Content Import

Cancel Job

POST
/knowledge/contentmgr/v4/import/content/{job_id}/cancel

Cancel Import or Validation Job

Overview

This API allows users to cancel import or validation operations that are currently in progress or scheduled for future execution. Cancellation is immediate for scheduled jobs and graceful for running jobs.

Cancellation Behavior

  • Scheduled Jobs: Immediate cancellation, no processing occurs
  • In Progress Jobs: Graceful shutdown, current item completes, no new items start
  • Completed Jobs: Cannot be cancelled (returns error)
  • Failed Jobs: Cannot be cancelled (already stopped)

When to Cancel

  • Content Issues: Discover problems with source content
  • Timing Changes: Need to reschedule for different time
  • Resource Constraints: System resources are needed elsewhere
  • User Request: Manual cancellation by authorized users
  • System Maintenance: Planned maintenance windows

Cancellation Process

  1. Request Received: System receives cancellation request
  2. Status Check: Verifies current job status
  3. Graceful Shutdown: For running jobs, completes current item
  4. Resource Cleanup: Releases allocated system resources
  5. Status Update: Marks job as cancelled
  6. Notification: Updates job status and logs

Post-Cancellation

  • Job Status: Changes to "Cancelled"
  • Partial Results: Any completed items remain in system
  • Logs: Cancellation reason and timing recorded
  • Resources: System resources freed for other operations

Best Practices

  • Monitor Jobs: Regularly check job status to identify candidates for cancellation
  • Plan Cancellations: Schedule cancellations during low-usage periods
  • Resource Planning: Consider resource impact before cancelling large jobs

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

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

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

Get Article by ID GET

## Overview * The Get Article by ID API allows a user or client application to retrieve an Article using its ID. * It requires a Portal ID, which a user or client application can retrieve through the Administrative Console or by calling Get All Portals API. * Additional Article attributes and contextual views can be specified in the query parameters. * This API returns structured authoring attributes of Issue, Environment, Cause and Confidence Level when the following conditions are met: * The "Allow Structured Authoring" setting is enabled at the partition/department level through the Administrative Console. * The "Use Structured Authoring" flag is set on the article type. ## Prerequisites * Agents without a user profile and customers in a portal without a default user profile only have access to articles that: * Do not contain any access tags. * Do not contain any publish views. * Contain publish views without any associated tags. * Agents with a user profile and customers in a portal with a default user profile have access to articles that: * Do not contain any access tags. * Do not contain any publish views. * Contain publish views without any associated tags. * Contain access tags that are also in the assigned user profiles. * Contain publish views with associated tags that are also in the assigned user profiles. * Agents with the following assigned actions can view updates to articles currently being processed in workflows: * View Author Portal – Allows agents to view updates to articles at any stage in a workflow. * View Staging Portal – Allows agents to view updates to articles in the Staging stage or a subsequent stage in a workflow.