Job List¶

Get a list of all jobs associated with the user account that generated the given API Token. The list is sorted by default to the creation time of the job, descending.

HTTP Method

GET /api/job/list¶

Query String Parameters — Required

Name	Details
v	Description	The version of the API to use
	Allowed Values	1
	Example	`v=1`
api_token	Description	The API token used for this session
	Allowed Values	Hex String
	Example	`api_token=7ca5dc5c7cce449fb0fff719307e8f5f`

Query String Parameters for filtering — Optional

Name	Details
CreationDateFrom	Description	List jobs that were created on or after the specified date and time.
	Allowed Values	Date in ISO format.
	Example	`CreationDateFrom=2014-08-27T13:40:53`
CreationDateTo	Description	List jobs that were created on or before the specified date and time.
	Allowed Values	Date in ISO format.
	Example	`CreationDateTo=2014-08-27T13:40:53`
StartDateFrom	Description	List jobs that were started on or after the specified date and time.
	Allowed Values	Date in ISO format.
	Example	`StartDateFrom=2014-08-27T13:40:53`
StartDateTo	Description	List jobs that were started on or before the specified date and time.
	Allowed Values	Date in ISO format.
	Example	`StartDateTo=2014-08-27T13:40:53`
DueDateFrom	Description	List jobs that have a due date on or after the specified date and time.
	Allowed Values	Date in ISO format.
	Example	`DueDateFrom=2014-08-27T13:40:53`
DueDateTo	Description	List jobs that have a due date on or before the specified date and time.
	Allowed Values	Date in ISO format.
	Example	`DueDateTo=2014-08-27T13:40:53`
CompleteDateFrom	Description	List jobs that were completed on or after the specified date and time.
	Allowed Values	Date in ISO format.
	Example	`CompleteDateFrom=2014-08-27T13:40:53`
CompleteDateTo	Description	List jobs that were completed on or before the specified date and time.
	Allowed Values	Date in ISO format.
	Example	`CompleteDateTo=2014-08-27T13:40:53`
ReturnDateFrom	Description	List jobs that were returned on or after the specified date and time.
	Allowed Values	Date in ISO format.
	Example	`ReturnDateFrom=2014-08-27T13:40:53`
ReturnDateTo	Description	List jobs that were returned on or before the specified date and time.
	Allowed Values	Date in ISO format.
	Example	`ReturnDateTo=2014-08-27T13:40:53`
AuthorizationDateFrom	Description	List jobs that were authorized on or after the specified date and time.
	Allowed Values	Date in ISO format.
	Example	`AuthorizationDateFrom=2014-08-27T13:40:53`
AuthorizationDateTo	Description	List jobs that were authorized on or before the specified date and time.
	Allowed Values	Date in ISO format.
	Example	`AuthorizationDateTo=2014-08-27T13:40:53`
JobStatus	Description	List jobs with the specified status.
	Allowed Values	String.
	Example	`JobStatus=Complete`
Fidelity	Description	List jobs with the specified fidelity.
	Allowed Values	String.
	Example	`Fidelity=MECHANICAL`
Priority	Description	List jobs with the specified priority.
	Allowed Values	String.
	Example	`Priority=STANDARD`
TurnaroundTimeHoursFrom	Description	List jobs that have a turnaround time on or after the specified hour.
	Allowed Values	Integer.
	Example	`TurnaroundTimeHoursFrom=24`
TurnaroundTimeHoursTo	Description	List jobs that have a turnaround time on or before the specified hour.
	Allowed Values	Integer.
	Example	`TurnaroundTimeHoursTo=48`
JobName	Description	List jobs matching the specified job name. (supports wildcards: *)
	Allowed Values	String.
	Example	`JobName=job__name_`
ExternalID	Description	List jobs with the specified ExternalId.
	Allowed Values	String.
	Example	`ExternalID=external_1234`
Username	Description	List jobs that are owned by the specified sub-account. Pass '*' to list all jobs owned by the logged in account and all of its descendants.
	Allowed Values	String.
	Example	`Username=my_account_name`
JobDifficulty	Description	List jobs with the specified JobDifficulty.
	Allowed Values	JobDifficulty Enumeration
	Example	`JobDifficulty=Good`

Responses

HTTP Code	Details
200	Description	Success
200	Contents	JSON formatted Job List. See Job List Format for details.
400	Description	An error occurred
400	Contents	Error description (see Error Format for details)

Example Requests

GET /api/job/list?v=1&api_token=7ca5dc5c7cce449fb0fff719307e8f5f HTTP/1.1
Host: api.cielo24.com

GET /api/job/list?v=1&api_token=7ca5dc5c7cce449fb0fff719307e8f5f&Priority=STANDARD HTTP/1.1
Host: api.cielo24.com

GET /api/job/list?v=1&api_token=7ca5dc5c7cce449fb0fff719307e8f5f
&CompleteDateTo=2014-08-27T14%3A44%3A54 HTTP/1.1
Host: api.cielo24.com

GET /api/job/list?v=1&api_token=7ca5dc5c7cce449fb0fff719307e8f5f
&CompleteDateTo=2014-08-27 HTTP/1.1
Host: api.cielo24.com

Example Response

HTTP/1.1 200 OK
Content-Type: application/json

{
    "Username": "john_doe",
    "ActiveJobs":
    [{
        "JobId": "d4fb871e07514304b23131b45f8caa1f",
        "JobName": "example_job",
        "MediaLengthSeconds": 607.81,
        "ExternalID": "sample_id",
        "Priority": "STANDARD",
        "Fidelity": "MECHANICAL",
        "JobStatus": "Complete",
        "SourceLanguage": "en",
        "TargetLanguage": "en",
        "CreationDate": "2014-08-27T14:00:06.472706",
        "StartDate": "2014-08-27T14:00:06.472706",
        "DueDate": "2014-08-29T14:00:06.472706",
        "CompletedDate": "2014-08-27T14:10:41.923125",
        "ReturnDate": "2014-08-27T14:10:42.885185",
        "AuthorizationDate": "2014-08-27T14:00:06.472706",
        "JobDifficulty": "Unknown",
        "ReturnTargets":  {
            "url": [
                {
                    "callback_url": "https://sample-url.com/return/"
                },
                {
                    "callback_url": "https://sample-url-2.com/return/"
                }
            ]
        },
        "Options": {
            "option_name": {
                "label": "option_label",
                "setting": "option_setting"
            }
        }
    }]
}