Change Request Vector API Resource

Abstract class for REST webservices

PUT /api/requestentity

Update request entities (request shape) parameters

request must also contains json array of objects with xml snippets and params to be updated

Request Body
media type data type
application/json HdcModifiedEntitiesListTO (JSON)
Response Body
media type data type description
application/json object (JSON) json object with report about success of update operations

Example

Request
PUT /api/requestentity
Content-Type: application/json
Accept: application/json

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

                
...

POST /api/requestentity/delete

Remove request entities

Example of request:

{"list":[{"entityId":"389540"}, {"entityId":"389541"}]}

Request Body
media type data type
application/json HdcModifiedEntitiesListTO (JSON)
Response Body
media type data type description
application/json object (JSON) JSON with information about operation's result {list: [{entityId: "54388", success: true}, {entityId: "54394", success: true]}

Example

Request
POST /api/requestentity/delete
Content-Type: application/json
Accept: application/json

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

                
...

POST /api/requestentity/add/{requestDrawingId}

Create new request entities to be attached to request drawing

Request Parameters
name type description constraints
requestDrawingId path - id of request drawing to which entity is attached

Example of request:

{"list":[{"snippet":"","entityId":1,"entityType":1,"layerId":"${LayerID}"}]} 		long
Request Body
media type data type
application/json HdcModifiedEntitiesListTO (JSON)
Response Body
media type data type description
application/json object (JSON) json object with report about success of insertions

Example

Request
POST /api/requestentity/add/{requestDrawingId}
Content-Type: application/json
Accept: application/json

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

                
...

PUT /api/requestentity/order/{vectorId}

Update entities order

Request Parameters
name type description constraints
vectorId path - id of request drawing in which entities are to be rearranged

request must also contains json array of objects with xml snippets to be ordered and flag toBottom showing direction of rearrangement

Example of request:

{"list":[{"snippet":"","entityId":1,"layerId":"${LayerID}"}],"toBottom":true} 		long
Request Body
media type data type
application/json HdcModifiedEntitiesListTO (JSON)
Response Body
media type data type description
application/json object (JSON) json object with report about success of ordering

Example

Request
PUT /api/requestentity/order/{vectorId}
Content-Type: application/json
Accept: application/json

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

                
...

DELETE /api/requestentity/fromlayer/{vectorId}/{layerId}

Remove all request entities from layer

Request Parameters
name type description constraints
layerId path JSON with information about operation's result {list: [{entityId: "54388", success: true}, {entityId: "54394", success: true}]} long
vectorId path long
Response Body
media type data type description
application/json object (JSON)

Example

Request
DELETE /api/requestentity/fromlayer/{vectorId}/{layerId}
Content-Type: */*
Accept: application/json

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

                
...