Layer tdxm API Resource

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

POST /api/tdxm/layersmapping/global/{domainId}

Add global layer mapping.

Example of request:

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

Example

Request
POST /api/tdxm/layersmapping/global/{domainId}
Content-Type: application/json
Accept: application/json

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

                
{ }

DELETE /api/tdxm/layersmapping/global/{mappingId}

Remove global layer mapping

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

Example

Request
DELETE /api/tdxm/layersmapping/global/{mappingId}
Content-Type: */*
Accept: application/json

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

                
{ }

POST /api/tdxm/layersmapping/local/{domainId}

Add local layer mapping.

Example of request:

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

Example

Request
POST /api/tdxm/layersmapping/local/{domainId}
Content-Type: application/json
Accept: application/json

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

                
{ }

DELETE /api/tdxm/layersmapping/local/{mappingId}

Remove local layer mapping

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

Example

Request
DELETE /api/tdxm/layersmapping/local/{mappingId}
Content-Type: */*
Accept: application/json

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

                
{ }

POST /api/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 constraints
domainId path long
layerName path  
restriction query restriction type  
Request Body
media type data type
application/json string (JSON)
Response Body
media type data type description
application/json object (JSON) JSON response with information if assignment was successful or not

Example

Request
POST /api/tdxm/layersmapping/assign/{domainId}/{layerName}
Content-Type: application/json
Accept: application/json

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

                
...

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

Get list of global layers mappings.

Request Parameters
name type description constraints
domainId path long
Response Body
media type data type description
application/json array of HdcLayersMappingsTO (JSON) JSON Response with list of layers mappings

Example of response:

Example

Request
GET /api/tdxm/layersmapping/global/json/{domainId}
Content-Type: */*
Accept: application/json

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

                
[ { } ]

GET /api/tdxm/layersmapping/layer/global/json

Get list of global layers

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

Example

Request
GET /api/tdxm/layersmapping/layer/global/json
Content-Type: */*
Accept: application/json

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

                
...

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

Get list of local layers mappings.

Request Parameters
name type description constraints
domainId path long
Response Body
media type data type description
application/json array of HdcLocalLayersMappingsTO (JSON) JSON Response with list of layers mappings

Example of response:

Example

Request
GET /api/tdxm/layersmapping/local/json/{domainId}
Content-Type: */*
Accept: application/json

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

                
[ { } ]

GET /api/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 constraints
domainId path domain Id 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) 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"}]}

Example

Request
GET /api/tdxm/layersmapping/members/{domainId}/{layerName}
Content-Type: */*
Accept: application/json

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

                
...

POST /api/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 constraints
domainId path long
layerName path  
restriction query restriction type  
Request Body
media type data type
application/json string (JSON)
Response Body
media type data type description
application/json object (JSON) JSON response with information if assignment was successful or not

Example

Request
POST /api/tdxm/layersmapping/unassign/{domainId}/{layerName}
Content-Type: application/json
Accept: application/json

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

                
...