Interventions

Service intervention reports. Records on-site or remote work performed for a customer.

Endpoints

• GET /obapi/v1/interventions -- list
• GET /obapi/v1/interventions/{id} -- single with lines
• GET /obapi/v1/download/{id}?type=intervention -- PDF

Parameters

page, per_page, date_start, date_end, status, sort

Status values

Response (list)

{
    "items": [
        {
            "id": "42",
            "ref": "FI2405-0005",
            "date_intervention": "2024-05-18",
            "duration": 7200,
            "status": "done"
        }
    ],
    "pagination": { "..." }
}

Response (single)

{
    "intervention": {
        "id": "42",
        "ref": "FI2405-0005",
        "customer_ref": "",
        "date_intervention": "2024-05-18",
        "date_start": "2024-05-18",
        "date_end": "2024-05-18",
        "contract_ref": "CT2405-0002",
        "description": "On-site server maintenance",
        "duration": 7200,
        "validated_at": "2024-05-19T09:00:00Z",
        "created_at": "2024-05-17T14:00:00Z",
        "updated_at": "2024-05-19T09:00:00Z",
        "status": "done",
        "public_note": "",
        "lines": [
            {
                "id": "85",
                "position": 1,
                "description": "Hardware diagnostic and repair",
                "date": "2024-05-18",
                "duration": 3600,
                "product_ref": "SRV-MAINT"
            },
            {
                "id": "86",
                "position": 2,
                "description": "Software update and configuration",
                "date": "2024-05-18",
                "duration": 3600,
                "product_ref": "SRV-CONF"
            }
        ]
    }
}

Notes

• duration is expressed in seconds (7200 = 2 hours).
• Each line represents a task performed during the intervention.
• contract_ref links the intervention to a service contract (if applicable).

Download PDF

GET /obapi/v1/download/{id}?type=intervention