Skip to main content

Project and data

settings

FieldPurpose
nameShort project name
initializedWhether the project has been initialized
splitterNested-field splitter (default .). Change when . is part of a key, for example OData @odata.count
logfileLog file name (default apibackuper.log)
state_filePersistent run state
checkpoint_fileResume checkpoint path
checkpoint_interval_pagesPages between checkpoint writes

project

FieldPurpose
descriptionHuman-readable purpose
urlAPI endpoint
http_modeGET or POST
work_modesComma-separated full, incremental, update
iterate_bypage, skip, or range
resp_typejson (default), xml, or html
update_modeby_change_key, by_timestamp, or custom_script
detectAuto-detect keys during run
default_delay / retry_delay / retry_countSimple delay and retry
force_retryRetry on errors

data

FieldPurpose
data_keyPath to the array of records
total_number_keyPath to the total record count
pages_number_keyPath to the total page count
item_keyUnique id (comma-separated for composites)
change_keyField that indicates a record changed

Nested keys use settings.splitter (default .), for example result.results or СтатусАккредитации.ДействуетС.