Sign in

v1

latestOpenAPI 3.0.02026-08-064311,0881.3 MB
archiveManagement

Create an ingestion job.

Create an ingestion job to pull data from your S3 bucket.

post/v1/archive/{sourceId}/jobs

Path parameters

sourceIdstring required
Example:000000000606C009

The identifier of the Archive Source for which the job is to be added.

Request body

namestring required

The name of the ingestion job.

startTimestring date-time required

The starting timestamp of the ingestion job.

endTimestring date-time required

The ending timestamp of the ingestion job.

Example request

{
  "startTime": "2018-10-16T09:10:00Z",
  "endTime": "2018-10-16T10:10:00Z"
}

Response

The ingestion job was created successfully.

namestring required

The name of the ingestion job.

startTimestring date-time required

The starting timestamp of the ingestion job.

endTimestring date-time required

The ending timestamp of the ingestion job.

idstring required

The unique identifier of the ingestion job.

totalObjectsScannedinteger required

The total number of objects scanned by the ingestion job.

totalObjectsIngestedinteger required

The total number of objects ingested by the ingestion job.

totalBytesIngestedinteger required

The total bytes ingested by the ingestion job.

statusstring required

The status of the ingestion job, either Pending,Scanning,Ingesting,Failed, or Succeeded.

createdAtstring date-time required

The creation timestamp in UTC of the ingestion job.

createdBystring required

The identifier of the user who created the ingestion job.

Example response

{
  "startTime": "2018-10-16T09:10:00Z",
  "endTime": "2018-10-16T10:10:00Z",
  "id": "4e214571-cf27-4114-93e6-69a98c017f3",
  "totalObjectsScanned": 25,
  "totalObjectsIngested": 10,
  "totalBytesIngested": 100,
  "status": "Scanning",
  "createdAt": "2018-10-16T09:10:00Z",
  "createdBy": "0000000006743FDD"
}