API docs by Redocly

Data Export Spring Jobs (v1)

getJobs

Get jobs fy filter

query Parameters
offset
integer [ 0 .. 2147483647 ]
Default: 0

Skip over a number of elements by specifying an offset value for the query

limit
integer [ 0 .. 2147483647 ]
Default: 10

Limit the number of elements returned in the response

query
string

A query string to filter rules based on matching criteria in fields.

Responses

Response samples

Content type
application/json
{
  • "jobRecords": [
    ],
  • "totalRecords": 0
}

upsertJob

Create or update a job

header Parameters
X-Okapi-Tenant
required
string
Request Body schema: application/json
required
id
string <uuid>

Job ID

name
string <= 100 characters

Job name

description
string

Job description

source
string <= 50 characters

Job source

isSystemSource
boolean

Was the job created by system

tenant
string

Tenant id

type
required
string (ExportType)
Default: "BURSAR_FEES_FINES"
Enum: "CIRCULATION_LOG" "BURSAR_FEES_FINES" "BATCH_VOUCHER_EXPORT" "EDIFACT_ORDERS_EXPORT" "CLAIMS" "ORDERS_EXPORT" "INVOICE_EXPORT" "BULK_EDIT_IDENTIFIERS" "BULK_EDIT_QUERY" "BULK_EDIT_UPDATE" "E_HOLDINGS" "AUTH_HEADINGS_UPDATES" "FAILED_LINKED_BIB_UPDATES"
required
object (ExportTypeSpecificParameters)
object (bursarExportJob)

Bursar export job schema

object (VendorEdiOrdersExportConfig)
query
string <= 5000 characters

CQL query to be passed to the module which data is being exported. Use it to filter data.

object (EHoldingsExportConfig)
object (AuthorityControlExportConfig)
status
string (JobStatus)
Enum: "SCHEDULED" "IN_PROGRESS" "SUCCESSFUL" "FAILED"
files
Array of strings

Export files URLs

fileNames
Array of strings

Exported files

startTime
string <date-time>

Job start timestamp

endTime
string <date-time>

Job end timestamp

object (Metadata Schema)
createdDate
string <date-time>

Date and time when the record was created

createdByUserId
string <uuid>

ID of the user who created the record (when available)

createdByUsername
string <= 50 characters

Username of the user who created the record (when available)

updatedDate
string <date-time>

Date and time when the record was last updated

updatedByUserId
string <uuid>

ID of the user who last updated the record (when available)

updatedByUsername
string <= 50 characters

Username of the user who last updated the record (when available)

outputFormat
string

Job output format

errorDetails
string

Job error details

identifierType
string (IdentifierType)
Enum: "ID" "BARCODE" "HRID" "FORMER_IDS" "ACCESSION_NUMBER" "HOLDINGS_RECORD_ID" "USER_NAME" "EXTERNAL_SYSTEM_ID" "INSTANCE_HRID" "ITEM_BARCODE" "ISBN" "ISSN"
entityType
string (EntityType)
Enum: "USER" "ITEM" "HOLDINGS_RECORD" "INSTANCE"
object (Progress)
total
integer >= 0
Default: 0

Total number of records being processed

processed
integer >= 0
Default: 0

Current number of records already processed

progress
integer [ 0 .. 100 ]
Default: 0

Current progress in %

success
integer [ 0 .. 0 ]
Default: 0

Current number of success processed records

errors
integer [ 0 .. 0 ]
Default: 0

Current number of errors

warnings
integer [ 0 .. 0 ]
Default: 0

Current number of warnings

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "source": "string",
  • "isSystemSource": true,
  • "tenant": "string",
  • "type": "CIRCULATION_LOG",
  • "exportTypeSpecificParameters": {
    },
  • "status": "SCHEDULED",
  • "files": [
    ],
  • "fileNames": [
    ],
  • "startTime": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z",
  • "metadata": {
    },
  • "outputFormat": "string",
  • "errorDetails": "string",
  • "identifierType": "ID",
  • "entityType": "USER",
  • "progress": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "source": "string",
  • "isSystemSource": true,
  • "tenant": "string",
  • "type": "CIRCULATION_LOG",
  • "exportTypeSpecificParameters": {
    },
  • "status": "SCHEDULED",
  • "files": [
    ],
  • "fileNames": [
    ],
  • "startTime": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z",
  • "metadata": {
    },
  • "outputFormat": "string",
  • "errorDetails": "string",
  • "identifierType": "ID",
  • "entityType": "USER",
  • "progress": {
    }
}

getJobById

Get a job by the job ID

path Parameters
id
required
string <uuid> (UUID)

UUID of the job

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "source": "string",
  • "isSystemSource": true,
  • "tenant": "string",
  • "type": "CIRCULATION_LOG",
  • "exportTypeSpecificParameters": {
    },
  • "status": "SCHEDULED",
  • "files": [
    ],
  • "fileNames": [
    ],
  • "startTime": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z",
  • "metadata": {
    },
  • "outputFormat": "string",
  • "errorDetails": "string",
  • "identifierType": "ID",
  • "entityType": "USER",
  • "progress": {
    }
}

resendExportedFile

resend exported file by the job ID

path Parameters
id
required
string <uuid> (UUID)

UUID of the job

Responses

Response samples

Content type
application/json
{
  • "value": {
    }
}

downloadExportedFileByJobId

Download exported file by the job ID

path Parameters
id
required
string <uuid> (UUID)

UUID of the job

query Parameters
key
string

Key of the file in storage to be downloaded

Responses

sendJob

Send job via Kafka

Request Body schema: application/json
required
id
string <uuid>

Job ID

name
string <= 100 characters

Job name

description
string

Job description

source
string <= 50 characters

Job source

isSystemSource
boolean

Was the job created by system

tenant
string

Tenant id

type
required
string (ExportType)
Default: "BURSAR_FEES_FINES"
Enum: "CIRCULATION_LOG" "BURSAR_FEES_FINES" "BATCH_VOUCHER_EXPORT" "EDIFACT_ORDERS_EXPORT" "CLAIMS" "ORDERS_EXPORT" "INVOICE_EXPORT" "BULK_EDIT_IDENTIFIERS" "BULK_EDIT_QUERY" "BULK_EDIT_UPDATE" "E_HOLDINGS" "AUTH_HEADINGS_UPDATES" "FAILED_LINKED_BIB_UPDATES"
required
object (ExportTypeSpecificParameters)
object (bursarExportJob)

Bursar export job schema

object (VendorEdiOrdersExportConfig)
query
string <= 5000 characters

CQL query to be passed to the module which data is being exported. Use it to filter data.

object (EHoldingsExportConfig)
object (AuthorityControlExportConfig)
status
string (JobStatus)
Enum: "SCHEDULED" "IN_PROGRESS" "SUCCESSFUL" "FAILED"
files
Array of strings

Export files URLs

fileNames
Array of strings

Exported files

startTime
string <date-time>

Job start timestamp

endTime
string <date-time>

Job end timestamp

object (Metadata Schema)
createdDate
string <date-time>

Date and time when the record was created

createdByUserId
string <uuid>

ID of the user who created the record (when available)

createdByUsername
string <= 50 characters

Username of the user who created the record (when available)

updatedDate
string <date-time>

Date and time when the record was last updated

updatedByUserId
string <uuid>

ID of the user who last updated the record (when available)

updatedByUsername
string <= 50 characters

Username of the user who last updated the record (when available)

outputFormat
string

Job output format

errorDetails
string

Job error details

identifierType
string (IdentifierType)
Enum: "ID" "BARCODE" "HRID" "FORMER_IDS" "ACCESSION_NUMBER" "HOLDINGS_RECORD_ID" "USER_NAME" "EXTERNAL_SYSTEM_ID" "INSTANCE_HRID" "ITEM_BARCODE" "ISBN" "ISSN"
entityType
string (EntityType)
Enum: "USER" "ITEM" "HOLDINGS_RECORD" "INSTANCE"
object (Progress)
total
integer >= 0
Default: 0

Total number of records being processed

processed
integer >= 0
Default: 0

Current number of records already processed

progress
integer [ 0 .. 100 ]
Default: 0

Current progress in %

success
integer [ 0 .. 0 ]
Default: 0

Current number of success processed records

errors
integer [ 0 .. 0 ]
Default: 0

Current number of errors

warnings
integer [ 0 .. 0 ]
Default: 0

Current number of warnings

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "source": "string",
  • "isSystemSource": true,
  • "tenant": "string",
  • "type": "CIRCULATION_LOG",
  • "exportTypeSpecificParameters": {
    },
  • "status": "SCHEDULED",
  • "files": [
    ],
  • "fileNames": [
    ],
  • "startTime": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z",
  • "metadata": {
    },
  • "outputFormat": "string",
  • "errorDetails": "string",
  • "identifierType": "ID",
  • "entityType": "USER",
  • "progress": {
    }
}

Response samples

Content type
application/json
{
  • "value": {
    }
}