Tessel HDC API documentation: Config (tdxm) admin API

Abstract class for REST webservices

POST /tdxm/config/rewrite

Response Body
media type	data type	description
application/json	object

POST /tdxm/config/classrelation/json

Request Body
media type	data type
application/json	string

Response Body
media type	data type	description
application/json	object

DELETE /tdxm/config/contextparent/{domainId}

Delete context root configuration for given domain

Request Parameters
name	type	description	default	constraints
domainId	path	domain ID		long

Response Body
media type	data type	description
application/json	object	JSON Response with information if deleting context parent configuration for domain was successful or not

GET /tdxm/config/contextparent/{domainId}

Get context root configuration for given domain

Request Parameters
name	type	description	default	constraints
domainId	path			long

Response Body
media type	data type	description
application/json	object	JSON Response with the configuration for context parent. Example of response: `{"configuredContextRootClassId": "102","configuredContextRootFieldToMatch": "borgitm_descr","contextRootIdChildFieldName": "prop_parent","contextRootChildClassName": "fi2property"}`

POST /tdxm/config/contextparent/{domainId}

Set context root configuration for given domain

Request Parameters
name	type	description	default	constraints
domainId	path			long

Request Body
media type	data type	description
/	object	HdcContextParentTO

Response Body
media type	data type	description
application/json	object

POST /tdxm/config/domain/json

Request Body
media type	data type
application/json	object

Response Body
media type	data type	description
application/json	object

GET /tdxm/config/domains/json

Response Body
media type	data type	description
application/json	object

POST /tdxm/config/importconfig/{domainId}

Request Parameters
name	type	description	default	constraints
domainId	path			long

Request Body
media type	data type
multipart/form-data	(custom)

Response Body
media type	data type	description
application/json	object

GET /tdxm/config/internaldomains/json

Response Body
media type	data type	description
application/json	object

DELETE /tdxm/config/class/guidfield/{classId}

Request Parameters
name	type	description	default	constraints
classId	path			long

Response Body
media type	data type	description
application/json	object

DELETE /tdxm/config/class/json/{classId}

Request Parameters
name	type	description	default	constraints
classId	path			long

Response Body
media type	data type	description
application/json	object

PUT /tdxm/config/class/json/{classId}

Request Parameters
name	type	description	default	constraints
classId	path			long

Request Body
media type	data type
application/json	object

Response Body
media type	data type	description
application/json	object

POST /tdxm/config/class/json/{domainId}

Request Parameters
name	type	description	default	constraints
domainId	path			long

Request Body
media type	data type
application/json	object

Response Body
media type	data type	description
application/json	object

GET /tdxm/config/class/names/json

Get list of object classes names in active configuration.

Response Body
media type	data type	description
application/json	object	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":[]}]}

DELETE /tdxm/config/class/scalefield/{classId}

Remove scale field from class

Request Parameters
name	type	description	default	constraints
classId	path	- class id		long

Response Body
media type	data type	description
application/json	object

DELETE /tdxm/config/class/searchfields/{classId}

Request Parameters
name	type	description	default	constraints
classId	path			long

Response Body
media type	data type	description
application/json	object

PUT /tdxm/config/class/searchfields/{classId}

Request Parameters
name	type	description	default	constraints
classId	path			long

Request Body
media type	data type
/	object

Response Body
media type	data type	description
application/json	object

DELETE /tdxm/config/class/ssfield/{classId}

Remove security scheme id field from class

Request Parameters
name	type	description	default	constraints
classId	path	- class id		long

Response Body
media type	data type	description
application/json	object

GET /tdxm/config/classes/json/{domainId}

Request Parameters
name	type	description	default	constraints
domainId	path			long

Response Body
media type	data type	description
application/json	object

DELETE /tdxm/config/classrelation/json/{relationId}

Request Parameters
name	type	description	default	constraints
relationId	path			long

Response Body
media type	data type	description
application/json	object

PUT /tdxm/config/classrelation/json/{relationId}

Request Parameters
name	type	description	default	constraints
relationId	path			long

Request Body
media type	data type
application/json	string

Response Body
media type	data type	description
application/json	object

GET /tdxm/config/classrelations/json/{domainId}

Request Parameters
name	type	description	default	constraints
domainId	path			long

Response Body
media type	data type	description
application/json	object

DELETE /tdxm/config/coordinatesrelation/json/{classRelationId}

Request Parameters
name	type	description	default	constraints
classRelationId	path			long

Response Body
media type	data type	description
application/json	object

PUT /tdxm/config/coordinatesrelation/json/{classRelationId}

Request Parameters
name	type	description	default	constraints
classRelationId	path			long

Request Body
media type	data type
application/json	string

Response Body
media type	data type	description
application/json	object

GET /tdxm/config/coordinatesrelation/json/{relationId}

Request Parameters
name	type	description	default	constraints
relationId	path			long

Response Body
media type	data type	description
application/json	object

DELETE /tdxm/config/domain/json/{domainId}

Request Parameters
name	type	description	default	constraints
domainId	path			long

Response Body
media type	data type	description
application/json	object

PUT /tdxm/config/domain/json/{domainId}

Updates existing external domain

Request Parameters
name	type	description	default	constraints
domainId	path	id of the domain		long

Request Body
media type	data type
application/json	object

Response Body
media type	data type	description
application/json	object	Sample input: {"domainName":"d1", "isPublic":false}

POST /tdxm/config/field/json/{classId}

Request Parameters
name	type	description	default	constraints
classId	path			long

Request Body
media type	data type
application/json	object

Response Body
media type	data type	description
application/json	object

DELETE /tdxm/config/field/json/{fieldId}

Request Parameters
name	type	description	default	constraints
fieldId	path			long

Response Body
media type	data type	description
application/json	object

PUT /tdxm/config/field/json/{fieldId}

Request Parameters
name	type	description	default	constraints
fieldId	path			long

Request Body
media type	data type
application/json	object

Response Body
media type	data type	description
application/json	object

GET /tdxm/config/fields/json/{classId}

Request Parameters
name	type	description	default	constraints
classId	path			long

Response Body
media type	data type	description
application/json	object

POST /tdxm/config/fieldsrelation/json/{classRelationId}

Request Parameters
name	type	description	default	constraints
classRelationId	path			long

Request Body
media type	data type
application/json	string

Response Body
media type	data type	description
application/json	object

PUT /tdxm/config/fieldsrelation/json/{classRelationId}

Request Parameters
name	type	description	default	constraints
classRelationId	path			long

Request Body
media type	data type
application/json	string

Response Body
media type	data type	description
application/json	object

GET /tdxm/config/fieldsrelations/json/{relationId}

Get list of field relations for tdxm class mapping

Request Parameters
name	type	description	default	constraints
relationId	path	id of tdxm class mapping		long

Response Body
media type	data type	description
application/json	object	JSON Response with list of field relations Example of response: `{"list":[{"srcClass":"HDV_H1_ORG2GRP","dstFieldId":"368","dstField":"fmf_name","srcFieldId":"599","srcField":"BORGITM_DESCR","relationId":"23","idMapping":false},{"srcClass":"HDV_H1_ORG2GRP","dstFieldId":"367","dstField":"fmf_id","srcFieldId":"894","srcField":"BORGITM_ID","relationId":"23","idMapping":true}]}`

POST /tdxm/config/importconfig/xls/{domainId}

Import external domain classes with fields from xls

Request Parameters
name	type	description	default	constraints
domainId	path	Id of the target import domain file upload request with xls with external domain configuration		long

Request Body
media type	data type
multipart/form-data	(custom)

Response Body
media type	data type	description
application/json	object

GET /tdxm/config/livesource/json/{domainId}

Get information about live source for given domain.

Request Parameters
name	type	description	default	constraints
domainId	path			long

Response Body
media type	data type	description
application/json	object	JSON Response with the list of versions. Example of response: `{"isLiveDataSource":true,"url":"http://webservice.com","properties":{"username":"test","password":"test1"}}`

POST /tdxm/config/livesource/json/{domainId}

Set live source for given domain

Example of request:


{"isLiveDataSource":true,"url":"http://webservice.com","properties":{"username":"test","password":"test1"}}

Request Parameters
name	type	description	default	constraints
domainId	path			long

Request Body
media type	data type	description
application/json	object	HdcLiveSourceTO

Response Body
media type	data type	description
application/json	object	JSON Response with information if setting properties for live source was successful or not

PUT /tdxm/config/class/guidfield/{classId}/{fieldId}

Request Parameters
name	type	description	default	constraints
classId	path			long
fieldId	path			long

Response Body
media type	data type	description
application/json	object

PUT /tdxm/config/class/scalefield/{classId}/{fieldId}

Set scale field for class

Request Parameters
name	type	description	default	constraints
classId	path	- class id		long
fieldId	path	- field id		long

Response Body
media type	data type	description
application/json	object

PUT /tdxm/config/class/ssfield/{classId}/{fieldId}

Set security sheme id field for class

Request Parameters
name	type	description	default	constraints
classId	path	- class id		long
fieldId	path	- field id		long

Response Body
media type	data type	description
application/json	object

POST /tdxm/config/domain/config/import/{domainId}

Import external domain configuration

Request Parameters
name	type	description	default	constraints
domainId	path	Id of the target import domain file upload request with external domain configuration (only xml and json extension are supported)		long

Request Body
media type	data type
multipart/form-data	(custom)

Response Body
media type	data type	description
application/json	object

GET /tdxm/config/domain/config/export/{outputType}/{domainId}

Export external domain configuration

Request Parameters
name	type	description	default	constraints
domainId	path	Id of the exported domain		long
outputType	path	Type of outputFile - JSON or XML

Response Body
media type	data type	description
application/json	object	XML or JSON file with external domain configuration
application/vnd.ms-excel	object
application/xml	object

POST /tdxm/config/domain/config/export/{outputType}/{domainId}

Request Parameters
name	type	description	default	constraints
domainId	path			long
outputType	path

Response Body
media type	data type	description
application/json	object

DELETE /tdxm/config/fieldsrelation/json/{classRelationId}/{srcFieldId}/{dstFieldId}

Request Parameters
name	type	constraints
classRelationId	path	long
dstFieldId	path	long
srcFieldId	path	long

Response Body
media type	data type	description
application/json	object

Config (tdxm) admin API Resource