API Documentation

API Overview

All endpoints follow the RESTful pattern:

GET /api/[app]/[model]/ - List all instances of a model
GET /api/[app]/[model]/[id]/ - Retrieve a specific instance by ID
GET /api/[app]/[model]/?[param]=[value] - Filter results by parameter

Authentication is required for most endpoints using token in the header:

Authorization: Token your_token_here

Available Endpoints

stackboard

Ticket

Endpoint: /api/stackboard/tickets/
Filters: status, assignee, priority
Example: /api/stackboard/tickets/?status=open

Comment

Endpoint: /api/stackboard/comments/
Filters: ticket, created_by, created_date
Example: /api/stackboard/comments/?ticket=123

dsl

TrackedItem

Endpoint: /api/dsl/tracked-items/
Filters: status, tracking_id
Example: /api/dsl/tracked-items/?status=active

statebe

TerraformWorkspace

Endpoint: /api/statebe/terraform-workspaces/
Filters: name, organization
Example: /api/statebe/terraform-workspaces/?organization=acme

TerraformState

Endpoint: /api/statebe/terraform-states/
Filters: workspace, version
Example: /api/statebe/terraform-states/?workspace=42

uptime

Website

Endpoint: /api/uptime/websites/
Filters: url, status
Example: /api/uptime/websites/?status=down

UptimeLog

Endpoint: /api/uptime/logs/
Filters: website, status, timestamp
Example: /api/uptime/logs/?website=5&status=ok

workspace

Workspace

Endpoint: /api/workspace/workspaces/
Filters: name, owner, created_date
Example: /api/workspace/workspaces/?owner=user123

WorkspaceItem

Endpoint: /api/workspace/items/
Filters: workspace, type, created_date
Example: /api/workspace/items/?workspace=42&type=document

booker

Location

Endpoint: /api/booker/locations/
Filters: name, address, active
Example: /api/booker/locations/?active=true

SelectableDayBooking

Endpoint: /api/booker/selectable-day-bookings/
Filters: location, date, status
Example: /api/booker/selectable-day-bookings/?location=3&status=confirmed

DateTimeBooking

Endpoint: /api/booker/datetime-bookings/
Filters: location, datetime, status
Example: /api/booker/datetime-bookings/?status=pending

Service

Endpoint: /api/booker/services/
Filters: name, duration, active
Example: /api/booker/services/?active=true

Voucher

Endpoint: /api/booker/vouchers/
Filters: code, expires, redeemed
Example: /api/booker/vouchers/?redeemed=false

bonsai

UploadedFile

Endpoint: /api/bonsai/files/
Filters: filename, upload_date, user
Example: /api/bonsai/files/?user=john

Audio

Endpoint: /api/bonsai/audio/
Filters: duration, format
Example: /api/bonsai/audio/?format=mp3

Job

Endpoint: /api/bonsai/jobs/
Filters: status, created_date, type
Example: /api/bonsai/jobs/?status=processing

Transcription

Endpoint: /api/bonsai/transcriptions/
Filters: audio, created_date, language
Example: /api/bonsai/transcriptions/?language=en

TemplateCategory

Endpoint: /api/bonsai/template-categories/
Filters: name
Example: /api/bonsai/template-categories/?name=legal

Template

Endpoint: /api/bonsai/templates/
Filters: name, category, created_date
Example: /api/bonsai/templates/?category=5

TemplateField

Endpoint: /api/bonsai/template-fields/
Filters: template, name, required
Example: /api/bonsai/template-fields/?template=10&required=true

FieldMapping

Endpoint: /api/bonsai/field-mappings/
Filters: source_field, target_field
Example: /api/bonsai/field-mappings/?source_field=15

FilledTemplate

Endpoint: /api/bonsai/filled-templates/
Filters: template, created_date, user
Example: /api/bonsai/filled-templates/?template=3

TemplateApprovalHistory

Endpoint: /api/bonsai/template-approvals/
Filters: template, approved_by, approval_date
Example: /api/bonsai/template-approvals/?approved_by=sarah

infra

Build

Endpoint: /api/infra/builds/
Filters: status, build_number, created_date
Example: /api/infra/builds/?status=success

Comment

Endpoint: /api/infra/comments/
Filters: build, author, created_date
Example: /api/infra/comments/?build=123

cladding

Image

Endpoint: /api/cladding/images/
Filters: upload_date, filename, size
Example: /api/cladding/images/?upload_date__gte=2023-01-01

Classification

Endpoint: /api/cladding/classifications/
Filters: image, category, confidence
Example: /api/cladding/classifications/?confidence__gte=0.9

renewableassets

Manufacturer

Endpoint: /api/renewableassets/manufacturers/
Filters: name, country
Example: /api/renewableassets/manufacturers/?country=Germany

Location

Endpoint: /api/renewableassets/locations/
Filters: name, latitude, longitude, country
Example: /api/renewableassets/locations/?country=UK

AssetHierarchy

Endpoint: /api/renewableassets/asset-hierarchies/
Filters: name, description
Example: /api/renewableassets/asset-hierarchies/?name__contains=solar

AssetHierarchyNode

Endpoint: /api/renewableassets/asset-hierarchy-nodes/
Filters: hierarchy, parent, level
Example: /api/renewableassets/asset-hierarchy-nodes/?hierarchy=5&level=2

DeviceModel

Endpoint: /api/renewableassets/device-models/
Filters: manufacturer, type, name
Example: /api/renewableassets/device-models/?manufacturer=3&type=inverter

Asset

Endpoint: /api/renewableassets/assets/
Filters: location, status, commissioning_date
Example: /api/renewableassets/assets/?status=active

Device

Endpoint: /api/renewableassets/devices/
Filters: asset, model, serial_number, status
Example: /api/renewableassets/devices/?asset=10&status=operational

Substation

Endpoint: /api/renewableassets/substations/
Filters: location, capacity, voltage
Example: /api/renewableassets/substations/?location=5

Inverter

Endpoint: /api/renewableassets/inverters/
Filters: device, power_rating, efficiency
Example: /api/renewableassets/inverters/?power_rating__gte=50

SolarArray

Endpoint: /api/renewableassets/solar-arrays/
Filters: asset, capacity, panel_count
Example: /api/renewableassets/solar-arrays/?capacity__gte=100

Pyranometer

Endpoint: /api/renewableassets/pyranometers/
Filters: device, last_calibration_date
Example: /api/renewableassets/pyranometers/?last_calibration_date__gte=2022-01-01

Albedometer

Endpoint: /api/renewableassets/albedometers/
Filters: device, last_calibration_date
Example: /api/renewableassets/albedometers/?device=15

Meter

Endpoint: /api/renewableassets/meters/
Filters: device, meter_type, accuracy
Example: /api/renewableassets/meters/?meter_type=revenue

CombinerBox

Endpoint: /api/renewableassets/combiner-boxes/
Filters: device, input_count, fuse_rating
Example: /api/renewableassets/combiner-boxes/?input_count__gte=12

Transformer

Endpoint: /api/renewableassets/transformers/
Filters: device, power_rating, primary_voltage, secondary_voltage
Example: /api/renewableassets/transformers/?power_rating__gte=500

CircuitBreaker

Endpoint: /api/renewableassets/circuit-breakers/
Filters: device, rating, type
Example: /api/renewableassets/circuit-breakers/?type=acb

Switchgear

Endpoint: /api/renewableassets/switchgears/
Filters: device, voltage_rating, current_rating
Example: /api/renewableassets/switchgears/?voltage_rating__gte=11000

Relay

Endpoint: /api/renewableassets/relays/
Filters: device, protection_type, setting
Example: /api/renewableassets/relays/?protection_type=overcurrent

Need more help?

This documentation covers the retrieval endpoints. For detailed information about creating, updating, or deleting resources, please refer to the full API documentation or contact the development team.