SpagoBI REST API 2.0

SpagoBI website: http://www.spagobi.org/

DATE: 04 September 2015

Editors

Copyright © 2015 Engineering Ingegneria Informatica S.p.A. All rights reserved.

Abstract

This specification defines the SpagoBI REST API 2.0. SpagoBI REST API is intended to manage the lifecycle of SpagoBI analytical documents and datasets.

Status of this document

This is a work in progress and is changing on a monthly basis.

This specification is licensed under the FIWARE Open Specification License. Engineering Ingegneria Informatica S.p.A. provides the software associated to SpagoBI as open source: see details here.

Authentication

In order to use RESTful API you will have to authenticate yourself. You can do that through basic authentication.

It is not however mandatory to send authentication information if you are already accessing the REST services through a browser and you are logged in SpagoBI, in that case the session will be used to retrieve profile information.

NB: there is no REST interfaces to manage users. This is because users authenticate using Fiware IdM. So, to manage users you can use IdM RESTful API (https://github.com/ging/fi-ware-idm/wiki/REST-API).

In the future will implement a second method of authentication: it will require that you send a token in all of your HTTP requests. We will add the token as a resource in our RESTful API so it will be possible to generate the token by sending a POST request to the token resource's url. The response will be a json object containing the token that will be used later on. In this way, username and password will be required only the first time.

Authorization

Each request will give you results accordingly to your roles and tenant (for example, if a document is not visible to members of your tenant it will not be in the list of documents).

Right now a user can be part at most of one tenant. In future we will probably extend SpagoBI such that a user could be part of more than one.

When this change will be applied, a request will return all the resources available for each tenant of the user. It will be however added a parameter for specify the tenant to give user the possibility to filter results accordingly to what he will be going to do.

Errors

If the user is not authenticated the response status code will be 401 The other times an error appears the response code is 200 and the response body contains a json object containing the error messages.

  • Response (application/json)
        {
        "service": "",
        "errors": [
            {
                "message": "Document with label [wrong_label] doesn't exist"
            }
        ]
    }

API Specification

Default

The documents resource [/restful-services/2.0/documents]

The documents resource represents the list of documents that are visible to the authenticated user.

List All Documents - GET /restful-services/2.0/documents

Response 200 (application/json)
Go to example
View in Apiary

Adds a new document - POST /restful-services/2.0/documents

Before adding a new document, you have to pay attention to the fact that the document could depend on other objects, in particular a data source and/or a dataset objects. In this case you have to create those objects first, using the standard web GUI. After you created those objects, you have to reference them by their label in 'dataSourceLabel' and 'dataSetLabel' request properties.

Request (application/json)
Response 200 (application/json)
Go to example
View in Apiary

The document resource [/restful-services/2.0/documents/{document_label}]

The document resource represents a specific document.

Parameters
document_label (Required, string )
the document's label

Return document with specified Label - GET /restful-services/2.0/documents/{document_label}

Response 200 (application/json)
Go to example
View in Apiary

Update the document - PUT /restful-services/2.0/documents/{document_label}

Request (application/json)
Response 200 (application/json)
Go to example
View in Apiary

Delete the document - DELETE /restful-services/2.0/documents/{document_label}

Response 200 (application/json)
Go to example
View in Apiary

The preview subresource [/restful-services/2.0/documents/{document_label}/preview]

An analytical document can optionally have a static preview file, typically a screenshot. In case the document has no preview, a response with status code 404 (Not found) is returned.

Parameters
document_label (Required, string )
the document's label

Return a document's preview file with Specified Label - GET /restful-services/2.0/documents/{document_label}/preview

Response 200
Go to example
View in Apiary

The template subresource [/restful-services/2.0/documents/{document_label}/template]

The template resource is optional. It is however mandatory for some type of documents. The templates of a document are versioned, so if you add a new template, the old one will be not deleted.

Parameters
document_label (Required, string )
the document's label

Return template with Specified Label - GET /restful-services/2.0/documents/{document_label}/template

Response 200
Go to example
View in Apiary

Update the template - POST /restful-services/2.0/documents/{document_label}/template

Pay attention to the fact that, if a high-level REST client is used, some header information could vary.

Request (multipart/form-data)
Response 200 (application/json)
Go to example
View in Apiary

Delete the template - DELETE /restful-services/2.0/documents/{document_label}/template

Response 200 (application/json)
Go to example
View in Apiary

The parameters subresource [/restful-services/2.0/documents/{document_label}/parameters]

A document can have one ore more parameters (i.e. analytical drivers) associated; you must create the analytical driver before invoking this service.

Parameters
document_label (Required, string )
the document's label

Return parameters by document's label - GET /restful-services/2.0/documents/{document_label}/parameters

Response 200 (application/json)
Go to example
View in Apiary

Add a parameter - POST /restful-services/2.0/documents/{document_label}/parameters

Request (application/json)
Response 200 (application/json)
Go to example
View in Apiary

The parameter subresource [/restful-services/2.0/documents/{document_label}/parameters/{par_id}]

Each parameter is seen as a resource (subresource of parameters) and is uniquely identified by its id.

Parameters
document_label (Required, string )
the document's label
par_id (Required, string )
the parameter's id

Return Parameter with specified Id - GET /restful-services/2.0/documents/{document_label}/parameters/{par_id}

Response 200 (application/json)
Go to example
View in Apiary

Update the parameter - PUT /restful-services/2.0/documents/{document_label}/parameters/{par_id}

Request (application/json)
Response 200 (application/json)
Go to example
View in Apiary

Delete the parameter - DELETE /restful-services/2.0/documents/{document_label}/parameters/{par_id}

Response 200 (application/json)
Go to example
View in Apiary

The content subresource: document execution [/restful-services/2.0/documents/{document_label}/content]

This REST service applies to static reports, since they do not require user interaction. Executing a document can be seen as the act of retrieving its content. For this reason, the content of a document is represented as a subresource of it.

Parameters
document_label (Required, string )
the document's label

Return the document content - POST /restful-services/2.0/documents/{document_label}/content

Pre-requisite: you should have a static report defined (as analytical document) and running on SpagoBI Server (look at SpagoBI documentation in order to see how to define an analytical document of type report). In order to execute the document you must put the document's parameters inside the body payload as a JSON object. There is also the outputType parameter represented as queryParameter. It accepts an output type, for example "HTML" or "PDF". The available output types depend from the kind of document. Check the available export types from the SpagoBI web application, inside the view of document.

Request (application/json)
Response 200 (application/json)
Go to example
View in Apiary

The datasets [/restful-services/2.0/datasets]

CRUD operations for Datasets

Returns the datasets - GET /restful-services/2.0/datasets

Request
Response 200 (application/json)
Go to example
View in Apiary

Add a dataset - POST /restful-services/2.0/datasets

Request (application/json)
Response 201
Go to example
View in Apiary

The dataset [/restful-services/2.0/datasets/{dataset_label}]

CRUD operations for a specific dataset

Parameters
dataset_label (Required, string )
the dataset's label

Return the dataset - GET /restful-services/2.0/datasets/{dataset_label}

Response 200 (application/json)
Go to example
View in Apiary

Update tha dataset - PUT /restful-services/2.0/datasets/{dataset_label}

Request (application/json)
Response 200
Go to example
View in Apiary

Delete tha dataset - DELETE /restful-services/2.0/datasets/{dataset_label}

Response 200
Go to example
View in Apiary

The dataset content [/restful-services/2.0/datasets/{dataset_label}/content]

Parameters
dataset_label (Required, string )
the dataset's label

Return the dataset's content - GET /restful-services/2.0/datasets/{dataset_label}/content

It accepts a list of multiple query parameters, name1=value1&name2=value2&...&nameN=valueN.

Response 200
Go to example
View in Apiary

The engines resource [/restful-services/2.0/engines]

In order to create a document it is mandatory to specify its engine. The list of engines can be retrieved by sending a GET request to the engines resource's url. There POST method is not implemented because engines cannot be changed.

Get the engine resources - GET /restful-services/2.0/engines

Response 200 (application/json)
Go to example
View in Apiary

The engine resource [/restful-services/2.0/engines/{label}]

Parameters
label (Required, string )
the engine's label

Get the engine specified resource - GET /restful-services/2.0/engines/{label}

Response 200 (application/json)
Go to example
View in Apiary

Examples

Default

The documents resource [/restful-services/2.0/documents]

List All Documents - GET /restful-services/2.0/documents

Response 200 (application/json)

Headers

Content-Type: application/json

Body

[
    {
        "id": 1,
        "name": "Accessible sales costs",
        "description": "",
        "label": "Sales and costs",
        "visible": true,
        "stateCode": "REL",
        "creationUser": "demo_admin",
        "objMetaDataAndContents": null,
        "tenant": "SPAGOBI",
        "previewFile": null,
        "docVersion": null,
        "parametersRegion": "east",
        "dataSourceLabel": "foodmart",
        "dataSetLabel": "DEMO_SALES_COSTS",
        "typeCode": "ACCESSIBLE_HTML",
        "public": true,
        "engine": "SpagoBIAccessibleEng",
        "functionalities": [
            "/Functionalities/DOC_DEMO/Accessibility"
        ],
        "creationDate": "2015-04-20 10:12:08.0"
    },
    {
        "id": 133,
        "name": "Char Grouped Bar",
        "description": "Char Grouped Bar",
        "label": "Char Grouped Bar",
        "visible": true,
        "stateCode": "REL",
        "creationUser": "biadmin",
        "objMetaDataAndContents": null,
        "tenant": "SPAGOBI",
        "previewFile": null,
        "docVersion": null,
        "parametersRegion": "east",
        "dataSourceLabel": "FoodmartHSQL",
        "dataSetLabel": "DS_DEMO_EXTCHART",
        "typeCode": "CHART",
        "public": true,
        "engine": "SpagoBIJSChartEngine",
        "functionalities": [
            "/Functionalities/DOC_DEMO/CHARTS"
        ],
        "creationDate": "2014-01-23 11:56:59.0"
    }
]
Go to specification

Adds a new document - POST /restful-services/2.0/documents

Request (application/json)

Headers

Content-Type: application/json

Body

{
    "name": "Accessible sales costs",
    "description": "",
    "label": "Sales and costs",
    "visible": true,
    "stateCode": "REL",
    "creationUser": "demo_admin",
    "objMetaDataAndContents": null,
    "tenant": "SPAGOBI",
    "previewFile": null,
    "docVersion": null,
    "parametersRegion": "east",
    "dataSourceLabel": "foodmart",
    "dataSetLabel": "DEMO_SALES_COSTS",
    "typeCode": "ACCESSIBLE_HTML",
    "public": true,
    "engine": "SpagoBIAccessibleEng",
    "functionalities": [
        "/Functionalities/DOC_DEMO/Accessibility"
    ],
    "creationDate": "2015-04-20 10:12:08.0"
}
Response 200 (application/json)

Headers

Content-Type: application/json
Go to specification

The document resource [/restful-services/2.0/documents/{document_label}]

Parameters
document_label (Required, string )
the document's label

Return document with specified Label - GET /restful-services/2.0/documents/{document_label}

Response 200 (application/json)

Headers

Content-Type: application/json

Body

{
    "id": 1,
    "name": "Accessible sales costs",
    "description": "",
    "label": "Sales and costs",
    "visible": true,
    "stateCode": "REL",
    "creationUser": "demo_admin",
    "objMetaDataAndContents": null,
    "tenant": "SPAGOBI",
    "previewFile": null,
    "docVersion": null,
    "parametersRegion": "east",
    "dataSourceLabel": "foodmart",
    "dataSetLabel": "DEMO_SALES_COSTS",
    "typeCode": "ACCESSIBLE_HTML",
    "public": true,
    "engine": "SpagoBIAccessibleEng",
    "functionalities": [
        "/Functionalities/DOC_DEMO/Accessibility"
    ],
    "creationDate": "2015-04-20 10:12:08.0"
}
Go to specification

Update the document - PUT /restful-services/2.0/documents/{document_label}

Request (application/json)

Headers

Content-Type: application/json

Body

{
    "id": 1,
    "name": "Accessible sales costs",
    "description": "",
    "label": "Sales and costs",
    "visible": true,
    "stateCode": "REL",
    "creationUser": "demo_admin",
    "objMetaDataAndContents": null,
    "tenant": "SPAGOBI",
    "previewFile": null,
    "docVersion": null,
    "parametersRegion": "east",
    "dataSourceLabel": "foodmart",
    "dataSetLabel": "DEMO_SALES_COSTS",
    "typeCode": "ACCESSIBLE_HTML",
    "public": true,
    "engine": "SpagoBIAccessibleEng",
    "functionalities": [
        "/Functionalities/DOC_DEMO/Accessibility"
    ],
    "creationDate": "2015-04-20 10:12:08.0"
}
Response 200 (application/json)

Headers

Content-Type: application/json
Go to specification

Delete the document - DELETE /restful-services/2.0/documents/{document_label}

Response 200 (application/json)

Headers

Content-Type: application/json
Go to specification

The preview subresource [/restful-services/2.0/documents/{document_label}/preview]

Parameters
document_label (Required, string )
the document's label

Return document's preview file with Specified Label - GET /restful-services/2.0/documents/{document_label}/preview

Response 200

Headers

Content-Disposition: attachment; filename="preview.JPG"

Body

Preview is a file, typically an image.
Go to specification

The template subresource [/restful-services/2.0/documents/{document_label}/template]

Parameters
document_label (Required, string )
the document's label

Return template with Specified Label - GET /restful-services/2.0/documents/{document_label}/template

Response 200

Headers

Content-Disposition: attachment; filename="my_file"

Body

Template is a file, generally an xml.
Go to specification

Update the template - POST /restful-services/2.0/documents/{document_label}/template

Request (multipart/form-data)

Headers

Content-Type: multipart/form-data
Content-Disposition: form-data; name="file"; filename="my_file"

Body

Template is a file, generally an xml.
Response 200 (application/json)

Headers

Content-Type: application/json
Go to specification

Delete the template - DELETE /restful-services/2.0/documents/{document_label}/template

Response 200 (application/json)

Headers

Content-Type: application/json
Go to specification

The parameters subresource [/restful-services/2.0/documents/{document_label}/parameters]

Parameters
document_label (Required, string )
the document's label

Return parameters with Specified Label - GET /restful-services/2.0/documents/{document_label}/parameters

Response 200 (application/json)

Headers

Content-Type: application/json

Body

    [
					{
					"id": 44,
					"biObjectID": 8,
					"parID": 4,
					"parameter": {
						"id": 4,
						"description": "",
						"length": null,
						"label": "",
						"name": "",
						"type": "",
						"mask": "",
						"typeId": null,
						"modality": "",
						"modalityValue": null,
						"modalityValueForDefault": null,
						"defaultFormula": "",
						"checks": null,
						"temporal": false,
						"functional": false
					},
					"label": "Prod. department",
					"required": true,
					"modifiable": 0,
					"visible": 1,
					"multivalue": false,
					"colSpan": null,
					"thickPerc": null,
					"prog": 1,
					"priority": 2,
					"parameterUrlName": "ParDepartment",
					"parameterValues": null,
					"parameterValuesDescription": null,
					"transientParmeters": false,
					"parameterValuesRetriever": null,
					"iterative": false
				},
				{
					"id": 45,
					"biObjectID": 8,
					"parID": 3,
					"parameter": {
						"id": 3,
						"description": "",
						"length": null,
						"label": "",
						"name": "",
						"type": "",
						"mask": "",
						"typeId": null,
						"modality": "",
						"modalityValue": null,
						"modalityValueForDefault": null,
						"defaultFormula": "",
						"checks": null,
						"temporal": false,
						"functional": false
					},
					"label": "Age range",
					"required": true,
					"modifiable": 0,
					"visible": 1,
					"multivalue": false,
					"colSpan": null,
					"thickPerc": null,
					"prog": 1,
					"priority": 3,
					"parameterUrlName": "ParAgeGroup",
					"parameterValues": null,
					"parameterValuesDescription": null,
					"transientParmeters": false,
					"parameterValuesRetriever": null,
					"iterative": false
				}
    ]
Go to specification

Add a parameter - POST /restful-services/2.0/documents/{document_label}/parameters

Request (application/json)

Headers

Content-Type: application/json

Body

   			{
				"biObjectID": 8,
				"parID": 4,
				"parameter": {
					"id": 4,
					"description": "",
					"length": null,
					"label": "",
					"name": "",
					"type": "STRING",
					"mask": "",
					"typeId": null,
					"modality": "",
					"modalityValue": null,
					"modalityValueForDefault": null,
					"defaultFormula": "",
					"checks": null,
					"temporal": false,
					"functional": false
				},
				"label": "Prod. department",
				"required": true,
				"modifiable": 0,
				"visible": 1,
				"multivalue": false,
				"colSpan": 1,
				"thickPerc": 0,
				"prog": 1,
				"priority": 1,
				"parameterUrlName": "ParDepartment",
				"parameterValues": null,
				"parameterValuesDescription": null,
				"transientParmeters": false,
				"parameterValuesRetriever": null,
				"iterative": false
			}
Response 200 (application/json)

Headers

Content-Type: application/json
Go to specification

The parameter subresource [/restful-services/2.0/documents/{document_label}/parameters/{par_id}]

Parameters
document_label (Required, string )
the document's label
par_id (Required, string )
the parameter's id

Return Parameter with specified Id - GET /restful-services/2.0/documents/{document_label}/parameters/{par_id}

Response 200 (application/json)

Headers

Content-Type: application/json

Body

   			{
				"id": 44,
				"biObjectID": 8,
				"parID": 4,
				"parameter": {
					"id": 4,
					"description": "",
					"length": null,
					"label": "",
					"name": "",
					"type": "STRING",
					"mask": "",
					"typeId": null,
					"modality": "",
					"modalityValue": null,
					"modalityValueForDefault": null,
					"defaultFormula": "",
					"checks": null,
					"temporal": false,
					"functional": false
				},
				"label": "Prod. department",
				"required": true,
				"modifiable": 0,
				"visible": 1,
				"multivalue": false,
				"colSpan": 1,
				"thickPerc": 0,
				"prog": 1,
				"priority": 1,
				"parameterUrlName": "ParDepartment",
				"parameterValues": null,
				"parameterValuesDescription": null,
				"transientParmeters": false,
				"parameterValuesRetriever": null,
				"iterative": false
			}
Go to specification

Update the parameter - PUT /restful-services/2.0/documents/{document_label}/parameters/{par_id}

Request (application/json)

Headers

Content-Type: application/json

Body

    			{
				"id": 44,
				"biObjectID": 8,
				"parID": 4,
				"parameter": {
					"id": 4,
					"description": "",
					"length": null,
					"label": "",
					"name": "",
					"type": "STRING",
					"mask": "",
					"typeId": null,
					"modality": "",
					"modalityValue": null,
					"modalityValueForDefault": null,
					"defaultFormula": "",
					"checks": null,
					"temporal": false,
					"functional": false
				},
				"label": "Prod. department",
				"required": true,
				"modifiable": 0,
				"visible": 1,
				"multivalue": false,
				"colSpan": 1,
				"thickPerc": 0,
				"prog": 1,
				"priority": 1,
				"parameterUrlName": "ParDepartment",
				"parameterValues": null,
				"parameterValuesDescription": null,
				"transientParmeters": false,
				"parameterValuesRetriever": null,
				"iterative": false
			}
Response 200 (application/json)

Headers

Content-Type: application/json
Go to specification

Delete the parameter - DELETE /restful-services/2.0/documents/{document_label}/parameters/{par_id}

Response 200 (application/json)

Headers

Content-Type: application/json
Go to specification

The content subresource [/restful-services/2.0/documents/{document_label}/content]

Parameters
document_label (Required, string )
the document's label

Return the document content - POST /restful-services/2.0/documents/{document_label}/content

Request (application/json)

Headers

Content-Type: application/json

Body

    [
        {
               	"id": "1",
		    "label": "Country",
		    "type": "string",
		    "urlName": "country",
		    "values": ["Italy","USA"]
        }
    ]
Response 200 (application/json)

Headers

Content-Type: application/json
Content-Disposition: attachment; filename="my_file"

Body

documents content as file
Go to specification

The datasets [/restful-services/2.0/datasets]

Returns the datasets - GET /restful-services/2.0/datasets

Request Payload
callback (Not required, string)
the callback function for the response, optional

Response 200 (application/json)

Headers

Content-Type: application/json

Body

    [
        {
            "active": true,
            "categoryId": null,
            "commonInfo": {
                "organization": null,
                "sbiVersionDe": null,
                "sbiVersionIn": "4.0",
                "sbiVersionUp": null,
                "timeDe": null,
                "timeIn": 1437646316000,
                "timeUp": null,
                "userDe": null,
                "userIn": "biadmin",
                "userUp": null
            },
            "configuration": {
                "Query": "select * from business_demo_meter",
                "dataSource": "Cosmos",
                "queryScript": "",
                "queryScriptLanguage": ""
            },
            "description": null,
            "id": {
                "dsId": 4,
                "organization": "SPAGOBI",
                "versionNum": 7
            },
            "label": "Meter",
            "metaVersion": null,
            "metadata": {
                "fieldsMeta": [
                    {
                        "alias": "id",
                        "fieldType": "ATTRIBUTE",
                        "name": "id",
                        "properties": {},
                        "type": "java.lang.String"
                    },
                    {
                        "alias": "recvtime",
                        "fieldType": "ATTRIBUTE",
                        "name": "recvtime",
                        "properties": {},
                        "type": "java.lang.String"
                    }
                ],
                "properties": {
                    "resultNumber": "3276"
                }
            },
            "name": "Meter",
            "numRows": false,
            "owner": "biadmin",
            "parameters": [],
            "persistTableName": "",
            "persisted": false,
            "pivotColumnName": null,
            "pivotColumnValue": null,
            "pivotRowName": null,
            "publicDS": true,
            "sbiVersionDe": null,
            "sbiVersionIn": null,
            "sbiVersionUp": null,
            "scope": {
                "commonInfo": {
                    "organization": null,
                    "sbiVersionDe": null,
                    "sbiVersionIn": "4.0",
                    "sbiVersionUp": null,
                    "timeDe": null,
                    "timeIn": 1436791308000,
                    "timeUp": null,
                    "userDe": null,
                    "userIn": "server",
                    "userUp": null
                },
                "domainCd": "DS_SCOPE",
                "domainNm": "Dataset scope",
                "valueCd": "USER",
                "valueDs": "Dataset scope",
                "valueId": 185,
                "valueNm": "User"
            },
            "scopeId": 185,
            "timeDe": null,
            "timeIn": null,
            "timeUp": null,
            "transformerId": null,
            "type": "SbiQueryDataSet",
            "userDe": null,
            "userIn": null,
            "userUp": null
        },
        {
            "active": true,
            "categoryId": 150,
            "commonInfo": {
                "organization": null,
                "sbiVersionDe": null,
                "sbiVersionIn": "4.0",
                "sbiVersionUp": null,
                "timeDe": null,
                "timeIn": 1441025411000,
                "timeUp": null,
                "userDe": null,
                "userIn": "biadmin",
                "userUp": null
            },
            "configuration": {
                "restAddress": "http://192.168.2.137:1026/v1/queryContext",
                "restDirectlyJSONAttributes": "false",
                "restFetchSize": "limit",
                "restHttpMethod": "Post",
                "restJsonPathAttributes": [
                    {
                        "jsonPathType": "string",
                        "jsonPathValue": "pros3",
                        "name": "id"
                    }

                ],
                "restJsonPathItems": "$",
                "restMaxResults": "",
                "restNGSI": "true",
                "restOffset": "offset",
                "restRequestBody": "{ \n    \"entities\": [ \n        {\n            \"isPattern\": \"true\",\n            \"type\":\"Meter\",\n            \"id\": \".*\"\n        }\n    ]\n}",
                "restRequestHeaders": {
                    "Accept": "application/json",
                    "Content-Type": "application/json"
                }
            },
            "description": "Meters Values",
            "id": {
                "dsId": 5,
                "organization": "SPAGOBI",
                "versionNum": 10
            },
            "label": "RestMetersValues",
            "metaVersion": null,
            "metadata": {
                "fieldsMeta": [

                    {
                        "alias": "upstreamActivePower",
                        "fieldType": "ATTRIBUTE",
                        "name": "upstreamActivePower",
                        "properties": {
                            "jsonPathValue": "$.contextResponses[?(@.contextElement.id==pros3_Meter)].contextElement.attributes[?(@.name==upstreamActivePower)].value"
                        },
                        "type": "java.lang.Double"
                    },
                    {
                        "alias": "downstreamActivePower",
                        "fieldType": "ATTRIBUTE",
                        "name": "downstreamActivePower",
                        "properties": {
                            "jsonPathValue": "$.contextResponses[?(@.contextElement.id==pros3_Meter)].contextElement.attributes[?(@.name==downstreamActivePower)].value"
                        },
                        "type": "java.lang.Double"
                    }
                ],
                "properties": {}
            },
            "name": "RestMetersValues",
            "numRows": false,
            "owner": "biadmin",
            "parameters": [],
            "persistTableName": "",
            "persisted": false,
            "pivotColumnName": null,
            "pivotColumnValue": null,
            "pivotRowName": null,
            "publicDS": true,
            "sbiVersionDe": null,
            "sbiVersionIn": null,
            "sbiVersionUp": null,
            "scope": null,
            "scopeId": null,
            "timeDe": null,
            "timeIn": null,
            "timeUp": null,
            "transformerId": null,
            "type": "SbiRESTDataSet",
            "userDe": null,
            "userIn": null,
            "userUp": null
        },
        {
            "active": true,
            "categoryId": null,
            "commonInfo": {
                "organization": null,
                "sbiVersionDe": null,
                "sbiVersionIn": "4.0",
                "sbiVersionUp": null,
                "timeDe": null,
                "timeIn": 1440514105000,
                "timeUp": null,
                "userDe": null,
                "userIn": "biadmin",
                "userUp": null
            },
            "configuration": {
                "Query": "select *",
                "dataSource": "Cosmos",
                "queryScript": "",
                "queryScriptLanguage": ""
            },
            "description": null,
            "id": {
                "dsId": 6,
                "organization": "SPAGOBI",
                "versionNum": 1
            },
            "label": "LoadCosmos",
            "metaVersion": null,
            "metadata": null,
            "name": "LoadCosmos",
            "numRows": false,
            "owner": "biadmin",
            "parameters": [],
            "persistTableName": "",
            "persisted": false,
            "pivotColumnName": null,
            "pivotColumnValue": null,
            "pivotRowName": null,
            "publicDS": true,
            "sbiVersionDe": null,
            "sbiVersionIn": null,
            "sbiVersionUp": null,
            "scope": null,
            "scopeId": null,
            "timeDe": null,
            "timeIn": null,
            "timeUp": null,
            "transformerId": null,
            "type": "SbiQueryDataSet",
            "userDe": null,
            "userIn": null,
            "userUp": null
        },
        {
            "active": true,
            "categoryId": 150,
            "commonInfo": {
                "organization": null,
                "sbiVersionDe": null,
                "sbiVersionIn": "4.0",
                "sbiVersionUp": null,
                "timeDe": null,
                "timeIn": 1441189575000,
                "timeUp": null,
                "userDe": null,
                "userIn": "biadmin",
                "userUp": null
            },
            "configuration": {
                "restAddress": "http://192.168.2.137:1026/v1/queryContext",
                "restDirectlyJSONAttributes": "false",
                "restFetchSize": "",
                "restHttpMethod": "Post",
                "restJsonPathAttributes": [],
                "restJsonPathItems": "",
                "restMaxResults": "",
                "restNGSI": "true",
                "restOffset": "",
                "restRequestBody": "{ \n    \"entities\": [ \n        {\n            \"isPattern\": \"true\",\n            \"type\":\"Meter\",\n            \"id\": \".*\"\n        }\n    ]\n}",
                "restRequestHeaders": {}
            },
            "description": "Rest1 Desc",
            "id": {
                "dsId": 7,
                "organization": "SPAGOBI",
                "versionNum": 2
            },
            "label": "Rest2",
            "metaVersion": null,
            "metadata": {
                "fieldsMeta": [
                    {
                        "alias": "id",
                        "fieldType": "ATTRIBUTE",
                        "name": "id",
                        "properties": {
                            "jsonPathValue": "$.id"
                        },
                        "type": "java.lang.String"
                    },
                    {
                        "alias": "atTime",
                        "fieldType": "ATTRIBUTE",
                        "name": "atTime",
                        "properties": {
                            "dateFormat": "yyyy-MM-dd'T'HH:mm:ss.SSSZ",
                            "jsonPathType": "$.attributes[?(@.name==atTime)].type",
                            "jsonPathValue": "$.attributes[?(@.name==atTime)].value"
                        },
                        "type": "java.util.Date"
                    }

                ],
                "properties": {}
            },
            "name": "Rest2",
            "numRows": false,
            "owner": "biadmin",
            "parameters": [],
            "persistTableName": "",
            "persisted": false,
            "pivotColumnName": null,
            "pivotColumnValue": null,
            "pivotRowName": null,
            "publicDS": true,
            "sbiVersionDe": null,
            "sbiVersionIn": null,
            "sbiVersionUp": null,
            "scope": null,
            "scopeId": null,
            "timeDe": null,
            "timeIn": null,
            "timeUp": null,
            "transformerId": null,
            "type": "SbiRESTDataSet",
            "userDe": null,
            "userIn": null,
            "userUp": null
        }
    ]
Go to specification

Add a dataset - POST /restful-services/2.0/datasets

Request (application/json)

Headers

Content-Type: application/json

Body

    {
        "active": true,
        "categoryId": null,
        "commonInfo": {
            "organization": null,
            "sbiVersionDe": null,
            "sbiVersionIn": "4.0",
            "sbiVersionUp": null,
            "timeDe": null,
            "timeIn": 1437646316000,
            "timeUp": null,
            "userDe": null,
            "userIn": "biadmin",
            "userUp": null
        },
        "configuration": {
            "Query": "select * from business_demo_meter",
            "dataSource": "Cosmos",
            "queryScript": "",
            "queryScriptLanguage": ""
        },
        "description": null,
        "id": {
            "dsId": 4,
            "organization": "SPAGOBI",
            "versionNum": 7
        },
        "label": "Meter",
        "metaVersion": null,
        "metadata": {
            "fieldsMeta": [
                {
                    "alias": "id",
                    "fieldType": "ATTRIBUTE",
                    "name": "id",
                    "properties": {},
                    "type": "java.lang.String"
                },
                {
                    "alias": "recvtime",
                    "fieldType": "ATTRIBUTE",
                    "name": "recvtime",
                    "properties": {},
                    "type": "java.lang.String"
                }
            ],
            "properties": {
                "resultNumber": "3276"
            }
        },
        "name": "Meter",
        "numRows": false,
        "owner": "biadmin",
        "parameters": [],
        "persistTableName": "",
        "persisted": false,
        "pivotColumnName": null,
        "pivotColumnValue": null,
        "pivotRowName": null,
        "publicDS": true,
        "sbiVersionDe": null,
        "sbiVersionIn": null,
        "sbiVersionUp": null,
        "scope": {
            "commonInfo": {
                "organization": null,
                "sbiVersionDe": null,
                "sbiVersionIn": "4.0",
                "sbiVersionUp": null,
                "timeDe": null,
                "timeIn": 1436791308000,
                "timeUp": null,
                "userDe": null,
                "userIn": "server",
                "userUp": null
            },
            "domainCd": "DS_SCOPE",
            "domainNm": "Dataset scope",
            "valueCd": "USER",
            "valueDs": "Dataset scope",
            "valueId": 185,
            "valueNm": "User"
        },
        "scopeId": 185,
        "timeDe": null,
        "timeIn": null,
        "timeUp": null,
        "transformerId": null,
        "type": "SbiQueryDataSet",
        "userDe": null,
        "userIn": null,
        "userUp": null
    }
Response 201

Headers

Location: 1.0/datasets/datasetLabel
Go to specification

The dataset [/restful-services/2.0/datasets/{dataset_label}]

Parameters
dataset_label (Required, string )
the dataset's label

Return the dataset - GET /restful-services/2.0/datasets/{dataset_label}

Response 200 (application/json)

Headers

Content-Type: application/json

Body

    {
        "active": true,
        "categoryId": null,
        "commonInfo": {
            "organization": null,
            "sbiVersionDe": null,
            "sbiVersionIn": "4.0",
            "sbiVersionUp": null,
            "timeDe": null,
            "timeIn": 1437646316000,
            "timeUp": null,
            "userDe": null,
            "userIn": "biadmin",
            "userUp": null
        },
        "configuration": {
            "Query": "select * from business_demo_meter",
            "dataSource": "Cosmos",
            "queryScript": "",
            "queryScriptLanguage": ""
        },
        "description": null,
        "id": {
            "dsId": 4,
            "organization": "SPAGOBI",
            "versionNum": 7
        },
        "label": "Meter",
        "metaVersion": null,
        "metadata": {
            "fieldsMeta": [
                {
                    "alias": "id",
                    "fieldType": "ATTRIBUTE",
                    "name": "id",
                    "properties": {},
                    "type": "java.lang.String"
                },
                {
                    "alias": "recvtime",
                    "fieldType": "ATTRIBUTE",
                    "name": "recvtime",
                    "properties": {},
                    "type": "java.lang.String"
                }
            ],
            "properties": {
                "resultNumber": "3276"
            }
        },
        "name": "Meter",
        "numRows": false,
        "owner": "biadmin",
        "parameters": [],
        "persistTableName": "",
        "persisted": false,
        "pivotColumnName": null,
        "pivotColumnValue": null,
        "pivotRowName": null,
        "publicDS": true,
        "sbiVersionDe": null,
        "sbiVersionIn": null,
        "sbiVersionUp": null,
        "scope": {
            "commonInfo": {
                "organization": null,
                "sbiVersionDe": null,
                "sbiVersionIn": "4.0",
                "sbiVersionUp": null,
                "timeDe": null,
                "timeIn": 1436791308000,
                "timeUp": null,
                "userDe": null,
                "userIn": "server",
                "userUp": null
            },
            "domainCd": "DS_SCOPE",
            "domainNm": "Dataset scope",
            "valueCd": "USER",
            "valueDs": "Dataset scope",
            "valueId": 185,
            "valueNm": "User"
        },
        "scopeId": 185,
        "timeDe": null,
        "timeIn": null,
        "timeUp": null,
        "transformerId": null,
        "type": "SbiQueryDataSet",
        "userDe": null,
        "userIn": null,
        "userUp": null
    }
Go to specification

Update tha dataset - PUT /restful-services/2.0/datasets/{dataset_label}

Request (application/json)

Headers

Content-Type: application/json

Body

    {
        "active": true,
        "categoryId": null,
        "commonInfo": {
            "organization": null,
            "sbiVersionDe": null,
            "sbiVersionIn": "4.0",
            "sbiVersionUp": null,
            "timeDe": null,
            "timeIn": 1437646316000,
            "timeUp": null,
            "userDe": null,
            "userIn": "biadmin",
            "userUp": null
        },
        "configuration": {
            "Query": "select * from business_demo_meter",
            "dataSource": "Cosmos",
            "queryScript": "",
            "queryScriptLanguage": ""
        },
        "description": null,
        "id": {
            "dsId": 4,
            "organization": "SPAGOBI",
            "versionNum": 7
        },
        "label": "Meter",
        "metaVersion": null,
        "metadata": {
            "fieldsMeta": [
                {
                    "alias": "id",
                    "fieldType": "ATTRIBUTE",
                    "name": "id",
                    "properties": {},
                    "type": "java.lang.String"
                },
                {
                    "alias": "recvtime",
                    "fieldType": "ATTRIBUTE",
                    "name": "recvtime",
                    "properties": {},
                    "type": "java.lang.String"
                }
            ],
            "properties": {
                "resultNumber": "3276"
            }
        },
        "name": "Meter",
        "numRows": false,
        "owner": "biadmin",
        "parameters": [],
        "persistTableName": "",
        "persisted": false,
        "pivotColumnName": null,
        "pivotColumnValue": null,
        "pivotRowName": null,
        "publicDS": true,
        "sbiVersionDe": null,
        "sbiVersionIn": null,
        "sbiVersionUp": null,
        "scope": {
            "commonInfo": {
                "organization": null,
                "sbiVersionDe": null,
                "sbiVersionIn": "4.0",
                "sbiVersionUp": null,
                "timeDe": null,
                "timeIn": 1436791308000,
                "timeUp": null,
                "userDe": null,
                "userIn": "server",
                "userUp": null
            },
            "domainCd": "DS_SCOPE",
            "domainNm": "Dataset scope",
            "valueCd": "USER",
            "valueDs": "Dataset scope",
            "valueId": 185,
            "valueNm": "User"
        },
        "scopeId": 185,
        "timeDe": null,
        "timeIn": null,
        "timeUp": null,
        "transformerId": null,
        "type": "SbiQueryDataSet",
        "userDe": null,
        "userIn": null,
        "userUp": null
    }
Response 200

Go to specification

Delete tha dataset - DELETE /restful-services/2.0/datasets/{dataset_label}

Response 200

Go to specification

The dataset content [/restful-services/2.0/datasets/{dataset_label}/content]

Parameters
dataset_label (Required, string )
the dataset's label

Return the dataset's content - GET /restful-services/2.0/datasets/{dataset_label}/content

Response 200

Body

    {
        "metaData": {
            "totalProperty": "results",
            "root": "rows",
            "id": "id",
            "fields": [
                "recNo",
                {
                    "name": "column_1",
                    "header": "MONTH",
                    "dataIndex": "column_1",
                    "type": "string"
                },
                {
                    "name": "column_2",
                    "header": "SALES_STORE",
                    "dataIndex": "column_2",
                    "type": "float"
                },
                {
                    "name": "column_3",
                    "header": "COSTS_STORE",
                    "dataIndex": "column_3",
                    "type": "float"
                },
                {
                    "name": "column_4",
                    "header": "REVENUE",
                    "dataIndex": "column_4",
                    "type": "float"
                },
                {
                    "name": "column_5",
                    "header": "PERC_SALES",
                    "dataIndex": "column_5",
                    "type": "float"
                },
                {
                    "name": "column_6",
                    "header": "PERC_COSTS",
                    "dataIndex": "column_6",
                    "type": "float"
                },
                {
                    "name": "column_7",
                    "header": "PERC_REVENUE",
                    "dataIndex": "column_7",
                    "type": "float"
                }
            ]
        },
        "results": 11,
        "rows": [
            {
                "id": 1,
                "column_1": "January",
                "column_2": "71048.40",
                "column_3": "28416.27",
                "column_4": "207046.27",
                "column_5": "9.13",
                "column_6": "9.11",
                "column_7": "9.12"
            },
            {
                "id": 2,
                "column_1": "February",
                "column_2": "68078.88",
                "column_3": "27334.47",
                "column_4": "197757.39",
                "column_5": "8.75",
                "column_6": "8.76",
                "column_7": "8.71"
            },
            {
                "id": 3,
                "column_1": "March",
                "column_2": "70768.11",
                "column_3": "28402.76",
                "column_4": "206900.17",
                "column_5": "9.09",
                "column_6": "9.10",
                "column_7": "9.11"
            }
        ]
    }
Go to specification

The engines resource [/restful-services/2.0/engines]

Get the engine resources - GET /restful-services/2.0/engines

Response 200 (application/json)

Headers

Content-Type: application/json

Body

    [
        {
            "biobjTypeId": 15,
            "className": "",
            "criptable": 0,
            "description": "Cockpit Engine",
            "dirUpload": null,
            "dirUsable": null,
            "driverName": "it.eng.spagobi.engines.drivers.cockpit.CockpitDriver",
            "engineTypeId": 55,
            "id": 25,
            "label": "SpagoBICockpitEngine",
            "name": "Cockpit Engine",
            "secondaryUrl": null,
            "url": "/SpagoBICockpitEngine/api/1.0/pages/execute",
            "useDataSet": false,
            "useDataSource": false
        },
        {
            "biobjTypeId": 7,
            "className": "",
            "criptable": 0,
            "description": "What-If Engine",
            "dirUpload": null,
            "dirUsable": null,
            "driverName": "it.eng.spagobi.engines.drivers.whatif.WhatIfDriver",
            "engineTypeId": 55,
            "id": 26,
            "label": "SpagoBIWhatIfEngine",
            "name": "What-If Engine",
            "secondaryUrl": null,
            "url": "/SpagoBIWhatIfEngine/restful-services/start",
            "useDataSet": false,
            "useDataSource": true
        }
    ]
Go to specification

The engine resource [/restful-services/2.0/engines/{label}]

Parameters
label (Required, string )
the engine's label

Get the engine specified resource - GET /restful-services/2.0/engines/{label}

Response 200 (application/json)

Headers

Content-Type: application/json

Body

    {
        "biobjTypeId": 15,
        "className": "",
        "criptable": 0,
        "description": "Cockpit Engine",
        "dirUpload": null,
        "dirUsable": null,
        "driverName": "it.eng.spagobi.engines.drivers.cockpit.CockpitDriver",
        "engineTypeId": 55,
        "id": 25,
        "label": "SpagoBICockpitEngine",
        "name": "Cockpit Engine",
        "secondaryUrl": null,
        "url": "/SpagoBICockpitEngine/api/1.0/pages/execute",
        "useDataSet": false,
        "useDataSource": false
    }
Go to specification

Acknowledgements

The editors would like to express their gratitude to the following people who actively contributed to this specification: Monica Franceschini, Alessandro Daniele

References