API docs by Redocly

Data Export Spring Job Deletion Intervals (v1)

getAllJobDeletionIntervals

Get all job deletion intervals

Responses

Response samples

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

createJobDeletionInterval

Create a new job deletion interval

Request Body schema: application/json
required
exportType
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"
retentionDays
required
integer >= 1

Number of days to retain jobs of this type

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)

Responses

Request samples

Content type
application/json
{
  • "exportType": "CIRCULATION_LOG",
  • "retentionDays": 1,
  • "metadata": {
    }
}

Response samples

Content type
application/json
{
  • "exportType": "CIRCULATION_LOG",
  • "retentionDays": 1,
  • "metadata": {
    }
}

getJobDeletionIntervalByExportType

Get job deletion interval by export type

path Parameters
exportType
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"

Export type of the interval

Responses

Response samples

Content type
application/json
{
  • "exportType": "CIRCULATION_LOG",
  • "retentionDays": 1,
  • "metadata": {
    }
}

updateJobDeletionInterval

Update an existing job deletion interval

path Parameters
exportType
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"

Export type of the interval

Request Body schema: application/json
required
exportType
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"
retentionDays
required
integer >= 1

Number of days to retain jobs of this type

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)

Responses

Request samples

Content type
application/json
{
  • "exportType": "CIRCULATION_LOG",
  • "retentionDays": 1,
  • "metadata": {
    }
}

Response samples

Content type
application/json
{
  • "exportType": "CIRCULATION_LOG",
  • "retentionDays": 1,
  • "metadata": {
    }
}

deleteJobDeletionInterval

Delete a job deletion interval by export type

path Parameters
exportType
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"

Export type of the interval

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ],
  • "total_error_records": 0,
  • "total_warning_records": 0
}