-
Notifications
You must be signed in to change notification settings - Fork 1
Bulk KBART Import
Daniel Rupp edited this page Dec 17, 2025
·
7 revisions
For the purpose of managing the import of KBART files for multiple packages at once, the bulk import API defines a JSON format that saves the necessary information for creating the packages and fetching the corresponding KBART files via http.
The idea is to provide a config which is able to bundle multiple collections of packages defined by common characteristics, for example eBook and Journal packages. The properties on the collection level will be overridden by the same info in a specific package.
{
"collections": [
{
"collection_name": "<internal collection name, will not be displayed in GOKB>",
"scope": "<Front File|Back File|Aggregator|Master File",
"content_type": "<Book|Journal|Database|Mixed>",
"breakable": <true|false>,
"consistent": <true|false>,
"fixed": <true|false>,
"package_id_namespace": "<namespace for package id>",
"title_id_namespace": "<namespace for column title_id in KBART>",
"package_source": "<name of provider-code in config upload>",
"package_provider": "<GOKB-UUID of platform provider>",
"package_content_provider": "<GOKB-UUID of content provider if different from package_provider>",
"package_nominal_platform": "<GOKB-UUID of nominal package platform>",
"package_curatory_group": "<GOKB curatory group name>",
"global": "<Global|Regional|Consortium|Local|Other",
"global_note": "<free-text for global scope like institution name for Local>",
"package_list": [
{
"package_name": "<package name in GOKB standard>",
"package_uuid": "<GOKB-UUID for existing GOKB package to update>",
"scope": "<Front File|Back File|Aggregator|Master File",
"content_type": "<Book|Journal|Database|Mixed>",
"breakable": <true|false>,
"consistent": <true|false>,
"fixed": <true|false>,
"global": "<Global|Regional|Consortium|Local|Other",
"global_note": "<free-text for global scope like institution name for Local>",
"package_id_namespace": "<namespace for package id>",
"package_id": "<ID of package dependent of package_id_namespace>",
"title_id_namespace": "<namespace for column title_id in KBART>",
"package_source": "<name of provider-code in config upload>",
"package_provider": "<GOKB-UUID of platform provider>",
"package_content_provider": "<GOKB-UUID of content provider if different from package_provider>",
"package_nominal_platform": "<GOKB-UUID of nominal package platform>",
"package_curatory_group": "<GOKB curatory group name>",
"start_year": "<start year of package as YYYY>",
"end_year": "<start year of package as YYYY>",
"package_titlelist": "<URL of KBART title list>",
"other_package_identifiers": [
{
"value": "<id value of package in selected namespace>",
"namespace": "<existing GOKB namespace value for alternative package id like 'isil'>"
}
],
"package_created_date": "<date as YYYY-MM-DD>",
"package_changed_date": "<date as YYYY-MM-DD>"
}
]
}
]
}