Checklist Endpoints

Manage filing checklists, checklist items, and associated artifacts. Served through the API gateway at http://localhost:8000.

Endpoints

Method	Path	Description
`POST`	`/checklists`	Create a new checklist
`GET`	`/checklists/{id}`	Get checklist details
`PATCH`	`/checklists/{id}`	Update checklist metadata
`PATCH`	`/checklists/{id}/items/{idx}`	Update a checklist item
`POST`	`/checklists/{id}/submit`	Submit checklist for approval
`POST`	`/checklists/{id}/exception`	Request an exception
`POST`	`/checklists/{id}/reject`	Reject a checklist
`POST`	`/checklists/{id}/items/{idx}/artifacts`	Upload an artifact
`GET`	`/checklists/{id}/items/{idx}/artifacts`	List item artifacts
`GET`	`/checklists/{id}/artifacts`	List all checklist artifacts
`DELETE`	`/checklists/{id}/items/{idx}/artifacts/{aid}`	Delete an artifact

POST /checklists

Create a new filing checklist for an entity and compliance domain.


curl -X POST http://localhost:8000/checklists \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "entity_id": "well-001",
    "entity_type": "Well",
    "domain": "spacing",
    "template_id": "rule37-template"
  }'

Response (201): Returns the created checklist with all items from the template.

GET /checklists/{checklist_id}

Get full checklist details including all items and their status.


curl -H "Authorization: Bearer $TOKEN" \
  http://localhost:8000/checklists/chk-abc123

Response (200):


{
  "checklist_id": "chk-abc123",
  "entity_id": "well-001",
  "domain": "spacing",
  "status": "in_progress",
  "items": [
    {
      "index": 0,
      "label": "Well Data Review",
      "status": "complete",
      "item_type": "data_table"
    },
    {
      "index": 1,
      "label": "Spacing Analysis",
      "status": "in_progress",
      "item_type": "analysis"
    }
  ],
  "created_at": "2026-04-10T14:00:00Z"
}

PATCH /checklists/{checklist_id}/items/{idx}

Update a specific checklist item’s status or data.


curl -X PATCH http://localhost:8000/checklists/chk-abc123/items/1 \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"status": "complete", "notes": "Analysis verified by engineer"}'

POST /checklists/{checklist_id}/submit

Submit a completed checklist for HITL approval.


curl -X POST http://localhost:8000/checklists/chk-abc123/submit \
  -H "Authorization: Bearer $TOKEN"

All checklist items must be marked complete before submission. The system will reject submissions with incomplete items.

Artifact Management

POST /checklists/{id}/items/{idx}/artifacts

Upload an artifact (document, report, form) to a checklist item.


curl -X POST http://localhost:8000/checklists/chk-abc123/items/1/artifacts \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "artifact_type": "spacing_report",
    "content": "...",
    "filename": "spacing-analysis.pdf"
  }'

GET /checklists/{id}/items/{idx}/artifacts

List artifacts for a specific checklist item.

GET /checklists/{id}/artifacts

List all artifacts across the entire checklist.

DELETE /checklists/{id}/items/{idx}/artifacts/{artifact_id}

Remove an artifact.