Cancel query

4 Minutes to read

Print
Share
Dark
Light

Cancel query

4 Minutes to read

Print
Share
Dark
Light

Article summary

Did you find this summary helpful?

Thank you for your feedback

Delete

/analysis-query/{correlationId}

Abort running query, if still running

Security

OAuth

FlowClient credentials

Token URLhttps://intelligence.eu.mapp.com/analytics/api/oauth/token

Scopes:

mapp.intelligence-apiUse intelligence APIs

Path parameters

correlationId

stringRequired

ID of the query to be canceled

Responses

200

Query successfully canceled

403

No permission to execute operation

AnalysisNotFound

Invalid Token

{
  "title": "Invalid Token",
  "status": 403,
  "detail": "Token not valid",
  "statusCode": "INVALID_TOKEN"
}

Expand All

object

status

integer

HTTP Status Code

statusCode

string

Specific Mapp Error Code

title

string

Short description of the problem

detail

string

Detailed informations about the problem

errors

Array of object (Error)

object

name

string

Each error has specific properties described in following table:

Error	Description	Relevant parameters
UnmappedName	At least one object name cannot be found.	List of objects not found in names array.
PivotIncompatibleMetric	Metric not usable in Pivot detected.	List of incompatible Metrics in names array.
PivotIncompatibleDimension	Dimension not usable in Pivot detected.	List of incompatible Dimensions in names array.
AnalysisLogicalCubeMismatch	All Dimensions and Metrics are not compatible.	List of incompatible objects in names array.
InvalidSortingCriteria	Sorting is applied on a non-sortable object.	List of invalid sorted objects in names array.
TimeFilterMissing	Each query must have a minimum of one Time Filter.	N/A
InvalidSegmentNoneContainer	A segment container has context set to NONE but either its connector is not set to AND or its inOrNotIn property is not set to IN.	N/A

Valid values[ "\"UnmappedName\"", "\"PivotIncompatibleMetric\"", "\"PivotIncompatibleDimension\"", "\"AnalysisLogicalCubeMismatch\"", "\"InvalidSortingCriteria\"", "\"TimeFilterMissing\"", "\"InvalidSegmentNoneContainer\"" ]

parameters

object

arrangeTypes

Array of string

List of internal object names (dimension, metrics, filter, ...) that corresponds to the error.

string

aliases

Array of string

List of columns aliases that corresponds to the error. See Result Header alias property.

string

names

Array of string

List of object names (dimension, metrics, filter, ...) that corresponds to the error.

string

warnings

Array of object (Warning)

object

name

string

Each warnings has specific properties described in following table:

Warning	Description	Relevant parameters
FilterLogicalCubeMismatch	At least one filter is ignored due to incompatibily with Dimensions and Metrics used.	List of incomptible filter objects in names array.
InvalidMetricContext	Metric used in an invalid context.	List of metric with invalid context in aliases array.
SortingEnforced	Sorting criteria has been added automatically	List of objects that were sorted automatically in aliases array.
NoSortingDefined	Sorting criteria is required for some dimensions.	List of dimensions requiring a sorting in names array.
SortingLimitExceeded	3 sorting criteria are allowed. All additional sorting criteria have been omitted.	List of columns ignored for sorting in aliases array.
SortingRemoved	A requested sorting criteria has been removed	List of objects that were removed automatically in aliases array.
TodayRemoved	Today date has been removed from calculation time range because the selected datasource does not contain it.	daysInDataSource, todayDate

Valid values[ "\"FilterLogicalCubeMismatch\"", "\"InvalidMetricContext\"", "\"SortingEnforced\"", "\"NoSortingDefined\"", "\"SortingLimitExceeded\"", "\"SortingRemoved\"", "\"TodayRemoved\"" ]

parameters

object

arrangeTypes

Array of string

List of internal object names (dimension, metrics, filter, ...) that corresponds to the warning.

string

aliases

Array of string

List of columns aliases that corresponds to the error. See Result Header alias property.

string

names

Array of string

List of object names (dimension, metrics, filter, ...) that corresponds to the warning.

string

daysInDataSource

string

Number of days in the datasource which is beeing cut

todayDate

string

Date of the day being cut

404

Entity not found

AnalysisNotFound

CorrelationId does not exist

{
  "title": "Analysis not found",
  "status": 404,
  "detail": "Analysis not found",
  "statusCode": "ANALYSIS_NOT_FOUND"
}

Expand All

object

status

integer

HTTP Status Code

statusCode

string

Specific Mapp Error Code

title

string

Short description of the problem

detail

string

Detailed informations about the problem

errors

Array of object (Error)

object

name

string

Each error has specific properties described in following table:

Error	Description	Relevant parameters
UnmappedName	At least one object name cannot be found.	List of objects not found in names array.
PivotIncompatibleMetric	Metric not usable in Pivot detected.	List of incompatible Metrics in names array.
PivotIncompatibleDimension	Dimension not usable in Pivot detected.	List of incompatible Dimensions in names array.
AnalysisLogicalCubeMismatch	All Dimensions and Metrics are not compatible.	List of incompatible objects in names array.
InvalidSortingCriteria	Sorting is applied on a non-sortable object.	List of invalid sorted objects in names array.
TimeFilterMissing	Each query must have a minimum of one Time Filter.	N/A
InvalidSegmentNoneContainer	A segment container has context set to NONE but either its connector is not set to AND or its inOrNotIn property is not set to IN.	N/A

parameters

object

arrangeTypes

Array of string

List of internal object names (dimension, metrics, filter, ...) that corresponds to the error.

string

aliases

Array of string

List of columns aliases that corresponds to the error. See Result Header alias property.

string

names

Array of string

List of object names (dimension, metrics, filter, ...) that corresponds to the error.

string

warnings

Array of object (Warning)

object

name

string

Each warnings has specific properties described in following table:

Warning	Description	Relevant parameters
FilterLogicalCubeMismatch	At least one filter is ignored due to incompatibily with Dimensions and Metrics used.	List of incomptible filter objects in names array.
InvalidMetricContext	Metric used in an invalid context.	List of metric with invalid context in aliases array.
SortingEnforced	Sorting criteria has been added automatically	List of objects that were sorted automatically in aliases array.
NoSortingDefined	Sorting criteria is required for some dimensions.	List of dimensions requiring a sorting in names array.
SortingLimitExceeded	3 sorting criteria are allowed. All additional sorting criteria have been omitted.	List of columns ignored for sorting in aliases array.
SortingRemoved	A requested sorting criteria has been removed	List of objects that were removed automatically in aliases array.
TodayRemoved	Today date has been removed from calculation time range because the selected datasource does not contain it.	daysInDataSource, todayDate

Valid values[ "\"FilterLogicalCubeMismatch\"", "\"InvalidMetricContext\"", "\"SortingEnforced\"", "\"NoSortingDefined\"", "\"SortingLimitExceeded\"", "\"SortingRemoved\"", "\"TodayRemoved\"" ]

parameters

object

arrangeTypes

Array of string

List of internal object names (dimension, metrics, filter, ...) that corresponds to the warning.

string

aliases

Array of string

List of columns aliases that corresponds to the error. See Result Header alias property.

string

names

Array of string

List of object names (dimension, metrics, filter, ...) that corresponds to the warning.

string

daysInDataSource

string

Number of days in the datasource which is beeing cut

todayDate

string

Date of the day being cut

Was this article helpful?

What's Next

Get analysis result