Class admin API Resource

WS for getting information about object classes and their fields defined in active system configuration.

GET /api/admin/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": "98", "name": "drawinglink", "parentId": "", "hasContent": false, "label": "Drawing link", "subClasses": false }, { "classId": "15", "name": "equipment", "parentId": "", "hasContent": false, "label": "Equipment", "values": [{ "classId": "16", "name": "ventilation", "parentId": "15", "hasContent": false, "label": "Ventilation", "subClasses": false }], "subClasses": true }, { "classId": "13", "name": "h1_floor", "parentId": "", "hasContent": false, "label": "Plan", "subClasses": false }, { "classId": "14", "name": "h1_space", "parentId": "", "hasContent": false, "label": "Rum", "subClasses": false }, { "classId": "11", "name": "h1_prop", "parentId": "", "hasContent": false, "label": "Fastighet", "subClasses": false }, { "classId": "12", "name": "h1_struct", "parentId": "", "hasContent": false, "label": "Hus", "subClasses": false }, { "classId": "10", "name": "root", "parentId": "", "hasContent": false, "label": "Faciliteter", "subClasses": false }] }

Example

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

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

                
{ }

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

Get description of specified object class in active configuration

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

Example of response:

{ "list": [{ "isDynamicField": false, "name": "hdid", "seq": "0", "label": "HyperDoc ID", "required": true, "isIdField": true, "typeId": 4, "isLabelField": false }, { "isDynamicField": false, "name": "nm", "seq": "1", "label": "HyperDoc Name", "required": false, "isIdField": false, "typeId": 2, "isLabelField": false }, { "isDynamicField": false, "name": "fi2spsys_id", "seq": "2", "label": "Floor ID", "required": false, "isIdField": false, "typeId": 2, "isLabelField": false }, { "isDynamicField": false, "name": "fi2spsys_class", "seq": "3", "label": "Class", "required": false, "isIdField": false, "typeId": 2, "isLabelField": false }, { "isDynamicField": false, "name": "fi2spsys_sysid", "seq": "4", "label": "Sys ID", "required": false, "isIdField": false, "typeId": 2, "isLabelField": false }, { "isDynamicField": false, "name": "fi2spsys_guid", "seq": "5", "label": "GUID", "required": false, "isIdField": false, "typeId": 2, "isLabelField": false }, { "isDynamicField": false, "name": "fi2spsys_name", "seq": "6", "label": "Floor", "required": true, "isIdField": false, "typeId": 2, "isLabelField": true }, { "isDynamicField": false, "name": "fi2spsys_fullname", "seq": "7", "label": "Fullname", "required": false, "isIdField": false, "typeId": 2, "isLabelField": false }, { "isDynamicField": false, "name": "fi2spsys_descr", "seq": "8", "label": "Description", "required": false, "isIdField": false, "typeId": 2, "isLabelField": false }] }

Example

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

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

                
...

GET /api/admin/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/admin/class/names/json
Content-Type: */*
Accept: application/json

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

                
...

GET /api/admin/class/types/json

Get list of defined field types.

Response Body
media type data type description
application/json object (JSON) JSON Response

Example of response:

{"dictId":"FieldTypes","list":{3:"Float",2:"Text",10:"Quantity",1:"None",7:"Dictionary",6:"Boolean",5:"DateTime",4:"Integer"}}

Example

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

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

                
...