OBAPI OBAPI

Projects

Shared project tracking between entities.

Endpoints

  • GET /obapi/v1/projects -- list
  • GET /obapi/v1/projects/{id} -- single with tasks

Parameters

page, per_page, status, sort

Status values

Value Description
draft Draft project
validated Active project
closed Closed project

Response (list)

{
    "items": [
        {
            "id": "15",
            "ref": "PJ2405-0003",
            "title": "ERP Migration Q3",
            "date_start": "2024-07-01",
            "date_end": "2024-09-30",
            "status": "validated"
        }
    ],
    "pagination": { "..." }
}

Response (single)

{
    "project": {
        "id": "15",
        "ref": "PJ2405-0003",
        "title": "ERP Migration Q3",
        "description": "Full migration of legacy ERP to cloud platform",
        "date_start": "2024-07-01",
        "date_end": "2024-09-30",
        "created_at": "2024-05-01T10:00:00Z",
        "status": "validated",
        "public_note": "",
        "tasks": [
            {
                "id": "42",
                "ref": "TK2405-0010",
                "label": "Data migration",
                "date_start": "2024-07-01",
                "date_end": "2024-07-31",
                "planned_hours": "120.00",
                "spent_hours": "45.00",
                "progress": 35,
                "priority": 2,
                "status": "validated"
            },
            {
                "id": "43",
                "ref": "TK2405-0011",
                "label": "User acceptance testing",
                "date_start": "2024-08-01",
                "date_end": "2024-08-31",
                "planned_hours": "80.00",
                "spent_hours": "0.00",
                "progress": 0,
                "priority": 1,
                "status": "draft"
            }
        ]
    }
}