QueryResource

The following resources are part of this group:

/saiku/{username}/query

Mount Point: /rest/saiku/{username}/query

GET

Return a list of open queries.

Response Body

element: (custom)

(no documentation provided)

/saiku/{username}/query/{queryname}

Mount Point: /rest/saiku/{username}/query/{queryname}

The following operations are supported on this resource:

GET

Parameters

name description type default
queryname (no documentation provided) path

Response Body

element: (custom)

(no documentation provided)

DELETE

Delete query from the query pool.

Parameters

name description type default
queryname (no documentation provided) path

Response Body

element: (custom)

a HTTP 410(Works) or HTTP 404(Call failed).

POST

Create a new Saiku Query.

Parameters

name description type default
connection the name of the Saiku connection. form
cube the name of the cube. form
catalog the catalog name. form
schema the name of the schema. form
xml (no documentation provided) form
queryname the name you want to assign to the query. path

Response Body

element: (custom)

(no documentation provided)

/saiku/{username}/query/{queryname}/axis

Mount Point: /rest/saiku/{username}/query/{queryname}/axis

DELETE

Parameters

name description type default
queryname (no documentation provided) path

/saiku/{username}/query/{queryname}/drillthrough

Mount Point: /rest/saiku/{username}/query/{queryname}/drillthrough

GET

Parameters

name description type default
queryname (no documentation provided) path
maxrows (no documentation provided) query 100
position (no documentation provided) query
returns (no documentation provided) query

Response Body

element: (custom)

(no documentation provided)

/saiku/{username}/query/{queryname}/explain

Mount Point: /rest/saiku/{username}/query/{queryname}/explain

GET

Parameters

name description type default
queryname (no documentation provided) path

Response Body

element: (custom)

(no documentation provided)

/saiku/{username}/query/{queryname}/mdx

Mount Point: /rest/saiku/{username}/query/{queryname}/mdx

GET

Parameters

name description type default
queryname (no documentation provided) path

Response Body

element: (custom)

(no documentation provided)

POST

Parameters

name description type default
queryname (no documentation provided) path
mdx (no documentation provided) form

/saiku/{username}/query/{queryname}/properties

Mount Point: /rest/saiku/{username}/query/{queryname}/properties

GET

Parameters

name description type default
queryname (no documentation provided) path

Response Body

element: (custom)

(no documentation provided)

POST

Parameters

name description type default
queryname (no documentation provided) path
properties (no documentation provided) form

Response Body

element: (custom)

(no documentation provided)

/saiku/{username}/query/{queryname}/qm2mdx

Mount Point: /rest/saiku/{username}/query/{queryname}/qm2mdx

POST

Parameters

name description type default
queryname (no documentation provided) path

Response Body

element: (custom)

(no documentation provided)

/saiku/{username}/query/{queryname}/result

Mount Point: /rest/saiku/{username}/query/{queryname}/result

The following operations are supported on this resource:

DELETE

Parameters

name description type default
queryname (no documentation provided) path

Response Body

element: (custom)

(no documentation provided)

GET

Parameters

name description type default
queryname (no documentation provided) path
limit (no documentation provided) query 0

Response Body

element: (custom)

(no documentation provided)

POST

Parameters

name description type default
queryname (no documentation provided) path
mdx (no documentation provided) form
limit (no documentation provided) form 0

Response Body

element: (custom)

(no documentation provided)

/saiku/{username}/query/{queryname}/swapaxes

Mount Point: /rest/saiku/{username}/query/{queryname}/swapaxes

PUT

Parameters

name description type default
queryname (no documentation provided) path

Response Body

element: (custom)

(no documentation provided)

/saiku/{username}/query/{queryname}/tag

Mount Point: /rest/saiku/{username}/query/{queryname}/tag

PUT

Parameters

name description type default
queryname (no documentation provided) path
tag (no documentation provided) form

Response Body

element: (custom)

(no documentation provided)

DELETE

Parameters

name description type default
queryname (no documentation provided) path
tagname (no documentation provided) path

Response Body

element: (custom)

(no documentation provided)

/saiku/{username}/query/{queryname}/xml

Mount Point: /rest/saiku/{username}/query/{queryname}/xml

GET

Parameters

name description type default
queryname (no documentation provided) path

Response Body

element: (custom)

(no documentation provided)

/saiku/{username}/query/{queryname}/axis/{axis}

Mount Point: /rest/saiku/{username}/query/{queryname}/axis/{axis}

GET

Return a list of dimensions for an axis in a query.

Parameters

name description type default
queryname the name of the query. path
axis the name of the axis. path

Response Body

element: (custom)

a list of available dimensions.

DELETE

Remove all dimensions and selections on an axis

Parameters

name description type default
queryname the name of the query. path
axis the name of the axis. path

Response Body

element: (custom)

(no documentation provided)

/saiku/{username}/query/{queryname}/export/csv

Mount Point: /rest/saiku/{username}/query/{queryname}/export/csv

GET

Parameters

name description type default
queryname (no documentation provided) path

Response Body

element: (custom)

(no documentation provided)

/saiku/{username}/query/{queryname}/export/pdf

Mount Point: /rest/saiku/{username}/query/{queryname}/export/pdf

POST

Parameters

name description type default
queryname (no documentation provided) path
svg (no documentation provided) path

Response Body

element: (custom)

(no documentation provided)

GET

Parameters

name description type default
queryname (no documentation provided) path

Response Body

element: (custom)

(no documentation provided)

/saiku/{username}/query/{queryname}/export/xls

Mount Point: /rest/saiku/{username}/query/{queryname}/export/xls

GET

Parameters

name description type default
queryname (no documentation provided) path

Response Body

element: (custom)

(no documentation provided)

/saiku/{username}/query/{queryname}/properties/{propertyKey}

Mount Point: /rest/saiku/{username}/query/{queryname}/properties/{propertyKey}

POST

Parameters

name description type default
queryname (no documentation provided) path
propertyKey (no documentation provided) path
propertyValue (no documentation provided) form

Response Body

element: (custom)

(no documentation provided)

/saiku/{username}/query/{queryname}/result/{format}

Mount Point: /rest/saiku/{username}/query/{queryname}/result/{format}

POST

Parameters

name description type default
queryname (no documentation provided) path
format (no documentation provided) path
mdx (no documentation provided) form
limit (no documentation provided) form 0

Response Body

element: (custom)

(no documentation provided)

GET

Parameters

name description type default
queryname (no documentation provided) path
format (no documentation provided) path
limit (no documentation provided) query 0

Response Body

element: (custom)

(no documentation provided)

/saiku/{username}/query/{queryname}/axis/{axis}/filter

Mount Point: /rest/saiku/{username}/query/{queryname}/axis/{axis}/filter

POST

Parameters

name description type default
queryname (no documentation provided) path
axis (no documentation provided) path
filterCondition (no documentation provided) form

DELETE

Parameters

name description type default
queryname (no documentation provided) path
axis (no documentation provided) path

/saiku/{username}/query/{queryname}/axis/{axis}/limit

Mount Point: /rest/saiku/{username}/query/{queryname}/axis/{axis}/limit

DELETE

Parameters

name description type default
queryname (no documentation provided) path
axis (no documentation provided) path

/saiku/{username}/query/{queryname}/axis/{axis}/sort

Mount Point: /rest/saiku/{username}/query/{queryname}/axis/{axis}/sort

DELETE

Parameters

name description type default
queryname (no documentation provided) path
axis (no documentation provided) path

/saiku/{username}/query/{queryname}/cell/{position}/{value}

Mount Point: /rest/saiku/{username}/query/{queryname}/cell/{position}/{value}

POST

Parameters

name description type default
queryname (no documentation provided) path
position (no documentation provided) path
value (no documentation provided) path

Response Body

element: (custom)

(no documentation provided)

/saiku/{username}/query/{queryname}/drillthrough/export/csv

Mount Point: /rest/saiku/{username}/query/{queryname}/drillthrough/export/csv

GET

Parameters

name description type default
queryname (no documentation provided) path
maxrows (no documentation provided) query 100
position (no documentation provided) query
returns (no documentation provided) query

Response Body

element: (custom)

(no documentation provided)

/saiku/{username}/query/{queryname}/export/csv/{format}

Mount Point: /rest/saiku/{username}/query/{queryname}/export/csv/{format}

GET

Parameters

name description type default
queryname (no documentation provided) path
format (no documentation provided) path

Response Body

element: (custom)

(no documentation provided)

/saiku/{username}/query/{queryname}/export/pdf/{format}

Mount Point: /rest/saiku/{username}/query/{queryname}/export/pdf/{format}

GET

Parameters

name description type default
queryname (no documentation provided) path
format (no documentation provided) path

Response Body

element: (custom)

(no documentation provided)

POST

Parameters

name description type default
queryname (no documentation provided) path
format (no documentation provided) path
svg (no documentation provided) form

Response Body

element: (custom)

(no documentation provided)

/saiku/{username}/query/{queryname}/export/xls/{format}

Mount Point: /rest/saiku/{username}/query/{queryname}/export/xls/{format}

GET

Parameters

name description type default
queryname (no documentation provided) path
format (no documentation provided) path flattened

Response Body

element: (custom)

(no documentation provided)

/saiku/{username}/query/{queryname}/axis/{axis}/dimension/{dimension}

Mount Point: /rest/saiku/{username}/query/{queryname}/axis/{axis}/dimension/{dimension}

The following operations are supported on this resource:

GET

Return a dimension and its selections for an axis in a query.

Parameters

name description type default
queryname the name of the query. path
axis the name of the axis. path
dimension the name of the axis. path

Response Body

element: (custom)

a list of available dimensions.

POST

Move a dimension from one axis to another.

Parameters

name description type default
queryname the name of the query. path
axis the name of the axis. path
dimension the name of the dimension. path
position (no documentation provided) form -1

Response Body

element: (custom)

HTTP 200 or HTTP 500.

DELETE

Delete a dimension.

Parameters

name description type default
queryname (no documentation provided) path
axis (no documentation provided) path
dimension (no documentation provided) path

Response Body

element: (custom)

(no documentation provided)

PUT

Parameters

name description type default
queryname (no documentation provided) path
axis (no documentation provided) path
dimension (no documentation provided) path
selections (no documentation provided) form

Response Body

element: (custom)

(no documentation provided)

/saiku/{username}/query/{queryname}/axis/{axis}/limit/{limitfunction}

Mount Point: /rest/saiku/{username}/query/{queryname}/axis/{axis}/limit/{limitfunction}

POST

Parameters

name description type default
queryname (no documentation provided) path
axis (no documentation provided) path
limitfunction (no documentation provided) path
n (no documentation provided) form
sortliteral (no documentation provided) form

/saiku/{username}/query/{queryname}/axis/{axis}/dimension/{dimension}/children

Mount Point: /rest/saiku/{username}/query/{queryname}/axis/{axis}/dimension/{dimension}/children

PUT

Parameters

name description type default
queryname (no documentation provided) path
axis (no documentation provided) path
dimension (no documentation provided) path
member (no documentation provided) form

Response Body

element: (custom)

(no documentation provided)

DELETE

Parameters

name description type default
queryname (no documentation provided) path
axis (no documentation provided) path
dimension (no documentation provided) path
member (no documentation provided) form

Response Body

element: (custom)

(no documentation provided)

/saiku/{username}/query/{queryname}/axis/{axis}/dimension/{dimension}/member

Mount Point: /rest/saiku/{username}/query/{queryname}/axis/{axis}/dimension/{dimension}/member

DELETE

Parameters

name description type default
queryname (no documentation provided) path
axis (no documentation provided) path
dimension (no documentation provided) path

Request Body

element: (custom)

(no documentation provided)

Response Body

element: (custom)

(no documentation provided)

/saiku/{username}/query/{queryname}/axis/{axis}/sort/{sortorder}/{sortliteral}

Mount Point: /rest/saiku/{username}/query/{queryname}/axis/{axis}/sort/{sortorder}/{sortliteral}

POST

Parameters

name description type default
queryname (no documentation provided) path
axis (no documentation provided) path
sortorder (no documentation provided) path
sortliteral (no documentation provided) path

/saiku/{username}/query/{queryname}/axis/{axis}/dimension/{dimension}/member/{member}

Mount Point: /rest/saiku/{username}/query/{queryname}/axis/{axis}/dimension/{dimension}/member/{member}

POST

Move a member.

Parameters

name description type default
selection (no documentation provided) form MEMBER
queryname (no documentation provided) path
axis (no documentation provided) path
dimension (no documentation provided) path
member (no documentation provided) path
position (no documentation provided) form -1
memberposition (no documentation provided) form -1

Response Body

element: (custom)

(no documentation provided)

DELETE

Parameters

name description type default
selection (no documentation provided) form MEMBER
queryname (no documentation provided) path
axis (no documentation provided) path
dimension (no documentation provided) path
member (no documentation provided) path

Response Body

element: (custom)

(no documentation provided)

/saiku/{username}/query/{queryname}/axis/{axis}/dimension/{dimension}/hierarchy/{hierarchy}/{level}

Mount Point: /rest/saiku/{username}/query/{queryname}/axis/{axis}/dimension/{dimension}/hierarchy/{hierarchy}/{level}

POST

Parameters

name description type default
queryname (no documentation provided) path
axis (no documentation provided) path
dimension (no documentation provided) path
hierarchy (no documentation provided) path
level (no documentation provided) path
position (no documentation provided) form -1

Response Body

element: (custom)

(no documentation provided)

DELETE

Parameters

name description type default
queryname (no documentation provided) path
axis (no documentation provided) path
dimension (no documentation provided) path
hierarchy (no documentation provided) path
level (no documentation provided) path

Response Body

element: (custom)

(no documentation provided)

/saiku/{username}/query/{queryname}/result/metadata/dimensions/{dimension}/hierarchies/{hierarchy}/levels/{level}

Mount Point: /rest/saiku/{username}/query/{queryname}/result/metadata/dimensions/{dimension}/hierarchies/{hierarchy}/levels/{level}

GET

Parameters

name description type default
queryname (no documentation provided) path
dimension (no documentation provided) path
hierarchy (no documentation provided) path
level (no documentation provided) path
result (no documentation provided) query true

Response Body

element: (custom)

(no documentation provided)