Created
August 19, 2013 08:39
-
-
Save rdpanek/6266905 to your computer and use it in GitHub Desktop.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
# vytvoreni tasku | |
POST /api/v1/tasks | |
{ | |
"identificator": "hera", | |
"requirement": "users-api", | |
"framework": "hera", | |
"timeout": 1 | |
} | |
- timeout je v minutách a není poviný a nastavuje se s defaultní hodnotou 3 minuty | |
- framework musí existovat. Task s frameworkem ktery neexistuje se pri spusteni zastavi | |
- identificator je poviny parametr. Doplnuje se do framework url {identificator} | |
- requiremenet je poviny parametr. Doplnuje se do framework url {requirement} | |
- po vytvoreni tasku je defaultne ve stavu "pause" | |
- response ETag: id: 5211d0607ee514d33b000012, uri: '/api/v1/tasks/5211d0607ee514d33b000012', type: 'task' | |
# spusteni nyni | |
PUT /api/v1/tasks/:id | |
{ | |
"now": true | |
} | |
- task se spusti okamzite a pouze jednou. Po timeoutu nebo po prichozim vysledku se task prepne zpet do stavu "pause" | |
# spusteni ve smycce | |
PUT /api/v1/tasks/:id | |
{ | |
"play": true | |
} | |
- task se zaradi do fronty tasku, ktere maji stav "play". Tyto tasky bezi ve smycce jeden podruhym stale dokola. | |
- ukonceni behu ve smyce se provede nastavenim stavu na "pause" | |
# pozastaveni tasku "pause" | |
PUT /api/v1/tasks/:id | |
{ | |
"pause": true | |
} | |
- stavy play a now se nastavi na "false" | |
- stav "pause" nezastavuje beh tasku, ktery se spousti podle casoveho planu "od-do" nebo "definice cronu" | |
# nastaveni casoveho planu "definice cronu" | |
PUT /api/v1/tasks/:id | |
{ | |
"runInTime": true, | |
"runTimeType": "runByCron", | |
"cronDefinition": "*/2 * * * *" | |
} | |
- zruseni spousteni podle casoveho planu | |
{ | |
"runInTime": false | |
} | |
# nastaveni casoveho planu "od-do" | |
PUT /api/v1/tasks/:id | |
{ | |
"runInTime": true, | |
"runTimeType": "runFromTo", | |
"playTime": 946632240000, | |
"stopTime": 946632360000 | |
} | |
- playTime & stopTime jsou unix timestamp | |
- zruseni spousteni podle casoveho planu | |
{ | |
"runInTime": false | |
} | |
# odstraneni tasku | |
DELETE /api/v1/tasks/:id | |
- prijate vysledky zustavaji zachovany | |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment