Return All Bulk Import Jobs and Statuses - Content REST API - Current - Current - Ready - Hyland Experience - external

Hyland Experience Content REST API

Platform
Hyland Experience
Product
Content REST API
Release
Current
License

Returns a list of all bulk import jobs and their current statuses.

Base Request

GET /api/import/jobs

Query Parameters

Parameter Description Type Required Notes
limit The number of jobs to return. integer Optional Default is 10.

Headers

Header Name Description Required Values
Authorization The access token Required Bearer [access_token]

where [access_token] is a string generated when you complete authentication (see Getting Started)

User-Agent Identity of the client making the request to the server Required [product]/[version]

where [product] is the name of the software you are using to make the request and [version] is the numbered version of the software (for example, MyCompanyProduct/1.0).

For information on other types of values commonly included in user-agent request headers, see the User-Agent HTTP header reference section on the Mozilla developer documentation website.

Accept The format of the data to be returned Optional application/vnd.hxcs.v1+json

Sample Request

GET /api/import/jobs?limit=8

Authorization: Bearer [access_token]
User-Agent: MyCompanyProduct/1.0
Accept: application/vnd.hxcs.v1+json

Response

See Bulk Import for response body details and a sample response.

Status Codes and Errors

The following table lists the returned status codes.

Code Description Notes
200 OK Returns all bulk import jobs and their statuses.
401 Not Authorized Authentication has failed or was not provided.
403 Not Allowed Access permissions are invalid or missing.