Config API Resource

Rest class for configuration

GET /api/config/attrmasks

This method has been deprecated. to be removed in a version with database configuration support implemented.

Get masks of PropertyAttribute enum type as attrName, attrValue pairs.

Response Body
media type data type description
application/json object (JSON) The desired dictionary as JSON String Response.

Example

Request
GET /api/config/attrmasks
Content-Type: */*
Accept: application/json

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

                
...

GET /api/config/class/json

Get list of object classes in active configuration.

Response Body
media type data type description
application/json HdcAdminClassTO (JSON) JSON Response with list of classes

Example of response:

{"values":[{"classId":"15","name":"equipment","parentId":"","hasContent":false,"isExternalContent":false,"templateUrl":"","label":"Equipment","values":[{"classId":"16","name":"ventilation","parentId":"15","hasContent":false,"isExternalContent":false,"templateUrl":"","label":"Ventilation","subClasses":false}],"subClasses":true},{"classId":"13","name":"h1_floor","parentId":"","hasContent":false,"isExternalContent":false,"templateUrl":"","label":"Plan","subClasses":false},{"classId":"14","name":"h1_space","parentId":"","hasContent":false,"isExternalContent":false,"templateUrl":"","label":"Rum","subClasses":false},{"classId":"1497","name":"org2grp","parentId":"","hasContent":false,"isExternalContent":false,"templateUrl":"","label":"Marknadsomrade","subClasses":false},{"classId":"1498","name":"org3grp","parentId":"","hasContent":false,"isExternalContent":false,"templateUrl":"","label":"Affärsomrade","subClasses":false},{"classId":"11","name":"h1_propjtte","parentId":"","hasContent":false,"isExternalContent":false,"templateUrl":"","label":"Fastighet","subClasses":false},{"classId":"12","name":"h1_struct","parentId":"","hasContent":false,"isExternalContent":false,"templateUrl":"","label":"Hus","subClasses":false},{"classId":"10","name":"root","parentId":"","hasContent":false,"isExternalContent":false,"templateUrl":"","label":"Facilitetere","subClasses":false},{"classId":"100","name":"document","parentId":"","hasContent":true,"isExternalContent":false,"templateUrl":"","label":"Dokument","values":[{"classId":"1590","name":"point_cloud","parentId":"100","hasContent":false,"isExternalContent":true,"templateUrl":"https://websharecloud.com/?v=pv&t=p:default,c:panoramaview,m:f&pv=pv1&pv1=t:annotation,o:{scene_guid}&p={faro_project}","label":"Point Cloud","subClasses":false},{"classId":"109","name":"mark","parentId":"100","hasContent":true,"isExternalContent":false,"templateUrl":"","label":"Mark","subClasses":false},{"classId":"108","name":"vent","parentId":"100","hasContent":true,"isExternalContent":false,"templateUrl":"","label":"Vent","subClasses":false},{"classId":"107","name":"el","parentId":"100","hasContent":true,"isExternalContent":false,"templateUrl":"","label":"El","subClasses":false},{"classId":"106","name":"vs","parentId":"100","hasContent":true,"isExternalContent":false,"templateUrl":"","label":"VS","subClasses":false},{"classId":"105","name":"k","parentId":"100","hasContent":true,"isExternalContent":false,"templateUrl":"","label":"K","subClasses":false},{"classId":"104","name":"brand","parentId":"100","hasContent":true,"isExternalContent":false,"templateUrl":"","label":"Brand","subClasses":false},{"classId":"103","name":"historiskt","parentId":"100","hasContent":true,"isExternalContent":false,"templateUrl":"","label":"Historisk","subClasses":false},{"classId":"102","name":"navigation","parentId":"100","hasContent":true,"isExternalContent":false,"templateUrl":"","label":"Navigation","subClasses":false},{"classId":"101","name":"arkitekt","parentId":"100","hasContent":true,"isExternalContent":false,"templateUrl":"","label":"Arkitekt","values":[{"classId":"110","name":"Arki1","parentId":"101","hasContent":true,"isExternalContent":false,"templateUrl":"","label":"Arki1","subClasses":false}],"subClasses":true}],"subClasses":true}]}

Example

Request
GET /api/config/class/json
Content-Type: */*
Accept: application/json

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

                
{ }

GET /api/config/classes/json

Get schema of the specified class.

Response Body
media type data type description
application/json object (JSON) JSON String Response with the schema of the specified class.

Example of response:

{ list :[{"metadata":[{"fieldId":"fi2spsys_id","fieldLabel":"ID","fieldType":"text",fieldMask: 48},{"fieldId":"fi2spsys_name","fieldLabel":"Plan","fieldType":"text",fieldMask: 48}],"classId":"13","className":"Plan","labelField":"fi2spsys_name","types":[{"name":"generic floor","id":"0"}]}]}

Example

Request
GET /api/config/classes/json
Content-Type: */*
Accept: application/json

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

                
...

GET /api/config/dicts/json

Get contents of all dictionaries

Response Body
media type data type description
application/json object (JSON) JSON Response with content of dictionary

Example of response:

{ list : [{"dictId":"2","list":[{"dictKey":"00","dictValue":"Undefined","seq":0},{"dictKey":"BIA","dictValue":"BIA","seq":1},{"dictKey":"BOA","dictValue":"BOA"},{"dictKey":"LOA","dictValue":"LOA","seq":2},{"dictKey":"____VA","dictValue":"____VA","seq":3}]}]}

Example

Request
GET /api/config/dicts/json
Content-Type: */*
Accept: application/json

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

                
...

GET /api/config/perspectivesets/json

Get structure of all perspective sets.

Response Body
media type data type description
application/json array of HdcPerspectiveSetTO (JSON) JSON String Response with the schema for given perspective set; the only service that distinguish the rootlevel.

Example of response:

{ list :[{"perspectiveSetId":"1","rootClassId":"110","rootId":"13","list":[{"classId":"10","className":"root","parentClassId":"","subclasses":false,"descendants":[{"classId":"11","className":"h1_prop","parentClassId":"","subclasses":false}]},{"classId":"11","className":"h1_prop","parentClassId":"","subclasses":false,"descendants":[{"classId":"12","className":"h1_struct","parentClassId":"","subclasses":false}]},{"classId":"12","className":"h1_struct","parentClassId":"","subclasses":false,"descendants":[{"classId":"13","className":"h1_floor","parentClassId":"","subclasses":false}]},{"classId":"13","className":"h1_floor","parentClassId":"","subclasses":false,"descendants":[{"classId":"14","className":"h1_space","parentClassId":"","subclasses":false}]},{"classId":"14","className":"h1_space","parentClassId":"","subclasses":false}],"error":false}]}

Example

Request
GET /api/config/perspectivesets/json
Content-Type: */*
Accept: application/json

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

                
[ { } ]

GET /api/config/class/json/{classId}

Get schema of the specified class.

Request Parameters
name type description constraints
classId path The unique identifier of class that schema is returned in response. long
Response Body
media type data type description
application/json HdcClassSchemaTO (JSON) JSON String Response with the schema of the specified class.

Example of response:

{"metadata":[{"fieldId":"fi2spsys_id","fieldLabel":"ID","fieldType":"text",fieldMask: 48},{"fieldId":"fi2spsys_name","fieldLabel":"Plan","fieldType":"text",fieldMask: 48}],"classId":"13","className":"Plan","labelField":"fi2spsys_name","types":[{"name":"generic floor","id":"0"}]}

Example

Request
GET /api/config/class/json/{classId}
Content-Type: */*
Accept: application/json

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

                
{ }

GET /api/config/class/names/json

Get list of object classes names in active configuration.

Response Body
media type data type description
application/json object (JSON) JSON Response with list of classes

Example of response:

{"list":[{"classId":"101","name":"org4grp","parentId":"","hasContent":false,"isExternalContent":false,"values":[],"subClasses":false,"properties":[]},{"classId":"105","name":"struct","parentId":"","hasContent":false,"isExternalContent":false,"values":[],"subClasses":false,"properties":[]},{"classId":"104","name":"prop","parentId":"","hasContent":false,"isExternalContent":false,"values":[],"subClasses":false,"properties":[]},{"classId":"103","name":"org2grp","parentId":"","hasContent":false,"isExternalContent":false,"values":[],"subClasses":false,"properties":[]},{"classId":"102","name":"org3grp","parentId":"","hasContent":false,"isExternalContent":false,"values":[],"subClasses":false,"properties":[]},{"classId":"111","name":"document","parentId":"","hasContent":false,"isExternalContent":false,"values":[],"subClasses":false,"properties":[]},{"classId":"106","name":"org1grp","parentId":"","hasContent":false,"isExternalContent":false,"values":[],"subClasses":false,"properties":[]},{"classId":"107","name":"floor","parentId":"","hasContent":false,"isExternalContent":false,"values":[],"subClasses":false,"properties":[]},{"classId":"108","name":"space","parentId":"","hasContent":false,"isExternalContent":false,"values":[],"subClasses":false,"properties":[]},{"classId":"109","name":"object","parentId":"","hasContent":false,"isExternalContent":false,"values":[],"subClasses":false,"properties":[]},{"classId":"110","name":"root","parentId":"","hasContent":false,"isExternalContent":false,"values":[],"subClasses":false,"properties":[]},{"classId":"112","name":"fi2equipment","parentId":"","hasContent":false,"isExternalContent":false,"values":[],"subClasses":false,"properties":[]},{"classId":"113","name":"arkitekt","parentId":"","hasContent":false,"isExternalContent":false,"values":[],"subClasses":false,"properties":[]},{"classId":"115","name":"konstr","parentId":"","hasContent":false,"isExternalContent":false,"values":[],"subClasses":false,"properties":[]},{"classId":"114","name":"mark","parentId":"","hasContent":false,"isExternalContent":false,"values":[],"subClasses":false,"properties":[]},{"classId":"116","name":"vs","parentId":"","hasContent":false,"isExternalContent":false,"values":[],"subClasses":false,"properties":[]},{"classId":"117","name":"ventilation","parentId":"","hasContent":false,"isExternalContent":false,"values":[],"subClasses":false,"properties":[]},{"classId":"118","name":"el","parentId":"","hasContent":false,"isExternalContent":false,"values":[],"subClasses":false,"properties":[]},{"classId":"119","name":"event","parentId":"","hasContent":false,"isExternalContent":false,"values":[],"subClasses":false,"properties":[]},{"classId":"120","name":"foto","parentId":"","hasContent":false,"isExternalContent":false,"values":[],"subClasses":false,"properties":[]},{"classId":"121","name":"navigation","parentId":"","hasContent":false,"isExternalContent":false,"values":[],"subClasses":false,"properties":[]},{"classId":"122","name":"historisk","parentId":"","hasContent":false,"isExternalContent":false,"values":[],"subClasses":false,"properties":[]},{"classId":"123","name":"sba","parentId":"","hasContent":false,"isExternalContent":false,"values":[],"subClasses":false,"properties":[]},{"classId":"124","name":"brand","parentId":"","hasContent":false,"isExternalContent":false,"values":[],"subClasses":false,"properties":[]},{"classId":"125","name":"point_cloud","parentId":"","hasContent":false,"isExternalContent":false,"values":[],"subClasses":false,"properties":[]},{"classId":"126","name":"point_cloud_url","parentId":"","hasContent":false,"isExternalContent":false,"values":[],"subClasses":false,"properties":[]},{"classId":"127","name":"contract","parentId":"","hasContent":false,"isExternalContent":false,"values":[],"subClasses":false,"properties":[]},{"classId":"128","name":"ru","parentId":"","hasContent":false,"isExternalContent":false,"values":[],"subClasses":false,"properties":[]},{"classId":"130","name":"hdv_h3_struct","parentId":"","hasContent":false,"isExternalContent":false,"values":[],"subClasses":false,"properties":[]},{"classId":"132","name":"hdv_h3_space","parentId":"","hasContent":false,"isExternalContent":false,"values":[],"subClasses":false,"properties":[]},{"classId":"131","name":"hdv_h3_floor","parentId":"","hasContent":false,"isExternalContent":false,"values":[],"subClasses":false,"properties":[]}]}

Example

Request
GET /api/config/class/names/json
Content-Type: */*
Accept: application/json

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

                
...

GET /api/config/dict/json/{dictId}

Get contents of specified dictionary

Request Parameters
name type description constraints
dictId path Unique identifier of dictionary long
Response Body
media type data type description
application/json object (JSON) JSON Response with content of dictionary

Example of response:

{"dictId":"2","list":[{"dictKey":"00","dictValue":"Undefined","seq":0},{"dictKey":"BIA","dictValue":"BIA","seq":1},{"dictKey":"BOA","dictValue":"BOA"},{"dictKey":"LOA","dictValue":"LOA","seq":2},{"dictKey":"____VA","dictValue":"____VA","seq":3}]}

Example

Request
GET /api/config/dict/json/{dictId}
Content-Type: */*
Accept: application/json

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

                
...

GET /api/config/perspectiveset/json/{perspectiveSetId}

Get structure of the specified perspective set.

Request Parameters
name type description constraints
perspectiveSetId path The unique identifier of perspective set. long
Response Body
media type data type description
application/json HdcPerspectiveSetTO (JSON) JSON String Response with the schema for given perspective set; the only service that distinguish the rootlevel.

Example of response:

{"perspectiveSetId":"1","rootClassId":"110","rootId":"13","list":[{"classId":"10","className":"root","parentClassId":"","subclasses":false,"descendants":[{"classId":"11","className":"h1_prop","parentClassId":"","subclasses":false}]},{"classId":"11","className":"h1_prop","parentClassId":"","subclasses":false,"descendants":[{"classId":"12","className":"h1_struct","parentClassId":"","subclasses":false}]},{"classId":"12","className":"h1_struct","parentClassId":"","subclasses":false,"descendants":[{"classId":"13","className":"h1_floor","parentClassId":"","subclasses":false}]},{"classId":"13","className":"h1_floor","parentClassId":"","subclasses":false,"descendants":[{"classId":"14","className":"h1_space","parentClassId":"","subclasses":false}]},{"classId":"14","className":"h1_space","parentClassId":"","subclasses":false}],"error":false}

Example

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

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

                
{ }

GET /api/config/system/dict/json/{dictId}

Get specified system dictionary.

Request Parameters
name type description
dictId path Name of system dictionary. Possible values: langs, units, unitsymbols
Response Body
media type data type description
application/json object (JSON) All values of specified dictionary

Example

Request
GET /api/config/system/dict/json/{dictId}
Content-Type: */*
Accept: application/json

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

                
...