<commit_before>FORMAT: 1A

# OnCue
The OnCue API allows you to to interact programmatically with the [OnCue](https://github.com/michaelmarconi/oncue) *distributed job scheduling* service.

# Group Notes
Notes related resources of the **Notes API**

## Notes Collection [/notes]
### List all Notes [GET]
+ Response 200 (application/json)

        [{
          "id": 1, "title": "Jogging in park"
        }, {
          "id": 2, "title": "Pick-up posters from post-office"
        }]

### Create a Note [POST]
+ Request (application/json)

        { "title": "Buy cheese and bread for breakfast." }

+ Response 201 (application/json)

        { "id": 3, "title": "Buy cheese and bread for breakfast." }

## Note [/notes/{id}]
A single Note object with all its details

+ Parameters
    + id (required, number, `1`) ... Numeric `id` of the Note to perform action with. Has example value.

### Retrieve a Note [GET]
+ Response 200 (application/json)

    + Header

            X-My-Header: The Value

    + Body

            { "id": 2, "title": "Pick-up posters from post-office" }

### Remove a Note [DELETE]
+ Response 204
<commit_msg>Transferring blueprint from apiary.io<commit_after>FORMAT: 1A

# OnCue
The OnCue API allows you to to interact programmatically with the [OnCue](https://github.com/michaelmarconi/oncue) *distributed job scheduling* service.

# Group Agents
Get information about all remote agents that are registered with the scheduler

## Agents Collection [/api/agents]
### List all Agents [GET]
+ Response 200 (application/json)

        [{
            "id": "akka://oncue-agent@localhost:55538/user/agent",
            "url": "akka://oncue-agent@localhost:55538/user/agent"
        }]
    
# Group Jobs
Get information about the state of all Jobs that have been enqueued in the system

## Jobs Collection [/api/jobs]
### List all Jobs [GET]
+ Response 200 (application/json)

        [{
            "enqueued_at": "2014-03-09T22:23:01.833Z",
            "started_at": "2014-03-09T22:23:05.995Z",
            "completed_at": "2014-03-09T22:23:06.006Z",
            "error_message": null,
            "id": 1,
            "params": {
                "expiration-age": "24 hours",
                "include-failed-jobs": "true"
            },
            "progress": 1.0,
            "rerun": false,
            "state": "complete",
            "worker_type": "oncue.worker.MaintenanceWorker"
        }]
        
### Create a Job [POST]
+ Request (application/json)

        { "worker_type": "oncue.worker.TestWorker" }

+ Response 200 (application/json)

        { 
            "enqueued_at": "2014-03-09T22:28:12.508Z",
            "started_at": null,
            "completed_at": null,
            "error_message": null,
            "id": 2,
            "params": {},
            "progress": 0.0,
            "rerun": false,
            "state": "queued",
            "worker_type": "oncue.worker.TestWorker"
        }    

## Job [/api/jobs/{id}]
An individual job and all of its details

+ Parameters
    + id (required, number, `1`) ... Numeric `id` of the Job to perform the action with.
    
### Retrieve a Job [GET]
+ Response 200 (application/json)

        {
            "enqueued_at": "2014-03-09T22:23:01.833Z",
            "started_at": "2014-03-09T22:23:05.995Z",
            "completed_at": "2014-03-09T22:23:06.006Z",
            "error_message": null,
            "id": 1,
            "params": {
                "expiration-age": "24 hours",
                "include-failed-jobs": "true"
            },
            "progress": 1.0,
            "rerun": false,
            "state": "complete",
            "worker_type": "oncue.worker.MaintenanceWorker"
        }
            
### Remove a Job [DELETE]
+ Response 200
{'fraction_non_alphanumeric': 0.13973333333333332, 'fraction_numerical': 0.0472, 'mean_word_length': 2.1521008403361344, 'pattern_counts': {'":': 46, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 2, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '6903898', 'n_tokens_mistral': 1317, 'n_tokens_neox': 1137, 'n_words': 321}