Description of REST methods for processing tasks
PAAS also works as a web service. You can access methods for getting reports, for work with the document system and for managing workflows.
In this chapter, you can find the following REST methods for processing tasks and their descriptions:
1. Creating a new processing task
2. Get existing task status
3. Download a single resulting file
1. Creating a new processing task
POST /api/v1/:database/process/:command
Parameters:
- database: SQL Server database where task should be run;
- command: command to execute on PAAS;
- body: should contain JSON parameters for new task.
Returns: JSON object with two fields;
- task: numeric task ID
- runner: string task token
Examples of creating a new processing task:
 |
This method schedules a task for execution and returns immediately. The parameters :command and :body are stored in ‘tPA_PAASProcessing’ table as sent. |
The actual execution is performed by ‘PANTHEON.exe’. PAAS will start PANTHEON if it is not already running, or notify from an already running PANTHEON program that there is an available task to run.
2. Get existing task status
GET /api/v1/:database/status/:task?guid=:runner
Parameters:
Database: SQL Server database where task is task: task ID is created into file; guid 'runner' is received when task was created.
Returns status from ‘tPA_PAASProcessing’ table for the given task:
{ "id": numeric task ID (anQId) "status": num status (anStatus): 0: pending, 102: processing, 200: done OK, 400: Err "lane": string name of priority lane where task is executing (unused for now) "command": string requested task command (Printing, Workflow, ...) (acCommand) "result": JSON with results. returned from Pantheon (acResult) when task is done
{ "guid": guid of task processor (unused for now) when status is OK "files": array of strings ["full\\path1\\to_file1.ext", full\\path1\\to_file1.ext"] "error": error string description if there was an error } }
Example of Get existing task status
3. Download a single resulting file
GET /api/v1/:database/download/:task/:file?guid=:guid
Parameters:
- Database: SQL Server database where task was run and finished with OK.
- Task: task ID of created file.
- File: numeric order of file from files array in status > result > files.
- Guid: ‘runner’ received when task was created.
Returns: File contents.
Example of downloading a single resulting file
Related topics: