Write JSON Objects for ServPulse API
Closed, ResolvedPublic
Actions

Assigned To

Authored By

	ieli
	May 13 2023, 06:41

Description

Full REST API implemented with JSON request/response objects across 7 controllers and 8 route files. Public endpoints (services, incidents, maintenances, metrics, config, subscribers) + admin endpoints (CRUD + auth). Monitoring webhook at POST /api/webhooks/ingest. All endpoints documented in README.md API Reference section.

Commit: bd4a46b (Phase 2), 2854f43 (Phase 4)

NOTE: Work in progress, could entirely change as we're going.

{
  "service": {
    "id": 1,
    "name": "Example Service",
    "group": 1,
    "description": "This is an example service.",
    "status": "Active"
  },

  "service_group": {
    "id": 1,
    "name": "Example Group",
    "description": "This is an example service group."
  },

  "incident": {
    "id": 1,
    "title": "Example Incident",
    "start_date": "2023-05-13T00:00:00",
    "update_date": "2023-05-13T00:00:00",
    "type_id": 1,
    "status": "Open"
  },

  "incident_service": {
    "id": 1,
    "incident": 1,
    "service": 1
  },

  "incident_type": {
    "id": 1,
    "label": "Example Type",
    "color": "#FF0000"
  },

  "incident_post": {
    "id": 1,
    "incident_id": 1,
    "date": "2023-05-13T00:00:00",
    "step_id": 1,
    "note": "This is an example incident post."
  },

  "incident_post_status": {
    "id": 1,
    "label": "Example Status"
  }
}