Creates a job for bulk ingesting documents into the repository.
Base Request
PUT /api/import
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 |
| Content-Type | The format of the data to be posted | Optional | application/json |
Request Body
See Bulk Import for request body details. The request body follows the same structure as the response body, only the request body does not require several of the response body's elements.
Sample Request
PUT /api/import
Authorization: Bearer [access_token]
User-Agent: MyCompanyProduct/1.0
Accept: application/vnd.hxcs.v1+json
Content-Type: application/json
{
"name": "string",
"description": "string",
"creator": "string",
"queue": "string",
"unique_key": "string"
}
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 | Creates a job for bulk ingesting documents into the repository. |
| 400 | Bad Request | The server could not process the request due to invalid details for the bulk import job . |
| 401 | Not Authorized | Authentication has failed or was not provided. |
| 403 | Not Allowed | Access permissions are invalid or missing. |