Data Export Spring Configurations (v1)

getExportConfigs

Get a list of data export configurations

query Parameters

query	string A query string to filter rules based on matching criteria in fields.
limit	integer Default: 10 Limit the number of elements returned in the response

Responses

Response samples

Content type

application/json

{"configs": [{"id": "string",
"type": "CIRCULATION_LOG",
"tenant": "string",
"exportTypeSpecificParameters": {"bursarFeeFines": {"filter": {"type": "Age",
"numDays": 1,
"condition": "LESS_THAN_EQUAL"
},
"groupByPatron": true,
"groupByPatronFilter": {"type": "Aggregate",
"property": "NUM_ROWS",
"amount": 0,
"condition": "LESS_THAN_EQUAL"
},
"header": [{"type": "Aggregate",
"value": "NUM_ROWS",
"decimal": true,
"lengthControl": {"character": "s",
"length": 0,
"direction": "FRONT",
"truncate": true
}
}
],
"data": [{"type": "Aggregate",
"value": "NUM_ROWS",
"decimal": true,
"lengthControl": {"character": "s",
"length": 0,
"direction": "FRONT",
"truncate": true
}
}
],
"footer": [{"type": "Aggregate",
"value": "NUM_ROWS",
"decimal": true,
"lengthControl": {"character": "s",
"length": 0,
"direction": "FRONT",
"truncate": true
}
}
],
"transferInfo": {"conditions": [{"condition": {"type": "Age",
"numDays": 1,
"condition": "LESS_THAN_EQUAL"
},
"account": "f5b54a51-a98c-44cf-bb68-a676332e7d12"
}
],
"else": {"account": "f5b54a51-a98c-44cf-bb68-a676332e7d12"
}
}
},
"vendorEdiOrdersExportConfig": {"exportConfigId": "435cb3a4-03b6-4647-9934-9c99bc385ae1",
"vendorId": "e9b57fab-1850-44d4-8499-71fd15c845a0",
"configName": "string",
"configDescription": "string",
"ediConfig": {"accountNoList": ["string"
],
"defaultAcquisitionMethods": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"ediNamingConvention": "string",
"libEdiCode": "string",
"libEdiType": "014/EAN",
"vendorEdiCode": "string",
"vendorEdiType": "014/EAN",
"notes": "string",
"sendAccountNumber": false,
"supportOrder": false,
"supportInvoice": false
},
"ediFtp": {"ftpConnMode": "Active",
"ftpFormat": "SFTP",
"ftpMode": "ASCII",
"ftpPort": 0,
"invoiceDirectory": "string",
"isPrimaryTransmissionMethod": true,
"notes": "string",
"orderDirectory": "string",
"password": "string",
"serverAddress": "string",
"username": "string"
},
"ediSchedule": {"enableScheduledExport": false,
"scheduleParameters": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"scheduleFrequency": 0,
"schedulePeriod": "MONTH",
"schedulingDate": "2019-08-24T14:15:22Z",
"scheduleTime": "string",
"scheduleDay": 0,
"weekDays": ["MONDAY"
],
"timeZone": "UTC"
},
"schedulingNotes": "string"
},
"isDefaultConfig": false,
"integrationType": "Ordering",
"transmissionMethod": "FTP",
"fileFormat": "CSV",
"claimPieceIds": ["string"
]
},
"query": "string",
"eHoldingsExportConfig": {"recordId": "91525-1152699-659590",
"recordType": "PACKAGE",
"titleSearchFilters": "filter[name]=title&sort=name",
"packageFields": ["string"
],
"titleFields": ["string"
]
},
"authorityControlExportConfig": {"fromDate": "2019-08-24",
"toDate": "2019-08-24"
}
},
"scheduleFrequency": 0,
"schedulePeriod": "WEEK",
"scheduleTime": "string",
"weekDays": ["MONDAY"
]
}
],
"totalRecords": 0
}

postExportConfig

Add an export configuration

header Parameters

X-Okapi-Tenant

required

string

Request Body schema: application/json
required

string

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"

tenant

string

Tenant id

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)

scheduleFrequency

integer

Number of time periods

schedulePeriod

required

string

Enum: "WEEK" "DAY" "HOUR" "NONE"

Time period for repeating job

scheduleTime

string

Time to run the job

weekDays

Array of strings

Items Enum: "MONDAY" "TUESDAY" "WEDNESDAY" "THURSDAY" "FRIDAY" "SATURDAY" "SUNDAY"

Day of week to run the job

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"type": "CIRCULATION_LOG",
"tenant": "string",
"exportTypeSpecificParameters": {"bursarFeeFines": {"filter": {"type": "Age",
"numDays": 1,
"condition": "LESS_THAN_EQUAL"
},
"groupByPatron": true,
"groupByPatronFilter": {"type": "Aggregate",
"property": "NUM_ROWS",
"amount": 0,
"condition": "LESS_THAN_EQUAL"
},
"header": [{"type": "Aggregate",
"value": "NUM_ROWS",
"decimal": true,
"lengthControl": {"character": "s",
"length": 0,
"direction": "FRONT",
"truncate": true
}
}
],
"data": [{"type": "Aggregate",
"value": "NUM_ROWS",
"decimal": true,
"lengthControl": {"character": "s",
"length": 0,
"direction": "FRONT",
"truncate": true
}
}
],
"footer": [{"type": "Aggregate",
"value": "NUM_ROWS",
"decimal": true,
"lengthControl": {"character": "s",
"length": 0,
"direction": "FRONT",
"truncate": true
}
}
],
"transferInfo": {"conditions": [{"condition": {"type": "Age",
"numDays": 1,
"condition": "LESS_THAN_EQUAL"
},
"account": "f5b54a51-a98c-44cf-bb68-a676332e7d12"
}
],
"else": {"account": "f5b54a51-a98c-44cf-bb68-a676332e7d12"
}
}
},
"vendorEdiOrdersExportConfig": {"exportConfigId": "435cb3a4-03b6-4647-9934-9c99bc385ae1",
"vendorId": "e9b57fab-1850-44d4-8499-71fd15c845a0",
"configName": "string",
"configDescription": "string",
"ediConfig": {"accountNoList": ["string"
],
"defaultAcquisitionMethods": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"ediNamingConvention": "string",
"libEdiCode": "string",
"libEdiType": "014/EAN",
"vendorEdiCode": "string",
"vendorEdiType": "014/EAN",
"notes": "string",
"sendAccountNumber": false,
"supportOrder": false,
"supportInvoice": false
},
"ediFtp": {"ftpConnMode": "Active",
"ftpFormat": "SFTP",
"ftpMode": "ASCII",
"ftpPort": 0,
"invoiceDirectory": "string",
"isPrimaryTransmissionMethod": true,
"notes": "string",
"orderDirectory": "string",
"password": "string",
"serverAddress": "string",
"username": "string"
},
"ediSchedule": {"enableScheduledExport": false,
"scheduleParameters": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"scheduleFrequency": 0,
"schedulePeriod": "MONTH",
"schedulingDate": "2019-08-24T14:15:22Z",
"scheduleTime": "string",
"scheduleDay": 0,
"weekDays": ["MONDAY"
],
"timeZone": "UTC"
},
"schedulingNotes": "string"
},
"isDefaultConfig": false,
"integrationType": "Ordering",
"transmissionMethod": "FTP",
"fileFormat": "CSV",
"claimPieceIds": ["string"
]
},
"query": "string",
"eHoldingsExportConfig": {"recordId": "91525-1152699-659590",
"recordType": "PACKAGE",
"titleSearchFilters": "filter[name]=title&sort=name",
"packageFields": ["string"
],
"titleFields": ["string"
]
},
"authorityControlExportConfig": {"fromDate": "2019-08-24",
"toDate": "2019-08-24"
}
},
"scheduleFrequency": 0,
"schedulePeriod": "WEEK",
"scheduleTime": "string",
"weekDays": ["MONDAY"
]
}

Response samples

Content type

application/json

{"value": {"$ref": "../../../../folio-export-common/examples/errors.sample"
}
}

getConfigById

Get a export configuration by the export configuration ID

path Parameters

required

string

UUID of the export configuration

Responses

Response samples

Content type

application/json

{"id": "string",
"type": "CIRCULATION_LOG",
"tenant": "string",
"exportTypeSpecificParameters": {"bursarFeeFines": {"filter": {"type": "Age",
"numDays": 1,
"condition": "LESS_THAN_EQUAL"
},
"groupByPatron": true,
"groupByPatronFilter": {"type": "Aggregate",
"property": "NUM_ROWS",
"amount": 0,
"condition": "LESS_THAN_EQUAL"
},
"header": [{"type": "Aggregate",
"value": "NUM_ROWS",
"decimal": true,
"lengthControl": {"character": "s",
"length": 0,
"direction": "FRONT",
"truncate": true
}
}
],
"data": [{"type": "Aggregate",
"value": "NUM_ROWS",
"decimal": true,
"lengthControl": {"character": "s",
"length": 0,
"direction": "FRONT",
"truncate": true
}
}
],
"footer": [{"type": "Aggregate",
"value": "NUM_ROWS",
"decimal": true,
"lengthControl": {"character": "s",
"length": 0,
"direction": "FRONT",
"truncate": true
}
}
],
"transferInfo": {"conditions": [{"condition": {"type": "Age",
"numDays": 1,
"condition": "LESS_THAN_EQUAL"
},
"account": "f5b54a51-a98c-44cf-bb68-a676332e7d12"
}
],
"else": {"account": "f5b54a51-a98c-44cf-bb68-a676332e7d12"
}
}
},
"vendorEdiOrdersExportConfig": {"exportConfigId": "435cb3a4-03b6-4647-9934-9c99bc385ae1",
"vendorId": "e9b57fab-1850-44d4-8499-71fd15c845a0",
"configName": "string",
"configDescription": "string",
"ediConfig": {"accountNoList": ["string"
],
"defaultAcquisitionMethods": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"ediNamingConvention": "string",
"libEdiCode": "string",
"libEdiType": "014/EAN",
"vendorEdiCode": "string",
"vendorEdiType": "014/EAN",
"notes": "string",
"sendAccountNumber": false,
"supportOrder": false,
"supportInvoice": false
},
"ediFtp": {"ftpConnMode": "Active",
"ftpFormat": "SFTP",
"ftpMode": "ASCII",
"ftpPort": 0,
"invoiceDirectory": "string",
"isPrimaryTransmissionMethod": true,
"notes": "string",
"orderDirectory": "string",
"password": "string",
"serverAddress": "string",
"username": "string"
},
"ediSchedule": {"enableScheduledExport": false,
"scheduleParameters": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"scheduleFrequency": 0,
"schedulePeriod": "MONTH",
"schedulingDate": "2019-08-24T14:15:22Z",
"scheduleTime": "string",
"scheduleDay": 0,
"weekDays": ["MONDAY"
],
"timeZone": "UTC"
},
"schedulingNotes": "string"
},
"isDefaultConfig": false,
"integrationType": "Ordering",
"transmissionMethod": "FTP",
"fileFormat": "CSV",
"claimPieceIds": ["string"
]
},
"query": "string",
"eHoldingsExportConfig": {"recordId": "91525-1152699-659590",
"recordType": "PACKAGE",
"titleSearchFilters": "filter[name]=title&sort=name",
"packageFields": ["string"
],
"titleFields": ["string"
]
},
"authorityControlExportConfig": {"fromDate": "2019-08-24",
"toDate": "2019-08-24"
}
},
"scheduleFrequency": 0,
"schedulePeriod": "WEEK",
"scheduleTime": "string",
"weekDays": ["MONDAY"
]
}

putExportConfig

Change an export configuration

path Parameters

required

string

header Parameters

X-Okapi-Tenant

required

string

Request Body schema: application/json
required

string

type

required

string (ExportType)

Default: "BURSAR_FEES_FINES"

tenant

string

Tenant id

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)

scheduleFrequency

integer

Number of time periods

schedulePeriod

required

string

Enum: "WEEK" "DAY" "HOUR" "NONE"

Time period for repeating job

scheduleTime

string

Time to run the job

weekDays

Array of strings

Items Enum: "MONDAY" "TUESDAY" "WEDNESDAY" "THURSDAY" "FRIDAY" "SATURDAY" "SUNDAY"

Day of week to run the job

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"type": "CIRCULATION_LOG",
"tenant": "string",
"exportTypeSpecificParameters": {"bursarFeeFines": {"filter": {"type": "Age",
"numDays": 1,
"condition": "LESS_THAN_EQUAL"
},
"groupByPatron": true,
"groupByPatronFilter": {"type": "Aggregate",
"property": "NUM_ROWS",
"amount": 0,
"condition": "LESS_THAN_EQUAL"
},
"header": [{"type": "Aggregate",
"value": "NUM_ROWS",
"decimal": true,
"lengthControl": {"character": "s",
"length": 0,
"direction": "FRONT",
"truncate": true
}
}
],
"data": [{"type": "Aggregate",
"value": "NUM_ROWS",
"decimal": true,
"lengthControl": {"character": "s",
"length": 0,
"direction": "FRONT",
"truncate": true
}
}
],
"footer": [{"type": "Aggregate",
"value": "NUM_ROWS",
"decimal": true,
"lengthControl": {"character": "s",
"length": 0,
"direction": "FRONT",
"truncate": true
}
}
],
"transferInfo": {"conditions": [{"condition": {"type": "Age",
"numDays": 1,
"condition": "LESS_THAN_EQUAL"
},
"account": "f5b54a51-a98c-44cf-bb68-a676332e7d12"
}
],
"else": {"account": "f5b54a51-a98c-44cf-bb68-a676332e7d12"
}
}
},
"vendorEdiOrdersExportConfig": {"exportConfigId": "435cb3a4-03b6-4647-9934-9c99bc385ae1",
"vendorId": "e9b57fab-1850-44d4-8499-71fd15c845a0",
"configName": "string",
"configDescription": "string",
"ediConfig": {"accountNoList": ["string"
],
"defaultAcquisitionMethods": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"ediNamingConvention": "string",
"libEdiCode": "string",
"libEdiType": "014/EAN",
"vendorEdiCode": "string",
"vendorEdiType": "014/EAN",
"notes": "string",
"sendAccountNumber": false,
"supportOrder": false,
"supportInvoice": false
},
"ediFtp": {"ftpConnMode": "Active",
"ftpFormat": "SFTP",
"ftpMode": "ASCII",
"ftpPort": 0,
"invoiceDirectory": "string",
"isPrimaryTransmissionMethod": true,
"notes": "string",
"orderDirectory": "string",
"password": "string",
"serverAddress": "string",
"username": "string"
},
"ediSchedule": {"enableScheduledExport": false,
"scheduleParameters": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"scheduleFrequency": 0,
"schedulePeriod": "MONTH",
"schedulingDate": "2019-08-24T14:15:22Z",
"scheduleTime": "string",
"scheduleDay": 0,
"weekDays": ["MONDAY"
],
"timeZone": "UTC"
},
"schedulingNotes": "string"
},
"isDefaultConfig": false,
"integrationType": "Ordering",
"transmissionMethod": "FTP",
"fileFormat": "CSV",
"claimPieceIds": ["string"
]
},
"query": "string",
"eHoldingsExportConfig": {"recordId": "91525-1152699-659590",
"recordType": "PACKAGE",
"titleSearchFilters": "filter[name]=title&sort=name",
"packageFields": ["string"
],
"titleFields": ["string"
]
},
"authorityControlExportConfig": {"fromDate": "2019-08-24",
"toDate": "2019-08-24"
}
},
"scheduleFrequency": 0,
"schedulePeriod": "WEEK",
"scheduleTime": "string",
"weekDays": ["MONDAY"
]
}

Response samples

Content type

application/json

{"value": {"$ref": "../../../../folio-export-common/examples/errors.sample"
}
}

deleteExportConfigById

Delete export configuration by UUID

path Parameters

required

string

Responses

Response samples

Content type

application/json

{"value": {"$ref": "../../../../folio-export-common/examples/errors.sample"
}
}

Data Export Spring Configurations (v1)

getExportConfigs

query Parameters

Responses

Response samples

postExportConfig

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

getConfigById

path Parameters

Responses

Response samples

putExportConfig

path Parameters

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

deleteExportConfigById

path Parameters

Responses

Response samples

Request Body schema: application/json
required

Request Body schema: application/json
required