POST /dumps

Create dump

Create data dump. The allowed dumps in parallel are 2 dumps per user created dumps and only 1 full dump. If the dump filter contains search parameters, then it must also contain exactly one database. If the filter contains only a list of series ids, then selecting a database is not required.

Header Parameters

Name Type Type Required Default
Accept-Language Preferred language code in which data shall be returned. Defaults to English if no translation in the specified language is available. Can be used through the query parameter query or using the header Accept-Language.

en - English
zh - Chinese
ru - Russian
id - Indonesian
jp - Japanese
String en
Accept Response data format. Default is application/json. Can be used through the query parameter format or using the header Accept. String json

Query Parameters

Name Type Type Required Default
lang Preferred language code in which data will be returned. Defaults to English if no translation in the language specified is available. Can be used through the query parameter query or using the header Accept-Language.

en - English
zh - Chinese
ru - Russian
id - Indonesian
jp - Japanese
String en
format Response data format. Default is json. Can be used through the query parameter format or using the header Accept. String json
token Access API key. String
with_model_information If set to true returns the model names as part of the response. Boolean false

FormData Parameters

Name Type Type Required Default
name Name of the new record. Max length 100 String
description Description of the new record. Max length 1000 String
filter_id Filter ID String
consolidation Consolidation Method String zip
delivery Delivery Method String web
user_ftp_url Result delivery URL for local FTP server. Only valid when the localftp delivery method is selected. String
user_ftp_path Result delivery path for local FTP server. Only valid when the localftp delivery method is selected. String /ceic_data_dumps/
user_ftp_username Username for the local FTP server. Only valid when the localftp delivery method is selected. String
user_ftp_password Password for the local FTP server. Only valid when the localftp delivery method is selected and if local_ftp_username is specified. String
notification_email When set, the user will receive notifications by the e-mail address specified. Multiple comma separated e-mail addresses could be set. String
notification_url URL for push notification upon dump completion. String
notification_http_method HTTP Method for push notifications. String GET

Responses

Status Code Type Type
201 Process of dump creation is started DumpResult
400 Incorrect input parameters. BadRequest
401 Authorization error. AuthorizationError
403 Incorrect user permissions. PermissionsError
404 Requested entity not found. NotFound
415 Unsupported data format. Only json, xml, csv are supported. UnsupportedMedia
429 Too many requests were send or limit exceeded. TooManyRequests
500 Internal Server Error. InternalError
API Query Builder
Query
Query Result