Intellicus supports REST calls for integrating Intellicus data and functions into an application. This section of document discusses the Intellicus integration architecture of REST APIs along with their use cases to perform CRUD operations and apply transformations on various Reporting use cases. These REST services enable you to log in, and then perform various Reporting activities in Intellicus.
REST stands for Representational State Transfer. It relies on a stateless, client-server, cacheable communications protocol — and in virtually all cases, the HTTP protocol is used.
RESTful applications use HTTP requests to post data (create and/or update), read data (e.g., make queries), and delete data.
Rest Integration Architecture
Response Code
The intellicus API attempts to return appropriate status codes for every request.
| Response Code | Response Message |
| 200 | OK |
| 503 | TIMEOUT OCCURED. LOGIN AGAIN. |
| 401 | UNAUTHORIZED ACCESS |
| 404 | RECORD NOT FOUND |
| 412 | PRECONDITION FAILED. PARAMETER MISSING |
| 500 | FAILED |
Accessing the REST API
We have created REST clients using JERSEY client APIs that we ship with Intellicus installer. To use those intellicus Restful APIs, we used below jersey jars :
- jersey-core.jar
- jersey-client.jar
- java-json.jar
URL
| URL | Action | Description |
| http://<host>:<port>/rest/login | POST | Login into Intellicus Report Server using this API. |
| http://<host>:<port>/rest/logout | GET | Logout from Intellicus Report Server using this API. |
| URL | Action | Description |
| http://<host>:<port>/rest/report | GET | List of all the reports. |
| http://<host>:<port>/rest/report/{reportId} | GET | Return the object of the report Id specified. |
| http://<host>:<port>/rest/report/categoryId/{categoryId} | GET | List of reports inside a category. |
| http://<host>:<port>/rest/report/saved/{reportId} | GET | List of saved report of the given report inside a category. |
| http://<host>:<port>/rest/report/{reportId} | DELETE | Delete the report specified by report Id. |
| URL | Action | Description |
| http://<host>:<port>/rest/reportObject | GET | List of all the report objects. |
| http://<host>:<port>/rest/reportObject/{reportObjectType} | GET | Return the object of the report Object specified. |
| http://<host>:<port>/rest/reportObject/category/{categoryName} | GET | List of all the report object inside a category. |
| http://<host>:<port>/rest/reportObject/report/{reportId} | GET | List of all the report object inside a report. |
| http://<host>:<port>/rest/reportObject/{reportObjectType} | DELETE | Delete the specified report. |
| URL | Action | Description |
| http://<host>:<port>/rest/olap | GET | List of all the dimensions in a cube. |
| http://<host>:<port>/rest/olap/buildStatus | GET | Return the status of the cube which is on build. |
| http://<host>:<port>/rest/olap/buildCube | PUT | |
| http://<host>:<port>/rest/olap/{cubename} | DELETE | Delete the specified cube object. |
| URL | Action | Description |
| http://<host>:<port>/rest/dashboard | GET | List of the dashboards. |
| http://<host>:<port>/rest/dashboard/dashboardpreference | GET | List of dashboards set in particular user preference. |
| http://<host>:<port>/rest/dashboard/categoryId/{categoryId} | GET | List of dashboards which are present inside a category. |
| http://<host>:<port>/rest/dashboard/{dashboardId} | GET | Return the object of the specified dashboard. |
| http://<host>:<port>/rest/dashboard/{dashboardId} | DELETE | Delete the specified dashboard. |
| URL | Action | Description |
| http://<host>:<port>/rest/dashboardWidget | GET | List of the dashboard Widgets. |
| http://<host>:<port>/rest/dashboardWidget /categoryId/{categoryId} | GET | List of dashboard Widgets which are present inside a category. |
| http://<host>:<port>/rest/dashboardWidget/{dashboardWidgetName} | GET | Return the object of the specified dashboard widget. |
| http://<host>:<port>/rest/dashboard/{dashboardWidgetName} | DELETE | Delete the specified dashboard widget. |
| URL | Action | Description |
| http://<host>:<port>/rest/dbConnection | GET | List of the DB connections |
| http://<host>:<port>/rest/dbConnection/{ connName} | GET | Return the object of the specified DB connection. |
| http://<host>:<port>/rest/dbConnection/{connName } | DELETE | Delete the specified DB connection. |
| http://<host>:<port>/rest/dbConnection/create | POST | Create a MYSQL/ORACLE connection using this API. |
| URL | Action | Description |
| http://<host>:<port>/rest/schedule | GET | List of the schedule. |
| http://<host>:<port>/rest/schedule/{scheduleId} | GET | Return the object of the specified schedule. |
| http://<host>:<port>/rest/schedule/{scheduleId} | DELETE | Delete the specified schedule. |
| URL | Action | Description |
| http://<host>:<port>/rest/scheduleJob | GET | List of the scheduleb Job. |
| http://<host>:<port>/rest/scheduleJob/{schdJobName} | GET | Return the object of the specified scheduled Job. |
| http://<host>:<port>/rest/scheduleJob/{schdJobName} | DELETE | Delete the specified scheduled Job. |
| URL | Action | Description |
| http://<host>:<port>/rest/task | GET | List of all the task.. |
| http://<host>:<port>/rest/task/{taskName} | GET | Return the object XML of the specified task. |
| http://<host>:<port>/rest/task/{taskName} | DELETE | Delete the specified task. |
| URL | Action | Description |
| http://<host>:<port>/rest/entities/copy | PUT | Copy entities from one category to another. |
| http://<host>:<port>/rest/entities/move | PUT | Move entities from one category to another. |
| http://<host>:<port>/rest/entities/delete | DELETE | Delete all the specified entities |
| URL | Action | Description |
| http://<host>:<port>/rest/reportExec/runReport | GET | Accessing the REST API |
Authentication
Login
This API is needed to authenticate a user. On successful authentication, this REST call returns with a session id that can be further used to request any other REST call.
Pattern
/rest/login
Method
POST
Request body
| content type* | application/x-www-form-urlencoded |
Parameters
| Name | Description | Type | Default |
| username* | User present in Intellicus Repository. The user must have the appropriate privileges configured for the actions he/she is going to take using the API calls. | formdata | None |
| password* | Password associated with the username. | formdata | None |
| organization* | The organization of the user to be authenticated | formdata | None |
| tokenTimeOut | Number of minutes of inactivity after which the login session will end. After this timeout login request has to be resent for any further request. | formdata | 30 |
| Accept* | Type of the response either JSON or XML.
(Application/xml or Application/Json) |
Request header
|
XML |
Example:
POST http://<IP>:<Port>/intellicus/rest/login
Post Paramters
username:John
password: abcd1234
organization: Intellica
tokenTimeOut: 20
Note: Users of organizations whose authentication type is Host Application cannot acess REST APIs.
API results with sessionid enclosed in a success tag, in case of successful authentication.
API results with an error message, in case of any error.
The sessionid attribute of this user should be passed in other APIs in subsequent requests for User Identification.
Note: Login will return a sessionid as a response.
Ex: <SUCCESS> New organization – Advanced tab </SUCCESS>, and this sessionid will be used in all the other REST API’s as a header parameter.
Setting sessionId
This session Id is the one that is established using the login call.
Header Paramter
Session- > a session in Intellicus on which this call will run.
Logout
This API is needed to logout from REST API access.
This call ends a session identified by the sessionid and expires that session. This session is the one that was established using the login call.
Pattern
/rest/logout
Method
GET
Parameters
| Name | Description | Type | Default |
| sessionid* | Session in Intellicus on which this call will run. | Request header | None |
| Accept* | Type of the response either JSON or XML.
(Application/xml or Application/Json) |
Request header
|
XML |
Example:
GET http://<IP>:<Port>/intellicus/rest/logout
API Result with Status #SUCCEEDED, if request was successful. API Result with Status #FAILED, if request had failed.
Dashboard
getDashboardList
This API is used to get the list of all Dashboards present in Intellicus Repository.
Pattern
/rest/dashboard
Method
GET
Parameters
| Name | Description | Type | Default |
| sessionid* | The sessionid in which user is working | Request header
|
None |
| Accept* | Type of the response either JSON or XML.
(Application/xml or Application/Json) |
Request header
|
XML |
Example:
GET http://<IP>:<Port>/intellicus/rest/dashboard
API Result with XML/JSON containing list of all the dashboards.
getDashboardObject
This API is used to get the object of the given Dashboard present in the Intellicus repository.
Pattern
/rest/dashboard/{dashboardId}
Method
GET
Parameters
| Name | Description | Type | Default |
| sessionid* | The sessionid in which user is working | Request header
|
None |
| dashboardId* | The ID of the dashboard whose object we want to get. | Path | None |
| Accept* | Type of the response either JSON or XML.
(Application/xml or Application/Json) |
Request header
|
XML |
Example:
GET http://<IP>:<Port>/intellicus/rest/dashboard/14345370998146127060052192759078
API Result with Status #SUCCEEDED, if request was successful. API Result with Status #FAILED, if request had failed.
getDashboardFromCategory
This API is used to get the list of Dashboard from the given category present in the Intellicus repository.
Pattern
/rest/dashboard/categoryId/{categoryId}
Method
GET
Parameters
| Name | Description | Type | Default |
| sessionid* | The sessionid in which user is working | Request header
|
None |
| categoryId* | The ID of the category whose dashboard list we want to get. | QueryParam | None |
| Accept* | Type of the response either JSON or XML.
(Application/xml or Application/Json) |
Request header
|
XML |
Example:
GET http://<IP>:<Port>/intellicus/rest/dashboard/categoryId/ 571937DE-9934-90CB-FFD0-371470A44B7E
API Result with Status #SUCCEEDED, if request was successful. API Result with Status #FAILED, if request had failed.
getDashboardPreference
This API is used to get the list of the Dashboards set in its Preferences.
Pattern
/rest/dashboard/dashboardpreference
Method
GET
Parameters
| Name | Description | Type | Default |
| sessionid* | The sessionid in which user is working
|
Request header | None |
| Accept* | Type of the response either JSON or XML.
(Application/xml or Application/Json) |
Request header
|
XML |
Example:
GET http://<IP>:<Port>/intellicus/rest/dashboard/dashboardpreference
API Result with XML/JSON containing list of the dashboards set in its preferences.
deleteDashboard
This API is used to delete an existing dashboard from the Intellicus repository.
Pattern
/rest/dashboard/{dashboardId}
Method
DELETE
Request body
| content type* | application/x-www-form-urlencoded |
Parameters
| Name | Description | Type | Default |
| Sessionid* | The sessionid in which user is working | Request header
|
None |
| dashboardId* | The ID of the dashboard which is to be deleted. | Path | None |
| Accept* | Type of the response either JSON or XML.
(Application/xml or Application/Json) |
Request header
|
XML |
Example:
DELETE http://<IP>:<Port>/intellicus/rest/dashboard/14345370998146127060052192759078
API Result with Status #SUCCEEDED, if request was successful. API Result with Status #FAILED, if request had failed.
Dashboard Widget
getDashboardWidgetList
This API is used to get the list of all Dashboards widgets present in Intellicus Repository.
Pattern
/rest/dashboardWidget
Method
GET
Parameters
| Name | Description | Type | Default |
| sessionid* | The sessionid in which user is working | Request header
|
None |
| Accept* | Type of the response either JSON or XML.
(Application/xml or Application/Json) |
Request header
|
XML |
Example:
GET http://<IP>:<Port>/intellicus/rest/dashboardWidget
API Result with XML/JSON containing list of all the dashboards widgets.
getDashboardWidgetInCategory
This API is used to list the dashboard widgets present in specified category in the Intellicus repository.
Pattern
/rest/dashboardWidget/ categoryId /{categoryId}
Method
GET
Parameters
| Name | Description | Type | Default |
| sessionid* | The sessionid in which user is working | Request header
|
None |
| categoryId* | The ID of the category whose dashboard widget list we want to get. | Path | None |
| Accept* | Type of the response either JSON or XML.
(Application/xml or Application/Json) |
Request header
|
XML |
Example:
GET http://<IP>:<Port>/intellicus/rest/dashboardWidget/categoryId/571937DE-9934-90CB-FFD0-371470A44B7E
API Result with Status #SUCCEEDED, if request was successful. API Result with Status #FAILED, if request had failed.
Report
getALLReportList
This API is used to get the list of all reports present in Intellicus Repository.
Pattern
/rest/report?show=[“STUDIO”]||[“ADHOC”]|[“OLAP”]
Method
GET
Parameters
| Name | Description | Type | Default |
| sessionid* | The sessionid in which user is working | Request header
|
None |
| show* | This can take the following value-
All: all reports STUDIO: only standard report list will be shown ADHOC: only ADHOC report list will be shown OLAP: only OLAP report list will be shown |
QueryParam | NONE |
| Accept* | Type of the response either JSON or XML.
(Application/xml or Application/Json) |
Request header
|
XML |
Example:
GET http://<IP>:<Port>/intellicus/rest/report/?show=OLAP
API Result with XML/JSON containing list of the reports.
getReportListForCategory
This API is used to get the list of all reports present in a particular category Intellicus Repository.
Pattern
/rest/report/categoryId/{categoryId}
Method
GET
Parameters
| Name | Description | Type | Default |
| sessionid* | The sessionid in which user is working | Request header
|
None |
| categoryId* | Id of the category of which report list is needed. | path | NONE |
| show* | This can take the following value-
All: all reports STUDIO: only standard report list will be shown ADHOC: only ADHOC report list will be shown OLAP: only OLAP report list will be shown |
QueryParam | NONE |
| Accept* | Type of the response either JSON or XML.
(Application/xml or Application/Json) |
Request header
|
XML |
Example:
GET http://<IP>:<Port>/intellicus/rest/report/categoryId/571937DE-9934-90CB-FFD0-371470A44B7E
API Result with XML/JSON containing list of the reports in the given category.
getReportObject
This API is used to get the object of the report present in the Intellicus repository.
Pattern
/rest/report/{reportId}
Method
GET
Parameters
| Name | Description | Type | Default |
| sessionid* | The sessionid in which user is working | Request header
|
None |
| reportId* | The ID of the report whose object we want to get. | Path | None |
| Accept* | Type of the response either JSON or XML.
(Application/xml or Application/Json) |
Request header
|
XML |
Example:
GET http://<IP>:<Port>/intellicus/rest/report/571937D993490CBFFD371470A44B7E
API Result with Status #SUCCEEDED, if request was successful. API Result with Status #FAILED, if request had failed. The XML contains System privileges and access rights. Details of System privileges and access rights are present in Appendix-2.
GetSavedReportList
This Java API is used to get the list of Saved Reports in a particular Report.
/rest/report/saved/{reportId}
Method
GET
Parameters
| Name | Description | Type | Default |
| sessionid* | The sessionid in which user is working | Request header
|
None |
| reportId* | Id of the report of which saved report list is needed. | path | NONE |
| Accept* | Type of the response either JSON or XML.
(Application/xml or Application/Json) |
Request header
|
XML |
Example:
GET http://<IP>:<Port>/intellicus/rest/report/saved/571937DE993490CBFFD371470A44B7E
API Result with XML/JSON containing list of the saved reports in the given report id.
deleteReport
This API is used to delete an existing report from the Intellicus repository.
Pattern
/rest/report/{reportId}
Method
DELETE
Request body
| content type* | application/x-www-form-urlencoded |
Parameters
| Name | Description | Type | Default |
| sessionid* | The sessionid in which user is working | Request header
|
None |
| reportId* | The ID of the report which is to be deleted. | Path | None |
| Accept* | Type of the response either JSON or XML.
(Application/xml or Application/Json) |
Request header
|
XML |
Example:
DELETE http://<IP>:<Port>/intellicus/rest/report/ 9D5BD0C3-99B8-8ACE-8FE5-724131D79124
API Result with Status #SUCCEEDED, if request was successful. API Result with Status #FAILED, if request had failed.
Database Connection Management
dbConnection/create
This API is used to create a Db connection of MySql/Oracle
Pattern
/rest/dbConnection/create
Method
POST
Request body
| content type* | application/x-www-form-urlencoded |
Parameters
| Name | Description | Type | Default |
| sessionid* | The sessionid in which user is working | Request header
|
None |
| Accept* | Type of the response either JSON or XML. (Application/xml or Application/Json) | Request header | XML |
| connectionName* | Name of the connection to be created | Formdata | None |
| serverIp* | serverIp of database server | Formdata | None |
| port* | Port of database server | Formdata | None |
| SID* | Database name | Formdata | None |
| driverVersion* | Version of the driver | Formdata | None |
| userId* | Database username | Formdata | None |
| password* | Database user password | Formdata | None |
| driverProvider* | driverProvider | Formdata | None |
getDBConnection
This API is used to get the list of all database connections present in Intellicus Repository.
Pattern
/rest/dbConnection
Method
GET
Parameters
| Name | Description | Type | Default |
| sessionid* | The sessionid in which user is working | Request header | None |
| Accept* | Type of the response either JSON or XML.
(Application/xml or Application/Json) |
Request header
|
XML |
Example:
GET http://<IP>:<Port>/intellicus/rest/dbConnection
API Result with XML/JSON containing list of the connections.
getConnectionObject
This API is used to get the object of the given connection present in the Intellicus repository.
Pattern
/rest/dbConnection/{connName}
Method
GET
Parameters
| Name | Description | Type | Default |
| sessionid* | The sessionid in which user is working | Request header
|
None |
| connName* | The name of the connection whose object we want to get. | Path | None |
| Accept* | Type of the response either JSON or XML.
(Application/xml or Application/Json) |
Request header
|
XML |
Example:
GET http://<IP>:<Port>/intellicus/rest/dbConnection/demoDB
API Result with Status #SUCCEEDED, if request was successful. API Result with Status #FAILED, if request had failed.
deleteConnection
This API is used to delete an existing connection from the Intellicus repository.
Pattern
/rest/dbConnection/{ connName }
Method
DELETE
Request body
| content type* | application/x-www-form-urlencoded |
Parameters
| Name | Description | Type | Default |
| sessionid* | The sessionid in which user is working | Request header
|
None |
| connName* | The Name of the connection which is to be deleted. | Path | None |
| Accept* | Type of the response either JSON or XML.
(Application/xml or Application/Json) |
Request header
|
XML |
Example:
DELETE http://<IP>:<Port>/intellicus/rest/dbConnection/DemoDB
API Result with Status #SUCCEEDED, if request was successful. API Result with Status #FAILED, if request had failed.
Report Object
getReportObjectList
This API is used to get the list of all report objects present in Intellicus Repository.
Pattern
/rest/reportObject?type=[“query”]||[“parameter”]||[“cube”]
Method
GET
Parameters
| Name | Description | Type | Default |
| sessionid* | The sessionid in which user is working | Request header
|
None |
| type* | This can take the following value-
QUERY: for query objects PARAMETER: for parameter objects CUBE: for cube objects |
QueryParam | NONE |
| Accept* | Type of the response either JSON or XML.
(Application/xml or Application/Json) |
Request header
|
XML |
Example:
GET http://<IP>:<Port>/intellicus/rest/reportObject?type=CUBE
API Result with XML/JSON containing list of the report objects.
getReportObjectListForCategory
This API is used to get the list of all report objects present in a particular category in Intellicus Repository.
Pattern
/rest/reportObject/category/{categoryId}
Method
GET
Parameters
| Name | Description | Type | Default |
| sessionid* | The sessionid in which user is working | Request header
|
None |
| categoryId* | Id of the category of which report object list is needed. | Path param | NONE |
| Accept* | Type of the response either JSON or XML.
(Application/xml or Application/Json) |
Request header
|
XML |
Example:
GET http://<IP>:<Port>/intellicus/rest/reportObject/category/571937DE-9934-90CB-FFD0-371470A44B7E
API Result with XML/JSON containing list of the report objects in the given category.
getObjectofReportObject
This API is used to get the object of the report object present in the Intellicus repository.
Pattern
/rest/reportObject/{reportObjectType}
Method
GET
Parameters
| Name | Description | Type | Default |
| sessionid* | The sessionid in which user is working | Request header
|
None |
| reportObjectType* | The type of the report object which is to be deleted. | Path | None |
| reportObjectname* | The name of the report object which is to be deleted. | QueryParam | None |
| Accept* | Type of the response either JSON or XML.
(Application/xml or Application/Json) |
Request header
|
XML |
Example:
GET http://<IP>:<Port>/intellicus/rest/reportObject/QUERY?reportObjectname=QO_Name
API Result with state Status #SUCCEEDED, if request was successful. API Result with state Status #FAILED, if request had failed.
deleteReportObject
This API is used to delete an existing report object from the Intellicus repository.
Pattern
/rest/reportObject/{reportObjectType}
Method
DELETE
Request body
| content type* | application/x-www-form-urlencoded |
Parameters
| Name | Description | Type | Default |
| sessionid* | The sessionid in which user is working | Request header
|
None |
| reportObjectType* | The type of the report object which is to be deleted. | Path | None |
| reportObjectname* | The name of the report object which is to be deleted. | QueryParam | None |
| Accept* | Type of the response either JSON or XML.
(Application/xml or Application/Json) |
Request header
|
XML |
Example:
DELETE http://<IP>:<Port>/intellicus/rest/reportObject/QUERY?reportObjectname=QO_Name
API Result with Status #SUCCEEDED, if request was successful. API Result with Status #FAILED, if request had failed.
Schedule
getScheduleList
This API is used to get the list of all report objects present in Intellicus Repository.
Pattern
/rest/schedule
Method
GET
Parameters
| Name | Description | Type | Default |
| sessionid* | The sessionid in which user is working | Request header
|
None |
| Accept* | Type of the response either JSON or XML.
(Application/xml or Application/Json) |
Request header
|
XML |
Example:
Get http://<IP>:<Port>/intellicus/rest/schedule
API Result with XML/JSON containing list of the schedule.
getScheduleObject
This API is used to get the object of the schedule present in the Intellicus repository.
Pattern
/rest/schedule/scheduleName
Method
GET
Parameters
| Name | Description | Type | Default |
| sessionid* | The sessionid in which user is working | Request header
|
None |
| scheduleName* | The name of the schedule whose object we want to get. | Path | None |
| Accept* | Type of the response either JSON or XML.
(Application/xml or Application/Json) |
Request header
|
XML |
Example:
GET http://<IP>:<Port>/intellicus/rest/schedule/TestSchedule
API Result with Status #SUCCEEDED, if request was successful. API Result with Status #FAILED, if request had failed.
deleteSchedule
This API is used to delete an existing schedule from the Intellicus repository.
Pattern
/rest/schedule/{scheduleName}
Method
DELETE
Request body
| content type* | application/x-www-form-urlencoded |
Parameters
| Name | Description | Type | Default |
| sessionid* | The sessionid in which user is working | Request header
|
None |
| scheduleName* | The name of the schedule which is to be deleted. | Path | None |
| Accept* | Type of the response either JSON or XML.
(Application/xml or Application/Json) |
Request header
|
XML |
Example:
DELETE http://<IP>:<Port>/intellicus/rest/schedule/TestSchedule
API Result with Status #SUCCEEDED, if request was successful. API Result with Status #FAILED, if request had failed.
Task
getTaskList
This API is used to get the list of all tasks present in Intellicus Repository.
Pattern
/rest/task
Method
GET
Parameters
| Name | Description | Type | Default |
| sessionid* | The sessionid in which user is working | Request header
|
None |
| Accept* | Type of the response either JSON or XML.
(Application/xml or Application/Json) |
Request header
|
XML |
Example:
GET http://<IP>:<Port>/intellicus/rest/task
API Result with XML/JSON containing list of the task.
getTaskObject
This API is used to get the object of a task present in the Intellicus repository.
Pattern
/rest/task/{taskName}
Method
GET
Parameters
| Name | Description | Type | Default |
| sessionid* | The sessionid in which user is working | Request header | None |
| taskName* | The name of the task whose object we want to get. | Path | None |
| Accept* | Type of the response either JSON or XML.
(Application/xml or Application/Json) |
Request header
|
XML |
Example:
GET http://<IP>:<Port>/intellicus/rest/task/TestTask
API Result with state Status #SUCCEEDED, if request was successful. API Result with state Status #FAILED, if request had failed.
deleteTask
This API is used to delete an existing task from the Intellicus repository.
Pattern
/rest/task/{taskName}
Method
DELETE
Request body
| content type | application/x-www-form-urlencoded |
Parameters
| Name | Description | Type | Default |
| sessionid* | The sessionid in which user is working | Request header
|
None |
| taskName* | The name of the task which is to be deleted. | Path | None |
| Accept* | Type of the response either JSON or XML.
(Application/xml or Application/Json) |
Request header
|
XML |
Example:
DELETE http://<IP>:<Port>/intellicus/rest/task/TestTask
API Result with Status #SUCCEEDED, if request was successful. API Result with Status #FAILED, if request had failed.
Schedule Job
getScheduleJobList
This API is used to get the list of all scheduled job present in Intellicus Repository.
Pattern
/rest/scheduleJob
Method
GET
Parameters
| Name | Description | Type | Default |
| sessionid* | The sessionid in which user is working | Request header | None |
| Accept* | Type of the response either JSON or XML.
(Application/xml or Application/Json) |
Request header
|
XML |
Example:
GET http://<IP>:<Port>/intellicus/rest/scheduleJob
API Result with XML/JSON containing list of the scheduled job.
getScheduleJobObject
This API is used to get the object of a scheduledJob present in the Intellicus repository.
Pattern
/rest/scheduleJob/{scheduleJobName}
Method
GET
Parameters
| Name | Description | Type | Default |
| sessionid* | The sessionid in which user is working | Request header | None |
| scheduleJobName* | The name of the scheduledJob whose object we want to get. | Path | None |
| Accept* | Type of the response either JSON or XML.
(Application/xml or Application/Json) |
Request header
|
XML |
Example:
GET http://<IP>:<Port>/intellicus/rest/scheduleJob/TestJob
API Result with Status #SUCCEEDED, if request was successful. API Result with Status #FAILED, if request had failed.
deleteScheduleJob
This API is used to delete an existing scheduled job from the Intellicus repository.
Pattern
/rest/scheduleJob/scheduleJobName
Method
DELETE
Parameters
| Name | Description | Type | Default |
| sessionid* | The sessionid in which user is working | Request header
|
None |
| scheduleJobName* | The name of the scheduled job which is to be deleted. | Path | None |
| Accept* | Type of the response either JSON or XML.
(Application/xml or Application/Json) |
Request header
|
XML |
Example:
DELETE http://<IP>:<Port>/intellicus/rest/scheduleJob/TestJob
API Result with Status #SUCCEEDED, if request was successful. API Result with Status #FAILED, if request had failed.
Entities
copyEntities
This API is used to copy entity present in Intellicus Repository.
Pattern
/rest/entities/copy
Method
PUT
Parameters
| Name | Description | Type | Default |
| sessionid* | The sessionid in which user is working | Request header
|
None |
| entityType* | Type of entity you want to copy. (Example: QUERY, PARAMETER, ANALYTICAL) | queryParam | None |
| entityIds* | Id of the given type of entity. (Ids should be comma seperated) | queryParam | None |
| destCategoryId* | Id of the destination category, where entities will be moved. | queryParam | None |
| Accept* | Type of the response either JSON or XML.
(Application/xml or Application/Json) |
Request header
|
XML |
Example:
PUT http://<IP>:<Port>/intellicus/rest/entities/copy?entityIds= 12603516809689203129192914431493,218491B2-DF5A-A4DB-8829-B1E2F7F15C0C,13874593138006172260434555452223,12591419101541192168102272352078&entitiType=QUERY&destCategoryId= 571937DE-9934-90CB-FFD0-371470A44B7E
API Result with Status #SUCCEEDED, if request was successful. API Result with Status #FAILED, if request had failed.
moveEntities
This API is used to move entity present in Intellicus Repository.
Pattern
/rest/entities/move
Method
PUT
Parameters
| Name | Description | Type | Default |
| sessionid* | The sessionid in which user is working | Request header
|
None |
| entityType* | Type of entity you want to copy. (Example: QUERY, PARAMETER, ANALYTICAL) | queryParam | None |
| entityIds* | Id of the given type of entity. (Ids should be comma seperated) | queryParam | None |
| destCategoryId | Id of the destination category, where entities will be moved. | queryParam | None |
| Accept* | Type of the response either JSON or XML.
(Application/xml or Application/Json) |
Request header
|
XML |
Example:
PUT http://<IP>:<Port>/intellicus/rest/entities/move?entityIds= 12603516809689203129192914431493,218491B2-DF5A-A4DB-8829-B1E2F7F15C0C,13874593138006172260434555452223,12591419101541192168102272352078&entitiType=PARAMETER&destCategoryId= 571937DE-9934-90CB-FFD0-371470A44B7E
API Result with Status #SUCCEEDED, if request was successful. API Result with Status #FAILED, if request had failed.
deleteEntities
This API is used to delete entity present in Intellicus Repository.
Pattern
/rest/entities/delete
Method
DELETE
Request body
| content type* | application/x-www-form-urlencoded |
Parameters
| Name | Description | Type | Default |
| sessionid* | The sessionid in which user is working | Request header
|
None |
| entityType* | Type of entity you want to copy. (Example: QUERY, PARAMETER, ANALYTICAL) | queryParam | None |
| entityIds* | Id of the given type of entity. (Ids should be comma seperated) | queryParam | None |
| Accept* | Type of the response either JSON or XML.
(Application/xml or Application/Json) |
Request header
|
XML |
Example:
DELETE http://<IP>:<Port>/intellicus/rest/entities/delete?entityIds= 12603516809689203129192914431493,218491B2-DF5A-A4DB-8829-B1E2F7F15C0C,13874593138006172260434555452223,12591419101541192168102272352078&entitiType=QUERY
API Result with state Status #SUCCEEDED, if request was successful. API Result with state Status #FAILED, if request had failed.
OLAP
getDimensionList
This API is used to get dimension list of a cube from Intellicus Repository.
Pattern
/rest/olap
Method
GET
Parameters
| Name | Description | Type | Default |
| sessionid* | The sessionid in which user is working | Request header
|
None |
| cubeName* | Name of the cube | queryParam | None |
| Accept* | Type of the response either JSON or XML.
(Application/xml or Application/Json) |
Request header
|
XML |
Example:
GET http://<IP>:<Port>/intellicus/rest/olap?cubeName=TestCube
API Result with XML/JSON containing list of the dimensios in the cube.
getMeasureList
This API is used to get measure list of a cube from Intellicus Repository.
Pattern
/rest/olap/Measure
Method
GET
Parameters
| Name | Description | Type | Default |
| sessionid* | The sessionid in which user is working | Request header
|
None |
| cubeName* | Name of the cube | queryParam | None |
| Accept* | Type of the response either JSON or XML.
(Application/xml or Application/Json) |
Request header
|
XML |
Example:
GET http://<IP>:<Port>/intellicus/rest/olap/Measure?cubeName=TestCube
API Result with XML/JSON containing list of the measures in the cube.
getOlapData
This API is used to get olap data of a cube from Intellicus Repository.
Pattern
/rest/olap/olapData
Method
GET
Parameters
| Name | Description | Type | Default |
| sessionid* | The sessionid in which user is working | Request header
|
None |
| cubeName* | Name of the cube | queryParam | None |
| cubeId
|
Id of the cube. | queryParam | None |
| Measure | Measure name in the cube.In case of multiple measures, measure name should be comma separated. Example:- order_no,income | queryParam | None |
| rowLevelDimension | Dimension to be on row level. In case of multiple Dimensions, Dimension name should be comma separated. | queryParam | None |
| columnLevelDimension | Dimension to be on column level. . In case of multiple Dimensions, Dimension name should be comma separated. | queryParam | None |
| filterName | Filter list should be in the format:
DimensionName::LevelName::comma seperatedvalue. Example:-Insured::Country::Australia,Africa |
queryParam | None |
| Accept* | Type of the response either JSON or XML.
(Application/xml or Application/Json) |
Request header
|
XML |
Example:
GET http://<IP>:<Port>/intellicus/rest/olap/olapData?cubeName=AssetMgmt-Insurance&cubeId=CUBE_OBJECT_13418448596848127031012183580027&Measure=TotaIIncome&rowLevelDimension=PolicyType&columnLevelDimension=PolicyName&filterName=Agency::Agency Name::’Chubb & Son’,’Cumberland Mutual Fire Insurance’,’Fitchburg Mutual’~~Insured::Country::’Australia’
API Result with XML/JSON containing desired result.
BuildCube
This API is used to build a cube in Intellicus Repository.
Pattern
/rest/olap
Method
PUT
Parameters
| Name | Description | Type | Default |
| sessionid* | The sessionid in which user is working | Request header | None |
| cubeId* | Id of the cube | queryParam | None |
| cubeName* | Name of the cube | queryParam | None |
| Accept* | Type of the response either JSON or XML.
(Application/xml or Application/Json) |
Request header
|
XML |
Example:
PUT http://<IP>:<Port>/intellicus/rest/olap?cubeId= cube120245&cubeName= TestCube
API Result with state Status #SUCCEEDED, if request was successful. API Result with state Status #FAILED, if request had failed.
getbuildStatus
This API is to get build status of the cube from Intellicus Repository.
Pattern
/rest/olap/buildStatus
Method
GET
Parameters
| Name | Description | Type | Default |
| sessionid* | The sessionid in which user is working | Request header | None |
| cubeId* | Id of the cube | QueryParam | None |
| Accept* | Type of the response either JSON or XML.
(Application/xml or Application/Json) |
Request header
|
XML |
Example:
GET http://<IP>:<Port>/intellicus/rest/olap?cubeId=TestCube
API Result with XML/JSON containing build status.
DeleteCube
This API is used to delete a cube in Intellicus Repository.
Pattern
/rest/olap/{cubeName}
Method
DELETE
Request body
| content type | application/x-www-form-urlencoded |
Parameters
| Name | Description | Type | Default |
| sessionid* | The sessionid in which user is working | Request header | None |
| cubeName* | Name of the cube | queryParam | None |
| Accept* | Type of the response either JSON or XML.
(Application/xml or Application/Json) |
Request header
|
XML |
Example:
DELETE http://<IP>:<Port>/intellicus/rest/olap?cubeName= TestCube
API Result with state Status #SUCCEEDED, if request was successful. API Result with state Status #FAILED, if request had failed.
Report Execution
RunReport
This API is used to run report in a particular format from Intellicus Repository.
Pattern
/rest/reportExec/runReport
Method
GET
Parameters
| Name | Description | Type | Default |
| sessionid* | The sessionid in which user is working | Request header | None |
| reportId* | Id of the report | queryParam | None |
| reportFormat* | Format of the report | queryParam | None |
| Accept* | Type of the response either JSON or XML.
(Application/xml or Application/Json) |
Request header
|
XML |
Example:
GET http://<IP>:<Port>/intellicus/rest/reportExec/runReport?reportId=C76816F4-CA91-E6C0-C90F26C53EC542C&reportFormat=PDF
API Result with state Status #SUCCEEDED, if request was successful. API Result with state Status #FAILED, if request had failed.