Export

Start export file creation

post/api/v2/export

Request

  • Base URL: https://demo.mysurvey.solutions (the document declares no server; this is the origin it was published from)
  • URL: https://demo.mysurvey.solutions/api/v2/export
  • Auth: HTTP basic and HTTP bearer

Request body

ExportType'Tabular' | 'STATA' | 'SPSS' | 'Binary' | 'DDI' | 'Paradata' | 'AudioAudit' required
QuestionnaireIdstring required

Questionnaire id in format [QuestionnaireGuid$Version]

InterviewStatus'All' | 'SupervisorAssigned' | 'InterviewerAssigned' | 'RejectedBySupervisor' | 'Completed' | 'ApprovedBySupervisor' | 'RejectedByHeadquarters' | 'ApprovedByHeadquarters' required
Fromstring date-time nullable

Started date for timeframe of exported interviews (when change was done to an interview). Should be in UTC date

Tostring date-time nullable

Finished date for timeframe of exported interviews (when change was done to an interview). Should be in UTC date

AccessTokenstring nullable

Access token to external storage

RefreshTokenstring nullable

Refresh token to external storage

StorageType'Dropbox' | 'OneDrive' | 'GoogleDrive'
TranslationIdstring uuid nullable

Translation Id of the questionnaire

IncludeMetaboolean nullable
ParadataReducedboolean nullable

Response

Export started

JobIdinteger

Export process id

ExportStatus'Created' | 'Running' | 'Completed' | 'Fail' | 'Canceled'
StartDatestring date-time nullable

Export process stated date

CompleteDatestring date-time nullable

Export process completed date

CreateDatestring date-time nullable

Export process stated date

Progressinteger

Progress of export in percents

ETAstring date-span nullable

Estimated time to finish of export

Errorstring nullable
HasExportFileboolean

True, if export process is finished and exported file ready for download, otherwise false

ExportType'Tabular' | 'STATA' | 'SPSS' | 'Binary' | 'DDI' | 'Paradata' | 'AudioAudit' required
QuestionnaireIdstring required

Questionnaire id in format [QuestionnaireGuid$Version]

InterviewStatus'All' | 'SupervisorAssigned' | 'InterviewerAssigned' | 'RejectedBySupervisor' | 'Completed' | 'ApprovedBySupervisor' | 'RejectedByHeadquarters' | 'ApprovedByHeadquarters' required
Fromstring date-time nullable

Started date for timeframe of exported interviews (when change was done to an interview). Should be in UTC date

Tostring date-time nullable

Finished date for timeframe of exported interviews (when change was done to an interview). Should be in UTC date

AccessTokenstring nullable

Access token to external storage

RefreshTokenstring nullable

Refresh token to external storage

StorageType'Dropbox' | 'OneDrive' | 'GoogleDrive'
TranslationIdstring uuid nullable

Translation Id of the questionnaire

IncludeMetaboolean nullable
ParadataReducedboolean nullable

Changes

No recorded changes to this operation across all 1 revision of this API.