# This page
http://127.0.0.1:65445/api/json/v1

#================================================================================
#Name: Get workflows list
#Description:Get a list of all workflows available
#Type:HTTP/1.1 GET
#Send:URI

http://127.0.0.1:65445/api/json/v1/workflows/id=?

#Return:JSON array
#Content-Type:application/json; charset=utf-8

{

	"workflows": 
	[
		{

		"id": "Identifier for workflow",
		"name": "Name of workflow",
		"folder": "Folder that holds the workflow"
		},
		{
		"id": "Identifier for workflow",
		"name": "Name of workflow",
		"folder": "Folder that holds the workflow"
		}
	]
}
#================================================================================
#Name: Submit job
#Description:Submitting a file to a workflow with optional output file.
#Type:HTTP/1.1 POST
#Content-Type:application/json; charset=utf-8
#Send:JSON

{
    "workflows": 
	{
        "wf_id": "workflow id",
        "submit_file": "c:\\name\\of\\file.mxf",
        "output_file": "c:\\name\\of\\file.mkv"
    	}
}

#Return: JSON

{
	"job_id": "identifier for the job"
}

#================================================================================
#Name: Get job(s) status
#Description:Get status of job using the returned job id or question mark (?) for all jobs.
#Type:HTTP/1.1 GET
#Send:URI

http://127.0.0.1:65445/api/json/v1/status/id=12345678-098765-321-90abcdef

#Return:JSON array
#Content-Type:application/json; charset=utf-8

{
	"jobs": 
	[
		{
		"job_id": "identifier for the job",
		"steps": "steps until finished (step / total_steps)",
		"processor": "name of current operating processor",
		"file": "name file peing processed",
		"status": "state of current operating processor",
		"node": "computer on which the current processor run",
		"workflow": "name of the workflow"
		}
	]
}

#Send:URI

http://127.0.0.1:65445/api/json/v1/status/id=?

#Return:JSON array
#Content-Type:application/json; charset=utf-8

{
	"jobs": 
	[
		{
		"job_id": "identifier for job 1",
		"steps": "steps until finished (step / total_steps)",
		"processor": "name of current operating processor",
		"file": "name file peing processed",
		"status": "state of current operating processor",
		"node": "computer on which the current processor run",
		"workflow": "name of the workflow"
		},
		{
		"job_id": "identifier for job 2",
		"steps": "steps until finished (step / total_steps)",
		"processor": "name of current operating processor",
		"file": "name file peing processed",
		"status": "state of current operating processor",
		"node": "computer on which the current processor run",
		"workflow": "name of the workflow"
		}
	]
}
