GET

Job Instance

API endpoint that allows jobs to be viewed or edited.

Pass the start_now url parameter to the POST method to enqueue the job immediately.

Use the delay field to create a test job with fake duration of work (in seconds).

Actions

/jobs/{id}/run/ (POST)

Run a job (add it to the queue).

/jobs/{id}/cancel/ (POST)

Cancel a job (terminate the background task)

GET /api/v2/jobs/1218/?format=api
HTTP 200 OK
Allow: GET, PUT, PATCH, DELETE, HEAD, OPTIONS
Content-Type: application/json
Vary: Accept

{
    "id": 1218,
    "details": "https://api.beluga.insectai.org/api/v2/jobs/1218/?format=api",
    "name": "Export occurrences for collection 19",
    "delay": 0,
    "limit": null,
    "shuffle": true,
    "project": {
        "id": 23,
        "name": "Insectarium de Montréal",
        "details": "https://api.beluga.insectai.org/api/v2/projects/23/?format=api",
        "user_permissions": []
    },
    "deployment": null,
    "source_image_collection": {
        "id": 19,
        "name": "Insectarium, bi-hourly",
        "details": "https://api.beluga.insectai.org/api/v2/captures/collections/19/?format=api",
        "method": "interval",
        "user_permissions": []
    },
    "source_image_single": null,
    "pipeline": null,
    "status": "SUCCESS",
    "created_at": "2025-04-09T16:44:44.159096",
    "updated_at": "2025-04-09T16:44:45.179525",
    "started_at": "2025-04-09T16:44:44.296239",
    "finished_at": "2025-04-09T16:44:45.131499",
    "duration": "0.83526",
    "progress": {
        "summary": {
            "status": "SUCCESS",
            "progress": 1.0
        },
        "stages": [
            {
                "status": "SUCCESS",
                "progress": 1.0,
                "key": "data_export",
                "name": "Exporting data",
                "params": [
                    {
                        "name": "Number of records exported",
                        "key": "number_of_records_exported",
                        "category": "default",
                        "value": 18
                    },
                    {
                        "name": "Total records to export",
                        "key": "total_records_to_export",
                        "category": "default",
                        "value": 18
                    }
                ]
            },
            {
                "status": "SUCCESS",
                "progress": 1.0,
                "key": "uploading_snapshot",
                "name": "Uploading snapshot",
                "params": [
                    {
                        "name": "File URL",
                        "key": "file_url",
                        "category": "default",
                        "value": "https://object-arbutus.cloud.computecanada.ca/ami-media-staging/uploads/exports/insectarium-de-montreal_export-1.csv"
                    }
                ]
            }
        ],
        "errors": [],
        "logs": []
    },
    "logs": {
        "stdout": [
            "[2025-04-09 16:44:45] INFO Finished job #1218 \"Export occurrences for collection 19\" (SUCCESS)",
            "[2025-04-09 16:44:45] INFO Changing status of job 1218 from STARTED to SUCCESS",
            "[2025-04-09 16:44:45] INFO File uploaded to Project Storage: https://object-arbutus.cloud.computecanada.ca/ami-media-staging/uploads/exports/insectarium-de-montreal_export-1.csv",
            "[2025-04-09 16:44:45] INFO Export completed: https://object-arbutus.cloud.computecanada.ca/ami-media-staging/uploads/exports/insectarium-de-montreal_export-1.csv",
            "[2025-04-09 16:44:44] INFO Starting export for project #23 Insectarium de Montréal",
            "[2025-04-09 16:44:44] INFO Changing status of job 1218 from PENDING to STARTED",
            "[2025-04-09 16:44:44] INFO Running job #1218 \"Export occurrences for collection 19\" (PENDING)"
        ],
        "stderr": []
    },
    "job_type": {
        "name": "Data Export",
        "key": "data_export"
    },
    "data_export": {
        "id": 1,
        "user": 2,
        "project": 23,
        "format": "occurrences_simple_csv",
        "filters": {
            "collection_id": "19"
        },
        "file_url": "https://object-arbutus.cloud.computecanada.ca/ami-media-staging/uploads/exports/insectarium-de-montreal_export-1.csv"
    },
    "dispatch_mode": "internal",
    "result": null,
    "user_permissions": []
}