Presentation admin API Resource

HDC Hierarchy returned in JSON data type Web Service.

POST /api/admin/presentation

Add presentation.

Example of request:

{"presentationName":"Test","presentationDescription":"Test Presentation","layerId":"2","typeId":1,"showSum":false,"countColumn":true,"spotAreaColumn":false,"summaryColumn":true,"summaryColumnLabel":"Custom label","summaryColumnSuffix":"Summary sufix"}

Request Body
media type data type description
application/json HdcPresentationModelTO (JSON) The specification of presentation that has to be added.
Response Body
media type data type description
application/json HdcBasicObjectIdOnlyTO (JSON) JSON Response with information, whether the adding has or has not been succeeded.

Example

Request
POST /api/admin/presentation
Content-Type: application/json
Accept: application/json

                
{ }
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{ }

GET /api/admin/presentation/json

Get list of presentations.

Response Body
media type data type description
application/json object (JSON) JSON Response with the list of presentations and filters.

Example of response:

{"list":[{"presentationId":"2","presentationName":"Area","presentationDescription":"Test presentation 2","isAutomatic":false},{"presentationId":"22","presentationName":"Functionality","presentationDescription":"","isAutomatic":false},]}

Example

Request
GET /api/admin/presentation/json
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
...

DELETE /api/admin/presentation/{presentationId}

Remove presentation

Request Parameters
name type description constraints
presentationId path ID of presentation long
Response Body
media type data type description
application/json HdcSuccessTO (JSON) JSON Response with information, whether the removing has or has not been succeeded.

Example

Request
DELETE /api/admin/presentation/{presentationId}
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{ }

PUT /api/admin/presentation/{presentationId}

Update presentation.

Example of request:

{"presentationName":"Test updated","presentationDescription":"Test Presentation updated","layerId":"2","typeId":1,"showSum":false,"countColumn":true,"spotAreaColumn":true,"summaryColumn":false}

Request Parameters
name type description constraints
presentationId path ID of presentation long
Request Body
media type data type description
application/json HdcPresentationModelTO (JSON) The specification of presentation that has to be updated.
Response Body
media type data type description
application/json HdcSuccessTO (JSON) JSON Response with information, whether the updating has or has not been succeeded.

Example

Request
PUT /api/admin/presentation/{presentationId}
Content-Type: application/json
Accept: application/json

                
{ }
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{ }

DELETE /api/admin/presentation/filter/{filterId}

Remove filter

Request Parameters
name type description constraints
filterId path ID of filter long
Response Body
media type data type description
application/json HdcSuccessTO (JSON) JSON Response with information, whether the removing has or has not been succeeded.

Example

Request
DELETE /api/admin/presentation/filter/{filterId}
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{ }

POST /api/admin/presentation/filter/{presentationId}

Add presentation filter.

Example of request:

{"label":"Test filter","targetClass":"108","summaryField":"fi2space_areanta","toolset":{"id":730},"hql":"fi2space_areabra > 10","sourceClass":"128","perspectiveSetId":"928"}

Request Parameters
name type description constraints
presentationId path long
Request Body
media type data type description
application/json HdcFilterModelTO (JSON) The specification of filter that has to be added.
Response Body
media type data type description
application/json HdcSuccessWithId (JSON) JSON Response with information, whether the adding has or has not been succeeded.

Example

Request
POST /api/admin/presentation/filter/{presentationId}
Content-Type: application/json
Accept: application/json

                
{ }
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{ }

PUT /api/admin/presentation/filter/{presentationId}/{filterId}

Update filter.

Example of request:

{"label":"Test Filter","targetClass":"108","summaryField":"cq_window_area","toolset":{"id":"730"},"hql":"fi2space_areabra >= 10","perspectiveSetId":""}

Request Parameters
name type description constraints
filterId path ID of filter long
presentationId path ID of presentation long
Request Body
media type data type description
application/json HdcFilterModelTO (JSON) The specification of filter that has to be updated.
Response Body
media type data type description
application/json HdcSuccessTO (JSON) JSON Response with information, whether the updating has or has not been succeeded.

Example

Request
PUT /api/admin/presentation/filter/{presentationId}/{filterId}
Content-Type: application/json
Accept: application/json

                
{ }
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{ }

GET /api/admin/presentation/filters/json/{presentationId}

Request Parameters
name type description constraints
presentationId path long
Response Body
media type data type description
application/json object (JSON)

Example

Request
GET /api/admin/presentation/filters/json/{presentationId}
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
...