Perspective API Resource

HDC filters for tesselet Web Service.

GET /api/filters/grid/json

Get all filters for specified user.

Response Body
media type data type description
application/json array of HdcUserFilterTO (JSON) JSON Response with filter data

Example of response:

Example

Request
GET /api/filters/grid/json
Content-Type: */*
Accept: application/json

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

                
[ {
  "classId" : 12345,
  "name" : "...",
  "userId" : 12345,
  "isDefault" : true,
  "ownerFullName" : "...",
  "filterId" : 12345,
  "filterData" : "...",
  "isOwner" : true
} ]

POST /api/filters/grid/json

add new filter for user

Request Body
media type data type description
application/json HdcUserFilterTO (JSON) - grid filter data
Response Body
media type data type description
application/json HdcUserFilterTO (JSON) JSON Response with description of filter with unique ID

Example

Request
POST /api/filters/grid/json
Content-Type: application/json
Accept: application/json

                
{
  "classId" : 12345,
  "name" : "...",
  "userId" : 12345,
  "isDefault" : true,
  "ownerFullName" : "...",
  "filterId" : 12345,
  "filterData" : "...",
  "isOwner" : true
}
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "classId" : 12345,
  "name" : "...",
  "userId" : 12345,
  "isDefault" : true,
  "ownerFullName" : "...",
  "filterId" : 12345,
  "filterData" : "...",
  "isOwner" : true
}

POST /api/perspective/entityarea/xls

Get Area compare report for Layer

Request Body
media type data type description
application/json HdcPolygonAreaCheck4ObjectListRequest (JSON) - input data
Response Body
media type data type description
application/json HdcPathProcessStateTO (JSON) json response with information about started process

Example

Request
POST /api/perspective/entityarea/xls
Content-Type: application/json
Accept: application/json

                
{
  "objects" : [ { }, { } ],
  "serverFilePrefix" : "...",
  "pagingLimit" : 12345,
  "contextObject" : { },
  "layerId" : 12345,
  "pagingOffset" : 12345,
  "sortField" : {
    "second" : true,
    "value0" : "...",
    "value1" : true,
    "first" : "..."
  },
  "params" : {
    "userId" : 12345,
    "vectorId2CompUnits" : {
      "property1" : "Yard",
      "property2" : "Inch"
    },
    "precision" : 12345,
    "fieldId" : "...",
    "vectorId2VectorUnits" : {
      "property1" : "Cm",
      "property2" : "Cm"
    },
    "classLabel" : "...",
    "versionId" : 12345,
    "classId" : 12345
  },
  "vectorId" : 12345
}
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{ }

GET /api/perspective/json/{perspectiveId}

Get hierarchy in the given perspective - using configured root object.

Request Parameters
name type description default constraints
perspectiveId path The unique identifier of perspective.   long
status query If set to true - status mode is activated. false boolean
Response Body
media type data type description
application/json object (JSON) JSON Response with the list of children of the root object in the given perspective.

Example of response:

{"children":[{"hasChildren":true,"metadata":{},"contentType":0,"contentId":0,"objectName":"7101 XXX 2","objectId":"90","classId":"11", "securityMask":"3"},{"hasChildren":true,"metadata":{},"contentType":0,"contentId":0,"objectName":"7102 - Bottenstocken 13","objectId":"91","classId":"11", "securityMask":"3"},{"hasChildren":true,"metadata":{},"contentType":0,"contentId":0,"objectName":"7103 - Bygeln 1","objectId":"92","classId":"11", "securityMask":"3"},{"hasChildren":true,"metadata":{},"contentType":0,"contentId":0,"objectName":"7104 - Bygeln 5bb","objectId":"93","classId":"11", "securityMask":"3"}],"hasChildren":true,"metadata":{},"contentType":0,"contentId":0,"objectName":"Root","objectId":"0","classId":"10", "securityMask":"3"}

Example

Request
GET /api/perspective/json/{perspectiveId}
Content-Type: */*
Accept: application/json

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

                
...

GET /api/perspective/set/json

Get perspective sets for active configuration.

Response Body
media type data type description
application/json object (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/perspective/set/json
Content-Type: */*
Accept: application/json

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

                
...

POST /api/filters/grid/assign/{filterId}

Assign user to filter

Request Parameters
name type description constraints
filterId path Id of filter long
Request Body
media type data type
application/json string (JSON)
Response Body
media type data type description
application/json HdcSuccessTO (JSON) JSON Response with information if operation succeeded

Example

Request
POST /api/filters/grid/assign/{filterId}
Content-Type: application/json
Accept: application/json

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

                
{ }

GET /api/filters/grid/byid/{filterId}

Get filter by id.

Request Parameters
name type description constraints
filterId path The unique identifier of filter long
Response Body
media type data type description
application/json HdcUserFilterTO (JSON) JSON Response with filter data

Example of response:

Example

Request
GET /api/filters/grid/byid/{filterId}
Content-Type: */*
Accept: application/json

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

                
{
  "classId" : 12345,
  "name" : "...",
  "userId" : 12345,
  "isDefault" : true,
  "ownerFullName" : "...",
  "filterId" : 12345,
  "filterData" : "...",
  "isOwner" : true
}

DELETE /api/filters/grid/json/{filterId}

delete user 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 if operation succeeded

Example

Request
DELETE /api/filters/grid/json/{filterId}
Content-Type: */*
Accept: application/json

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

                
{ }

GET /api/filters/grid/json/{userId}

Get all filters for specified user.

Request Parameters
name type description constraints
userId path The unique identifier of user long
Response Body
media type data type description
application/json array of HdcUserFilterTO (JSON) JSON Response with filter data

Example of response:

Example

Request
GET /api/filters/grid/json/{userId}
Content-Type: */*
Accept: application/json

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

                
[ {
  "classId" : 12345,
  "name" : "...",
  "userId" : 12345,
  "isDefault" : true,
  "ownerFullName" : "...",
  "filterId" : 12345,
  "filterData" : "...",
  "isOwner" : true
} ]

GET /api/filters/grid/members/{filterId}

Get shared users/groups for filter utilized in gridview tesslet

Request Parameters
name type description constraints
filterId path id of filter utilized in gridview tesslet long
mode query Values can be users or groups  
Response Body
media type data type description
application/json object (JSON) JSON response with advanced search queries

Example of response:

{"list":[{"id":7129,"name":"user123","userFullName":"user123","enabled":false,"email":"user123@tessel.pl"}]}

Example

Request
GET /api/filters/grid/members/{filterId}
Content-Type: */*
Accept: application/json

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

                
...

POST /api/filters/grid/unassign/{filterId}

Unassign user to filter

Request Parameters
name type description constraints
filterId path Id of filter long
Request Body
media type data type
application/json string (JSON)
Response Body
media type data type description
application/json HdcSuccessTO (JSON) JSON Response with information if operation succeeded

Example

Request
POST /api/filters/grid/unassign/{filterId}
Content-Type: application/json
Accept: application/json

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

                
{ }

POST /api/perspective/byguid/entityarea/xls

Get Area compare report for Layer

Request Body
media type data type description
application/json HdcPolygonAreaCheck4ObjectListRequest (JSON) - input data
Response Body
media type data type description
application/json HdcPathProcessStateTO (JSON) json response with information about started process

Example

Request
POST /api/perspective/byguid/entityarea/xls
Content-Type: application/json
Accept: application/json

                
{
  "objects" : [ { }, { } ],
  "serverFilePrefix" : "...",
  "pagingLimit" : 12345,
  "contextObject" : { },
  "layerId" : 12345,
  "pagingOffset" : 12345,
  "sortField" : {
    "second" : true,
    "value0" : "...",
    "value1" : true,
    "first" : "..."
  },
  "params" : {
    "userId" : 12345,
    "vectorId2CompUnits" : {
      "property1" : "Yard",
      "property2" : "Foot"
    },
    "precision" : 12345,
    "fieldId" : "...",
    "vectorId2VectorUnits" : {
      "property1" : "Mm",
      "property2" : "Inch"
    },
    "classLabel" : "...",
    "versionId" : 12345,
    "classId" : 12345
  },
  "vectorId" : 12345
}
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{ }

POST /api/perspective/metadata/json/{perspectiveId}

Get children objects package with properties of the specified objects collection in the given perspective context. Please note that returned attribute "hasChildren" is for now always set to false.

Request Parameters
name type description default constraints
perspectiveId path The unique identifier of perspective.   long
childClassId query The unique identifier of children class.   long
hqlCriteria query String with filter criteria in HQL format.    
limit query Used in paging, defines the number of objects returned in a single call. 10000 long
location query false boolean
offset query Used in paging, defines the offset for positions.   long
sortField query Used as a sorting base of the returned objects package, consists of field name and sorting directions: 'asc' or 'desc' (format: sortField=[{"property":"hd_docdescr","direction":"ASC"}])    
srId query   long
status query If set to true - status mode is activated. false boolean
subtree query false boolean
Request Body
media type data type description
application/json array of HdcObjectWithChildrenTO (JSON) json with parent objects and hql criteria string

Example of request:

[{"classId":"104","objectId":"21673"},{"classId":"106","objectId":"28845"}]
Response Body
media type data type description
application/json object (JSON) JSON Response with the list of children objects with properties in the given perspective.

Example of response:

{"children":[{"hasChildren":false,"linkedToSpot":false,"metadata":{"fi2spsys_sysid":"","fi2floor_areabta":"","fi2spsys_descr":"","hd_objcustom3":"","hd_objcustom4":"","hdid":"644","hd_objcustom1":"","hd_objcustom2":"","fi2spsys_id":"90000164","fi2spsys_fullname":"","fi2spsys_class":"","haschildren":"false","fi2spsys_guid":"","fi2spsys_name":"9TR","classid":"13"},"contentType":0,"contentId":0,"objectId":"644","classId":"13", "securityMask":"3"},{"hasChildren":false,"linkedToSpot":false,"metadata":{"fi2spsys_sysid":"nrnr","fi2floor_areabta":"","fi2spsys_descr":"","hd_objcustom3":"","hd_objcustom4":"","hdid":"900","hd_objcustom1":"","hd_objcustom2":"","fi2spsys_id":"90000158","fi2spsys_fullname":"","fi2spsys_class":"","haschildren":"false","fi2spsys_guid":"5f16a417-a499-4352-a073-ff7bab34f958","fi2spsys_name":"UKV","classid":"13"},"contentType":0,"contentId":0,"objectId":"900","classId":"13", "securityMask":"3"},{"hasChildren":false,"linkedToSpot":false,"metadata":{"fi2spsys_sysid":"","fi2floor_areabta":"","fi2spsys_descr":"","hd_objcustom3":"","hd_objcustom4":"","hdid":"1458","hd_objcustom1":"","hd_objcustom2":"","fi2spsys_id":"2AA8E419AE674244BEE15585BC44C0DE","fi2spsys_fullname":"ggg","fi2spsys_class":"","haschildren":"false","fi2spsys_guid":"7568b150-031f-4649-92cc-b42a108e9df5","fi2spsys_name":"BV","classid":"13"},"contentType":0,"contentId":0,"objectId":"1458","classId":"13", "securityMask":"3"},{"hasChildren":false,"linkedToSpot":false,"metadata":{"fi2spsys_sysid":"","fi2floor_areabta":"","fi2spsys_descr":"","hd_objcustom3":"","hd_objcustom4":"","hdid":"1729","hd_objcustom1":"","hd_objcustom2":"","fi2spsys_id":"102","fi2spsys_fullname":"","fi2spsys_class":"","hasChildren":"false","fi2spsys_guid":"2a27bd3d-16ba-44f7-a690-648375b0c869","fi2spsys_name":"KV","classid":"13"},"contentType":0,"contentId":0,"objectId":"1729","classId":"13", "securityMask":"3"},{"hasChildren":false,"linkedToSpot":false,"metadata":{"fi2spsys_sysid":"","fi2floor_areabta":"","fi2spsys_descr":"","hd_objcustom3":"","hd_objcustom4":"","hdid":"1731","hd_objcustom1":"","hd_objcustom2":"","fi2spsys_id":"104","fi2spsys_fullname":"hhhfhfhfhaa","fi2spsys_class":"nrn","hasChildren":"false","fi2spsys_guid":"042e3f4d-467b-47f5-8e32-d7d15c5fb2d5","fi2spsys_name":"1TR","classid":"13"},"contentType":0,"contentId":0,"objectId":"1731","classId":"13", "securityMask":"3"},{"hasChildren":false,"linkedToSpot":false,"metadata":{"fi2spsys_sysid":"","fi2floor_areabta":"","fi2spsys_descr":"","hd_objcustom3":"","hd_objcustom4":"","hdid":"1737","hd_objcustom1":"","hd_objcustom2":"","fi2spsys_id":"110","fi2spsys_fullname":"","fi2spsys_class":"","hasChildren":"false","fi2spsys_guid":"70bcac3d-f75c-4ba8-ba69-e287aaf52e94","fi2spsys_name":"3TR","classid":"13"},"contentType":0,"contentId":0,"objectId":"1737","classId":"13", "securityMask":"3"},{"hasChildren":false,"linkedToSpot":false,"metadata":{"fi2spsys_sysid":"","fi2floor_areabta":"","fi2spsys_descr":"","hd_objcustom3":"","hd_objcustom4":"","hdid":"1738","hd_objcustom1":"","hd_objcustom2":"","fi2spsys_id":"111","fi2spsys_fullname":"","fi2spsys_class":"","hasChildren":"false","fi2spsys_guid":"af63c730-9348-48d4-ab0b-00c851756370","fi2spsys_name":"4TR","classid":"13"},"contentType":0,"contentId":0,"objectId":"1738","classId":"13", "securityMask":"3"},{"hasChildren":false,"linkedToSpot":false,"metadata":{"fi2spsys_sysid":"","fi2floor_areabta":"","fi2spsys_descr":"","hd_objcustom3":"","hd_objcustom4":"","hdid":"1739","hd_objcustom1":"","hd_objcustom2":"","fi2spsys_id":"112","fi2spsys_fullname":"","fi2spsys_class":"","hasChildren":"false","fi2spsys_guid":"db7b1069-19fe-46ad-903b-13424b6b409c","fi2spsys_name":"5TR","classid":"13"},"contentType":0,"contentId":0,"objectId":"1739","classId":"13", "securityMask":"3"},{"hasChildren":false,"linkedToSpot":false,"metadata":{"fi2spsys_sysid":"","fi2floor_areabta":"","fi2spsys_descr":"","hd_objcustom3":"","hd_objcustom4":"","hdid":"1740","hd_objcustom1":"","hd_objcustom2":"","fi2spsys_id":"113","fi2spsys_fullname":"","fi2spsys_class":"","hasChildren":"false","fi2spsys_guid":"63f7d28f-ad5a-497e-814d-35bdf655e039","fi2spsys_name":"6TR","classid":"13"},"contentType":0,"contentId":0,"objectId":"1740","classId":"13", "securityMask":"3"},{"hasChildren":false,"linkedToSpot":false,"metadata":{"fi2spsys_sysid":"","fi2floor_areabta":"","fi2spsys_descr":"","hd_objcustom3":"","hd_objcustom4":"","hdid":"183128","hd_objcustom1":"","hd_objcustom2":"","fi2spsys_id":"","fi2spsys_fullname":"","fi2spsys_class":"","haschildren":"false","fi2spsys_guid":"","fi2spsys_name":"","classid":"13"},"contentType":0,"contentId":0,"objectId":"183128","classId":"13", "securityMask":"3"}],"total":"10","hasChildren":false,"linkedToSpot":false,"metadata":{},"contentType":0,"contentId":0,"objectId":"325","classId":"12", "securityMask":"3"}

Example

Request
POST /api/perspective/metadata/json/{perspectiveId}
Content-Type: application/json
Accept: application/json

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

                
...

POST /api/perspective/metadata/xls/{perspectiveId}

Starts process that generates file with perspective children metadata for given child class in the given perspective context. The data is returned omitting paging parameters - offset and limit. Please note that returned attribute "hasChildren" is for now always set to false.

Request Parameters
name type description default constraints
perspectiveId path The unique identifier of perspective.   long
childClassId query The unique identifier of children class.   long
isBatchExport query true if all children visible in this perspective should be exported   boolean
outputType query destination output format for Excel Workbook (PDF, XLS)    
sortField query Used as a sorting base of the returned objects package, consists of field name and sorting directions: 'asc' or 'desc' (format: sortField=[{"property":"hd_docdescr","direction":"ASC"}])    
subtree query false boolean
Request Body
media type data type description
application/json HdcParamObjectListTOOfHdcObjectWithChildrenTO (JSON) json with parent objects and hql criteria string

Example of request:

{"list":[{"classId":"107","objectId":"14464"},{"classId":"108","objectId":"14414"},{"classId":"113","objectId":"14414"}],"hqlCriteria":"(boolean_type = \"true\")"}
Response Body
media type data type description
application/json HdcProcessStateTO (JSON) json response with information about started process

Example

Request
POST /api/perspective/metadata/xls/{perspectiveId}
Content-Type: application/json
Accept: application/json

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

                
{ }

GET /api/filters/grid/json/{userId}/{classId}

Get default filter for specified user.

Request Parameters
name type description constraints
classId path long
userId path The unique identifier of user long
Response Body
media type data type description
application/json HdcUserFilterTO (JSON) JSON Response with filter data

Example of response:

Example

Request
GET /api/filters/grid/json/{userId}/{classId}
Content-Type: */*
Accept: application/json

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

                
{
  "classId" : 12345,
  "name" : "...",
  "userId" : 12345,
  "isDefault" : true,
  "ownerFullName" : "...",
  "filterId" : 12345,
  "filterData" : "...",
  "isOwner" : true
}

POST /api/filters/grid/setdefault/{classId}/{filterId}

Set filter as default for current session user

Request Parameters
name type description constraints
classId path long
filterId path Id of filter long
Response Body
media type data type description
application/json HdcSuccessTO (JSON) JSON Response with information if operation succeeded

Example

Request
POST /api/filters/grid/setdefault/{classId}/{filterId}
Content-Type: */*
Accept: application/json

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

                
{ }

GET /api/perspective/byguid/json/{perspectiveId}/{contextGuid}

Get hierarchy of the specified object with the given class in the given perspective.

Request Parameters
name type description default constraints
contextGuid path - The unique system guid identifier of context object    
perspectiveId path The unique identifier of perspective.   long
status query If set to true - status mode is activated. false boolean
Response Body
media type data type description
application/json object (JSON) JSON Response with the list of children of the specified object in the given perspective.

Example of response:

{"children":[{"hasChildren":true,"metadata":{},"contentType":0,"contentId":0,"objectName":"1","objectId":"325","classId":"12", "securityMask":"3"},{"hasChildren":true,"metadata":{},"contentType":0,"contentId":0,"objectName":"2","objectId":"327","classId":"12", "securityMask":"3"},{"hasChildren":true,"metadata":{},"contentType":0,"contentId":0,"objectName":"3","objectId":"192","classId":"12", "securityMask":"3"},{"hasChildren":true,"metadata":{},"contentType":0,"contentId":0,"objectName":"4","objectId":"158712","classId":"12", "securityMask":"3"}],"hasChildren":true,"metadata":{},"contentType":0,"contentId":0,"objectName":"7102 XXX 2","objectId":"90","classId":"11", "securityMask":"3"}

Example

Request
GET /api/perspective/byguid/json/{perspectiveId}/{contextGuid}
Content-Type: */*
Accept: application/json

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

                
...

POST /api/perspective/byguid/metadata/json/{perspectiveId}

Get children objects package with properties of the specified objects collection in the given perspective context. Please note that returned attribute "hasChildren" is for now always set to false.

Request Parameters
name type description default constraints
perspectiveId path The unique identifier of perspective.   long
childClassId query The unique identifier of children class.   long
hqlCriteria query String with filter criteria in HQL format.    
limit query Used in paging, defines the number of objects returned in a single call. 10000 long
location query false boolean
offset query Used in paging, defines the offset for positions.   long
sortField query Used as a sorting base of the returned objects package, consists of field name and sorting directions: 'asc' or 'desc' (format: sortField=[{"property":"hd_docdescr","direction":"ASC"}])    
srId query   long
status query If set to true - status mode is activated. false boolean
subtree query false boolean
Request Body
media type data type description
application/json array of HdcObjectWithChildrenTO (JSON) json with parent objects and hql criteria string

Example of request:

[{"guid":"21673"},{"guid":"28845"}]
Response Body
media type data type description
application/json object (JSON) JSON Response with the list of children objects with properties in the given perspective.

Example of response:

{"children":[{"hasChildren":false,"linkedToSpot":false,"metadata":{"fi2spsys_sysid":"","fi2floor_areabta":"","fi2spsys_descr":"","hd_objcustom3":"","hd_objcustom4":"","hdid":"644","hd_objcustom1":"","hd_objcustom2":"","fi2spsys_id":"90000164","fi2spsys_fullname":"","fi2spsys_class":"","haschildren":"false","fi2spsys_guid":"","fi2spsys_name":"9TR","classid":"13"},"contentType":0,"contentId":0,"objectId":"644","classId":"13", "securityMask":"3"},{"hasChildren":false,"linkedToSpot":false,"metadata":{"fi2spsys_sysid":"nrnr","fi2floor_areabta":"","fi2spsys_descr":"","hd_objcustom3":"","hd_objcustom4":"","hdid":"900","hd_objcustom1":"","hd_objcustom2":"","fi2spsys_id":"90000158","fi2spsys_fullname":"","fi2spsys_class":"","haschildren":"false","fi2spsys_guid":"5f16a417-a499-4352-a073-ff7bab34f958","fi2spsys_name":"UKV","classid":"13"},"contentType":0,"contentId":0,"objectId":"900","classId":"13", "securityMask":"3"},{"hasChildren":false,"linkedToSpot":false,"metadata":{"fi2spsys_sysid":"","fi2floor_areabta":"","fi2spsys_descr":"","hd_objcustom3":"","hd_objcustom4":"","hdid":"1458","hd_objcustom1":"","hd_objcustom2":"","fi2spsys_id":"2AA8E419AE674244BEE15585BC44C0DE","fi2spsys_fullname":"ggg","fi2spsys_class":"","haschildren":"false","fi2spsys_guid":"7568b150-031f-4649-92cc-b42a108e9df5","fi2spsys_name":"BV","classid":"13"},"contentType":0,"contentId":0,"objectId":"1458","classId":"13", "securityMask":"3"},{"hasChildren":false,"linkedToSpot":false,"metadata":{"fi2spsys_sysid":"","fi2floor_areabta":"","fi2spsys_descr":"","hd_objcustom3":"","hd_objcustom4":"","hdid":"1729","hd_objcustom1":"","hd_objcustom2":"","fi2spsys_id":"102","fi2spsys_fullname":"","fi2spsys_class":"","hasChildren":"false","fi2spsys_guid":"2a27bd3d-16ba-44f7-a690-648375b0c869","fi2spsys_name":"KV","classid":"13"},"contentType":0,"contentId":0,"objectId":"1729","classId":"13", "securityMask":"3"},{"hasChildren":false,"linkedToSpot":false,"metadata":{"fi2spsys_sysid":"","fi2floor_areabta":"","fi2spsys_descr":"","hd_objcustom3":"","hd_objcustom4":"","hdid":"1731","hd_objcustom1":"","hd_objcustom2":"","fi2spsys_id":"104","fi2spsys_fullname":"hhhfhfhfhaa","fi2spsys_class":"nrn","hasChildren":"false","fi2spsys_guid":"042e3f4d-467b-47f5-8e32-d7d15c5fb2d5","fi2spsys_name":"1TR","classid":"13"},"contentType":0,"contentId":0,"objectId":"1731","classId":"13", "securityMask":"3"},{"hasChildren":false,"linkedToSpot":false,"metadata":{"fi2spsys_sysid":"","fi2floor_areabta":"","fi2spsys_descr":"","hd_objcustom3":"","hd_objcustom4":"","hdid":"1737","hd_objcustom1":"","hd_objcustom2":"","fi2spsys_id":"110","fi2spsys_fullname":"","fi2spsys_class":"","hasChildren":"false","fi2spsys_guid":"70bcac3d-f75c-4ba8-ba69-e287aaf52e94","fi2spsys_name":"3TR","classid":"13"},"contentType":0,"contentId":0,"objectId":"1737","classId":"13", "securityMask":"3"},{"hasChildren":false,"linkedToSpot":false,"metadata":{"fi2spsys_sysid":"","fi2floor_areabta":"","fi2spsys_descr":"","hd_objcustom3":"","hd_objcustom4":"","hdid":"1738","hd_objcustom1":"","hd_objcustom2":"","fi2spsys_id":"111","fi2spsys_fullname":"","fi2spsys_class":"","hasChildren":"false","fi2spsys_guid":"af63c730-9348-48d4-ab0b-00c851756370","fi2spsys_name":"4TR","classid":"13"},"contentType":0,"contentId":0,"objectId":"1738","classId":"13", "securityMask":"3"},{"hasChildren":false,"linkedToSpot":false,"metadata":{"fi2spsys_sysid":"","fi2floor_areabta":"","fi2spsys_descr":"","hd_objcustom3":"","hd_objcustom4":"","hdid":"1739","hd_objcustom1":"","hd_objcustom2":"","fi2spsys_id":"112","fi2spsys_fullname":"","fi2spsys_class":"","hasChildren":"false","fi2spsys_guid":"db7b1069-19fe-46ad-903b-13424b6b409c","fi2spsys_name":"5TR","classid":"13"},"contentType":0,"contentId":0,"objectId":"1739","classId":"13", "securityMask":"3"},{"hasChildren":false,"linkedToSpot":false,"metadata":{"fi2spsys_sysid":"","fi2floor_areabta":"","fi2spsys_descr":"","hd_objcustom3":"","hd_objcustom4":"","hdid":"1740","hd_objcustom1":"","hd_objcustom2":"","fi2spsys_id":"113","fi2spsys_fullname":"","fi2spsys_class":"","hasChildren":"false","fi2spsys_guid":"63f7d28f-ad5a-497e-814d-35bdf655e039","fi2spsys_name":"6TR","classid":"13"},"contentType":0,"contentId":0,"objectId":"1740","classId":"13", "securityMask":"3"},{"hasChildren":false,"linkedToSpot":false,"metadata":{"fi2spsys_sysid":"","fi2floor_areabta":"","fi2spsys_descr":"","hd_objcustom3":"","hd_objcustom4":"","hdid":"183128","hd_objcustom1":"","hd_objcustom2":"","fi2spsys_id":"","fi2spsys_fullname":"","fi2spsys_class":"","haschildren":"false","fi2spsys_guid":"","fi2spsys_name":"","classid":"13"},"contentType":0,"contentId":0,"objectId":"183128","classId":"13", "securityMask":"3"}],"total":"10","hasChildren":false,"linkedToSpot":false,"metadata":{},"contentType":0,"contentId":0,"objectId":"325","classId":"12", "securityMask":"3"}

Example

Request
POST /api/perspective/byguid/metadata/json/{perspectiveId}
Content-Type: application/json
Accept: application/json

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

                
...

POST /api/perspective/byguid/metadata/xls/{perspectiveId}

Starts process that generates file with perspective children metadata for given child class in the given perspective context. The data is returned omitting paging parameters - offset and limit. Please note that returned attribute "hasChildren" is for now always set to false.

Request Parameters
name type description default constraints
perspectiveId path The unique identifier of perspective.   long
childClassId query The unique identifier of children class.   long
isBatchExport query true if all children visible in this perspective should be exported   boolean
outputType query destination output format for Excel Workbook (PDF, XLS)    
sortField query Used as a sorting base of the returned objects package, consists of field name and sorting directions: 'asc' or 'desc' (format: sortField=[{"property":"hd_docdescr","direction":"ASC"}])    
subtree query false boolean
Request Body
media type data type description
application/json HdcParamObjectListTOOfHdcObjectWithChildrenTO (JSON) json with parent objects and hql criteria string

Example of request:

{"list":[{"classId":"107","objectId":"14464"},{"classId":"108","objectId":"14414"},{"classId":"113","objectId":"14414"}],"hqlCriteria":"(boolean_type = \"true\")"}
Response Body
media type data type description
application/json object (JSON) json response with information about started process

Example

Request
POST /api/perspective/byguid/metadata/xls/{perspectiveId}
Content-Type: application/json
Accept: application/json

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

                
...

GET /api/perspective/json/{perspectiveId}/{classId}/{objectId}

Get hierarchy of the specified object with the given class in the given perspective.

Request Parameters
name type description default constraints
classId path The unique identifier of object class.   long
objectId path The unique identifier of object.   long
perspectiveId path The unique identifier of perspective.   long
status query If set to true - status mode is activated. false boolean
Response Body
media type data type description
application/json object (JSON) JSON Response with the list of children of the specified object in the given perspective.

Example of response:

{"children":[{"hasChildren":true,"metadata":{},"contentType":0,"contentId":0,"objectName":"1","objectId":"325","classId":"12", "securityMask":"3"},{"hasChildren":true,"metadata":{},"contentType":0,"contentId":0,"objectName":"2","objectId":"327","classId":"12", "securityMask":"3"},{"hasChildren":true,"metadata":{},"contentType":0,"contentId":0,"objectName":"3","objectId":"192","classId":"12", "securityMask":"3"},{"hasChildren":true,"metadata":{},"contentType":0,"contentId":0,"objectName":"4","objectId":"158712","classId":"12", "securityMask":"3"}],"hasChildren":true,"metadata":{},"contentType":0,"contentId":0,"objectName":"7102 XXX 2","objectId":"90","classId":"11", "securityMask":"3"}

Example

Request
GET /api/perspective/json/{perspectiveId}/{classId}/{objectId}
Content-Type: */*
Accept: application/json

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

                
...

POST /api/perspective/metadata/json/{perspectiveId}/{requiredObjectId}

Get children objects package with properties of the specified objects collection in the given perspective context and optionally with the specified object in the package. Please note that returned attribute "hasChildren" is for now always set to false.

Example of request:

[{"classId":"104","objectId":"21673"},{"classId":"106","objectId":"28845"}]

Request Parameters
name type description default constraints
perspectiveId path The unique identifier of perspective.   long
requiredObjectId path The unique identifier of object that has to be returned within object package.   long
childClassId query The unique identifier of children class.   long
limit query Used in paging, defines the number of objects returned in a single call.   long
offset query   long
sortField query Used as a sorting base of the returned objects package, consists of field name and sorting directions: 'asc' or 'desc' (format: sortField=[{"property":"hd_docdescr","direction":"ASC"}])    
status query If set to true - status mode is activated. false boolean
Request Body
media type data type
application/json array of HdcObjectWithChildrenTO (JSON)
Response Body
media type data type description
application/json object (JSON) JSON Response with the list of children objects with properties in the given perspective.

Example of response:

{"children":[{"hasChildren":false,"linkedToSpot":false,"metadata": {"fi2spsys_sysid":"","fi2floor_areabta":"","fi2spsys_descr":"","hd_objcustom3":"","hd_objcustom4":"","hdid":"644","hd_objcustom1":"","hd_objcustom2":"","fi2spsys_id":"90000164","fi2spsys_fullname":"","fi2spsys_class":"","hasChildren":"false","fi2spsys_guid":"","fi2spsys_name":"9TR","classid":"13"},"contentType":0,"contentId":0,"objectId":"644","classId":"13", "securityMask":"3"},{"hasChildren":false,"linkedToSpot":false,"metadata": {"fi2spsys_sysid":"nrnr","fi2floor_areabta":"","fi2spsys_descr":"","hd_objcustom3":"","hd_objcustom4":"","hdid":"900","hd_objcustom1":"","hd_objcustom2":"","fi2spsys_id":"90000158","fi2spsys_fullname":"","fi2spsys_class":"","hasChildren":"false","fi2spsys_guid":"5f16a417-a499-4352-a073-ff7bab34f958","fi2spsys_name":"UKV","classid":"13"},"contentType":0,"contentId":0,"objectId":"900","classId":"13", "securityMask":"3"},{"hasChildren":false,"linkedToSpot":false,"metadata": {"fi2spsys_sysid":"","fi2floor_areabta":"","fi2spsys_descr":"","hd_objcustom3":"","hd_objcustom4":"","hdid":"1458","hd_objcustom1":"","hd_objcustom2":"","fi2spsys_id":"2AA8E419AE674244BEE15585BC44C0DE","fi2spsys_fullname":"ggg","fi2spsys_class":"","hasChildren":"false","fi2spsys_guid":"7568b150-031f-4649-92cc-b42a108e9df5","fi2spsys_name":"BV","classid":"13"},"contentType":0,"contentId":0,"objectId":"1458","classId":"13", "securityMask":"3"},{"hasChildren":false,"linkedToSpot":false,"metadata": {"fi2spsys_sysid":"","fi2floor_areabta":"","fi2spsys_descr":"","hd_objcustom3":"","hd_objcustom4":"","hdid":"1729","hd_objcustom1":"","hd_objcustom2":"","fi2spsys_id":"102","fi2spsys_fullname":"","fi2spsys_class":"","hasChildren":"false","fi2spsys_guid":"2a27bd3d-16ba-44f7-a690-648375b0c869","fi2spsys_name":"KV","classid":"13"},"contentType":0,"contentId":0,"objectId":"1729","classId":"13", "securityMask":"3"},{"hasChildren":false,"linkedToSpot":false,"metadata": {"fi2spsys_sysid":"","fi2floor_areabta":"","fi2spsys_descr":"","hd_objcustom3":"","hd_objcustom4":"","hdid":"1731","hd_objcustom1":"","hd_objcustom2":"","fi2spsys_id":"104","fi2spsys_fullname":"hhhfhfhfhaa","fi2spsys_class":"nrn","hasChildren":"false","fi2spsys_guid":"042e3f4d-467b-47f5-8e32-d7d15c5fb2d5","fi2spsys_name":"1TR","classid":"13"},"contentType":0,"contentId":0,"objectId":"1731","classId":"13", "securityMask":"3"},{"hasChildren":false,"linkedToSpot":false,"metadata": {"fi2spsys_sysid":"","fi2floor_areabta":"","fi2spsys_descr":"","hd_objcustom3":"","hd_objcustom4":"","hdid":"1737","hd_objcustom1":"","hd_objcustom2":"","fi2spsys_id":"110","fi2spsys_fullname":"","fi2spsys_class":"","hasChildren":"false","fi2spsys_guid":"70bcac3d-f75c-4ba8-ba69-e287aaf52e94","fi2spsys_name":"3TR","classid":"13"},"contentType":0,"contentId":0,"objectId":"1737","classId":"13", "securityMask":"3"},{"hasChildren":false,"linkedToSpot":false,"metadata": {"fi2spsys_sysid":"","fi2floor_areabta":"","fi2spsys_descr":"","hd_objcustom3":"","hd_objcustom4":"","hdid":"1738","hd_objcustom1":"","hd_objcustom2":"","fi2spsys_id":"111","fi2spsys_fullname":"","fi2spsys_class":"","hasChildren":"false","fi2spsys_guid":"af63c730-9348-48d4-ab0b-00c851756370","fi2spsys_name":"4TR","classid":"13"},"contentType":0,"contentId":0,"objectId":"1738","classId":"13", "securityMask":"3"},{"hasChildren":false,"linkedToSpot":false,"metadata": {"fi2spsys_sysid":"","fi2floor_areabta":"","fi2spsys_descr":"","hd_objcustom3":"","hd_objcustom4":"","hdid":"1739","hd_objcustom1":"","hd_objcustom2":"","fi2spsys_id":"112","fi2spsys_fullname":"","fi2spsys_class":"","hasChildren":"false","fi2spsys_guid":"db7b1069-19fe-46ad-903b-13424b6b409c","fi2spsys_name":"5TR","classid":"13"},"contentType":0,"contentId":0,"objectId":"1739","classId":"13", "securityMask":"3"},{"hasChildren":false,"linkedToSpot":false,"metadata": {"fi2spsys_sysid":"","fi2floor_areabta":"","fi2spsys_descr":"","hd_objcustom3":"","hd_objcustom4":"","hdid":"1740","hd_objcustom1":"","hd_objcustom2":"","fi2spsys_id":"113","fi2spsys_fullname":"","fi2spsys_class":"","hasChildren":"false","fi2spsys_guid":"63f7d28f-ad5a-497e-814d-35bdf655e039","fi2spsys_name":"6TR","classid":"13"},"contentType":0,"contentId":0,"objectId":"1740","classId":"13", "securityMask":"3"},{"hasChildren":false,"linkedToSpot":false,"metadata": {"fi2spsys_sysid":"","fi2floor_areabta":"","fi2spsys_descr":"","hd_objcustom3":"","hd_objcustom4":"","hdid":"183128","hd_objcustom1":"","hd_objcustom2":"","fi2spsys_id":"","fi2spsys_fullname":"","fi2spsys_class":"","haschildren":"false","fi2spsys_guid":"","fi2spsys_name":"","classid":"13"},"contentType":0,"contentId":0,"objectId":"183128","classId":"13", "securityMask":"3"}],"total":"10","hasChildren":false,"linkedToSpot":false,"metadata": {},"contentType":0,"contentId":0,"objectId":"325","classId":"12", "securityMask":"3"}

Example

Request
POST /api/perspective/metadata/json/{perspectiveId}/{requiredObjectId}
Content-Type: application/json
Accept: application/json

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

                
...

POST /api/perspective/metadata/selected/{outputType}/{perspectiveId}

Starts process that generates file for selected objects of given child class with perspective children metadata in the given perspective context. The data is returned omitting paging parameters - offset and limit. Please note that returned attribute "hasChildren" is for now always set to false.

Request Parameters
name type description constraints
outputType path  
perspectiveId path The unique identifier of perspective. long
childClassId query The unique identifier of children class. long
sortField query Used as a sorting base of the returned objects package, consists of field name and sorting directions: 'asc' or 'desc' (format: sortField=[{"property":"hd_docdescr","direction":"ASC"}])  
Request Body
media type data type description
application/json HdcObjectsExtendedTargetsModelTO (JSON) json with object data and targetObjects identifiers list

Example of request:

{ parentObjects : [{"classId":"107","objectId":"14464"},{"classId":"108","objectId":"14414"},{"classId":"113","objectId":"14414"}], targetObjects : ["24112", "213266", "235257"] } }
Response Body
media type data type description
application/json HdcPathProcessStateTO (JSON) json response with information about started process

Example

Request
POST /api/perspective/metadata/selected/{outputType}/{perspectiveId}
Content-Type: application/json
Accept: application/json

                
{
  "targetObjects" : [ 12345, 12345 ],
  "parentObjects" : [ { }, { } ]
}
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{ }

POST /api/filters/grid/setdefault/{classId}/{filterId}/{userId}

Set filter as default for user

Request Parameters
name type description constraints
classId path long
filterId path Id of filter long
userId path Id of user long
Response Body
media type data type description
application/json HdcSuccessTO (JSON) JSON Response with information if operation succeeded

Example

Request
POST /api/filters/grid/setdefault/{classId}/{filterId}/{userId}
Content-Type: */*
Accept: application/json

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

                
{ }

GET /api/perspective/byguid/checkentityarea/json/{perspectiveId}/{contextGuid}

Check polygon area for entities linked to objects in object tree

Request Parameters
name type description default constraints
contextGuid path - system guid of context object    
perspectiveId path - perspective id for context objects children search   long
classId query - id of linked objects' class   long
fieldId query - id of linked objects' class field    
layerId query   long
limit query 100 long
offset query   long
precision query   int
sortField query    
Response Body
media type data type description
application/json object (JSON) JSON response with area report

Example

Request
GET /api/perspective/byguid/checkentityarea/json/{perspectiveId}/{contextGuid}
Content-Type: */*
Accept: application/json

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

                
...

GET /api/perspective/byguid/metadata/json/{perspectiveId}/{contextGuid}

Get children objects package with properties of the specified object with the given class in the given perspective context. Please note that returned attribute "hasChildren" is for now always set to false.

Request Parameters
name type description default constraints
contextGuid path - The unique system guid identifier of context object    
perspectiveId path The unique identifier of perspective.   long
childClassId query The unique identifier of children class.   long
limit query Used in paging, defines the number of objects returned in a single call. 10000 long
offset query Used in paging, defines the offset for positions.   long
sortField query Used as a sorting base of the returned objects package, consists of field name and sorting directions: 'asc' or 'desc' (format: sortField=[{"property":"hd_docdescr","direction":"ASC"}])    
status query If set to true - status mode is activated. false boolean
subtree query false boolean
subtreePerspectiveId query   long
Response Body
media type data type description
application/json object (JSON) JSON Response with the list of children objects with properties in the given perspective.

Example of response:

{"children":[{"hasChildren":false,"linkedToSpot":false,"metadata":{"fi2spsys_sysid":"","fi2floor_areabta":"","fi2spsys_descr":"","hd_objcustom3":"","hd_objcustom4":"","hdid":"644","hd_objcustom1":"","hd_objcustom2":"","fi2spsys_id":"90000164","fi2spsys_fullname":"","fi2spsys_class":"","haschildren":"false","fi2spsys_guid":"","fi2spsys_name":"9TR","classid":"13"},"contentType":0,"contentId":0,"objectId":"644","classId":"13", "securityMask":"3"},{"hasChildren":false,"linkedToSpot":false,"metadata": {"fi2spsys_sysid":"nrnr","fi2floor_areabta":"","fi2spsys_descr":"","hd_objcustom3":"","hd_objcustom4":"","hdid":"900","hd_objcustom1":"","hd_objcustom2":"","fi2spsys_id":"90000158","fi2spsys_fullname":"","fi2spsys_class":"","haschildren":"false","fi2spsys_guid":"5f16a417-a499-4352-a073-ff7bab34f958","fi2spsys_name":"UKV","classid":"13"},"contentType":0,"contentId":0,"objectId":"900","classId":"13", "securityMask":"3"},{"hasChildren":false,"linkedToSpot":false,"metadata": {"fi2spsys_sysid":"","fi2floor_areabta":"","fi2spsys_descr":"","hd_objcustom3":"","hd_objcustom4":"","hdid":"1458","hd_objcustom1":"","hd_objcustom2":"","fi2spsys_id":"2AA8E419AE674244BEE15585BC44C0DE","fi2spsys_fullname":"ggg","fi2spsys_class":"","haschildren":"false","fi2spsys_guid":"7568b150-031f-4649-92cc-b42a108e9df5","fi2spsys_name":"BV","classid":"13"},"contentType":0,"contentId":0,"objectId":"1458","classId":"13", "securityMask":"3"},{"hasChildren":false,"linkedToSpot":false,"metadata": {"fi2spsys_sysid":"","fi2floor_areabta":"","fi2spsys_descr":"","hd_objcustom3":"","hd_objcustom4":"","hdid":"1729","hd_objcustom1":"","hd_objcustom2":"","fi2spsys_id":"102","fi2spsys_fullname":"","fi2spsys_class":"","hasChildren":"false","fi2spsys_guid":"2a27bd3d-16ba-44f7-a690-648375b0c869","fi2spsys_name":"KV","classid":"13"},"contentType":0,"contentId":0,"objectId":"1729","classId":"13", "securityMask":"3"},{"hasChildren":false,"linkedToSpot":false,"metadata": {"fi2spsys_sysid":"","fi2floor_areabta":"","fi2spsys_descr":"","hd_objcustom3":"","hd_objcustom4":"","hdid":"1731","hd_objcustom1":"","hd_objcustom2":"","fi2spsys_id":"104","fi2spsys_fullname":"hhhfhfhfhaa","fi2spsys_class":"nrn","hasChildren":"false","fi2spsys_guid":"042e3f4d-467b-47f5-8e32-d7d15c5fb2d5","fi2spsys_name":"1TR","classid":"13"},"contentType":0,"contentId":0,"objectId":"1731","classId":"13", "securityMask":"3"},{"hasChildren":false,"linkedToSpot":false,"metadata": {"fi2spsys_sysid":"","fi2floor_areabta":"","fi2spsys_descr":"","hd_objcustom3":"","hd_objcustom4":"","hdid":"1737","hd_objcustom1":"","hd_objcustom2":"","fi2spsys_id":"110","fi2spsys_fullname":"","fi2spsys_class":"","hasChildren":"false","fi2spsys_guid":"70bcac3d-f75c-4ba8-ba69-e287aaf52e94","fi2spsys_name":"3TR","classid":"13"},"contentType":0,"contentId":0,"objectId":"1737","classId":"13", "securityMask":"3"},{"hasChildren":false,"linkedToSpot":false,"metadata": {"fi2spsys_sysid":"","fi2floor_areabta":"","fi2spsys_descr":"","hd_objcustom3":"","hd_objcustom4":"","hdid":"1738","hd_objcustom1":"","hd_objcustom2":"","fi2spsys_id":"111","fi2spsys_fullname":"","fi2spsys_class":"","hasChildren":"false","fi2spsys_guid":"af63c730-9348-48d4-ab0b-00c851756370","fi2spsys_name":"4TR","classid":"13"},"contentType":0,"contentId":0,"objectId":"1738","classId":"13", "securityMask":"3"},{"hasChildren":false,"linkedToSpot":false,"metadata": {"fi2spsys_sysid":"","fi2floor_areabta":"","fi2spsys_descr":"","hd_objcustom3":"","hd_objcustom4":"","hdid":"1739","hd_objcustom1":"","hd_objcustom2":"","fi2spsys_id":"112","fi2spsys_fullname":"","fi2spsys_class":"","hasChildren":"false","fi2spsys_guid":"db7b1069-19fe-46ad-903b-13424b6b409c","fi2spsys_name":"5TR","classid":"13"},"contentType":0,"contentId":0,"objectId":"1739","classId":"13", "securityMask":"3"},{"hasChildren":false,"linkedToSpot":false,"metadata": {"fi2spsys_sysid":"","fi2floor_areabta":"","fi2spsys_descr":"","hd_objcustom3":"","hd_objcustom4":"","hdid":"1740","hd_objcustom1":"","hd_objcustom2":"","fi2spsys_id":"113","fi2spsys_fullname":"","fi2spsys_class":"","hasChildren":"false","fi2spsys_guid":"63f7d28f-ad5a-497e-814d-35bdf655e039","fi2spsys_name":"6TR","classid":"13"},"contentType":0,"contentId":0,"objectId":"1740","classId":"13", "securityMask":"3"},{"hasChildren":false,"linkedToSpot":false,"metadata": {"fi2spsys_sysid":"","fi2floor_areabta":"","fi2spsys_descr":"","hd_objcustom3":"","hd_objcustom4":"","hdid":"183128","hd_objcustom1":"","hd_objcustom2":"","fi2spsys_id":"","fi2spsys_fullname":"","fi2spsys_class":"","haschildren":"false","fi2spsys_guid":"","fi2spsys_name":"","classid":"13"},"contentType":0,"contentId":0,"objectId":"183128","classId":"13", "securityMask":"3"}],"total":"10","hasChildren":false,"linkedToSpot":false,"metadata": {},"contentType":0,"contentId":0,"objectId":"325","classId":"12", "securityMask":"3"}

Example

Request
GET /api/perspective/byguid/metadata/json/{perspectiveId}/{contextGuid}
Content-Type: */*
Accept: application/json

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

                
...

POST /api/perspective/byguid/metadata/json/{perspectiveId}/{requiredObjectId}

Get children objects package with properties of the specified objects collection in the given perspective context and optionally with the specified object in the package. Please note that returned attribute "hasChildren" is for now always set to false.

Example of request:

[{"classId":"104","objectId":"21673"},{"classId":"106","objectId":"28845"}]

Request Parameters
name type description default constraints
perspectiveId path The unique identifier of perspective.   long
requiredObjectId path The unique identifier of object that has to be returned within object package.   long
childClassId query The unique identifier of children class.   long
limit query Used in paging, defines the number of objects returned in a single call.   long
offset query   long
sortField query Used as a sorting base of the returned objects package, consists of field name and sorting directions: 'asc' or 'desc' (format: sortField=[{"property":"hd_docdescr","direction":"ASC"}])    
status query If set to true - status mode is activated. false boolean
Request Body
media type data type
application/json array of HdcObjectWithChildrenTO (JSON)
Response Body
media type data type description
application/json object (JSON) JSON Response with the list of children objects with properties in the given perspective.

Example of response:

{"children":[{"hasChildren":false,"linkedToSpot":false,"metadata": {"fi2spsys_sysid":"","fi2floor_areabta":"","fi2spsys_descr":"","hd_objcustom3":"","hd_objcustom4":"","hdid":"644","hd_objcustom1":"","hd_objcustom2":"","fi2spsys_id":"90000164","fi2spsys_fullname":"","fi2spsys_class":"","hasChildren":"false","fi2spsys_guid":"","fi2spsys_name":"9TR","classid":"13"},"contentType":0,"contentId":0,"objectId":"644","classId":"13", "securityMask":"3"},{"hasChildren":false,"linkedToSpot":false,"metadata": {"fi2spsys_sysid":"nrnr","fi2floor_areabta":"","fi2spsys_descr":"","hd_objcustom3":"","hd_objcustom4":"","hdid":"900","hd_objcustom1":"","hd_objcustom2":"","fi2spsys_id":"90000158","fi2spsys_fullname":"","fi2spsys_class":"","hasChildren":"false","fi2spsys_guid":"5f16a417-a499-4352-a073-ff7bab34f958","fi2spsys_name":"UKV","classid":"13"},"contentType":0,"contentId":0,"objectId":"900","classId":"13", "securityMask":"3"},{"hasChildren":false,"linkedToSpot":false,"metadata": {"fi2spsys_sysid":"","fi2floor_areabta":"","fi2spsys_descr":"","hd_objcustom3":"","hd_objcustom4":"","hdid":"1458","hd_objcustom1":"","hd_objcustom2":"","fi2spsys_id":"2AA8E419AE674244BEE15585BC44C0DE","fi2spsys_fullname":"ggg","fi2spsys_class":"","hasChildren":"false","fi2spsys_guid":"7568b150-031f-4649-92cc-b42a108e9df5","fi2spsys_name":"BV","classid":"13"},"contentType":0,"contentId":0,"objectId":"1458","classId":"13", "securityMask":"3"},{"hasChildren":false,"linkedToSpot":false,"metadata": {"fi2spsys_sysid":"","fi2floor_areabta":"","fi2spsys_descr":"","hd_objcustom3":"","hd_objcustom4":"","hdid":"1729","hd_objcustom1":"","hd_objcustom2":"","fi2spsys_id":"102","fi2spsys_fullname":"","fi2spsys_class":"","hasChildren":"false","fi2spsys_guid":"2a27bd3d-16ba-44f7-a690-648375b0c869","fi2spsys_name":"KV","classid":"13"},"contentType":0,"contentId":0,"objectId":"1729","classId":"13", "securityMask":"3"},{"hasChildren":false,"linkedToSpot":false,"metadata": {"fi2spsys_sysid":"","fi2floor_areabta":"","fi2spsys_descr":"","hd_objcustom3":"","hd_objcustom4":"","hdid":"1731","hd_objcustom1":"","hd_objcustom2":"","fi2spsys_id":"104","fi2spsys_fullname":"hhhfhfhfhaa","fi2spsys_class":"nrn","hasChildren":"false","fi2spsys_guid":"042e3f4d-467b-47f5-8e32-d7d15c5fb2d5","fi2spsys_name":"1TR","classid":"13"},"contentType":0,"contentId":0,"objectId":"1731","classId":"13", "securityMask":"3"},{"hasChildren":false,"linkedToSpot":false,"metadata": {"fi2spsys_sysid":"","fi2floor_areabta":"","fi2spsys_descr":"","hd_objcustom3":"","hd_objcustom4":"","hdid":"1737","hd_objcustom1":"","hd_objcustom2":"","fi2spsys_id":"110","fi2spsys_fullname":"","fi2spsys_class":"","hasChildren":"false","fi2spsys_guid":"70bcac3d-f75c-4ba8-ba69-e287aaf52e94","fi2spsys_name":"3TR","classid":"13"},"contentType":0,"contentId":0,"objectId":"1737","classId":"13", "securityMask":"3"},{"hasChildren":false,"linkedToSpot":false,"metadata": {"fi2spsys_sysid":"","fi2floor_areabta":"","fi2spsys_descr":"","hd_objcustom3":"","hd_objcustom4":"","hdid":"1738","hd_objcustom1":"","hd_objcustom2":"","fi2spsys_id":"111","fi2spsys_fullname":"","fi2spsys_class":"","hasChildren":"false","fi2spsys_guid":"af63c730-9348-48d4-ab0b-00c851756370","fi2spsys_name":"4TR","classid":"13"},"contentType":0,"contentId":0,"objectId":"1738","classId":"13", "securityMask":"3"},{"hasChildren":false,"linkedToSpot":false,"metadata": {"fi2spsys_sysid":"","fi2floor_areabta":"","fi2spsys_descr":"","hd_objcustom3":"","hd_objcustom4":"","hdid":"1739","hd_objcustom1":"","hd_objcustom2":"","fi2spsys_id":"112","fi2spsys_fullname":"","fi2spsys_class":"","hasChildren":"false","fi2spsys_guid":"db7b1069-19fe-46ad-903b-13424b6b409c","fi2spsys_name":"5TR","classid":"13"},"contentType":0,"contentId":0,"objectId":"1739","classId":"13", "securityMask":"3"},{"hasChildren":false,"linkedToSpot":false,"metadata": {"fi2spsys_sysid":"","fi2floor_areabta":"","fi2spsys_descr":"","hd_objcustom3":"","hd_objcustom4":"","hdid":"1740","hd_objcustom1":"","hd_objcustom2":"","fi2spsys_id":"113","fi2spsys_fullname":"","fi2spsys_class":"","hasChildren":"false","fi2spsys_guid":"63f7d28f-ad5a-497e-814d-35bdf655e039","fi2spsys_name":"6TR","classid":"13"},"contentType":0,"contentId":0,"objectId":"1740","classId":"13", "securityMask":"3"},{"hasChildren":false,"linkedToSpot":false,"metadata": {"fi2spsys_sysid":"","fi2floor_areabta":"","fi2spsys_descr":"","hd_objcustom3":"","hd_objcustom4":"","hdid":"183128","hd_objcustom1":"","hd_objcustom2":"","fi2spsys_id":"","fi2spsys_fullname":"","fi2spsys_class":"","haschildren":"false","fi2spsys_guid":"","fi2spsys_name":"","classid":"13"},"contentType":0,"contentId":0,"objectId":"183128","classId":"13", "securityMask":"3"}],"total":"10","hasChildren":false,"linkedToSpot":false,"metadata": {},"contentType":0,"contentId":0,"objectId":"325","classId":"12", "securityMask":"3"}

Example

Request
POST /api/perspective/byguid/metadata/json/{perspectiveId}/{requiredObjectId}
Content-Type: application/json
Accept: application/json

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

                
...

POST /api/perspective/byguid/metadata/selected/{outputType}/{perspectiveId}

Starts process that generates file for selected objects of given child class with perspective children metadata in the given perspective context. The data is returned omitting paging parameters - offset and limit. Please note that returned attribute "hasChildren" is for now always set to false.

Request Parameters
name type description constraints
outputType path  
perspectiveId path The unique identifier of perspective. long
childClassId query The unique identifier of children class. long
sortField query Used as a sorting base of the returned objects package, consists of field name and sorting directions: 'asc' or 'desc' (format: sortField=[{"property":"hd_docdescr","direction":"ASC"}])  
Request Body
media type data type description
application/json HdcObjectsExtendedTargetsModelTO (JSON) json with object data and targetObjects identifiers list

Example of request:

{ parentObjects : [{"classId":"107","objectId":"14464"},{"classId":"108","objectId":"14414"},{"classId":"113","objectId":"14414"}], targetObjects : ["24112", "213266", "235257"] }
Response Body
media type data type description
application/json HdcPathProcessStateTO (JSON) json response with information about started process

Example

Request
POST /api/perspective/byguid/metadata/selected/{outputType}/{perspectiveId}
Content-Type: application/json
Accept: application/json

                
{
  "targetObjects" : [ 12345, 12345 ],
  "parentObjects" : [ { }, { } ]
}
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{ }

GET /api/perspective/byguid/parent/json/{perspId}/{contextGuid}

Get parent object for the specified perspective, class and identifier

Request Parameters
name type description constraints
contextGuid path - The unique system guid identifier of context object  
perspId path The unique identifier of perspective. long
Response Body
media type data type description
application/json object (JSON) JSON Response with the specified parent object

Example of response:

{"systemGuid":"9adaxcsvsr253220"}

Example

Request
GET /api/perspective/byguid/parent/json/{perspId}/{contextGuid}
Content-Type: */*
Accept: application/json

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

                
...

GET /api/perspective/byguid/subtree/json/{perspId}/{contextGuid}

Get subtree from specified object in terms of the specified perspective set.

Request Parameters
name type description default constraints
contextGuid path - The unique system guid identifier of context object    
perspId path The unique identifier of perspective.   long
status query If set to true - status mode is activated. false boolean
Response Body
media type data type description
application/json object (JSON) JSON response with the created tree

Example of response:

{"children": [{"children": [{"children": [{"hasChildren": true,"metadata": {}, "contentType": 0, "contentId": 0, "objectName": "1TR", "objectId": "1731", "classId": "13", "securityMask":"3"}, { "hasChildren": true, "metadata": {}, "contentType": 0, "contentId": 0, "objectName": "UKV", "objectId": "900", "classId": "13", "securityMask":"3" }, { "hasChildren": false, "metadata": {}, "contentType": 0, "contentId": 0, "objectName": "", "objectId": "183128", "classId": "13", "securityMask":"3" }], "hasChildren": true, "metadata": {}, "contentType": 0, "contentId": 0, "objectName": "1", "objectId": "325", "classId": "12", "securityMask":"3" }, { "hasChildren": true, "metadata": {}, "contentType": 0, "contentId": 0, "objectName": "4", "objectId": "158712", "classId": "12", "securityMask":"3" }], "hasChildren": true, "metadata": {}, "contentType": 0, "contentId": 0, "objectName": "7101 XXX 2", "objectId": "90", "classId": "11", "securityMask":"3" }, { "hasChildren": true, "metadata": {}, "contentType": 0, "contentId": 0, "objectName": "FZK-Haus-Gelaende", "objectId": "210590", "classId": "11", "securityMask":"3" }, { "hasChildren": true, "metadata": {}, "contentType": 0, "contentId": 0, "objectName": "Gelaende 0815", "objectId": "221026", "classId": "11", "securityMask":"3" }], "hasChildren": true, "metadata": {}, "contentType": 0, "contentId": 0, "objectName": "Root", "objectId": "0", "classId": "10", "securityMask":"3" }

Example

Request
GET /api/perspective/byguid/subtree/json/{perspId}/{contextGuid}
Content-Type: */*
Accept: application/json

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

                
...

GET /api/perspective/byguid/tree/json/{perspId}/{contextGuid}

Get tree from root to the object with the specified perspective, class and identifier that contains all object's siblings

Request Parameters
name type description default constraints
contextGuid path - The unique system guid identifier of context object    
perspId path The unique identifier of perspective.   long
status query If set to true - status mode is activated. false boolean
Response Body
media type data type description
application/json object (JSON) JSON response with the created tree

Example of response:

{"children": [{"children": [{"children": [{"hasChildren": true,"metadata": {}, "contentType": 0, "contentId": 0, "objectName": "1TR", "objectId": "1731", "classId": "13", "securityMask":"3"}, { "hasChildren": true, "metadata": {}, "contentType": 0, "contentId": 0, "objectName": "UKV", "objectId": "900", "classId": "13", "securityMask":"3" }, { "hasChildren": false, "metadata": {}, "contentType": 0, "contentId": 0, "objectName": "", "objectId": "183128", "classId": "13", "securityMask":"3" }], "hasChildren": true, "metadata": {}, "contentType": 0, "contentId": 0, "objectName": "1", "objectId": "325", "classId": "12", "securityMask":"3" }, { "hasChildren": true, "metadata": {}, "contentType": 0, "contentId": 0, "objectName": "4", "objectId": "158712", "classId": "12", "securityMask":"3" }], "hasChildren": true, "metadata": {}, "contentType": 0, "contentId": 0, "objectName": "7101 XXX 2", "objectId": "90", "classId": "11", "securityMask":"3" }, { "hasChildren": true, "metadata": {}, "contentType": 0, "contentId": 0, "objectName": "FZK-Haus-Gelaende", "objectId": "210590", "classId": "11", "securityMask":"3" }, { "hasChildren": true, "metadata": {}, "contentType": 0, "contentId": 0, "objectName": "Gelaende 0815", "objectId": "221026", "classId": "11", "securityMask":"3" }], "hasChildren": true, "metadata": {}, "contentType": 0, "contentId": 0, "objectName": "Root", "objectId": "0", "classId": "10", "securityMask":"3" }

Example

Request
GET /api/perspective/byguid/tree/json/{perspId}/{contextGuid}
Content-Type: */*
Accept: application/json

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

                
...

GET /api/perspective/checkentityarea/json/{perspectiveId}/{contextClassId}/{contextObjectId}

Check polygon area for entities linked to objects in object tree

Request Parameters
name type description default constraints
contextClassId path - context objects class id   long
contextObjectId path - id of context object   long
perspectiveId path - perspective id for context objects children search   long
classId query - id of linked objects' class   long
fieldId query - id of linked objects' class field    
layerId query   long
limit query 100 long
offset query   long
precision query   int
sortField query    
Response Body
media type data type description
application/json object (JSON) JSON response with area report

Example

Request
GET /api/perspective/checkentityarea/json/{perspectiveId}/{contextClassId}/{contextObjectId}
Content-Type: */*
Accept: application/json

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

                
...

GET /api/perspective/metadata/json/{perspectiveId}/{classId}/{objectId}

Get children objects package with properties of the specified object with the given class in the given perspective context. Please note that returned attribute "hasChildren" is for now always set to false.

Request Parameters
name type description default constraints
classId path The unique identifier of object class.   long
objectId path The unique identifier of object.   long
perspectiveId path The unique identifier of perspective.   long
childClassId query The unique identifier of children class.   long
limit query Used in paging, defines the number of objects returned in a single call. 10000 long
offset query Used in paging, defines the offset for positions.   long
sortField query Used as a sorting base of the returned objects package, consists of field name and sorting directions: 'asc' or 'desc' (format: sortField=[{"property":"hd_docdescr","direction":"ASC"}])    
status query If set to true - status mode is activated. false boolean
subtree query false boolean
subtreePerspectiveId query   long
Response Body
media type data type description
application/json object (JSON) JSON Response with the list of children objects with properties in the given perspective.

Example of response:

{"children":[{"hasChildren":false,"linkedToSpot":false,"metadata":{"fi2spsys_sysid":"","fi2floor_areabta":"","fi2spsys_descr":"","hd_objcustom3":"","hd_objcustom4":"","hdid":"644","hd_objcustom1":"","hd_objcustom2":"","fi2spsys_id":"90000164","fi2spsys_fullname":"","fi2spsys_class":"","haschildren":"false","fi2spsys_guid":"","fi2spsys_name":"9TR","classid":"13"},"contentType":0,"contentId":0,"objectId":"644","classId":"13", "securityMask":"3"},{"hasChildren":false,"linkedToSpot":false,"metadata": {"fi2spsys_sysid":"nrnr","fi2floor_areabta":"","fi2spsys_descr":"","hd_objcustom3":"","hd_objcustom4":"","hdid":"900","hd_objcustom1":"","hd_objcustom2":"","fi2spsys_id":"90000158","fi2spsys_fullname":"","fi2spsys_class":"","haschildren":"false","fi2spsys_guid":"5f16a417-a499-4352-a073-ff7bab34f958","fi2spsys_name":"UKV","classid":"13"},"contentType":0,"contentId":0,"objectId":"900","classId":"13", "securityMask":"3"},{"hasChildren":false,"linkedToSpot":false,"metadata": {"fi2spsys_sysid":"","fi2floor_areabta":"","fi2spsys_descr":"","hd_objcustom3":"","hd_objcustom4":"","hdid":"1458","hd_objcustom1":"","hd_objcustom2":"","fi2spsys_id":"2AA8E419AE674244BEE15585BC44C0DE","fi2spsys_fullname":"ggg","fi2spsys_class":"","haschildren":"false","fi2spsys_guid":"7568b150-031f-4649-92cc-b42a108e9df5","fi2spsys_name":"BV","classid":"13"},"contentType":0,"contentId":0,"objectId":"1458","classId":"13", "securityMask":"3"},{"hasChildren":false,"linkedToSpot":false,"metadata": {"fi2spsys_sysid":"","fi2floor_areabta":"","fi2spsys_descr":"","hd_objcustom3":"","hd_objcustom4":"","hdid":"1729","hd_objcustom1":"","hd_objcustom2":"","fi2spsys_id":"102","fi2spsys_fullname":"","fi2spsys_class":"","hasChildren":"false","fi2spsys_guid":"2a27bd3d-16ba-44f7-a690-648375b0c869","fi2spsys_name":"KV","classid":"13"},"contentType":0,"contentId":0,"objectId":"1729","classId":"13", "securityMask":"3"},{"hasChildren":false,"linkedToSpot":false,"metadata": {"fi2spsys_sysid":"","fi2floor_areabta":"","fi2spsys_descr":"","hd_objcustom3":"","hd_objcustom4":"","hdid":"1731","hd_objcustom1":"","hd_objcustom2":"","fi2spsys_id":"104","fi2spsys_fullname":"hhhfhfhfhaa","fi2spsys_class":"nrn","hasChildren":"false","fi2spsys_guid":"042e3f4d-467b-47f5-8e32-d7d15c5fb2d5","fi2spsys_name":"1TR","classid":"13"},"contentType":0,"contentId":0,"objectId":"1731","classId":"13", "securityMask":"3"},{"hasChildren":false,"linkedToSpot":false,"metadata": {"fi2spsys_sysid":"","fi2floor_areabta":"","fi2spsys_descr":"","hd_objcustom3":"","hd_objcustom4":"","hdid":"1737","hd_objcustom1":"","hd_objcustom2":"","fi2spsys_id":"110","fi2spsys_fullname":"","fi2spsys_class":"","hasChildren":"false","fi2spsys_guid":"70bcac3d-f75c-4ba8-ba69-e287aaf52e94","fi2spsys_name":"3TR","classid":"13"},"contentType":0,"contentId":0,"objectId":"1737","classId":"13", "securityMask":"3"},{"hasChildren":false,"linkedToSpot":false,"metadata": {"fi2spsys_sysid":"","fi2floor_areabta":"","fi2spsys_descr":"","hd_objcustom3":"","hd_objcustom4":"","hdid":"1738","hd_objcustom1":"","hd_objcustom2":"","fi2spsys_id":"111","fi2spsys_fullname":"","fi2spsys_class":"","hasChildren":"false","fi2spsys_guid":"af63c730-9348-48d4-ab0b-00c851756370","fi2spsys_name":"4TR","classid":"13"},"contentType":0,"contentId":0,"objectId":"1738","classId":"13", "securityMask":"3"},{"hasChildren":false,"linkedToSpot":false,"metadata": {"fi2spsys_sysid":"","fi2floor_areabta":"","fi2spsys_descr":"","hd_objcustom3":"","hd_objcustom4":"","hdid":"1739","hd_objcustom1":"","hd_objcustom2":"","fi2spsys_id":"112","fi2spsys_fullname":"","fi2spsys_class":"","hasChildren":"false","fi2spsys_guid":"db7b1069-19fe-46ad-903b-13424b6b409c","fi2spsys_name":"5TR","classid":"13"},"contentType":0,"contentId":0,"objectId":"1739","classId":"13", "securityMask":"3"},{"hasChildren":false,"linkedToSpot":false,"metadata": {"fi2spsys_sysid":"","fi2floor_areabta":"","fi2spsys_descr":"","hd_objcustom3":"","hd_objcustom4":"","hdid":"1740","hd_objcustom1":"","hd_objcustom2":"","fi2spsys_id":"113","fi2spsys_fullname":"","fi2spsys_class":"","hasChildren":"false","fi2spsys_guid":"63f7d28f-ad5a-497e-814d-35bdf655e039","fi2spsys_name":"6TR","classid":"13"},"contentType":0,"contentId":0,"objectId":"1740","classId":"13", "securityMask":"3"},{"hasChildren":false,"linkedToSpot":false,"metadata": {"fi2spsys_sysid":"","fi2floor_areabta":"","fi2spsys_descr":"","hd_objcustom3":"","hd_objcustom4":"","hdid":"183128","hd_objcustom1":"","hd_objcustom2":"","fi2spsys_id":"","fi2spsys_fullname":"","fi2spsys_class":"","haschildren":"false","fi2spsys_guid":"","fi2spsys_name":"","classid":"13"},"contentType":0,"contentId":0,"objectId":"183128","classId":"13", "securityMask":"3"}],"total":"10","hasChildren":false,"linkedToSpot":false,"metadata": {},"contentType":0,"contentId":0,"objectId":"325","classId":"12", "securityMask":"3"}

Example

Request
GET /api/perspective/metadata/json/{perspectiveId}/{classId}/{objectId}
Content-Type: */*
Accept: application/json

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

                
...

GET /api/perspective/parent/json/{perspId}/{classId}/{objectId}

Get parent object for the specified perspective, class and identifier

Request Parameters
name type description constraints
classId path The unique identifier of object class. long
objectId path The unique identifier of object. long
perspId path The unique identifier of perspective. long
Response Body
media type data type description
application/json object (JSON) JSON Response with the specified parent object

Example of response:

{"objectClassId":"11","objectId":"90"}

Example

Request
GET /api/perspective/parent/json/{perspId}/{classId}/{objectId}
Content-Type: */*
Accept: application/json

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

                
...

GET /api/perspective/subtree/json/{perspId}/{classId}/{objectId}

Get subtree from specified object in terms of the specified perspective set.

Request Parameters
name type description default constraints
classId path The unique identifier of object class.   long
objectId path The unique identifier of object.   long
perspId path The unique identifier of perspective.   long
status query If set to true - status mode is activated. false boolean
Response Body
media type data type description
application/json object (JSON) JSON response with the created tree

Example of response:

{"children": [{"children": [{"children": [{"hasChildren": true,"metadata": {}, "contentType": 0, "contentId": 0, "objectName": "1TR", "objectId": "1731", "classId": "13", "securityMask":"3"}, { "hasChildren": true, "metadata": {}, "contentType": 0, "contentId": 0, "objectName": "UKV", "objectId": "900", "classId": "13", "securityMask":"3" }, { "hasChildren": false, "metadata": {}, "contentType": 0, "contentId": 0, "objectName": "", "objectId": "183128", "classId": "13", "securityMask":"3" }], "hasChildren": true, "metadata": {}, "contentType": 0, "contentId": 0, "objectName": "1", "objectId": "325", "classId": "12", "securityMask":"3" }, { "hasChildren": true, "metadata": {}, "contentType": 0, "contentId": 0, "objectName": "4", "objectId": "158712", "classId": "12", "securityMask":"3" }], "hasChildren": true, "metadata": {}, "contentType": 0, "contentId": 0, "objectName": "7101 XXX 2", "objectId": "90", "classId": "11", "securityMask":"3" }, { "hasChildren": true, "metadata": {}, "contentType": 0, "contentId": 0, "objectName": "FZK-Haus-Gelaende", "objectId": "210590", "classId": "11", "securityMask":"3" }, { "hasChildren": true, "metadata": {}, "contentType": 0, "contentId": 0, "objectName": "Gelaende 0815", "objectId": "221026", "classId": "11", "securityMask":"3" }], "hasChildren": true, "metadata": {}, "contentType": 0, "contentId": 0, "objectName": "Root", "objectId": "0", "classId": "10", "securityMask":"3" }

Example

Request
GET /api/perspective/subtree/json/{perspId}/{classId}/{objectId}
Content-Type: */*
Accept: application/json

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

                
...

GET /api/perspective/tree/json/{perspId}/{classId}/{objectId}

Get tree from root to the object with the specified perspective, class and identifier that contains all object's siblings

Request Parameters
name type description default constraints
classId path The unique identifier of object class.   long
objectId path The unique identifier of object.   long
perspId path The unique identifier of perspective.   long
status query If set to true - status mode is activated. false boolean
Response Body
media type data type description
application/json object (JSON) JSON response with the created tree

Example of response:

{"children": [{"children": [{"children": [{"hasChildren": true,"metadata": {}, "contentType": 0, "contentId": 0, "objectName": "1TR", "objectId": "1731", "classId": "13", "securityMask":"3"}, { "hasChildren": true, "metadata": {}, "contentType": 0, "contentId": 0, "objectName": "UKV", "objectId": "900", "classId": "13", "securityMask":"3" }, { "hasChildren": false, "metadata": {}, "contentType": 0, "contentId": 0, "objectName": "", "objectId": "183128", "classId": "13", "securityMask":"3" }], "hasChildren": true, "metadata": {}, "contentType": 0, "contentId": 0, "objectName": "1", "objectId": "325", "classId": "12", "securityMask":"3" }, { "hasChildren": true, "metadata": {}, "contentType": 0, "contentId": 0, "objectName": "4", "objectId": "158712", "classId": "12", "securityMask":"3" }], "hasChildren": true, "metadata": {}, "contentType": 0, "contentId": 0, "objectName": "7101 XXX 2", "objectId": "90", "classId": "11", "securityMask":"3" }, { "hasChildren": true, "metadata": {}, "contentType": 0, "contentId": 0, "objectName": "FZK-Haus-Gelaende", "objectId": "210590", "classId": "11", "securityMask":"3" }, { "hasChildren": true, "metadata": {}, "contentType": 0, "contentId": 0, "objectName": "Gelaende 0815", "objectId": "221026", "classId": "11", "securityMask":"3" }], "hasChildren": true, "metadata": {}, "contentType": 0, "contentId": 0, "objectName": "Root", "objectId": "0", "classId": "10", "securityMask":"3" }

Example

Request
GET /api/perspective/tree/json/{perspId}/{classId}/{objectId}
Content-Type: */*
Accept: application/json

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

                
...

GET /api/perspective/byguid/metadata/json/{perspectiveId}/{contextGuid}/{requiredObjectId}

Get children objects package with properties of the specified object with the given class in the given perspective context and optionally with the specified object in the package. Please note that returned attribute "hasChildren" is for now always set to false.

Request Parameters
name type description default constraints
contextGuid path - The unique system guid identifier of context object    
perspectiveId path The unique identifier of perspective.   long
requiredObjectId path The unique identifier of object that has to be returned within object package.   long
childClassId query The unique identifier of children class.   long
limit query Used in paging, defines the number of objects returned in a single call.   long
offset query   long
sortField query Used as a sorting base of the returned objects package, consists of field name and sorting directions: 'asc' or 'desc' (format: sortField=[{"property":"hd_docdescr","direction":"ASC"}])    
status query If set to true - status mode is activated. false boolean
Response Body
media type data type description
application/json object (JSON) JSON Response with the list of children objects with properties in the given perspective.

Example of response:

{"children":[{"hasChildren":false,"linkedToSpot":false,"metadata": {"fi2spsys_sysid":"","fi2floor_areabta":"","fi2spsys_descr":"","hd_objcustom3":"","hd_objcustom4":"","hdid":"644","hd_objcustom1":"","hd_objcustom2":"","fi2spsys_id":"90000164","fi2spsys_fullname":"","fi2spsys_class":"","hasChildren":"false","fi2spsys_guid":"","fi2spsys_name":"9TR","classid":"13"},"contentType":0,"contentId":0,"objectId":"644","classId":"13", "securityMask":"3"},{"hasChildren":false,"linkedToSpot":false,"metadata": {"fi2spsys_sysid":"nrnr","fi2floor_areabta":"","fi2spsys_descr":"","hd_objcustom3":"","hd_objcustom4":"","hdid":"900","hd_objcustom1":"","hd_objcustom2":"","fi2spsys_id":"90000158","fi2spsys_fullname":"","fi2spsys_class":"","hasChildren":"false","fi2spsys_guid":"5f16a417-a499-4352-a073-ff7bab34f958","fi2spsys_name":"UKV","classid":"13"},"contentType":0,"contentId":0,"objectId":"900","classId":"13", "securityMask":"3"},{"hasChildren":false,"linkedToSpot":false,"metadata": {"fi2spsys_sysid":"","fi2floor_areabta":"","fi2spsys_descr":"","hd_objcustom3":"","hd_objcustom4":"","hdid":"1458","hd_objcustom1":"","hd_objcustom2":"","fi2spsys_id":"2AA8E419AE674244BEE15585BC44C0DE","fi2spsys_fullname":"ggg","fi2spsys_class":"","hasChildren":"false","fi2spsys_guid":"7568b150-031f-4649-92cc-b42a108e9df5","fi2spsys_name":"BV","classid":"13"},"contentType":0,"contentId":0,"objectId":"1458","classId":"13", "securityMask":"3"},{"hasChildren":false,"linkedToSpot":false,"metadata": {"fi2spsys_sysid":"","fi2floor_areabta":"","fi2spsys_descr":"","hd_objcustom3":"","hd_objcustom4":"","hdid":"1729","hd_objcustom1":"","hd_objcustom2":"","fi2spsys_id":"102","fi2spsys_fullname":"","fi2spsys_class":"","hasChildren":"false","fi2spsys_guid":"2a27bd3d-16ba-44f7-a690-648375b0c869","fi2spsys_name":"KV","classid":"13"},"contentType":0,"contentId":0,"objectId":"1729","classId":"13", "securityMask":"3"},{"hasChildren":false,"linkedToSpot":false,"metadata": {"fi2spsys_sysid":"","fi2floor_areabta":"","fi2spsys_descr":"","hd_objcustom3":"","hd_objcustom4":"","hdid":"1731","hd_objcustom1":"","hd_objcustom2":"","fi2spsys_id":"104","fi2spsys_fullname":"hhhfhfhfhaa","fi2spsys_class":"nrn","hasChildren":"false","fi2spsys_guid":"042e3f4d-467b-47f5-8e32-d7d15c5fb2d5","fi2spsys_name":"1TR","classid":"13"},"contentType":0,"contentId":0,"objectId":"1731","classId":"13", "securityMask":"3"},{"hasChildren":false,"linkedToSpot":false,"metadata": {"fi2spsys_sysid":"","fi2floor_areabta":"","fi2spsys_descr":"","hd_objcustom3":"","hd_objcustom4":"","hdid":"1737","hd_objcustom1":"","hd_objcustom2":"","fi2spsys_id":"110","fi2spsys_fullname":"","fi2spsys_class":"","hasChildren":"false","fi2spsys_guid":"70bcac3d-f75c-4ba8-ba69-e287aaf52e94","fi2spsys_name":"3TR","classid":"13"},"contentType":0,"contentId":0,"objectId":"1737","classId":"13", "securityMask":"3"},{"hasChildren":false,"linkedToSpot":false,"metadata": {"fi2spsys_sysid":"","fi2floor_areabta":"","fi2spsys_descr":"","hd_objcustom3":"","hd_objcustom4":"","hdid":"1738","hd_objcustom1":"","hd_objcustom2":"","fi2spsys_id":"111","fi2spsys_fullname":"","fi2spsys_class":"","hasChildren":"false","fi2spsys_guid":"af63c730-9348-48d4-ab0b-00c851756370","fi2spsys_name":"4TR","classid":"13"},"contentType":0,"contentId":0,"objectId":"1738","classId":"13", "securityMask":"3"},{"hasChildren":false,"linkedToSpot":false,"metadata": {"fi2spsys_sysid":"","fi2floor_areabta":"","fi2spsys_descr":"","hd_objcustom3":"","hd_objcustom4":"","hdid":"1739","hd_objcustom1":"","hd_objcustom2":"","fi2spsys_id":"112","fi2spsys_fullname":"","fi2spsys_class":"","hasChildren":"false","fi2spsys_guid":"db7b1069-19fe-46ad-903b-13424b6b409c","fi2spsys_name":"5TR","classid":"13"},"contentType":0,"contentId":0,"objectId":"1739","classId":"13", "securityMask":"3"},{"hasChildren":false,"linkedToSpot":false,"metadata": {"fi2spsys_sysid":"","fi2floor_areabta":"","fi2spsys_descr":"","hd_objcustom3":"","hd_objcustom4":"","hdid":"1740","hd_objcustom1":"","hd_objcustom2":"","fi2spsys_id":"113","fi2spsys_fullname":"","fi2spsys_class":"","hasChildren":"false","fi2spsys_guid":"63f7d28f-ad5a-497e-814d-35bdf655e039","fi2spsys_name":"6TR","classid":"13"},"contentType":0,"contentId":0,"objectId":"1740","classId":"13", "securityMask":"3"},{"hasChildren":false,"linkedToSpot":false,"metadata": {"fi2spsys_sysid":"","fi2floor_areabta":"","fi2spsys_descr":"","hd_objcustom3":"","hd_objcustom4":"","hdid":"183128","hd_objcustom1":"","hd_objcustom2":"","fi2spsys_id":"","fi2spsys_fullname":"","fi2spsys_class":"","haschildren":"false","fi2spsys_guid":"","fi2spsys_name":"","classid":"13"},"contentType":0,"contentId":0,"objectId":"183128","classId":"13", "securityMask":"3"}],"total":"10","hasChildren":false,"linkedToSpot":false,"metadata": {},"contentType":0,"contentId":0,"objectId":"325","classId":"12", "securityMask":"3"}

Example

Request
GET /api/perspective/byguid/metadata/json/{perspectiveId}/{contextGuid}/{requiredObjectId}
Content-Type: */*
Accept: application/json

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

                
...

GET /api/perspective/metadata/json/{perspectiveId}/{classId}/{objectId}/{requiredObjectId}

Get children objects package with properties of the specified object with the given class in the given perspective context and optionally with the specified object in the package. Please note that returned attribute "hasChildren" is for now always set to false.

Request Parameters
name type description default constraints
classId path The unique identifier of object class.   long
objectId path The unique identifier of object.   long
perspectiveId path The unique identifier of perspective.   long
requiredObjectId path The unique identifier of object that has to be returned within object package.   long
childClassId query The unique identifier of children class.   long
limit query Used in paging, defines the number of objects returned in a single call.   long
offset query   long
sortField query Used as a sorting base of the returned objects package, consists of field name and sorting directions: 'asc' or 'desc' (format: sortField=[{"property":"hd_docdescr","direction":"ASC"}])    
status query If set to true - status mode is activated. false boolean
Response Body
media type data type description
application/json object (JSON) JSON Response with the list of children objects with properties in the given perspective.

Example of response:

{"children":[{"hasChildren":false,"linkedToSpot":false,"metadata": {"fi2spsys_sysid":"","fi2floor_areabta":"","fi2spsys_descr":"","hd_objcustom3":"","hd_objcustom4":"","hdid":"644","hd_objcustom1":"","hd_objcustom2":"","fi2spsys_id":"90000164","fi2spsys_fullname":"","fi2spsys_class":"","hasChildren":"false","fi2spsys_guid":"","fi2spsys_name":"9TR","classid":"13"},"contentType":0,"contentId":0,"objectId":"644","classId":"13", "securityMask":"3"},{"hasChildren":false,"linkedToSpot":false,"metadata": {"fi2spsys_sysid":"nrnr","fi2floor_areabta":"","fi2spsys_descr":"","hd_objcustom3":"","hd_objcustom4":"","hdid":"900","hd_objcustom1":"","hd_objcustom2":"","fi2spsys_id":"90000158","fi2spsys_fullname":"","fi2spsys_class":"","hasChildren":"false","fi2spsys_guid":"5f16a417-a499-4352-a073-ff7bab34f958","fi2spsys_name":"UKV","classid":"13"},"contentType":0,"contentId":0,"objectId":"900","classId":"13", "securityMask":"3"},{"hasChildren":false,"linkedToSpot":false,"metadata": {"fi2spsys_sysid":"","fi2floor_areabta":"","fi2spsys_descr":"","hd_objcustom3":"","hd_objcustom4":"","hdid":"1458","hd_objcustom1":"","hd_objcustom2":"","fi2spsys_id":"2AA8E419AE674244BEE15585BC44C0DE","fi2spsys_fullname":"ggg","fi2spsys_class":"","hasChildren":"false","fi2spsys_guid":"7568b150-031f-4649-92cc-b42a108e9df5","fi2spsys_name":"BV","classid":"13"},"contentType":0,"contentId":0,"objectId":"1458","classId":"13", "securityMask":"3"},{"hasChildren":false,"linkedToSpot":false,"metadata": {"fi2spsys_sysid":"","fi2floor_areabta":"","fi2spsys_descr":"","hd_objcustom3":"","hd_objcustom4":"","hdid":"1729","hd_objcustom1":"","hd_objcustom2":"","fi2spsys_id":"102","fi2spsys_fullname":"","fi2spsys_class":"","hasChildren":"false","fi2spsys_guid":"2a27bd3d-16ba-44f7-a690-648375b0c869","fi2spsys_name":"KV","classid":"13"},"contentType":0,"contentId":0,"objectId":"1729","classId":"13", "securityMask":"3"},{"hasChildren":false,"linkedToSpot":false,"metadata": {"fi2spsys_sysid":"","fi2floor_areabta":"","fi2spsys_descr":"","hd_objcustom3":"","hd_objcustom4":"","hdid":"1731","hd_objcustom1":"","hd_objcustom2":"","fi2spsys_id":"104","fi2spsys_fullname":"hhhfhfhfhaa","fi2spsys_class":"nrn","hasChildren":"false","fi2spsys_guid":"042e3f4d-467b-47f5-8e32-d7d15c5fb2d5","fi2spsys_name":"1TR","classid":"13"},"contentType":0,"contentId":0,"objectId":"1731","classId":"13", "securityMask":"3"},{"hasChildren":false,"linkedToSpot":false,"metadata": {"fi2spsys_sysid":"","fi2floor_areabta":"","fi2spsys_descr":"","hd_objcustom3":"","hd_objcustom4":"","hdid":"1737","hd_objcustom1":"","hd_objcustom2":"","fi2spsys_id":"110","fi2spsys_fullname":"","fi2spsys_class":"","hasChildren":"false","fi2spsys_guid":"70bcac3d-f75c-4ba8-ba69-e287aaf52e94","fi2spsys_name":"3TR","classid":"13"},"contentType":0,"contentId":0,"objectId":"1737","classId":"13", "securityMask":"3"},{"hasChildren":false,"linkedToSpot":false,"metadata": {"fi2spsys_sysid":"","fi2floor_areabta":"","fi2spsys_descr":"","hd_objcustom3":"","hd_objcustom4":"","hdid":"1738","hd_objcustom1":"","hd_objcustom2":"","fi2spsys_id":"111","fi2spsys_fullname":"","fi2spsys_class":"","hasChildren":"false","fi2spsys_guid":"af63c730-9348-48d4-ab0b-00c851756370","fi2spsys_name":"4TR","classid":"13"},"contentType":0,"contentId":0,"objectId":"1738","classId":"13", "securityMask":"3"},{"hasChildren":false,"linkedToSpot":false,"metadata": {"fi2spsys_sysid":"","fi2floor_areabta":"","fi2spsys_descr":"","hd_objcustom3":"","hd_objcustom4":"","hdid":"1739","hd_objcustom1":"","hd_objcustom2":"","fi2spsys_id":"112","fi2spsys_fullname":"","fi2spsys_class":"","hasChildren":"false","fi2spsys_guid":"db7b1069-19fe-46ad-903b-13424b6b409c","fi2spsys_name":"5TR","classid":"13"},"contentType":0,"contentId":0,"objectId":"1739","classId":"13", "securityMask":"3"},{"hasChildren":false,"linkedToSpot":false,"metadata": {"fi2spsys_sysid":"","fi2floor_areabta":"","fi2spsys_descr":"","hd_objcustom3":"","hd_objcustom4":"","hdid":"1740","hd_objcustom1":"","hd_objcustom2":"","fi2spsys_id":"113","fi2spsys_fullname":"","fi2spsys_class":"","hasChildren":"false","fi2spsys_guid":"63f7d28f-ad5a-497e-814d-35bdf655e039","fi2spsys_name":"6TR","classid":"13"},"contentType":0,"contentId":0,"objectId":"1740","classId":"13", "securityMask":"3"},{"hasChildren":false,"linkedToSpot":false,"metadata": {"fi2spsys_sysid":"","fi2floor_areabta":"","fi2spsys_descr":"","hd_objcustom3":"","hd_objcustom4":"","hdid":"183128","hd_objcustom1":"","hd_objcustom2":"","fi2spsys_id":"","fi2spsys_fullname":"","fi2spsys_class":"","haschildren":"false","fi2spsys_guid":"","fi2spsys_name":"","classid":"13"},"contentType":0,"contentId":0,"objectId":"183128","classId":"13", "securityMask":"3"}],"total":"10","hasChildren":false,"linkedToSpot":false,"metadata": {},"contentType":0,"contentId":0,"objectId":"325","classId":"12", "securityMask":"3"}

Example

Request
GET /api/perspective/metadata/json/{perspectiveId}/{classId}/{objectId}/{requiredObjectId}
Content-Type: */*
Accept: application/json

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

                
...