Configuring Content Synchronization
Step 1: Create Catalog Sync Job
- In the admin console, navigate to Catalog Sync / Content Export Configuration.
- Create a new job with the system name: MS-Copilot.
The system automatically sets the Action to API based Content Sync.
Step 2: Configure Job Parameters
Enter the following information:
- Job Name
- Frequency (scheduled interval)
- Start Date / Time
Reminder / Notes:
- Only one API sync job per system is permitted.
- Attempts to create multiple jobs for MS-Copilot will fail or be blocked.
Step 3: Catalog Selection Behavior
The Manage Catalog option is disabled for this system. The system automatically includes CAISY content only. No manual filtering or selection is allowed / required.
Step 4: Submit and Activate Job
- Save and submit the job.
- Set the job execution using either of the following options:
- Scheduled run – runs at the time you specify.
- Run Now – runs on demand.
Step 5: Validate Sync Completion
Once the job is executed successfully, CAISY content becomes available for consumption via the Skillsoft v2 catalog-content API.
API-based Content Retrieval
This section explains how to retrieve synchronized Skillsoft Caisy content using the v2 catalog-content API. It outlines the required endpoint, parameters, and authentication needed to access content generated by the MS-Copilot sync job, ensuring accurate and consistent data retrieval for downstream consumption within Microsoft Copilot experiences.
Endpoint
GET /content-discovery/v2/organizations/{orgId}/catalog-content
| Parameter | Description |
|---|---|
| offset | Pagination start index |
| max | Number of records to return |
| system | Must be MS-Copilot |
Critical Requirement
The parameter system=MS-Copilot ensures that the API retrieves content specifically from the Copilot sync job.
Sample Request
curl --location 'https://api.develop.squads-dev.com/content-discovery/v2/organizations/{orgId}/catalog-content?offset=0&max=1000&system=MS-Copilot' \
--header 'accept: application/json' \
--header 'Authorization: Bearer <ACCESS_TOKEN>'
Response Behavior
- Returns all CAISY content available in the organization.
- Response header includes x-total-count (total number of available content items)