Change Requests API Resource

Abstract class for REST webservices

GET /changerequest/json

Get list of all changerequests

Request Parameters
name type description default constraints
filter query    
limit query 25 long
offset query 0 long
sortField query    
Response Body
media type data type description
application/json object

POST /changerequest/json

Get list of all changerequests

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

GET /changerequest/report

Get list of all changerequests

Request Parameters
name type description default constraints
filter query    
sortField query    
Response Body
media type data type description
application/json object json response with information about started process

POST /changerequest/start

Start change request

Request Body
media type data type
application/json object
Response Body
media type data type description
application/json object JSON response with the information about change request just after start

Example of response:

PUT /changerequest/json/{changeRequestId}

Update change request info

Request Parameters
name type description default constraints
changeRequestId path Id of drawing   required long
Request Body
media type data type
application/json object
Response Body
media type data type description
application/json object

GET /changerequest/json/{drawingId}

Get list of all changerequests for given drawingId

Request Parameters
name type description default constraints
drawingId path Id of drawing   long
filter query    
Response Body
media type data type description
application/json object

GET /changerequest/states/json

Get all workflow states

Response Body
media type data type description
application/json object

POST /changerequest/util/initialize

Initialize Change Request Workflow

Response Body
media type data type description
application/json object JSON response with the information whether the initialization has or has not been succeeded.

PUT /changerequest/action/{changeRequestId}/{actionId}

Execute action

Request Parameters
name type description default constraints
actionId path Id of action that should be executed on given change request   required int
changeRequestId path Id of chenge request that should be changed   required long
Response Body
media type data type description
application/json object

POST /changerequest/assign/{changeRequestId}/{userId}

Assign user to change request

Request Parameters
name type description default constraints
changeRequestId path Id of change request   required long
userId path Id of user which should be set as assignee   required long
Response Body
media type data type description
application/json object

GET /changerequest/comment/json/{changeRequestId}

Get list of comments for given change request

Request Parameters
name type description default constraints
changeRequestId path Id of change request   required long
Response Body
media type data type description
application/json object

POST /changerequest/comment/json/{changeRequestId}

Request Parameters
name type description default constraints
changeRequestId path   required long
Request Body
media type data type
application/json object
Response Body
media type data type description
application/json object

DELETE /changerequest/comment/json/{commentId}

Delete comment.

Request Parameters
name type description default constraints
commentId path ID of comment to be deleted   required long
Response Body
media type data type description
application/json object JSON Response with information, whether the deletion has or has not been succeeded.

PUT /changerequest/comment/json/{commentId}

Update layer.

Example of request:

{"objectName":"BTA","metadata":{"layerStyle":"fill:none;stroke:#0000FF;stroke-width:0.03"}}

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

GET /changerequest/history/json/{changeRequestId}

Get history of given change request

Request Parameters
name type description default constraints
changeRequestId path Id of change request   required long
Response Body
media type data type description
application/json object

GET /changerequest/json/{drawingId}/{requestId}

Get given change request for given drawingId

Request Parameters
name type description default constraints
drawingId path Id of drawing   long
requestId path Id of change request   long
Response Body
media type data type description
application/json object

GET /changerequest/requests-svg/json/{contentId}

Get requests structure with svg for given drawing.

Request Parameters
name type description default constraints
contentId path ID of composite drawing   long
filter query    
Response Body
media type data type description
application/json object JSON response with svg structure

GET /changerequest/requests-svg/json/{contentId}/{requestId}

Get requests structure with svg for given drawing and changeRequest

Request Parameters
name type description default constraints
contentId path ID of composite drawing   long
requestId path   long
Response Body
media type data type description
application/json object JSON response with svg structure