Change Requests API Resource

Abstract class for REST webservices

GET /api/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 (JSON)

Example

Request
GET /api/changerequest/json
Content-Type: */*
Accept: application/json

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

                
...

POST /api/changerequest/json

Get list of all changerequests

Request Body
media type data type
application/json map of string (JSON)
Response Body
media type data type description
application/json object (JSON)

Example

Request
POST /api/changerequest/json
Content-Type: application/json
Accept: application/json

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

                
...

GET /api/changerequest/report

Get list of all changerequests

Request Parameters
name type description
filter query
sortField query
Response Body
media type data type description
application/json HdcPathProcessStateTO (JSON) json response with information about started process

Example

Request
GET /api/changerequest/report
Content-Type: */*
Accept: application/json

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

                
{ }

POST /api/changerequest/start

Start change request

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

Example of response:

Example

Request
POST /api/changerequest/start
Content-Type: application/json
Accept: application/json

                
{
  "stateId" : 12345,
  "workflowId" : 12345,
  "id" : 12345,
  "processId" : 12345,
  "state" : {
    "sysName" : "...",
    "name" : "...",
    "initial" : true,
    "workflowId" : 12345,
    "stateId" : 12345
  },
  "createdTime" : "...",
  "title" : "...",
  "drawingId" : 12345
}
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
...

PUT /api/changerequest/json/{changeRequestId}

Update change request info

Request Parameters
name type description constraints
changeRequestId path Id of drawing long
Request Body
media type data type
application/json ChangeRequestData (JSON)
Response Body
media type data type description
application/json HdcSuccessTO (JSON)

Example

Request
PUT /api/changerequest/json/{changeRequestId}
Content-Type: application/json
Accept: application/json

                
{
  "stateId" : 12345,
  "workflowId" : 12345,
  "id" : 12345,
  "processId" : 12345,
  "state" : {
    "sysName" : "...",
    "name" : "...",
    "initial" : true,
    "workflowId" : 12345,
    "stateId" : 12345
  },
  "createdTime" : "...",
  "title" : "...",
  "drawingId" : 12345
}
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{ }

GET /api/changerequest/json/{drawingId}

Get list of all changerequests for given drawingId

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

Example

Request
GET /api/changerequest/json/{drawingId}
Content-Type: */*
Accept: application/json

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

                
...

GET /api/changerequest/states/json

Get all workflow states

Response Body
media type data type description
application/json object (JSON)

Example

Request
GET /api/changerequest/states/json
Content-Type: */*
Accept: application/json

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

                
...

POST /api/changerequest/util/initialize

Initialize Change Request Workflow

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

Example

Request
POST /api/changerequest/util/initialize
Content-Type: */*
Accept: application/json

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

                
{ }

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

Execute action

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

Example

Request
PUT /api/changerequest/action/{changeRequestId}/{actionId}
Content-Type: */*
Accept: application/json

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

                
{ }

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

Assign user to change request

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

Example

Request
POST /api/changerequest/assign/{changeRequestId}/{userId}
Content-Type: */*
Accept: application/json

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

                
{ }

GET /api/changerequest/comment/json/{changeRequestId}

Get list of comments for given change request

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

Example

Request
GET /api/changerequest/comment/json/{changeRequestId}
Content-Type: */*
Accept: application/json

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

                
...

POST /api/changerequest/comment/json/{changeRequestId}

Request Parameters
name type description constraints
changeRequestId path long
Request Body
media type data type
application/json ChangeRequestComment (JSON)
Response Body
media type data type description
application/json HdcSuccessWithId (JSON)

Example

Request
POST /api/changerequest/comment/json/{changeRequestId}
Content-Type: application/json
Accept: application/json

                
{
  "text" : "...",
  "requestId" : 12345,
  "userId" : 12345,
  "sent" : true,
  "userFullName" : "...",
  "timestamp" : "...",
  "id" : 12345
}
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{ }

DELETE /api/changerequest/comment/json/{commentId}

Delete comment.

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

Example

Request
DELETE /api/changerequest/comment/json/{commentId}
Content-Type: */*
Accept: application/json

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

                
{ }

PUT /api/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 constraints
commentId path ID of layer to be updated long
Request Body
media type data type description
application/json ChangeRequestComment (JSON) The specification of layer that has to be updated.
Response Body
media type data type description
application/json HdcSuccessTO (JSON) JSON Response with information, whether the updating has or has not been succeeded.

Example

Request
PUT /api/changerequest/comment/json/{commentId}
Content-Type: application/json
Accept: application/json

                
{
  "text" : "...",
  "requestId" : 12345,
  "userId" : 12345,
  "sent" : true,
  "userFullName" : "...",
  "timestamp" : "...",
  "id" : 12345
}
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{ }

GET /api/changerequest/history/json/{changeRequestId}

Get history of given change request

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

Example

Request
GET /api/changerequest/history/json/{changeRequestId}
Content-Type: */*
Accept: application/json

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

                
...

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

Get given change request for given drawingId

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

Example

Request
GET /api/changerequest/json/{drawingId}/{requestId}
Content-Type: */*
Accept: application/json

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

                
...

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

Get requests structure with svg for given drawing.

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

Example

Request
GET /api/changerequest/requests-svg/json/{contentId}
Content-Type: */*
Accept: application/json

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

                
{ }

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

Get requests structure with svg for given drawing and changeRequest

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

Example

Request
GET /api/changerequest/requests-svg/json/{contentId}/{requestId}
Content-Type: */*
Accept: application/json

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

                
{ }