Scheduler¶
Scheduler helps you to manage time when transaction will be executed.
Get Periodicity List¶
# Http request to get list of periodicitiesGET
http://localhost:8080/api/scheduler/`periodicity/all`
HTTP/1.1
Response¶
Success:
Header:
¶200 OK
Body:
¶{
"_embedded": {
"periodicityResources": [
{
"enhanceId": 1,
"name": "daily",
"description": "Iteration each day"
},
{
"enhanceId": 2,
"name": "weekly",
"description": "Iteration each week"
},
{
"enhanceId": 3,
"name": "monthly",
"description": "Iteration each month"
}
]
}
}
Error:
Header:
¶Internal Error 500
Body:
¶{
"timestamp" : "2018-05-24T12:44:26.295+0000",
"status" : 500,
"error" : "Internal Error",
"message" : "WRONG_COMPONENT",
"success" : "false",
"path" : "/api/scheduler/periodicity/all"
}
Create new¶
# Http request to create schedulerPOST
http://localhost:8080/api/scheduler
HTTP/1.1
Request¶
Header:
¶Authorization : Bearer {jwt.token}
Content-Type : application/json
Body:
¶{
"connectionId" : 66,
"periodicityId" : 2,
"color" : "#FFFFFF",
"fromDate" : "2018-09-04T13:57:32.000+0000",
"tillDate" : "2018-09-04T13:57:32.000+0000",
"status" : false
}
Response¶
Success:
Header:
¶201 Created
Body:
¶{
"enhanceId": 5,
"connectionId": 407,
"periodicityId": {
"enhanceId": 1,
"name": "daily",
"description": "Iteration each day"
},
"color": "#FFFFFF",
"fromDate": "2018-09-04T13:57:32.000+0000",
"tillDate": "2018-09-04T13:57:32.000+0000",
"status": false
}
Error:
Header:
¶Internal Error 500
Body:
¶{
"timestamp" : "2018-05-24T12:44:26.295+0000",
"status" : 500,
"error" : "Internal Error",
"message" : "WRONG_COMPONENT",
"success" : "false",
"path" : "/api/scheduler"
}
Update scheduler¶
# Http request to update schedulerPUT
http://localhost:8080/api/scheduler/{schedulerId}
HTTP/1.1
Request¶
Header:
¶Authorization : Bearer {jwt.token}
Content-Type : application/json
Body:
¶{
"enhanceId" : 1,
"connectionId" : 66,
"periodicityId" : 2,
"title" : "Title here";
"color" : "#FFFFFF",
"fromDate" : "2018-09-04T13:57:32.000+0000",
"tillDate" : "2018-09-04T13:57:32.000+0000",
"status" : false
}
Get scheduler list¶
# Http request to get all scheduler listGET
http://localhost:8080/api/scheduler/all
HTTP/1.1
Response¶
Success:
Header:
¶200 OK
Body:
¶{
"_embedded": {
"schedulerResources": [
{
"enhanceId": 5,
"transaction": {
"enhanceId": 407,
"name": "Connection",
"description": "some text here",
"fromConnector": 14,
"toConnector": 15
},
"periodicity": {
"enhanceId": 1,
"name": "daily",
"description": "Iteration each day"
},
"title" : "Title here"
"color": "#FFFFFF",
"fromDate": "2018-09-04T13:57:32.000+0000",
"tillDate": "2018-09-04T13:57:32.000+0000",
"status": false
}
]
}
}
Error:
Status error could be different depending on exception
Header:
¶Access Denied 401
Body:
¶{
"timestamp" : "2018-05-24T12:44:26.295+0000",
"status" : 401,
"error" : "Password or email doesn't match",
"message" : "ACCESS_DENIED",
"path" : "/api/schedule/all"
}
Get scheduler¶
# Http request to get all schedulerGET
http://localhost:8080/api/scheduler/{schedulerId}
HTTP/1.1
Response¶
Success:
Header:
¶200 OK
Body:
¶{
"enhanceId": 4,
"transaction": {
"enhanceId": 163,
"title": "Best transaction",
"description": "Description",
"fromConnector": 1,
"toConnector": 2,
"connectorList": []
},
"periodicity": {
"enhanceId": 2,
"name": "weekly",
"description": "Iteration each week"
},
"color": "#FFFFFF",
"fromDate": "2018-09-04T13:57:32.000+0000",
"tillDate": "2018-09-04T13:57:32.000+0000",
"status": false
}
Error:
Status error could be different depending on error
Header:
¶Access Denied 401
Body:
¶{
"timestamp" : "2018-05-24T12:44:26.295+0000",
"status" : 401,
"error" : "Password or email doesnt match",
"message" : "ACCESS_DENIED",
"path" : "/api/scheduler/{schedulerId}"
}
Delete scheduler¶
# Http requestDELETE
http://localhost:8080/api/scheduler/{schedulerId}
HTTP/1.1