POST Exports/{InspectionKey}/{ExportType}/{Facets}/start

Starts an export of an inspection to Excel.
Multiple ExportType Excel values can be specified by using bar (|) character.
If non-Excel values are specified, they can only be single calls.
e.g. "Excel|ExcelWithTees|ExcelWithHeatMap" is valid but "Excel|SpssFile" and "StudyXml|SpssFile" is not.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
InspectionKey

integer

Required

ExportType

String: "Excel", "ExcelWithTees", "ExcelWithTeeHierarchy", "ExcelWithHeatMap", "ExcelWithTopicsTabbed", "ExcelWithGroups", "ExcelWithIncludeClosedEnds", "ExcelWithResponseSentiments", "ExcelWithRespondentSentiments", "ExcelWithResponsesWithoutExtracts", "ExcelWithResponseView", "ExcelWithTopThemes", "ExcelWithAttributes", "ExcelWithClosedEnds", "ExcelWithPositiveNegativeReport", "XScoreInsights", "Dichotomous", "DichotomousWithAverageSentiment", "StudyXml", "SpssFile"

string

Required

Facets

String: "Sentiment", "Topics", "SentimentTopics"

string

Required

Body Parameters

None.

Response Information

Starts an export of an inspection to Excel.
Multiple ExportType Excel values can be specified by using bar (|) character.
If non-Excel values are specified, they can only be single calls.
e.g. "Excel|ExcelWithTees|ExcelWithHeatMap" is valid but "Excel|SpssFile" and "StudyXml|SpssFile" is not.

InspectionExportResponse
NameDescriptionTypeAdditional information
errors

If null the request was processed without error. If not null errors occurred while processing the request. The array contains the error messages.

Collection of string

None.

taskStatusKey

Key of export task which can be used for getting progress status of export operation

integer

None.