Config (perspective) admin API Resource

WS for handling perspective sets, perspectives and perspective members in context of specified system configuration draft.

POST /api/admin/config/perspectiveset/{configurationId}

Add new perspective set in specified system configuration draft.

Example of request:

{"name":"name of the set","description":"description of the set"}

Request Parameters
name type description constraints
configurationId path System configuration draft identifier. long
Request Body
media type data type description
application/json HdcPerspectiveSetModelTO (JSON) The specification of group that has to be added.
Response Body
media type data type description
application/json HdcPerspectiveSetModelTO (JSON) JSON with id, name and description of created perspective set

{"id":"created set id","name":"name of the set","description":"description of the set"} *

Example

Request
POST /api/admin/config/perspectiveset/{configurationId}
Content-Type: application/json
Accept: application/json

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

                
{ }

GET /api/admin/config/perspectiveset/json/{configurationId}

Get perspective sets in given system configuration draft.

Request Parameters
name type description constraints
configurationId path System configuration draft identifier. long
Response Body
media type data type description
application/json array of HdcPerspectiveSetModelTO (JSON) JSON Response with perspectives

Example of response:

{"list":[{"id":"2","description":"Grid perspective set","name":"Grid"},{"id":"3","description":"Second version of grid perspective set","name":"Second grid"},{"id":"1","description":"Main hierarchy perspective set","name":"Main hierarchy"}]}

Example

Request
GET /api/admin/config/perspectiveset/json/{configurationId}
Content-Type: */*
Accept: application/json

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

                
[ { } ]

DELETE /api/admin/config/perspectiveset/{configurationId}/{setFormatId}

Remove perspective set for specified system configuration draft.

Request Parameters
name type description constraints
configurationId path System configuration draft identifier long
setFormatId path 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/config/perspectiveset/{configurationId}/{setFormatId}
Content-Type: */*
Accept: application/json

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

                
{ }

PUT /api/admin/config/perspectiveset/{configurationId}/{setFormatId}

Update perspective set in specified system configuration draft.

Example of request:

{"name":"name of the set","description":"description of the set"}

Request Parameters
name type description constraints
configurationId path long
setFormatId path long
Request Body
media type data type description
application/json HdcPerspectiveSetModelTO (JSON) The id of set 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/config/perspectiveset/{configurationId}/{setFormatId}
Content-Type: application/json
Accept: application/json

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

                
{ }

POST /api/admin/config/perspectiveset/members/remove/{configurationId}

Remove perspective member from perspective in specified system configuration draft.

Request Parameters
name type description constraints
configurationId path System configuration draft identifier long
Request Body
media type data type description
application/json string (JSON) list of perspective members id's to be deleted
Response Body
media type data type description
application/json object (JSON) JSON with information whether request was successful

Example

Request
POST /api/admin/config/perspectiveset/members/remove/{configurationId}
Content-Type: application/json
Accept: application/json

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

                
...

POST /api/admin/config/perspectiveset/members/update/{configurationId}

Update perspective member in specified system configuration draft.

Request Parameters
name type description constraints
configurationId path System configuration draft identifier long
Request Body
media type data type description
application/json string (JSON) list of perspective members to be updated
Response Body
media type data type description
application/json object (JSON) JSON with information whether request was successful

Example

Request
POST /api/admin/config/perspectiveset/members/update/{configurationId}
Content-Type: application/json
Accept: application/json

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

                
...

POST /api/admin/config/perspectiveset/relatives/remove/{configurationId}

Remove perspective from set in given system configuration draft. Please note that each perspective has unique id (we do not need to specify set to delete from).

Request Parameters
name type description constraints
configurationId path System configuration draft identifier long
Request Body
media type data type description
application/json string (JSON) id of perspectives to be deleted

Example of request:

{"list":[{"id":"4280"}]}
Response Body
media type data type description
application/json object (JSON) JSON with information whether request was successful

Example

Request
POST /api/admin/config/perspectiveset/relatives/remove/{configurationId}
Content-Type: application/json
Accept: application/json

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

                
...

POST /api/admin/config/perspectiveset/members/add/{configurationId}/{perspectiveId}

Add members (classes) to perspective in specified system configuration draft.

Request Parameters
name type description constraints
configurationId path System configuration draft identifier long
perspectiveId path The unique identifier of perspective long
Request Body
media type data type description
application/json string (JSON) id's of classes to be added as perspective members

Example of request:

{"list":[{"id":"11"},{"id":"12"}]}
Response Body
media type data type description
application/json object (JSON) JSON with information whether request was successful

Example

Request
POST /api/admin/config/perspectiveset/members/add/{configurationId}/{perspectiveId}
Content-Type: application/json
Accept: application/json

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

                
...

GET /api/admin/config/perspectiveset/members/json/{configurationId}/{perspectiveId}

Get members of specified perspective in specified system configuration draft.

Request Parameters
name type description constraints
configurationId path System configuration draft identifier long
perspectiveId path The unique identifier of perspective long
Response Body
media type data type description
application/json object (JSON) JSON Response with description of perspective

Example of response:

{"list":[{"classId":"10","classLabel":"Faciliteter"},{"classId":"11","classLabel":"Fastighet"},{"classId":"13","classLabel":"Plan"},{"classId":"12","classLabel":"Hus"}]}

Example

Request
GET /api/admin/config/perspectiveset/members/json/{configurationId}/{perspectiveId}
Content-Type: */*
Accept: application/json

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

                
...

GET /api/admin/config/perspectiveset/perspectives/json/{configurationId}/{perspectiveSetId}

Get perspectives from perspective set in given system configuration draft.

Request Parameters
name type description constraints
configurationId path System configuration draft identifier long
perspectiveSetId path The unique identifier of perspective long
Response Body
media type data type description
application/json object (JSON) JSON Response with description of perspective

Example of response:

{"list":[{"classId":"10","classLabel":"Faciliteter"},{"classId":"11","classLabel":"Fastighet"},{"classId":"13","classLabel":"Plan"},{"classId":"12","classLabel":"Hus"}]}

Example

Request
GET /api/admin/config/perspectiveset/perspectives/json/{configurationId}/{perspectiveSetId}
Content-Type: */*
Accept: application/json

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

                
...

POST /api/admin/config/perspectiveset/relatives/add/{configurationId}/{perspectiveSetId}

Add perspectives to set in specified system configuration draft.

Request Parameters
name type description constraints
configurationId path System configuration draft identifier long
perspectiveSetId path The unique identifier of perspective long
Request Body
media type data type description
application/json string (JSON) id of classes to be added to perspective set

Example of request:

{"list":[{"id":"14"},{"id":"11"}]}
Response Body
media type data type description
application/json object (JSON) JSON with information whether request was successful

Example

Request
POST /api/admin/config/perspectiveset/relatives/add/{configurationId}/{perspectiveSetId}
Content-Type: application/json
Accept: application/json

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

                
...