Sign in

v1

latestOpenAPI 3.0.42026-07-2481154567.6 KB
Training Content

Get Batch Upload Status

🚧 Partner Restricted All LMS API endpoints are restricted to LMS providers that have signed a Paylocity technology partnership agreement. Please reach out to our team if you would like to discuss partnership opportunities.

Summary Description

Returns the status of a bulk upload operation, including overall progress, success/failure counts, and detailed status for each content item. Partners can call this endpoint at any time to monitor the progress of their bulk upload.

Use includeDetails=false (default) for lightweight polling and includeDetails=true when detailed per-item diagnostics are needed.

Use Cases

  • Partner wants to check the progress of a bulk upload operation.
  • Partner needs to identify which content items succeeded or failed.
  • Partner wants detailed error messages for failed items.

Status Values

  • Pending: Bulk upload request created, waiting for ZIP file upload
  • Downloading: ZIP file is being downloaded from File Access
  • Downloaded: ZIP file downloaded and extracted
  • Processing: Content items are being created in LMS
  • Uploading: Content files are being uploaded to LMS
  • Created: All content items created successfully (before upload)
  • PartialCreated: Some content items created, some failed (before upload)
  • CreationFailed: All content items failed to create
  • Completed: All content items successfully processed and uploaded
  • PartialSuccess: Some content items succeeded, some failed
  • Failed: All content items failed to process
get/apiHub/learningManagementSystem/v1/companies/{companyId}/batchedContent/{bulkUploadId}/status

Path parameters

companyIdstring required

The Paylocity Company Identifier. Unique value provided by Paylocity. Allowable Values: 9 char max.

bulkUploadIdstring required

Unique identifier for the bulk upload operation (GUID).

Query parameters

includeDetailsboolean

If true, includes detailed status for each content item. Default is false.

Headers

testModeboolean

If true, responses are mocked and generated randomly.

Response

OK - Returns the bulk upload status.

bulkUploadIdstring nullable

Unique identifier for the bulk upload operation.

companyIdstring nullable

The Paylocity Company Identifier.

status'Pending' | 'Downloading' | 'Downloaded' | 'Processing' | 'Uploading' | 'Created' | 'PartialCreated' | 'CreationFailed' | 'Completed' | 'PartialSuccess' | 'Failed'

Overall status of the bulk upload operation.

totalItemsinteger

Total number of content items in the bulk upload.

successfulItemsinteger

Number of content items successfully processed and created in LMS.

failedItemsinteger

Number of content items that failed during processing.

pendingItemsinteger

Number of content items still pending processing.

startedAtstring date-time nullable

ISO 8601 timestamp when the bulk upload processing started.

completedAtstring date-time nullable

ISO 8601 timestamp when the bulk upload processing completed (null if still processing).

Example response

{
  "bulkUploadId": "\"550e8400-e29b-41d4-a716-446655440000\"",
  "companyId": "\"b0001\"",
  "status": "Processing",
  "totalItems": 10,
  "successfulItems": 7,
  "failedItems": 1,
  "pendingItems": 2,
  "startedAt": "2024-01-15T10:00:00Z",
  "completedAt": "2024-01-15T10:05:00Z",
  "items": [
    {
      "title": "\"Introduction to Workplace Safety\"",
      "status": "Success",
      "contentId": "\"550e8400-e29b-41d4-a716-446655440001\"",
      "processedAt": "2024-01-15T10:02:30Z",
      "error": "\"File validation failed: Invalid file format\""
    }
  ],
  "errors": [
    {
      "itemIndex": 1,
      "title": "\"Cybersecurity Awareness\"",
      "error": "\"File validation failed: Invalid file format\"",
      "timestamp": "2024-01-15T10:02:45Z"
    }
  ]
}