Sync Request Resource

GET /syncrequest/requests

Get all sync requests with given filter

Request Parameters
name type description default constraints
type query all|failed|permanently_failed all  
Response Body
media type data type description
application/json object JSON with list of sync requests

Example of response:

{"list":[{"id":"guid","parameters":{"changeRequestId":"number"},"type":"NEW_REQUEST|STATE_CHANGED|NEW_COMMENT","exceptions":[],"ts":"2020-04-17T11:15:08.085975Z","failureCounter":0,"changeRequestId":769,"status":"pending|failed|permanently_failed"}]}

POST /syncrequest/requests

Get all sync requests for given list of changeRequests

Example of request:

[1,2,3]

Request Body
media type data type
application/json string
Response Body
media type data type description
application/json object JSON with list of sync requests

Example of response:

{"list":[{"id":"guid","parameters":{"changeRequestId":"number"},"type":"NEW_REQUEST|STATE_CHANGED|NEW_COMMENT","exceptions":[],"ts":"2020-04-17T11:15:08.085975Z","failureCounter":0,"changeRequestId":769,"status":"pending|failed|permanently_failed"}]}

POST /syncrequest/requests/retry

Retry sync requests

Example of request:

{"mode":"all|failed|permanently_failed|selected", "guids":["selected_guid1","selected_guid2"]}

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

DELETE /syncrequest/requests/{id}

Remove sync request with given ID

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

GET /syncrequest/states/json

List of all request states from external service

Request Parameters
name type description default constraints
filter query all  
service query tp  
Response Body
media type data type description
application/json object JSON with list of states

Example of response:

{"list":[{"stateId":1,"name":"New"},{"stateId":2,"name":"Under Review"},{"stateId":3,"name":"Approved"},{"stateId":4,"name":"Closed"}]}

POST /ext/changerequest/addcomment/{token}

Add comment to change request

Request Parameters
name type description default constraints
token path authorization token

Example of request:

{"id":1,"comment":"comment","userMail":"user@mail.com","token":"token"} where: id - id of external request comment - new comment userMail - mail of user, which should be set as author of change		    
Request Body
media type data type
application/json string
Response Body
media type data type description
application/json object Response with information, whether the operation has or has not been succeeded.

POST /ext/changerequest/changestate/{token}

Change state of change request

Request Parameters
name type description default constraints
token path authorization token

Example of request:

{"id":1,"stateId":1,"userMail":"user@mail.com","token":"token"} where: id - id of external request stateId - new external state id userMail - mail of user, which should be set as author of change		    
Request Body
media type data type
application/json string
Response Body
media type data type description
application/json object Response with information, whether the operation has or has not been succeeded.

GET /syncrequest/statesrelations/json/{stateId}

TargetProcess state related to HDC change request state

Request Parameters
name type description default constraints
stateId path HDC change request state ID   required int
Response Body
media type data type description
application/json object JSON with list of states

Example of response:

{"list":[{"stateId":1,"name":"New"}]}

DELETE /syncrequest/statesrelations/{crStateId}/{tpStateId}

Remove relation between states

Request Parameters
name type description default constraints
crStateId path HDC change request state ID   required int
tpStateId path TargetProcess request state ID   required int
Response Body
media type data type description
application/json object JSON Response with information, whether the deletion has or has not been succeeded.

POST /syncrequest/statesrelations/{crStateId}/{tpStateId}

Add relation between states

Request Parameters
name type description default constraints
crStateId path HDC change request state ID   required int
tpStateId path TargetProcess request state ID   required int
Response Body
media type data type description
application/json object JSON Response with information, whether the adding has or has not been succeeded.