Layer tdxm API Resource

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

POST /tdxm/layersmapping/global/{domainId}

Add global layer mapping.

Example of request:

Request Parameters
name type description default constraints
domainId path   required long
Request Body
media type data type description
application/json object The specification of layer mapping that has to be added.
Response Body
media type data type description
application/json object JSON Response with information, whether the adding has or has not been succeeded.

DELETE /tdxm/layersmapping/global/{mappingId}

Remove global layer mapping

Request Parameters
name type description default constraints
mappingId path ID of layer mapping   long
Response Body
media type data type description
application/json object JSON Response with information, whether the removing has or has not been succeeded.

POST /tdxm/layersmapping/local/{domainId}

Add local layer mapping.

Example of request:

Request Parameters
name type description default constraints
domainId path   required long
Request Body
media type data type description
application/json object The specification of layer mapping that has to be added.
Response Body
media type data type description
application/json object JSON Response with information, whether the adding has or has not been succeeded.

DELETE /tdxm/layersmapping/local/{mappingId}

Remove local layer mapping

Request Parameters
name type description default constraints
mappingId path ID of layer mapping   long
Response Body
media type data type description
application/json object JSON Response with information, whether the removing has or has not been succeeded.

POST /tdxm/layersmapping/assign/{domainId}/{layerName}

Assign restrictions for users or/and groups

Example of request:

{"list":[{"id":"userId"}]} or {"list":[{"id":"groupId"}]}

Request Parameters
name type description default constraints
domainId path   required long
layerName path    
restriction query restriction type    
Request Body
media type data type
application/json string
Response Body
media type data type description
application/json object JSON response with information if assignment was successful or not

GET /tdxm/layersmapping/global/json/{domainId}

Get list of global layers mappings.

Request Parameters
name type description default constraints
domainId path   long
Response Body
media type data type description
application/json object JSON Response with list of layers mappings

Example of response:

GET /tdxm/layersmapping/layer/global/json

Get list of global layers

Response Body
media type data type description
application/json object JSON with list of layers

GET /tdxm/layersmapping/local/json/{domainId}

Get list of local layers mappings.

Request Parameters
name type description default constraints
domainId path   long
Response Body
media type data type description
application/json object JSON Response with list of layers mappings

Example of response:

GET /tdxm/layersmapping/members/{domainId}/{layerName}

Get list of users or groups, which are restricted for private layer mapping in domain

Request Parameters
name type description default constraints
domainId path domain Id   required long
layerName path target layer name in mapping    
mode query Could be users - get list of users or groups - get list of groups    
restriction query restriction type    
Response Body
media type data type description
application/json object JSON Response with list of users/groups

Example of response:

{"list":[{"id":2,"userFullName":"User 1","description":"","email":"john.doe@example.com"}]} or {"list":[{"id":22,"name":"Group C5","description":"Description of group C1"}]}

POST /tdxm/layersmapping/unassign/{domainId}/{layerName}

Unassign restrictions for users or/and groups

Example of request:

{"list":[{"id":"userId"}]} or {"list":[{"id":"groupId"}]}

Request Parameters
name type description default constraints
domainId path   required long
layerName path    
restriction query restriction type    
Request Body
media type data type
application/json string
Response Body
media type data type description
application/json object JSON response with information if assignment was successful or not