Aerones Operations Hub API
The REST surface of the Aerones Operations Hub, described by a publicly served OpenAPI 3.1.0 document (760 paths / 1,114 operations / 1,377 component schemas) generated by Django Ninja. It covers the wind-service operating model end to end: customers, turbines and turbine models, blades and cross-sections, anomalies and AI anomaly detection, robot sets, resources and certificates, projects, commercial offers, dispatch boards and work orders, technician reporting, inspections (point clouds, rosbags, video), planning, and accounting integrations with NetSuite. The description is anonymous; every data operation requires a bearer token or the opshub session cookie.
This API exposes 1114 operations across 760 paths, organized into 192 resource areas, and defines 1377 schemas. It is described by OpenAPI 3.1.0, at version 0.1.1.
Requests are made against the base URL https://operations.aerones.com/api.
1114 operations
760 paths
1377 schemas
133 DELETE517 GET128 PATCH309 POST27 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 3
Aerones Operations Hub API declares
3 security schemes
for authenticating requests.
It accepts HTTP bearer tokens (APIKeyAuth).
An API key is passed in the cookie as opshub_prod_sessionid (CookieAuth).
It accepts HTTP bearer tokens (AuthBearer).
Paths & Operations 1114
Across 760 paths, the API surfaces 1114 operations — 133 DELETE, 517 GET, 128 PATCH, 309 POST, 27 PUT. They span 192 resource areas, including docs, auth, core.manufacturers, core.component-models, core.turbine-models, core.component-types, core.robot-sets, core.robot-sets.services, and 184 more. Each is listed below with its method, path, parameters, and response codes.
docs 1
GET
/api/graphql-schema
GraphQL Schema (SDL)
auth 4
POST
/api/auth
Authenticate
POST
/api/clients/login
Client Login
POST
/api/logout
Do Logout
GET
/api/me
Get User
core.manufacturers 5
GET
/api/core/v1/manufacturers
List Manufacturers
POST
/api/core/v1/manufacturers
Create Manufacturer
GET
/api/core/v1/manufacturers/{id}
Get Manufacturer
PATCH
/api/core/v1/manufacturers/{id}
Update Manufacturer
DELETE
/api/core/v1/manufacturers/{id}
Delete Manufacturer
core.component-models 5
GET
/api/core/v1/component-models
List Component Models
POST
/api/core/v1/component-models
Create Component Model
GET
/api/core/v1/component-models/{id}
Get Component Model
PATCH
/api/core/v1/component-models/{id}
Update Component Model
DELETE
/api/core/v1/component-models/{id}
Delete Component Model
core.turbine-models 5
GET
/api/core/v1/turbine-models
List Turbine Models
POST
/api/core/v1/turbine-models
Create Turbine Model
GET
/api/core/v1/turbine-models/{id}
Get Turbine Model
PATCH
/api/core/v1/turbine-models/{id}
Update Turbine Model
DELETE
/api/core/v1/turbine-models/{id}
Delete Turbine Model
core.component-types 1
GET
/api/core/v1/component-types
List ComponentTypes
core.robot-sets 6
GET
/api/core/v1/robot-sets
List Robot Sets
POST
/api/core/v1/robot-sets
Create Robot Set
GET
/api/core/v1/robot-sets/{id}
Get Robot Set
PATCH
/api/core/v1/robot-sets/{id}
Update Robot Set
DELETE
/api/core/v1/robot-sets/{id}
Delete Robot Set
POST
/api/core/v1/robot-sets/{id}/netsuite-sync
Sync this robot set to NetSuite — creates if missing, patches name if already linked
core.robot-sets.services 1
GET
/api/core/v1/robot-sets/{robot_set_id}/services
List Services for Robot Set
core.resources 6
GET
/api/core/v1/resources/summary
Get Resource Summary
GET
/api/core/v1/resources
List Resources
POST
/api/core/v1/resources
Create Resource
GET
/api/core/v1/resources/{id}
Get Resource
PATCH
/api/core/v1/resources/{id}
Update Resource
DELETE
/api/core/v1/resources/{id}
Delete Resource
core.resources.service-positions 5
GET
/api/core/v1/resources/{resource_id}/service-positions
List Service Positions for Resource
POST
/api/core/v1/resources/{resource_id}/service-positions
Create Service Position
GET
/api/core/v1/resources/{resource_id}/service-positions/{position_id}
Get Service Position
PATCH
/api/core/v1/resources/{resource_id}/service-positions/{position_id}
Update Service Position
DELETE
/api/core/v1/resources/{resource_id}/service-positions/{position_id}
Delete Service Position
core.resources.certificates 5
GET
/api/core/v1/resources/{resource_id}/certificates
List Certificates for Resource
POST
/api/core/v1/resources/{resource_id}/certificates
Create Certificate
GET
/api/core/v1/resources/{resource_id}/certificates/{certificate_id}
Get Certificate
PATCH
/api/core/v1/resources/{resource_id}/certificates/{certificate_id}
Update Certificate
DELETE
/api/core/v1/resources/{resource_id}/certificates/{certificate_id}
Delete Certificate
core.resource-sets 5
GET
/api/core/v1/resource-sets
List Resource Sets
POST
/api/core/v1/resource-sets
Create Resource Set
GET
/api/core/v1/resource-sets/{id}
Get Resource Set
PATCH
/api/core/v1/resource-sets/{id}
Update Resource Set
DELETE
/api/core/v1/resource-sets/{id}
Delete Resource Set
core.countries 1
GET
/api/core/v1/countries
List Countrys
core.locations 6
POST
/api/core/v1/locations/resolve-coordinates
Resolve geographic data from coordinates
GET
/api/core/v1/locations
List Locations
POST
/api/core/v1/locations
Create Location
GET
/api/core/v1/locations/{id}
Get Location
PATCH
/api/core/v1/locations/{id}
Update Location
DELETE
/api/core/v1/locations/{id}
Delete Location
core.services.pricing-units 1
GET
/api/core/v1/services/{service_id}/pricing-units
List Pricing Units for Service
core.services.related-services 1
GET
/api/core/v1/services/{service_id}/related-services
List Related Services for Service
core.services 2
GET
/api/core/v1/services
List Services
GET
/api/core/v1/services/{service_id}
Get Service
core.service-categories 1
GET
/api/core/v1/service-categories
List Service Categorys
core.service-families 1
GET
/api/core/v1/service-families
List Service Familys
core.service-groups 1
GET
/api/core/v1/service-groups
List Service Groups
core.pricing-units 1
GET
/api/core/v1/pricing-units
List PricingUnits
core.erp-parts 3
GET
/api/core/v1/erp-parts
List ERP Parts
GET
/api/core/v1/erp-parts/{id}
Get ERP Part
PATCH
/api/core/v1/erp-parts/{id}
Set ERP Part category
core.erp-part-codes 1
GET
/api/core/v1/erp-part-codes
List ERP Part Codes
core.item-categories 1
GET
/api/core/v1/item-categories
List Item Categorys
core.service-standard-items 5
GET
/api/core/v1/service-standard-items
List Service Standard Items
POST
/api/core/v1/service-standard-items
Create Service Standard Item
GET
/api/core/v1/service-standard-items/{id}
Get Service Standard Item
PATCH
/api/core/v1/service-standard-items/{id}
Update Service Standard Item
DELETE
/api/core/v1/service-standard-items/{id}
Delete Service Standard Item
core.certificate-requirements 7
GET
/api/core/v1/certificate-requirements
List Certificate Requirement Rules
POST
/api/core/v1/certificate-requirements
Create Certificate Requirement Rule
GET
/api/core/v1/certificate-requirements/{id}
Get Certificate Requirement Rule
PATCH
/api/core/v1/certificate-requirements/{id}
Update Certificate Requirement Rule
DELETE
/api/core/v1/certificate-requirements/{id}
Delete Certificate Requirement Rule
POST
/api/core/v1/certificate-requirement-groups
Save a certificate mapping group
POST
/api/core/v1/projects/{project_id}/recompute-suggested-certificates
Recompute suggested certificates for a project
core.relationship-types 1
GET
/api/core/v1/relationship-types
List RelationshipTypes
core.standards 1
GET
/api/core/v1/standards
List Standards
core.positions 5
GET
/api/core/v1/positions
List Positions
POST
/api/core/v1/positions
Create Position
GET
/api/core/v1/positions/{id}
Get Position
PATCH
/api/core/v1/positions/{id}
Update Position
DELETE
/api/core/v1/positions/{id}
Delete Position
core.users 7
GET
/api/core/v1/users
List Users
POST
/api/core/v1/users
Create User
GET
/api/core/v1/users/{id}
Get User
PATCH
/api/core/v1/users/{id}
Update User
DELETE
/api/core/v1/users/{id}
Delete User
POST
/api/core/v1/users/{id}/reset-password
Reset User Password
GET
/api/core/v1/roles
Get Roles
core.customers 6
GET
/api/core/v1/customers
List Customers
POST
/api/core/v1/customers
Create Customer
GET
/api/core/v1/customers/{id}
Get Customer
PATCH
/api/core/v1/customers/{id}
Update Customer
DELETE
/api/core/v1/customers/{id}
Delete Customer
GET
/api/core/v1/customers/{id}/netsuite-subsidiary
Get Customer NetSuite Subsidiary
core.vendors 5
GET
/api/core/v1/vendors
List Vendors
POST
/api/core/v1/vendors
Create Vendor
GET
/api/core/v1/vendors/{id}
Get Vendor
PATCH
/api/core/v1/vendors/{id}
Update Vendor
DELETE
/api/core/v1/vendors/{id}
Delete Vendor
core.customers.contacts 5
GET
/api/core/v1/customers/{customer_id}/contacts
List Contacts for Customer
POST
/api/core/v1/customers/{customer_id}/contacts
Create Contact
GET
/api/core/v1/customers/{customer_id}/contacts/{contact_id}
Get Contact
PATCH
/api/core/v1/customers/{customer_id}/contacts/{contact_id}
Update Contact
DELETE
/api/core/v1/customers/{customer_id}/contacts/{contact_id}
Delete Contact
core.customers.addresses 5
GET
/api/core/v1/customers/{customer_id}/addresses
List Addresses for Customer
POST
/api/core/v1/customers/{customer_id}/addresses
Create Address
GET
/api/core/v1/customers/{customer_id}/addresses/{address_id}
Get Address
PATCH
/api/core/v1/customers/{customer_id}/addresses/{address_id}
Update Address
DELETE
/api/core/v1/customers/{customer_id}/addresses/{address_id}
Delete Address
core.customers.bank-accounts 5
GET
/api/core/v1/customers/{customer_id}/bank-accounts
List Bank Accounts for Customer
POST
/api/core/v1/customers/{customer_id}/bank-accounts
Create Bank Account
GET
/api/core/v1/customers/{customer_id}/bank-accounts/{bank_account_id}
Get Bank Account
PATCH
/api/core/v1/customers/{customer_id}/bank-accounts/{bank_account_id}
Update Bank Account
DELETE
/api/core/v1/customers/{customer_id}/bank-accounts/{bank_account_id}
Delete Bank Account
core.customers.locations 5
GET
/api/core/v1/customers/{customer_id}/locations
List Locations for Customer
POST
/api/core/v1/customers/{customer_id}/locations
Create Location
GET
/api/core/v1/customers/{customer_id}/locations/{customer_location_id}
Get Location
PATCH
/api/core/v1/customers/{customer_id}/locations/{customer_location_id}
Update Location
DELETE
/api/core/v1/customers/{customer_id}/locations/{customer_location_id}
Delete Location
core.customer-locations 1
GET
/api/core/v1/customer-locations
List Customer Locations
core.customers.users 5
GET
/api/core/v1/customers/{customer_id}/users
List Users for Customer
POST
/api/core/v1/customers/{customer_id}/users
Create User
GET
/api/core/v1/customers/{customer_id}/users/{user_id}
Get User
PATCH
/api/core/v1/customers/{customer_id}/users/{user_id}
Update User
DELETE
/api/core/v1/customers/{customer_id}/users/{user_id}
Delete User
core.customers.roles 1
GET
/api/core/v1/customers/{customer_id}/roles
List Roles for Customer
core.customers.turbines 5
GET
/api/core/v1/customers/{customer_id}/turbines
List Turbines for Customer
POST
/api/core/v1/customers/{customer_id}/turbines
Create Turbine
GET
/api/core/v1/customers/{customer_id}/turbines/{customer_turbine_id}
Get Turbine
PATCH
/api/core/v1/customers/{customer_id}/turbines/{customer_turbine_id}
Update Turbine
DELETE
/api/core/v1/customers/{customer_id}/turbines/{customer_turbine_id}
Delete Turbine
core.delay-categories 5
GET
/api/core/v1/delay-categories
List DelayCategorys
POST
/api/core/v1/delay-categories
Create DelayCategory
GET
/api/core/v1/delay-categories/{id}
Get DelayCategory
PATCH
/api/core/v1/delay-categories/{id}
Update DelayCategory
DELETE
/api/core/v1/delay-categories/{id}
Delete DelayCategory
core.delay-types 5
GET
/api/core/v1/delay-types
List DelayTypes
POST
/api/core/v1/delay-types
Create DelayType
GET
/api/core/v1/delay-types/{id}
Get DelayType
PATCH
/api/core/v1/delay-types/{id}
Update DelayType
DELETE
/api/core/v1/delay-types/{id}
Delete DelayType
core.delays 5
GET
/api/core/v1/delays
List Delays
POST
/api/core/v1/delays
Create Delay
GET
/api/core/v1/delays/{id}
Get Delay
PATCH
/api/core/v1/delays/{id}
Update Delay
DELETE
/api/core/v1/delays/{id}
Delete Delay
core.notifications 8
GET
/api/core/v1/notifications
List Notifications
GET
/api/core/v1/notifications/unread-count
Unread Count
PATCH
/api/core/v1/notifications/mark-all-read
Mark All Read
PATCH
/api/core/v1/notifications/seen
Mark Seen
GET
/api/core/v1/notifications/preferences
List Preferences
PUT
/api/core/v1/notifications/preferences
Upsert Preferences
GET
/api/core/v1/notifications/{notification_id}
Get Notification
PATCH
/api/core/v1/notifications/{notification_id}
Update Notification
notifications.events 1
POST
/api/notifications/v1/events
Announce Event
core.file-entity-links 5
GET
/api/core/v1/file-entity-links
List File Entity Links
POST
/api/core/v1/file-entity-links
Create File Entity Link
GET
/api/core/v1/file-entity-links/{id}
Get File Entity Link
PATCH
/api/core/v1/file-entity-links/{id}
Update File Entity Link
DELETE
/api/core/v1/file-entity-links/{id}
Delete File Entity Link
core.turbines 7
GET
/api/core/v1/turbines/import-template
Download turbine import CSV template
POST
/api/core/v1/turbines/import
Import turbines from CSV
GET
/api/core/v1/turbines
List Turbines
POST
/api/core/v1/turbines
Create Turbine
GET
/api/core/v1/turbines/{id}
Get Turbine
PATCH
/api/core/v1/turbines/{id}
Update Turbine
DELETE
/api/core/v1/turbines/{id}
Delete Turbine
core.turbine-components 8
GET
/api/core/v1/turbine-components/import-template
Download turbine component import CSV template
POST
/api/core/v1/turbine-components/import
Import turbine components from CSV
GET
/api/core/v1/turbine-components/{id}/reassignment-history
List Turbine Component Reassignment History
GET
/api/core/v1/turbine-components
List Turbine Components
POST
/api/core/v1/turbine-components
Create Turbine Component
GET
/api/core/v1/turbine-components/{id}
Get Turbine Component
PATCH
/api/core/v1/turbine-components/{id}
Update Turbine Component
DELETE
/api/core/v1/turbine-components/{id}
Delete Turbine Component
core.certificates 5
GET
/api/core/v1/certificates
List Certificates
POST
/api/core/v1/certificates
Create Certificate
GET
/api/core/v1/certificates/{id}
Get Certificate
PATCH
/api/core/v1/certificates/{id}
Update Certificate
DELETE
/api/core/v1/certificates/{id}
Delete Certificate
core.certificate-categories 5
GET
/api/core/v1/certificate-categories
List CertificateCategorys
POST
/api/core/v1/certificate-categories
Create CertificateCategory
GET
/api/core/v1/certificate-categories/{id}
Get CertificateCategory
PATCH
/api/core/v1/certificate-categories/{id}
Update CertificateCategory
DELETE
/api/core/v1/certificate-categories/{id}
Delete CertificateCategory
core.certificate-issuers 5
GET
/api/core/v1/certificate-issuers
List CertificateIssuers
POST
/api/core/v1/certificate-issuers
Create CertificateIssuer
GET
/api/core/v1/certificate-issuers/{id}
Get CertificateIssuer
PATCH
/api/core/v1/certificate-issuers/{id}
Update CertificateIssuer
DELETE
/api/core/v1/certificate-issuers/{id}
Delete CertificateIssuer
core.certificate-offerings 5
GET
/api/core/v1/certificate-offerings
List CertificateOfferings
POST
/api/core/v1/certificate-offerings
Create CertificateOffering
GET
/api/core/v1/certificate-offerings/{id}
Get CertificateOffering
PATCH
/api/core/v1/certificate-offerings/{id}
Update CertificateOffering
DELETE
/api/core/v1/certificate-offerings/{id}
Delete CertificateOffering
core.certificate-expenses 5
GET
/api/core/v1/certificate-expenses
List CertificateExpenses
POST
/api/core/v1/certificate-expenses
Create CertificateExpense
GET
/api/core/v1/certificate-expenses/{id}
Get CertificateExpense
PATCH
/api/core/v1/certificate-expenses/{id}
Update CertificateExpense
DELETE
/api/core/v1/certificate-expenses/{id}
Delete CertificateExpense
core.anomalies 22
GET
/api/core/v1/anomaly-components
List AnomalyComponents
GET
/api/core/v1/anomaly-types
List AnomalyTypes
GET
/api/core/v1/anomaly-root-cause-types
List AnomalyRootCauseTypes
GET
/api/core/v1/anomaly-parent-types
List AnomalyParentTypes
GET
/api/core/v1/anomaly-materials
List AnomalyMaterials
GET
/api/core/v1/anomaly-component-type-maps
List AnomalyComponentTypeMaps
GET
/api/core/v1/anomaly-recommendations
List AnomalyRecommendations
POST
/api/core/v1/anomaly-recommendations
Create AnomalyRecommendation
GET
/api/core/v1/anomaly-recommendations/{id}
Get AnomalyRecommendation
PATCH
/api/core/v1/anomaly-recommendations/{id}
Update AnomalyRecommendation
DELETE
/api/core/v1/anomaly-recommendations/{id}
Delete AnomalyRecommendation
GET
/api/core/v1/anomalies/{id}/files/
Fetch all files associated with a given anomaly ID.
POST
/api/core/v1/anomalies/{id}/files/
Upload a new file associated with a given anomaly ID.
GET
/api/core/v1/anomalies/{id}/files/{file_id}/
Fetch a specific file associated with a given anomaly ID.
DELETE
/api/core/v1/anomalies/{id}/files/{file_id}/
Delete a file associated with a given anomaly ID.
POST
/api/core/v1/anomalies/{id}/files/b64/
Upload a new body file associated with a given anomaly ID.
GET
/api/core/v1/anomalies
List anomalies
POST
/api/core/v1/anomalies
Create anomaly
GET
/api/core/v1/anomalies/{id}
Get anomaly
PATCH
/api/core/v1/anomalies/{id}
Update anomaly
DELETE
/api/core/v1/anomalies/{id}
Delete anomaly
GET
/api/core/v1/anomalies/{id}/main-image
Get anomaly main image
core.customers.anomaly-client-fields 6
GET
/api/core/v1/customers/{customer_id}/anomaly-client-fields
List Anomaly Client Fields for Customer
POST
/api/core/v1/customers/{customer_id}/anomaly-client-fields
Create Anomaly Client Field
GET
/api/core/v1/customers/{customer_id}/anomaly-client-fields/{field_id}
Get Anomaly Client Field
PATCH
/api/core/v1/customers/{customer_id}/anomaly-client-fields/{field_id}
Update Anomaly Client Field
DELETE
/api/core/v1/customers/{customer_id}/anomaly-client-fields/{field_id}
Delete Anomaly Client Field
GET
/api/core/v1/anomaly-client-fields/applicable
List Applicable Anomaly Client Fields
core.files 8
GET
/api/core/v1/files/{entity_type}/{entity_id}/
Fetch all files associated with a supported entity.
POST
/api/core/v1/files/{entity_type}/{entity_id}/
Upload one or more files for a supported entity.
GET
/api/core/v1/files/{entity_type}/{entity_id}/{file_id}/
Fetch a specific file associated with a supported entity.
DELETE
/api/core/v1/files/{entity_type}/{entity_id}/{file_id}/
Delete a file associated with a supported entity.
GET
/api/core/v1/files/{entity_type}/{entity_id}/{file_id}/download/
Resolve and download an entity file.
POST
/api/core/v1/files
Upload one or more files without binding them to an entity.
POST
/api/core/v1/files/b64/
Upload base64-encoded files without binding them to an entity.
POST
/api/core/v1/files/{entity_type}/{entity_id}/b64/
Upload base64-encoded files for a supported entity.
core.blade-diagrams 2
POST
/api/core/v1/blade-diagrams
Generate blade anomaly diagram as PNG
GET
/api/core/v1/blade-diagrams/service-order-lines/{sol_id}
Generate blade diagram from service order line
core.cross-sections 2
POST
/api/core/v1/cross-sections
Generate blade cross-section as PNG
GET
/api/core/v1/cross-sections/anomalies/{anomaly_id}
Generate cross-section from anomaly
core.timezones 1
GET
/api/core/v1/timezones
List Timezones
core.currencies 1
GET
/api/core/v1/currencies
List Currencys
core.business-regions 1
GET
/api/core/v1/business-regions
List Business Regions
core.regions 1
GET
/api/core/v1/regions
List Regions
customer-portal 3
GET
/api/core/v1/terms-of-service
List Terms of Services
GET
/api/core/v1/user-tos-acceptances
List User ToS Acceptances
POST
/api/core/v1/user-tos-acceptances
Create User ToS Acceptance
reports 8
POST
/api/core/v1/reports/daily
Generate and download a daily report PDF
POST
/api/core/v1/reports/final
Download a final (SOL) report — engine-rendered or uploaded
GET
/api/core/v1/reports/final/{service_order_line_id}/filedeprecated
Download an uploaded final report file (e.g. LER)
POST
/api/core/v1/reports/custom
Request a custom report for a selection of turbines, locations or projects
GET
/api/core/v1/reports/custom
List the customer's latest custom report requests
GET
/api/core/v1/reports/custom/types
List the report types a custom report can be requested for
GET
/api/core/v1/reports/custom/{generation_id}/status
Poll a custom report request
GET
/api/core/v1/reports/custom/{generation_id}/download
Download a finished custom report
core.project-question-configs 1
GET
/api/core/v1/project-question-configs
List Project Question Configs
core.project-status 1
GET
/api/core/v1/project-statuses
List Project Status
core.report-types 1
GET
/api/core/v1/report-types
List Report Types
core.pipedrive-deals 1
GET
/api/core/v1/pipedrive-deals
List Pipedrive Deals
core.projects.pre-job-answers 6
PATCH
/api/core/v1/projects/{project_id}/pre-job-answers/bulk
Bulk update Pre-Job Answers
GET
/api/core/v1/projects/{project_id}/pre-job-answers
List Pre-Job Answers for Project
POST
/api/core/v1/projects/{project_id}/pre-job-answers
Create Pre-Job Answer
GET
/api/core/v1/projects/{project_id}/pre-job-answers/{answer_id}
Get Pre-Job Answer
PATCH
/api/core/v1/projects/{project_id}/pre-job-answers/{answer_id}
Update Pre-Job Answer
DELETE
/api/core/v1/projects/{project_id}/pre-job-answers/{answer_id}
Delete Pre-Job Answer
core.projects.rfi-billing 2
GET
/api/core/v1/projects/{project_id}/rfi-billing
Get RFI Billing composite (ProjectBilling and linked purchase orders)
PATCH
/api/core/v1/projects/{project_id}/rfi-billing
Update RFI Billing composite
core.projects.pre-job-sites 1
GET
/api/core/v1/projects/{project_id}/pre-job/sites
Get pre-job sites for a project
core.projects.contacts 5
GET
/api/core/v1/projects/{project_id}/contacts
List Contacts for Project
POST
/api/core/v1/projects/{project_id}/contacts
Create Contact
GET
/api/core/v1/projects/{project_id}/contacts/{contact_id}
Get Contact
PATCH
/api/core/v1/projects/{project_id}/contacts/{contact_id}
Update Contact
DELETE
/api/core/v1/projects/{project_id}/contacts/{contact_id}
Delete Contact
core.projects.locations 10
GET
/api/core/v1/projects/{project_id}/locations
List Project Locations
POST
/api/core/v1/projects/{project_id}/locations
Bulk Assign Locations to Project
GET
/api/core/v1/projects/{project_id}/locations/service-coverage
Per project location, the service ids offered or scoped there
GET
/api/core/v1/projects/{project_id}/locations/{location_id}/pre-job
Get pre-job composite for a project location
PUT
/api/core/v1/projects/{project_id}/locations/{location_id}/pre-job
Update pre-job composite for a project location
GET
/api/core/v1/projects/{project_id}/pre-job/prefill-source-projects
List candidate source projects for pre-job prefill
GET
/api/core/v1/projects/{project_id}/pre-job/prefill-source-sites
List sites on a source project for the prefill picker
GET
/api/core/v1/projects/{project_id}/locations/{location_id}
Get Project Location
PATCH
/api/core/v1/projects/{project_id}/locations/{location_id}
Update Project Location
DELETE
/api/core/v1/projects/{project_id}/locations/{location_id}
Remove Location from Project
core.turbine-components.receptors 2
GET
/api/core/v1/turbine-components/{blade_id}/receptors
List receptors on a single blade
PUT
/api/core/v1/turbine-components/{blade_id}/receptors
Sync receptors on a single blade
core.turbines.receptors 2
GET
/api/core/v1/turbines/{turbine_id}/receptors
List receptors for all blades on a turbine (one round-trip)
POST
/api/core/v1/turbines/{turbine_id}/receptors/init-from-preset
Initialize receptors on every blade from the chosen preset
core.turbine-models.receptor-presets 6
GET
/api/core/v1/turbine-models/{turbine_model_id}/receptor-presets
List receptor presets for a turbine model
POST
/api/core/v1/turbine-models/{turbine_model_id}/receptor-presets
Create a receptor preset for a turbine model
PATCH
/api/core/v1/receptor-presets/{preset_id}
Update a receptor preset (name / description)
DELETE
/api/core/v1/receptor-presets/{preset_id}
Soft-delete a receptor preset (and its receptor children)
GET
/api/core/v1/receptor-presets/{preset_id}/receptors
List receptors in a preset
PUT
/api/core/v1/receptor-presets/{preset_id}/receptors
Sync receptors in a preset
core.service-order-lines.lps-results 2
GET
/api/core/v1/service-order-lines/{sol_id}/lps-results
Per-blade LPS Service Results capture context
PUT
/api/core/v1/service-order-lines/{sol_id}/lps-results
Upsert per-receptor LPS measurements for a SOL
core.projects.offers 13
GET
/api/core/v1/projects/{project_id}/offers/current
Get Current Offer for Project
POST
/api/core/v1/projects/{project_id}/offers/draft
Create Draft Offer
POST
/api/core/v1/projects/{project_id}/offers/{offer_id}/send-for-approval
Send Offer for Approval
POST
/api/core/v1/projects/{project_id}/offers/{offer_id}/approve
Approve Pending Offer
POST
/api/core/v1/projects/{project_id}/offers/{offer_id}/reject
Reject Pending Offer
GET
/api/core/v1/projects/{project_id}/offers/history
Get Offer History for Project
POST
/api/core/v1/projects/{project_id}/offers/download
Download Offer PDF
POST
/api/core/v1/projects/{project_id}/offers/download-docx
Download Offer DOCX
GET
/api/core/v1/projects/{project_id}/offers
List Offers for Project
POST
/api/core/v1/projects/{project_id}/offers
Create Offer
GET
/api/core/v1/projects/{project_id}/offers/{offer_id}
Get Offer
PATCH
/api/core/v1/projects/{project_id}/offers/{offer_id}
Update Offer
DELETE
/api/core/v1/projects/{project_id}/offers/{offer_id}
Delete Offer
core.projects.billings 5
GET
/api/core/v1/projects/{project_id}/billings
List Billings for Project
POST
/api/core/v1/projects/{project_id}/billings
Create Billing
GET
/api/core/v1/projects/{project_id}/billings/{billing_id}
Get Billing
PATCH
/api/core/v1/projects/{project_id}/billings/{billing_id}
Update Billing
DELETE
/api/core/v1/projects/{project_id}/billings/{billing_id}
Delete Billing
core.projects.report-types 5
GET
/api/core/v1/projects/{project_id}/report-types
List Report Types for Project
POST
/api/core/v1/projects/{project_id}/report-types
Create Report Type
GET
/api/core/v1/projects/{project_id}/report-types/{project_report_type_id}
Get Report Type
PATCH
/api/core/v1/projects/{project_id}/report-types/{project_report_type_id}
Update Report Type
DELETE
/api/core/v1/projects/{project_id}/report-types/{project_report_type_id}
Delete Report Type
core.projects.offers.items 6
GET
/api/core/v1/offers/{offer_id}/items
List Items for Offer
POST
/api/core/v1/offers/{offer_id}/items
Create Item
GET
/api/core/v1/offers/{offer_id}/items/{item_id}
Get Item
PATCH
/api/core/v1/offers/{offer_id}/items/{item_id}
Update Item
DELETE
/api/core/v1/offers/{offer_id}/items/{item_id}
Delete Item
GET
/api/core/v1/projects/{project_id}/offers/{offer_id}/items
List Offer Items for Project Offer
core.commercial-offers 2
GET
/api/core/v1/commercial-offers
List Commercial Offers Pending Approval
POST
/api/core/v1/commercial-offers/approve
Bulk Approve Commercial Offers
core.projects.scope-items 6
GET
/api/core/v1/projects/{project_id}/scope-items
List Scope Items for Project
POST
/api/core/v1/projects/{project_id}/scope-items
Create Scope Item
GET
/api/core/v1/projects/{project_id}/scope-items/{scope_item_id}
Get Scope Item
PATCH
/api/core/v1/projects/{project_id}/scope-items/{scope_item_id}
Update Scope Item
DELETE
/api/core/v1/projects/{project_id}/scope-items/{scope_item_id}
Delete Scope Item
POST
/api/core/v1/projects/{project_id}/scope-item-batches
Create Scope Item Batch
core.projects.resource-sets 7
GET
/api/core/v1/projects/{project_id}/resource-sets
List Resource Sets for Project
POST
/api/core/v1/projects/{project_id}/resource-sets
Create Resource Set
GET
/api/core/v1/projects/{project_id}/resource-sets/{resource_set_id}
Get Resource Set
PATCH
/api/core/v1/projects/{project_id}/resource-sets/{resource_set_id}
Update Resource Set
DELETE
/api/core/v1/projects/{project_id}/resource-sets/{resource_set_id}
Delete Resource Set
POST
/api/core/v1/projects/{project_id}/materialize-planned-resource-set
Promote a planned resource set into an editable roster set
GET
/api/core/v1/projects/{project_id}/resource-set-activity-days
Per-set workorder-activity days for a project window
core.projects.planned-resource-sets 5
GET
/api/core/v1/projects/{project_id}/planned-resource-sets
List Planned Resource Sets for Project
POST
/api/core/v1/projects/{project_id}/planned-resource-sets
Create Planned Resource Set
GET
/api/core/v1/projects/{project_id}/planned-resource-sets/{planned_resource_set_id}
Get Planned Resource Set
PATCH
/api/core/v1/projects/{project_id}/planned-resource-sets/{planned_resource_set_id}
Update Planned Resource Set
DELETE
/api/core/v1/projects/{project_id}/planned-resource-sets/{planned_resource_set_id}
Delete Planned Resource Set
core.planned-resource-sets.items 5
GET
/api/core/v1/planned-resource-sets/{planned_resource_set_id}/items
List Items for Planned Resource Set
POST
/api/core/v1/planned-resource-sets/{planned_resource_set_id}/items
Create Item
GET
/api/core/v1/planned-resource-sets/{planned_resource_set_id}/items/{item_id}
Get Item
PATCH
/api/core/v1/planned-resource-sets/{planned_resource_set_id}/items/{item_id}
Update Item
DELETE
/api/core/v1/planned-resource-sets/{planned_resource_set_id}/items/{item_id}
Delete Item
core.planned-resource-set-items.commitments 5
GET
/api/core/v1/planned-resource-set-items/{planned_resource_set_item_id}/commitments
List Commitments for Planned Resource Set Item
POST
/api/core/v1/planned-resource-set-items/{planned_resource_set_item_id}/commitments
Create Commitment
GET
/api/core/v1/planned-resource-set-items/{planned_resource_set_item_id}/commitments/{commitment_id}
Get Commitment
PATCH
/api/core/v1/planned-resource-set-items/{planned_resource_set_item_id}/commitments/{commitment_id}
Update Commitment
DELETE
/api/core/v1/planned-resource-set-items/{planned_resource_set_item_id}/commitments/{commitment_id}
Delete Commitment
core.projects.readiness 1
GET
/api/core/v1/projects/{project_id}/readiness
Get Project Readiness
core.projects.bto 9
GET
/api/core/v1/projects/{project_id}/bto/travel-orders
List Bto Travel Orders
POST
/api/core/v1/projects/{project_id}/bto/travel-orders
Create Bto Travel Order
GET
/api/core/v1/projects/{project_id}/bto/travel-orders/{order_id}
Get Bto Travel Order
PATCH
/api/core/v1/projects/{project_id}/bto/travel-orders/{order_id}
Update Bto Travel Order
DELETE
/api/core/v1/projects/{project_id}/bto/travel-orders/{order_id}
Delete Bto Travel Order
POST
/api/core/v1/projects/{project_id}/bto/travel-orders/{order_id}/refresh
Refresh Bto Travel Order
POST
/api/core/v1/projects/{project_id}/bto/travel-orders/{order_id}/send-emails
Send Bto Travel Order Emails
GET
/api/core/v1/projects/{project_id}/bto/travel-orders/{order_id}/questions
Get Bto Travel Order Questions
PUT
/api/core/v1/projects/{project_id}/bto/travel-orders/{order_id}/questions
Update Bto Travel Order Questions
bto.travel-orders 13
GET
/api/bto/v1/projects/{project_id}/travel-orders
List a project's travel orders with full per-site detail (no N+1 needed to render a site card)
POST
/api/bto/v1/projects/{project_id}/travel-orders
Create a travel order
GET
/api/bto/v1/projects/{project_id}/travel-orders/{order_id}
Get a single travel order
PATCH
/api/bto/v1/projects/{project_id}/travel-orders/{order_id}
Partially update a Draft travel order
DELETE
/api/bto/v1/projects/{project_id}/travel-orders/{order_id}
Soft-delete a travel order
POST
/api/bto/v1/projects/{project_id}/travel-orders/{order_id}/refresh
Re-pull planned dates and team snapshot from their live sources
POST
/api/bto/v1/projects/{project_id}/travel-orders/{order_id}/send
Preflight-validate, freeze the team snapshot, and mark the order Sent
POST
/api/bto/v1/projects/{project_id}/travel-orders/{order_id}/resend-all
Resend the BTO email to every current crew member (Sent orders only)
POST
/api/bto/v1/projects/{project_id}/travel-orders/{order_id}/members/{resource_id}/resend
Resend the BTO email to one crew member (Sent orders only, magic link unchanged)
GET
/api/bto/v1/projects/{project_id}/travel-orders/{order_id}/questionnaire-progress
Read-only per-member questionnaire completion progress for the whole roster
GET
/api/bto/v1/projects/{project_id}/travel-orders/{order_id}/questionnaire/{resource_id}
Get one crew member's questionnaire with their current answers (read-only)
PUT
/api/bto/v1/projects/{project_id}/travel-orders/{order_id}/questionnaire/{resource_id}/{question_key}
Staff: edit one crew member's answer on their behalf (attributed to the acting user)
DELETE
/api/bto/v1/projects/{project_id}/travel-orders/{order_id}/questionnaire/{resource_id}/{question_key}
Staff: reset one crew member's answer back to unanswered
bto.crew 4
GET
/api/bto/v1/crew/{questionnaire_id}
Crew magic-link: order overview + this member's questionnaire
GET
/api/bto/v1/crew/{questionnaire_id}/pixel.gif
Crew email tracking pixel: records the first email open
GET
/api/bto/v1/crew/{questionnaire_id}/pre-job-pdf
Crew magic-link: download the project's live Pre-job PDF
PUT
/api/bto/v1/crew/{questionnaire_id}/questionnaire/{question_key}
Crew magic-link: submit (autosave) one answer
core.projects.communication 7
GET
/api/core/v1/projects/{project_id}/communication/messagesdeprecated
List Messages
POST
/api/core/v1/projects/{project_id}/communication/messagesdeprecated
Create Message
PATCH
/api/core/v1/projects/{project_id}/communication/messages/{comment_id}deprecated
Update Message
DELETE
/api/core/v1/projects/{project_id}/communication/messages/{comment_id}deprecated
Delete Message
GET
/api/core/v1/projects/{project_id}/communication/feeddeprecated
Get Feed
GET
/api/core/v1/roles/{role_id}/members
Role Members
GET
/api/core/v1/projects/{project_id}/communication/mention-candidatesdeprecated
Mention Candidates
core.project-scope-change-requests 7
GET
/api/core/v1/project-scope-change-requests
List ProjectScopeChangeRequests
POST
/api/core/v1/project-scope-change-requests
Create ProjectScopeChangeRequest
GET
/api/core/v1/project-scope-change-requests/{id}
Get ProjectScopeChangeRequest
PATCH
/api/core/v1/project-scope-change-requests/{id}
Update ProjectScopeChangeRequest
POST
/api/core/v1/project-scope-change-requests/{scope_change_request_id}/approve
Approve the current review stage of a ProjectScopeChangeRequest
POST
/api/core/v1/project-scope-change-requests/{scope_change_request_id}/reject
Reject a ProjectScopeChangeRequest at its current review stage
GET
/api/core/v1/project-scope-change-requests/{scope_change_request_id}/pdf
Download a ProjectScopeChangeRequest as a PDF
core.projects 15
GET
/api/core/v1/projects
List Projects
POST
/api/core/v1/projects
Create Project
GET
/api/core/v1/projects/search
Search Projects
GET
/api/core/v1/projects/{project_id}
Get Project
PATCH
/api/core/v1/projects/{project_id}
Update Project
DELETE
/api/core/v1/projects/{project_id}
Delete Project
GET
/api/core/v1/projects/{project_id}/overview
Get Project Overview
PATCH
/api/core/v1/projects/{project_id}/overview
Update Project Overview
GET
/api/core/v1/projects/{project_id}/overview/financials
Get Project Overview Financials
GET
/api/core/v1/projects/{project_id}/status-history
Get Project Status History
GET
/api/core/v1/projects/{project_id}/validate
Validate Project
POST
/api/core/v1/projects/{project_id}/refresh-google-drive
Refresh Project Google Drive
POST
/api/core/v1/projects/{project_id}/complete
Mark Project Completed
POST
/api/core/v1/projects/{project_id}/status-override
Override Project Status
PUT
/api/core/v1/projects/{project_id}/pre-job-received
Update Project Pre Job Received
core.purchase-orders 5
GET
/api/core/v1/purchase-orders
List purchase orders
POST
/api/core/v1/purchase-orders
Create a purchase order with its initial version
GET
/api/core/v1/purchase-orders/{id}
Get a purchase order
PATCH
/api/core/v1/purchase-orders/{id}
Update a purchase order (customer / currency only)
DELETE
/api/core/v1/purchase-orders/{id}
Soft-delete a purchase order
core.purchase-orders.versions 7
GET
/api/core/v1/purchase-orders/{id}/versions
List versions for a purchase order
POST
/api/core/v1/purchase-orders/{id}/versions
Add a new version (amendment) to a purchase order
GET
/api/core/v1/purchase-orders/{id}/versions/{version_id}
Get a version
PATCH
/api/core/v1/purchase-orders/{id}/versions/{version_id}
Update a version (scalar fields only)
DELETE
/api/core/v1/purchase-orders/{id}/versions/{version_id}
Soft-delete a version
POST
/api/core/v1/purchase-orders/{id}/versions/{version_id}/file
Set or replace the file attached to a version
DELETE
/api/core/v1/purchase-orders/{id}/versions/{version_id}/file
Detach the file from a version (no-op if none)
core.purchase-orders.projects 4
GET
/api/core/v1/purchase-orders/{id}/projects
List project links for a purchase order
POST
/api/core/v1/purchase-orders/{id}/projects
Link a project to a purchase order
PATCH
/api/core/v1/purchase-orders/{id}/projects/{project_id}
Update the allocation for a PO-project link
DELETE
/api/core/v1/purchase-orders/{id}/projects/{project_id}
Remove a project link from a purchase order
resource-mobilization.vehicles 12
GET
/api/resource-mobilization/v1/vehicles/summary
Get Vehicle Fleet Summary
GET
/api/resource-mobilization/v1/vehicles
List Vehicles
POST
/api/resource-mobilization/v1/vehicles
Create Vehicle
POST
/api/resource-mobilization/v1/vehicles/{id}/archive
Archive Vehicle
POST
/api/resource-mobilization/v1/vehicles/{id}/unarchive
Unarchive Vehicle
GET
/api/resource-mobilization/v1/vehicles/{id}
Get Vehicle
PATCH
/api/resource-mobilization/v1/vehicles/{id}
Update Vehicle
DELETE
/api/resource-mobilization/v1/vehicles/{id}
Delete Vehicle
GET
/api/resource-mobilization/v1/vehicles/{id}/insurances
List Vehicle Insurances
POST
/api/resource-mobilization/v1/vehicles/{id}/insurances
Create Vehicle Insurance
PATCH
/api/resource-mobilization/v1/vehicles/{id}/insurances/{insurance_id}
Update Vehicle Insurance
DELETE
/api/resource-mobilization/v1/vehicles/{id}/insurances/{insurance_id}
Delete Vehicle Insurance
resource-mobilization.vehicle-fleet-assignments 11
GET
/api/resource-mobilization/v1/vehicle-fleet-assignments/discrepancies
List Discrepancies
GET
/api/resource-mobilization/v1/vehicle-fleet-assignments
List Assignments
POST
/api/resource-mobilization/v1/vehicle-fleet-assignments/plan
Plan Assignment
POST
/api/resource-mobilization/v1/vehicle-fleet-assignments/accept
Accept Vehicle
GET
/api/resource-mobilization/v1/vehicle-fleet-assignments/user-projects
Get User Projects
POST
/api/resource-mobilization/v1/vehicle-fleet-assignments/planner-status
Planner Status
GET
/api/resource-mobilization/v1/vehicle-fleet-assignments/{id}
Get Assignment
POST
/api/resource-mobilization/v1/vehicle-fleet-assignments/{id}/accept
Accept Planned Assignment
POST
/api/resource-mobilization/v1/vehicle-fleet-assignments/{id}/update
Update Assignment
POST
/api/resource-mobilization/v1/vehicle-fleet-assignments/{id}/return
Return Vehicle
POST
/api/resource-mobilization/v1/vehicle-fleet-assignments/{id}/cancel
Cancel Assignment
resource-mobilization.vehicle-fleet-invoices 10
GET
/api/resource-mobilization/v1/vehicle-fleet-invoices
List Invoices
POST
/api/resource-mobilization/v1/vehicle-fleet-invoices
Create Invoice
POST
/api/resource-mobilization/v1/vehicle-fleet-invoices/extract
Extract Invoice
GET
/api/resource-mobilization/v1/vehicle-fleet-invoices/{id}
Get Invoice
PATCH
/api/resource-mobilization/v1/vehicle-fleet-invoices/{id}
Update Invoice
DELETE
/api/resource-mobilization/v1/vehicle-fleet-invoices/{id}
Delete Invoice
GET
/api/resource-mobilization/v1/vehicle-fleet-invoices/{id}/files
List Invoice Files
POST
/api/resource-mobilization/v1/vehicle-fleet-invoices/{id}/files
Upload Invoice File
GET
/api/resource-mobilization/v1/vehicle-fleet-invoices/{id}/files/{file_id}/download
Download Invoice File
DELETE
/api/resource-mobilization/v1/vehicle-fleet-invoices/{id}/files/{file_resource_id}
Delete Invoice File
resource-mobilization.obd-gps-devices 9
GET
/api/resource-mobilization/v1/obd-gps-devices
List Devices
POST
/api/resource-mobilization/v1/obd-gps-devices
Create Device
POST
/api/resource-mobilization/v1/obd-gps-devices/{id}/assign
Assign Device
POST
/api/resource-mobilization/v1/obd-gps-devices/{id}/end-assignment
End Assignment
POST
/api/resource-mobilization/v1/obd-gps-devices/sync-navirec
Sync Navirec
GET
/api/resource-mobilization/v1/obd-gps-devices/{id}/assignments
List Device Assignments
GET
/api/resource-mobilization/v1/obd-gps-devices/{id}
Get Device
PATCH
/api/resource-mobilization/v1/obd-gps-devices/{id}
Update Device
DELETE
/api/resource-mobilization/v1/obd-gps-devices/{id}
Delete Device
resource-mobilization.vehicle-fleet-locations 2
GET
/api/resource-mobilization/v1/vehicle-fleet-locations/vehicle-map
Get locations with vehicle counts for map view
GET
/api/resource-mobilization/v1/vehicle-fleet-locations
List locations for fleet use
technician.projects 3
GET
/api/technician/service-order-lines
List Service Order Lines
GET
/api/technician/service-order-lines/filters
Get Service Order Line Filters
GET
/api/technician/service-order-lines/{line_id}
Get Service Order Line Detail
technician.workorders 6
GET
/api/technician/workorders
List Workorders
GET
/api/technician/workorders/filters
Get Workorder Filters
GET
/api/technician/workorders/sol-activities
List Sol Activities
GET
/api/technician/workorders/{workorder_id}
Get Workorder Detail
GET
/api/technician/workorders/{workorder_id}/available-activities
Get Available Activities
GET
/api/technician/workorders/{workorder_id}/resource-presets
Get available resource presets (ProjectResourceSets) for a workorder
technician.service_results 11
GET
/api/technician/dashboard/summary
Get Dashboard Summary
GET
/api/technician/dashboard/queue
Get Dashboard Queue
GET
/api/technician/service-order-lines/{sol_id}/service-results
List Service Results For Sol
POST
/api/technician/service-order-lines/{sol_id}/service-results
Create Service Result
GET
/api/technician/service-order-lines/{sol_id}/result-capture-context
Get Result Capture Context
POST
/api/technician/service-order-lines/{sol_id}/finalize
Finalize Service Order Line
POST
/api/technician/service-order-lines/{sol_id}/unfinalize
Unfinalize Service Order Line
GET
/api/technician/service-results/{result_id}
Get Service Result
PATCH
/api/technician/service-results/{result_id}
Patch Service Result
GET
/api/technician/service-order-lines/{sol_id}/cleaning-imagesdeprecated
Get Sol Cleaning Images
PATCH
/api/technician/service-order-lines/{sol_id}/cleaning-imagesdeprecated
Patch Sol Cleaning Images
technician.reports 11
GET
/api/technician/reports/service-order-lines
List Report Service Order Lines
POST
/api/technician/reports/download
Download Report
POST
/api/technician/reports/submit-draft
Submit Draft Report
POST
/api/technician/reports/send
Send Report
POST
/api/technician/reports/final-report/download
Download Final Report
POST
/api/technician/reports/final-report/send
Send Final Report
POST
/api/technician/reports/final-report/start
Start Final Report
GET
/api/technician/reports/final-report/{generation_id}/status
Final Report Status
GET
/api/technician/reports/final-report/{generation_id}/download
Download Final Report By Id
GET
/api/technician/reports/final-report/state
Final Report State
POST
/api/technician/reports/final-report/{generation_id}/send
Send Final Report By Id
dispatch.services 22
GET
/api/dispatch/v1/services
List Services
GET
/api/dispatch/v1/services/{service_id}
Get Service
GET
/api/dispatch/v1/service-items
List Service Items
GET
/api/dispatch/v1/service-items/{service_item_id}
Get Service Item
GET
/api/dispatch/v1/services/{service_id}/service-items
List Service Items For Service
GET
/api/dispatch/v1/services/{service_id}/service-items/{service_item_id}
Get Service Item For Service
GET
/api/dispatch/v1/service-item-activities
List Service Item Activities
GET
/api/dispatch/v1/service-item-activities/{activity_id}
Get Service Item Activity
GET
/api/dispatch/v1/services/{service_id}/service-items/{service_item_id}/activities
List Service Item Activities For Service
GET
/api/dispatch/v1/services/{service_id}/service-items/{service_item_id}/activities/{activity_id}
Get Service Item Activity For Service
GET
/api/dispatch/v1/service-orders
List Service Orders
POST
/api/dispatch/v1/service-orders
Create Service Order
GET
/api/dispatch/v1/service-orders/summary
Get Service Order Summary
GET
/api/dispatch/v1/service-orders/{service_order_id}
Get Service Order
PATCH
/api/dispatch/v1/service-orders/{service_order_id}
Patch Service Order
DELETE
/api/dispatch/v1/service-orders/{service_order_id}
Delete Service Order
GET
/api/dispatch/v1/service-order-lines
List Service Order Lines
POST
/api/dispatch/v1/service-order-lines
Create Service Order Line
GET
/api/dispatch/v1/service-order-lines/{line_id}
Get Service Order Line
PUT
/api/dispatch/v1/service-order-lines/{line_id}
Update Service Order Line
PATCH
/api/dispatch/v1/service-order-lines/{line_id}
Patch Service Order Line
DELETE
/api/dispatch/v1/service-order-lines/{line_id}
Delete Service Order Line
dispatch.workorders 31
GET
/api/dispatch/v1/workorders
List Workorders
POST
/api/dispatch/v1/workorders
Create Workorder
GET
/api/dispatch/v1/workorders/summary
Get Workorder Summary
GET
/api/dispatch/v1/workorders/activity-counts
Get Workorder Activity Counts
GET
/api/dispatch/v1/workorder-activities
List Workorder Activities
POST
/api/dispatch/v1/workorder-activities
Create Workorder Activity
POST
/api/dispatch/v1/workorders/bulk
Bulk Create Workorders
GET
/api/dispatch/v1/workorders/{workorder_id}
Get Workorder
PUT
/api/dispatch/v1/workorders/{workorder_id}
Update Workorder
PATCH
/api/dispatch/v1/workorders/{workorder_id}
Patch Workorder
DELETE
/api/dispatch/v1/workorders/{workorder_id}
Delete Workorder
POST
/api/dispatch/v1/workorders/{workorder_id}/cancel
Cancel Workorder
GET
/api/dispatch/v1/workorder-activities/{activity_id}
Get Workorder Activity
PUT
/api/dispatch/v1/workorder-activities/{activity_id}
Update Workorder Activity
PATCH
/api/dispatch/v1/workorder-activities/{activity_id}
Patch Workorder Activity
DELETE
/api/dispatch/v1/workorder-activities/{activity_id}
Delete Workorder Activity
PATCH
/api/dispatch/v1/workorder-activities/bulk/update
Bulk Patch Workorder Activities
GET
/api/dispatch/v1/workorder-activities/{activity_id}/time-edits
List Workorder Activity Time Edits
GET
/api/dispatch/v1/workorder-plans
List Workorder Plans
POST
/api/dispatch/v1/workorder-plans
Create Workorder Plan
GET
/api/dispatch/v1/workorder-plans/{plan_id}
Get Workorder Plan
PUT
/api/dispatch/v1/workorder-plans/{plan_id}
Update Workorder Plan
PATCH
/api/dispatch/v1/workorder-plans/{plan_id}
Patch Workorder Plan
DELETE
/api/dispatch/v1/workorder-plans/{plan_id}
Delete Workorder Plan
GET
/api/dispatch/v1/work-time-logs
List Work Time Logs
POST
/api/dispatch/v1/work-time-logs
Create Work Time Log
GET
/api/dispatch/v1/work-time-logs/{log_id}
Get Work Time Log
PATCH
/api/dispatch/v1/work-time-logs/{log_id}
Patch Work Time Log
DELETE
/api/dispatch/v1/work-time-logs/{log_id}
Delete Work Time Log
GET
/api/dispatch/v1/workorder-status-changes
List Workorder Status Changes
GET
/api/dispatch/v1/workorder-status-changes/{change_id}
Get Workorder Status Change
dispatch.workorder-activity-metadata 5
GET
/api/dispatch/v1/workorder-activity-metadata
List Workorder Activity Metadata
POST
/api/dispatch/v1/workorder-activity-metadata
Create Workorder Activity Metadata
GET
/api/dispatch/v1/workorder-activity-metadata/{metadata_id}
Get Workorder Activity Metadata
PATCH
/api/dispatch/v1/workorder-activity-metadata/{metadata_id}
Patch Workorder Activity Metadata
DELETE
/api/dispatch/v1/workorder-activity-metadata/{metadata_id}
Delete Workorder Activity Metadata
dispatch.board 14
GET
/api/dispatch/v1/projects/{project_id}/dispatch/board-data
Get dispatching board data
GET
/api/dispatch/v1/projects/{project_id}/dispatch/board-turbines
Get per-turbine status rollup for the dispatching board
GET
/api/dispatch/v1/projects/{project_id}/dispatch/backlog
Server-filtered, paginated work-order list for the dispatch sidebar
GET
/api/dispatch/v1/projects/{project_id}/dispatch/board-weather
Get dispatching board weather
GET
/api/dispatch/v1/coverage
Per-project resource-set coverage by day
GET
/api/dispatch/v1/adoption
Teams x dates table of what the board dispatched (OH-4167)
GET
/api/dispatch/v1/supervisor-options
List BTO supervisors and the core projects they supervise
GET
/api/projects/{project_id}/dispatch/board-data
Get dispatching board data
GET
/api/projects/{project_id}/dispatch/board-turbines
Get per-turbine status rollup for the dispatching board
GET
/api/projects/{project_id}/dispatch/backlog
Server-filtered, paginated work-order list for the dispatch sidebar
GET
/api/projects/{project_id}/dispatch/board-weather
Get dispatching board weather
GET
/api/projects/dispatch/coverage
Per-project resource-set coverage by day
GET
/api/projects/dispatch/adoption
Teams x dates table of what the board dispatched (OH-4167)
GET
/api/projects/dispatch/supervisor-options
List BTO supervisors and the core projects they supervise
dispatch.board-workorders 20
POST
/api/dispatch/v1/projects/{project_id}/dispatch/assign
Assign workorder to resources
POST
/api/dispatch/v1/projects/{project_id}/dispatch/assign-bulk
Bulk assign workorders to resources
POST
/api/dispatch/v1/projects/{project_id}/dispatch/unassign
Unassign workorder from resources
DELETE
/api/dispatch/v1/projects/{project_id}/dispatch/workorders/{workorder_id}
Soft-delete an administrative workorder
PATCH
/api/dispatch/v1/projects/{project_id}/dispatch/admin-workorder/{workorder_id}
Edit an existing administrative workorder's name/duration
POST
/api/dispatch/v1/projects/{project_id}/dispatch/workorders/{workorder_id}/turbine
Set the turbine for a scope-dispatched workorder
POST
/api/dispatch/v1/projects/{project_id}/dispatch/admin-workorder
Create an ADMIN workorder assigned to a single technician
POST
/api/dispatch/v1/projects/{project_id}/dispatch/workorders/{workorder_id}/activities
Add an activity to an existing administrative workorder
PATCH
/api/dispatch/v1/projects/{project_id}/dispatch/workorders/{workorder_id}/activities/{activity_id}
Edit an activity on an existing administrative workorder
DELETE
/api/dispatch/v1/projects/{project_id}/dispatch/workorders/{workorder_id}/activities/{activity_id}
Remove an activity from an existing administrative workorder
POST
/api/projects/{project_id}/dispatch/assign
Assign workorder to resources
POST
/api/projects/{project_id}/dispatch/assign-bulk
Bulk assign workorders to resources
POST
/api/projects/{project_id}/dispatch/unassign
Unassign workorder from resources
DELETE
/api/projects/{project_id}/dispatch/workorders/{workorder_id}
Soft-delete an administrative workorder
PATCH
/api/projects/{project_id}/dispatch/admin-workorder/{workorder_id}
Edit an existing administrative workorder's name/duration
POST
/api/projects/{project_id}/dispatch/workorders/{workorder_id}/turbine
Set the turbine for a scope-dispatched workorder
POST
/api/projects/{project_id}/dispatch/admin-workorder
Create an ADMIN workorder assigned to a single technician
POST
/api/projects/{project_id}/dispatch/workorders/{workorder_id}/activities
Add an activity to an existing administrative workorder
PATCH
/api/projects/{project_id}/dispatch/workorders/{workorder_id}/activities/{activity_id}
Edit an activity on an existing administrative workorder
DELETE
/api/projects/{project_id}/dispatch/workorders/{workorder_id}/activities/{activity_id}
Remove an activity from an existing administrative workorder
dispatch.scope-commitments 12
GET
/api/dispatch/v1/projects/{project_id}/dispatch/scope-groups
List service/component-type buckets of scope items available for team dispatch
POST
/api/dispatch/v1/projects/{project_id}/dispatch/scope-workorder
Reserve pending scope-dispatch commitments for a team against a scope bucket
GET
/api/dispatch/v1/projects/{project_id}/dispatch/scope-commitments/{commitment_id}/turbines
List turbines a pending scope-dispatch commitment can resolve to
POST
/api/dispatch/v1/projects/{project_id}/dispatch/scope-commitments/{commitment_id}/turbine
Resolve a pending scope-dispatch commitment by picking a turbine
PATCH
/api/dispatch/v1/projects/{project_id}/dispatch/scope-commitments/{commitment_id}
Reschedule a still-pending scope-dispatch commitment
DELETE
/api/dispatch/v1/projects/{project_id}/dispatch/scope-commitments/{commitment_id}
Cancel a still-pending scope-dispatch commitment
GET
/api/projects/{project_id}/dispatch/scope-groups
List service/component-type buckets of scope items available for team dispatch
POST
/api/projects/{project_id}/dispatch/scope-workorder
Reserve pending scope-dispatch commitments for a team against a scope bucket
GET
/api/projects/{project_id}/dispatch/scope-commitments/{commitment_id}/turbines
List turbines a pending scope-dispatch commitment can resolve to
POST
/api/projects/{project_id}/dispatch/scope-commitments/{commitment_id}/turbine
Resolve a pending scope-dispatch commitment by picking a turbine
PATCH
/api/projects/{project_id}/dispatch/scope-commitments/{commitment_id}
Reschedule a still-pending scope-dispatch commitment
DELETE
/api/projects/{project_id}/dispatch/scope-commitments/{commitment_id}
Cancel a still-pending scope-dispatch commitment
dispatch.board-annotations 14
POST
/api/dispatch/v1/projects/{project_id}/dispatch/day-commentary
Add a dispatcher's day-commentary note to a project
GET
/api/dispatch/v1/projects/{project_id}/dispatch/day-commentary
List a project's day-commentary notes for one day
GET
/api/dispatch/v1/projects/{project_id}/dispatch/service-kpis
List KPI (benchmark duration) settings for every service used on a project
PUT
/api/dispatch/v1/projects/{project_id}/dispatch/service-kpis/{service_id}
Set a project's KPI override for one service
DELETE
/api/dispatch/v1/projects/{project_id}/dispatch/service-kpis/{service_id}
Clear a project's KPI override for one service, reverting to the global default
POST
/api/dispatch/v1/projects/{project_id}/dispatch/team-messages
Send a dispatcher message to a team
GET
/api/dispatch/v1/projects/{project_id}/dispatch/team-messages
List dispatcher messages to teams for a project
POST
/api/projects/{project_id}/dispatch/day-commentary
Add a dispatcher's day-commentary note to a project
GET
/api/projects/{project_id}/dispatch/day-commentary
List a project's day-commentary notes for one day
GET
/api/projects/{project_id}/dispatch/service-kpis
List KPI (benchmark duration) settings for every service used on a project
PUT
/api/projects/{project_id}/dispatch/service-kpis/{service_id}
Set a project's KPI override for one service
DELETE
/api/projects/{project_id}/dispatch/service-kpis/{service_id}
Clear a project's KPI override for one service, reverting to the global default
POST
/api/projects/{project_id}/dispatch/team-messages
Send a dispatcher message to a team
GET
/api/projects/{project_id}/dispatch/team-messages
List dispatcher messages to teams for a project
platform 2
GET
/api/platform/clientsdeprecated
Get Clients
GET
/api/platform/daily-reports/{project_id}deprecated
Get Daily Reports
projects.core 12
GET
/api/projects
Get Projects
POST
/api/projects
Create Project
GET
/api/projects/{project_id}
Get Project
GET
/api/projects/{project_id}/service-codes
Get Project Service Codes
GET
/api/projects/{project_id}/password
Get Project Password
POST
/api/projects/{project_id}/password
Create Project Password
DELETE
/api/projects/{project_id}/password
Delete Project Password
POST
/api/projects/{project_id}/send-email
Send Project Email
PUT
/api/projects/{project_id}/user-status
Update Project User Status
DELETE
/api/projects/{project_id}/user-status
Delete Project User Status
GET
/api/projects/{project_id}/customers
Get Customer For Project
GET
/api/projects/{project_id}/related
Get Related Projects
projects.rfi 12
PUT
/api/projects/{project_id}/rfi/general
Create Project General
GET
/api/projects/{project_id}/rfi/general
Get Project General
PUT
/api/projects/{project_id}/rfi/billing
Create Project Billing
GET
/api/projects/{project_id}/rfi/billing
Get Project Billing
GET
/api/projects/{project_id}/rfi/billing-prefilled
Get Project Billing Prefilled
PUT
/api/projects/{project_id}/rfi/sitesdeprecated
Create Project Site
GET
/api/projects/{project_id}/rfi/sitesdeprecated
Get Project Site
PUT
/api/projects/{project_id}/rfi/site-safety
Create Project Site Access
GET
/api/projects/{project_id}/rfi/site-safety
Get Project Site Access
PUT
/api/projects/{project_id}/rfi/assets-servicesdeprecated
Create Project Assets
GET
/api/projects/{project_id}/rfi/assets-servicesdeprecated
Get Project Assets
GET
/api/projects/{project_id}/rfi/assets-services/table-prefilleddeprecated
Get Project Assets Prefilled
projects.pre-job.assets-services.table 7
GET
/api/projects/{project_id}/pre-job/assets-services/tabledeprecated
Get Project Assets Table
POST
/api/projects/{project_id}/pre-job/assets-services/tabledeprecated
Export Project Assets Table To Excel
PUT
/api/projects/{project_id}/pre-job/assets-services/tabledeprecated
Put Project Asset
POST
/api/projects/{project_id}/pre-job/assets-services/table-uploaddeprecated
Upload Project Assets Table
PATCH
/api/projects/{project_id}/pre-job/assets-services/table/{db_id}deprecated
Patch Project Asset
DELETE
/api/projects/{project_id}/pre-job/assets-services/table/{db_id}deprecated
Delete Project Asset
POST
/api/projects/{project_id}/pre-job/assets-services/table-autofilldeprecated
Autofill Blade Names
projects.pre-job.assets-services 2
POST
/api/projects/{project_id}/pre-job/assets-services/customer-filesdeprecated
Associate Customer Asset Files
GET
/api/projects/{project_id}/pre-job/assets-services/customer-filesdeprecated
Get Customer Asset Files
projects.pre-job 1
GET
/api/projects/{project_id}/pre-job/pdf
Get Project Pre Job Pdf
projects.offer 8
GET
/api/projects/{project_id}/offer
Get Project Offer
PATCH
/api/projects/{project_id}/offer
Update Offer
POST
/api/projects/{project_id}/offer/download-v2
Download Offer V2
POST
/api/projects/{project_id}/offer/download-v2-docx
Download Offer V2 Docx
POST
/api/projects/{project_id}/offer/line-items
Create Line Item
PATCH
/api/projects/{project_id}/offer/line-items
Update Line Items
PATCH
/api/projects/{project_id}/offer/line-items/{line_item_id}
Update Line Item
DELETE
/api/projects/{project_id}/offer/line-items/{line_item_id}
Delete Line Item
projects.offer.changelog 6
GET
/api/projects/{project_id}/offer/view/{version}
Get Offer Version
GET
/api/projects/{project_id}/offer/compare
Compare Offer Versions
POST
/api/projects/{project_id}/offer/send-for-approval
Send For Approval
POST
/api/projects/{project_id}/offer/approve
Approve Offer
POST
/api/projects/{project_id}/offer/reject
Reject Offer
POST
/api/projects/{project_id}/offer/draft
Create Draft Offer
projects.bto 1
GET
/api/projects/{project_id}/bto
Get Project Bto Overview
projects.rams 24
GET
/api/projects/{project_id}/rams/documents
List Rams Documents
POST
/api/projects/{project_id}/rams/documents
Create Rams Document
GET
/api/projects/{project_id}/rams/set-options
Get Rams Set Options
GET
/api/projects/{project_id}/rams/documents/{doc_id}
Get Rams Document
PATCH
/api/projects/{project_id}/rams/documents/{doc_id}
Update Rams Document
DELETE
/api/projects/{project_id}/rams/documents/{doc_id}
Delete Rams Document
GET
/api/projects/{project_id}/rams/documents/{doc_id}/technician-acknowledgements
List Rams Technician Acknowledgements
GET
/api/projects/{project_id}/rams/documents/{doc_id}/technician-roster
Get Rams Technician Roster
POST
/api/projects/{project_id}/rams/documents/{doc_id}/send-to-new-technicians
Send Rams To New Technicians
POST
/api/projects/{project_id}/rams/documents/{doc_id}/duplicate
Duplicate Rams Document
GET
/api/projects/rams-attachments/shared/{token}
Download Shared Rams Attachment
GET
/api/projects/{project_id}/rams/documents/{doc_id}/attachments
List Rams Attachments
POST
/api/projects/{project_id}/rams/documents/{doc_id}/attachments
Upload Rams Attachment
DELETE
/api/projects/{project_id}/rams/documents/{doc_id}/attachments/{attachment_id}
Delete Rams Attachment
GET
/api/projects/{project_id}/rams/documents/{doc_id}/attachments/{attachment_id}/download
Download Rams Attachment
POST
/api/projects/{project_id}/rams/submit-to-customer
Submit Rams To Customer
POST
/api/projects/{project_id}/rams/convert-to-pdf
Convert Rams Docx To Pdf
GET
/api/projects/{project_id}/rams/{approval_id}/status
Get Rams Approval Status
GET
/api/projects/{project_id}/rams/{approval_id}
Get Rams For Client
POST
/api/projects/{project_id}/rams/{approval_id}/respond
Client Respond To Rams
GET
/api/projects/{project_id}/rams/{approval_id}/pdf
Download Rams Pdf
POST
/api/projects/{project_id}/rams/documents/{doc_id}/technician-acknowledgements/sign
Sign Rams Technician Acknowledgement
POST
/api/projects/{project_id}/rams/documents/{doc_id}/technician-acknowledgements/{ack_id}/mark-signed
Mark Rams Technician Acknowledgement Signed
POST
/api/projects/{project_id}/rams/documents/{doc_id}/technician-acknowledgements/{ack_id}/dismiss
Dismiss Rams Technician Acknowledgement
projects.rams-templates 9
GET
/api/rams-templates
List Rams Templates
POST
/api/rams-templates
Create Rams Template
POST
/api/rams-templates/convert-to-pdf
Convert Template Docx To Pdf
GET
/api/rams-templates/resolved
Resolve Rams Template Content
GET
/api/rams-templates/{template_id}
Get Rams Template
PATCH
/api/rams-templates/{template_id}
Update Rams Template
DELETE
/api/rams-templates/{template_id}
Delete Rams Template
POST
/api/rams-templates/{template_id}/images
Upload Rams Template Image
DELETE
/api/rams-templates/{template_id}/images/{image_id}
Delete Rams Template Image
projects.weather 4
GET
/api/projects/{project_id}/weather
Get Weather
POST
/api/projects/{project_id}/weather/refresh
Refresh Weather
PUT
/api/projects/{project_id}/weather/{date_str}
Update Weather Value
POST
/api/projects/{project_id}/weather/{date_str}/reset
Reset Weather Value
projects.robot-sets-and-teams 5
GET
/api/projects/{project_id}/available-services
Get Available Services
GET
/api/projects/{project_id}/available-robot-sets
Get Available Robot Sets
GET
/api/projects/{project_id}/available-resources
Get Available Resources
GET
/api/projects/{project_id}/robot-sets-and-teams
Get Robot Sets And Teams
PUT
/api/projects/{project_id}/robot-sets-and-teams
Update Robot Sets And Teams
projects.overview 2
GET
/api/projects/{project_id}/overview/percentages
Get Project Overview Percentages
GET
/api/projects/{project_id}/overview/technicians
Get Project Overview Technicians
projects.platform 1
POST
/api/projects/{project_id}/platform
Send Project To Platform
projects.service-orders 22
POST
/api/projects/{project_id}/service-orders/generate
⚠️ Generate service orders
POST
/api/projects/{project_id}/service-order-lines/{line_id}/workorders/generate
⚠️ Generate line workorders
GET
/api/projects/{project_id}/service-orders/generation-data
⚠️ Get service order generation data
GET
/api/projects/{project_id}/service-orders
⚠️ List service orders
DELETE
/api/projects/{project_id}/service-orders
⚠️ Delete all service orders
GET
/api/projects/{project_id}/service-orders/summary
⚠️ Get service order summary
GET
/api/projects/{project_id}/service-orders/lines/{line_id}
⚠️ Get service order line detail
PUT
/api/projects/{project_id}/service-orders/lines/{line_id}/customer-custom-field-values
⚠️ Replace the customer custom field values on a service order line
POST
/api/projects/{project_id}/service-orders/lines/{line_id}/warranty-work
⚠️ Create warranty-work SOL from this line
GET
/api/projects/{project_id}/service-orders/lines/{line_id}/workorders
⚠️ Get service order line workorders
GET
/api/projects/{project_id}/service-orders/lines/{line_id}/workorders/{workorder_id}
⚠️ Get workorder detail
GET
/api/projects/{project_id}/service-orders/lines/{line_id}/workorders/{workorder_id}/activities
⚠️ Get workorder activities
GET
/api/projects/{project_id}/service-orders/lines/{line_id}/workorders/{workorder_id}/available-activities
⚠️ Get available activities
GET
/api/projects/{project_id}/service-orders/lines/{line_id}/unplanned-service-items
⚠️ Get unplanned service items
DELETE
/api/projects/{project_id}/service-orders/workorders/{workorder_id}
⚠️ Delete unplanned workorder
GET
/api/projects/{project_id}/service-orders/workorders/{workorder_id}/status-changes
List workorder status change log
POST
/api/projects/{project_id}/service-orders/workorders/{workorder_id}/status-changes
Create status change log entry
DELETE
/api/projects/{project_id}/service-orders/workorders/{workorder_id}/status-changes/{entry_id}
Delete status change log entry
GET
/api/projects/{project_id}/service-orders/lines/{line_id}/status-changes
List SOL status change logs
GET
/api/projects/{project_id}/service-orders/lines/{line_id}/line-status-changes
List a service order line's own status change log
POST
/api/projects/{project_id}/service-orders/lines/{line_id}/status-changes/bulk-create
Bulk-create status change log entries
POST
/api/projects/{project_id}/service-orders/lines/{line_id}/status-changes/bulk-delete
Bulk-delete status change log entries
projects.workorders 2
GET
/api/projects/{project_id}/workorders
⚠️ List project workorders
GET
/api/projects/{project_id}/workorders/{workorder_id}
⚠️ Get admin workorder detail
projects.team-requests 23
POST
/api/projects/{project_id}/team-requests
Create Team Request
GET
/api/projects/{project_id}/team-requests
List Team Requests
GET
/api/projects/{project_id}/team-requests/site-options
Get Site Options
GET
/api/projects/{project_id}/team-requests/set-options
Get Set Options
GET
/api/projects/{project_id}/team-requests/offer-pairs
Get Team Request Offer Pairs
GET
/api/projects/{project_id}/team-requests/{team_request_id}
Get Team Request
PATCH
/api/projects/{project_id}/team-requests/{team_request_id}
Update Team Request
GET
/api/projects/{project_id}/team-requests/{team_request_id}/cert-drift
Get Cert Drift
POST
/api/projects/{project_id}/team-requests/{team_request_id}/apply-cert-drift
Apply Cert Drift
POST
/api/projects/{project_id}/team-requests/{team_request_id}/resolve-cert-token
Resolve Team Request Cert Token
POST
/api/projects/{project_id}/team-requests/{team_request_id}/submit
Submit Team Request
POST
/api/projects/{project_id}/team-requests/{team_request_id}/send-to-planner
Send Team Request To Planner
POST
/api/projects/{project_id}/team-requests/{team_request_id}/cancel
Cancel Team Request
POST
/api/projects/{project_id}/team-requests/{team_request_id}/duplicate
Duplicate Team Request
POST
/api/projects/{project_id}/team-requests/{team_request_id}/notes
Create Team Request Note
GET
/api/projects/{project_id}/team-requests/{team_request_id}/events
List Team Request Events
GET
/api/projects/{project_id}/team-requests/{team_request_id}/mention-candidates
List Team Request Mention Candidates
PATCH
/api/projects/{project_id}/team-requests/{team_request_id}/slots/{slot_id}
Update Team Request Slot
POST
/api/projects/{project_id}/team-requests/{team_request_id}/slots/{slot_id}/approve
Approve Team Request Slot
POST
/api/projects/{project_id}/team-requests/{team_request_id}/slots/{slot_id}/verify
Verify Team Request Slot
POST
/api/projects/{project_id}/team-requests/{team_request_id}/slots/{slot_id}/reject
Reject Team Request Slot
POST
/api/projects/{project_id}/team-requests/{team_request_id}/slots/{slot_id}/unreject
Unreject Team Request Slot
POST
/api/projects/{project_id}/team-requests/{team_request_id}/slots/{slot_id}/unverify
Unverify Team Request Slot
projects.reporting-requirements 7
GET
/api/projects/{project_id}/reporting-requirements
List Reporting Requirements
POST
/api/projects/{project_id}/reporting-requirements
Create Reporting Requirement
GET
/api/projects/{project_id}/reporting-requirements/options
Get Reporting Requirement Options
GET
/api/projects/{project_id}/reporting-requirements/{requirement_id}
Get Reporting Requirement
PATCH
/api/projects/{project_id}/reporting-requirements/{requirement_id}
Update Reporting Requirement
DELETE
/api/projects/{project_id}/reporting-requirements/{requirement_id}
Delete Reporting Requirement
POST
/api/projects/{project_id}/reporting-requirements/{requirement_id}/send
Send Reporting Requirement
reporting-requirements.cru 12
GET
/api/reporting-requirements/familiarity/check
Familiarity Check
POST
/api/reporting-requirements/familiarity
Mark Familiar
GET
/api/reporting-requirements
List Requirements
POST
/api/reporting-requirements
Create Requirement
GET
/api/reporting-requirements/{requirement_id}
Get Requirement
PATCH
/api/reporting-requirements/{requirement_id}
Update Requirement
DELETE
/api/reporting-requirements/{requirement_id}
Delete Requirement
PATCH
/api/reporting-requirements/{requirement_id}/accept
Accept Requirement
PATCH
/api/reporting-requirements/{requirement_id}/decline
Decline Requirement
PATCH
/api/reporting-requirements/{requirement_id}/deactivate
Deactivate Requirement
PATCH
/api/reporting-requirements/{requirement_id}/restore
Restore Requirement
GET
/api/reporting-requirements/{requirement_id}/history
Requirement History
projects.set-requests 25
GET
/api/projects/{project_id}/set-requests/set-options
Get Set Options
GET
/api/projects/{project_id}/set-requests/item-categories
List Set Request Item Categories
GET
/api/projects/{project_id}/set-requests/items
List Set Request Items
POST
/api/projects/{project_id}/set-requests/items
Create Set Request Item
PATCH
/api/projects/{project_id}/set-requests/items/{item_id}
Update Set Request Item
DELETE
/api/projects/{project_id}/set-requests/items/{item_id}
Delete Set Request Item
GET
/api/projects/{project_id}/set-requests/offer-pairs
Get Offer Pairs
GET
/api/projects/{project_id}/set-requests/inherit-candidates
Get Inherit Candidates
GET
/api/projects/{project_id}/set-requests/prefill-options
Get Prefill Options
POST
/api/projects/{project_id}/set-requests
Create Set Request
GET
/api/projects/{project_id}/set-requests
List Set Requests
GET
/api/projects/{project_id}/set-requests/{set_request_id}
Get Set Request
PATCH
/api/projects/{project_id}/set-requests/{set_request_id}
Update Set Request
GET
/api/projects/{project_id}/set-requests/{set_request_id}/events
List Set Request Events
POST
/api/projects/{project_id}/set-requests/{set_request_id}/notes
Create Set Request Note
GET
/api/projects/{project_id}/set-requests/{set_request_id}/mention-candidates
List Set Request Mention Candidates
POST
/api/projects/{project_id}/set-requests/{set_request_id}/submit
Submit Set Request
POST
/api/projects/{project_id}/set-requests/{set_request_id}/approve-current
Approve Current Set
POST
/api/projects/{project_id}/set-requests/{set_request_id}/change-set-and-approve
Change Set And Approve
POST
/api/projects/{project_id}/set-requests/{set_request_id}/reject
Reject Set Request
POST
/api/projects/{project_id}/set-requests/{set_request_id}/cancel
Cancel Set Request
POST
/api/projects/{project_id}/set-requests/{set_request_id}/mark-ready
Mark Set Request Ready
POST
/api/projects/{project_id}/set-requests/{set_request_id}/confirm-it
Confirm Set Request It
POST
/api/projects/{project_id}/set-requests/{set_request_id}/confirm-ppe
Confirm Set Request Ppe
POST
/api/projects/{project_id}/set-requests/{set_request_id}/mark-picked-up
Mark Set Request Picked Up
projects.set-demobs 9
GET
/api/projects/{project_id}/set-demobs
List Set Demobs
POST
/api/projects/{project_id}/set-demobs
Create Set Demob
GET
/api/projects/{project_id}/set-demobs/anchor-candidates
List Set Demob Anchor Candidates
GET
/api/projects/{project_id}/set-demobs/{demob_id}
Get Set Demob
GET
/api/projects/{project_id}/set-demobs/{demob_id}/events
List Set Demob Events
POST
/api/projects/{project_id}/set-demobs/{demob_id}/approve
Approve Set Demob
POST
/api/projects/{project_id}/set-demobs/{demob_id}/adjust-date
Adjust Set Demob Date
POST
/api/projects/{project_id}/set-demobs/{demob_id}/reject
Reject Set Demob
POST
/api/projects/{project_id}/set-demobs/{demob_id}/cancel
Cancel Set Demob
readiness 1
GET
/api/readiness/requests
Get Requests Readiness
projects.upcoming-rotations 1
GET
/api/projects/{code}/upcoming-rotations
List Upcoming Rotations
projects.accounting 48
GET
/api/projects/{project_id}/sales-orders
Get Sales Orders
POST
/api/projects/{project_id}/sales-orders
Create Sales Order
POST
/api/projects/{project_id}/sales-orders/legacy
Create Sales Order Old
POST
/api/projects/{project_id}/sales-orders/create-background
Create Sales Order In Background
GET
/api/projects/{project_id}/sales-orders/status
Get Sales Order Status
DELETE
/api/projects/{project_id}/sales-orders/{sales_order_id}
Delete Sales Order
GET
/api/projects/{project_id}/sales-orders/{sales_order_id}/line-items
Get Sales Order Line Items
GET
/api/projects/{project_id}/sales-orders/{sales_order_id}/line-items/summary
Get Sales Order Line Items Summary
GET
/api/projects/{project_id}/sales-orders/{sales_order_id}/line-items/tree
Get Sales Order Line Items Tree
GET
/api/projects/{project_id}/sales-orders/{sales_order_id}/charges
Get Charges
PATCH
/api/projects/{project_id}/sales-orders/{sales_order_id}/charges
Update Charges Bulk
DELETE
/api/projects/{project_id}/sales-orders/{sales_order_id}/charges
Delete Charges Bulk
GET
/api/projects/{project_id}/email-sends
Get Email Sends
GET
/api/projects/{project_id}/sales-orders/{sales_order_id}/charges/summary
Get Charges Summary
POST
/api/projects/{project_id}/sales-orders/{sales_order_id}/line-items/{line_item_id}/charges
Create Charge
PATCH
/api/projects/{project_id}/sales-orders/{sales_order_id}/line-items/{line_item_id}/charges/{charge_id}
Update Charge
DELETE
/api/projects/{project_id}/sales-orders/{sales_order_id}/line-items/{line_item_id}/charges/{charge_id}
Delete Charge
POST
/api/projects/{project_id}/sales-orders/{sales_order_id}/charges/bulk-approve
Bulk Approve Charges
GET
/api/projects/{project_id}/sales-orders/{sales_order_id}/invoices
Get Invoices
POST
/api/projects/{project_id}/sales-orders/{sales_order_id}/invoices
Create Invoice
POST
/api/projects/{project_id}/sales-orders/{sales_order_id}/invoices/create-background
Create Invoice In Background
GET
/api/projects/{project_id}/sales-orders/{sales_order_id}/diff-asset-names
Get Sales Order Diff Asset Names
POST
/api/projects/{project_id}/sales-orders/{sales_order_id}/diff-asset-names
Create Sales Order Diff Asset Names Patch
PATCH
/api/projects/{project_id}/sales-orders/{sales_order_id}/diff-asset-names
Apply Sales Order Diff Asset Names Patch
GET
/api/projects/{project_id}/sales-orders/{sales_order_id}/idle-hour-time-windows
Get Idle Hour Time Windows
POST
/api/projects/{project_id}/sales-orders/{sales_order_id}/sync-offer
Sync Offer Line Items
POST
/api/projects/{project_id}/sales-orders/{sales_order_id}/sync-background
Sync Sales Order In Background
POST
/api/projects/{project_id}/sales-orders/{sales_order_id}/sync-core
Sync Core Sales Order
POST
/api/projects/{project_id}/sales-orders/{sales_order_id}/sync-core-background
Sync Core Sales Order In Background
POST
/api/projects/{project_id}/sales-orders/{sales_order_id}/sync-delay-charges
Sync Delay Charges
POST
/api/projects/{project_id}/re-evaluate-require-po
Re Evaluate Require Po
GET
/api/projects/{project_id}/accounting/comments
List Accounting Comments
POST
/api/projects/{project_id}/accounting/comments
Create Accounting Comment
PATCH
/api/projects/{project_id}/accounting/comments/{comment_id}
Update Accounting Comment
DELETE
/api/projects/{project_id}/accounting/comments/{comment_id}
Delete Accounting Comment
GET
/api/projects/{project_id}/accounting/suggestion-decisions
List Suggestion Decisions
PUT
/api/projects/{project_id}/accounting/suggestion-decisions
Upsert Suggestion Decision
DELETE
/api/projects/{project_id}/accounting/suggestion-decisions
Delete Suggestion Decision
GET
/api/projects/{project_id}/accounting/team-workload
Get Team Workload
GET
/api/projects/{project_id}/accounting/delays
Get Delays
GET
/api/projects/{project_id}/accounting/daily-reports
Get Accounting Daily Reports
GET
/api/projects/{project_id}/charged-revenue
Get Charged Revenue
GET
/api/projects/netsuite/countries
Get Netsuite Service Countries
GET
/api/projects/{project_id}/sales-orders/{sales_order_id}/turbines-progress
Get Turbines Progress
GET
/api/projects/netsuite/subsidiaries
Get Netsuite Subsidiaries
GET
/api/projects/{project_id}/sales-orders/{sales_order_id}/service-rates-context
Get Service Rates Context
GET
/api/projects/{project_id}/sales-orders/{sales_order_id}/charge-creation-context
Get Charge Creation Context
POST
/api/projects/{project_id}/sales-orders/{sales_order_id}/scope-charges
Create Scope Charge
commercial-offers 2
GET
/api/commercial-offers
List Commercial Offers
POST
/api/commercial-offers/approve
Approve Commercial Offers
accounting 11
GET
/api/accounting/overview
Get Accounting Overview
GET
/api/accounting/overview/summary
Get Accounting Overview Summary
GET
/api/accounting/overview/filters
Get Accounting Overview Filters
GET
/api/accounting/overview/export
Export Accounting Overview To Excel
GET
/api/accounting/missing-charges-tracker
Get Missing Charges Tracker
POST
/api/accounting/missing-charges-tracker/sync
Sync Missing Charges Tracker
GET
/api/accounting/missing-charges-tracker/status
Get Missing Charges Cache Status
POST
/api/accounting/charges/bulk-mark-pm-review
Bulk Mark Charges Pm Review
POST
/api/accounting/charges/bulk-mark-customer-review
Bulk Mark Charges Customer Review
POST
/api/accounting/netsuite-local-sync
Trigger Netsuite Local Sync
GET
/api/accounting/missing-charges-tracker/export
Export Missing Charges Tracker
accounting.netsuite-departments 1
GET
/api/accounting/v1/netsuite-departments
List NetSuite Departments
accounting.sales-orders 5
GET
/api/accounting/v2/sales-orders
List Sales Orders
POST
/api/accounting/v2/sales-orders
Create Sales Order
GET
/api/accounting/v2/sales-orders/{id}
Get Sales Order
PATCH
/api/accounting/v2/sales-orders/{id}
Update Sales Order
DELETE
/api/accounting/v2/sales-orders/{id}
Delete Sales Order
accounting.sales-order-lines 5
GET
/api/accounting/v2/sales-order-lines
List Sales Order Lines
POST
/api/accounting/v2/sales-order-lines
Create Sales Order Line
GET
/api/accounting/v2/sales-order-lines/{id}
Get Sales Order Line
PATCH
/api/accounting/v2/sales-order-lines/{id}
Update Sales Order Line
DELETE
/api/accounting/v2/sales-order-lines/{id}
Delete Sales Order Line
accounting.sales-invoices 5
GET
/api/accounting/v2/sales-invoices
List Sales Invoices
POST
/api/accounting/v2/sales-invoices
Create Sales Invoice
GET
/api/accounting/v2/sales-invoices/{id}
Get Sales Invoice
PATCH
/api/accounting/v2/sales-invoices/{id}
Update Sales Invoice
DELETE
/api/accounting/v2/sales-invoices/{id}
Delete Sales Invoice
accounting.service-charges 5
GET
/api/accounting/v2/service-charges
List Service Charges
POST
/api/accounting/v2/service-charges
Create Service Charge
GET
/api/accounting/v2/service-charges/{id}
Get Service Charge
PATCH
/api/accounting/v2/service-charges/{id}
Update Service Charge
DELETE
/api/accounting/v2/service-charges/{id}
Delete Service Charge
accounting.billing-statements 5
GET
/api/accounting/v2/billing-statements
List Billing Statements
POST
/api/accounting/v2/billing-statements
Create Billing Statement
GET
/api/accounting/v2/billing-statements/{id}
Get Billing Statement
PATCH
/api/accounting/v2/billing-statements/{id}
Update Billing Statement
DELETE
/api/accounting/v2/billing-statements/{id}
Delete Billing Statement
accounting.notes 5
GET
/api/accounting/v2/notes
List Notes
POST
/api/accounting/v2/notes
Create Note
GET
/api/accounting/v2/notes/{id}
Get Note
PATCH
/api/accounting/v2/notes/{id}
Update Note
DELETE
/api/accounting/v2/notes/{id}
Delete Note
files 6
POST
/api/files
Upload File
GET
/api/files
List Files
GET
/api/files/{storage_id}/download
Download File
GET
/api/files/{storage_id}/inline
Get Inline File
GET
/api/files/{storage_id}
Get File Details
DELETE
/api/files/{storage_id}
Delete File
webhooks.wms 1
POST
/api/webhooks/wms/coverage-published
Handle Wms Coverage Published
webhooks.travel 1
POST
/api/webhooks/travel/task-updated
Handle Travel Task Updated
webhooks 5
POST
/api/webhooks/pipedrive-sync
Pipedrive Sync Webhook
POST
/api/webhooks/wrike/dates-changed
Handle Wrike Dates Changed Webhook
POST
/api/webhooks/wrike/task-created
Handle Wrike Task Created Webhook
POST
/api/webhooks/wrike/custom-field
Handle Wrike Custom Field Changed
POST
/api/webhooks/wrike/sync-task
Handle Wrike Sync Task Webhook
wms 7
GET
/api/wms/team-requests
List Team Requests
GET
/api/wms/team-requests/{external_id}
Get Team Request
POST
/api/wms/team-requests/{external_id}/approve
Approve Team Request
POST
/api/wms/team-requests/{external_id}/slots/{slot_id}/approve
Approve Team Request Slot
GET
/api/wms/team-requests/{external_id}/notes
List Team Request Notes
POST
/api/wms/team-requests/{external_id}/notes
Create Team Request Note
GET
/api/wms/vehicle-assignments
List Vehicle Assignments
netsuite 6
DELETE
/api/netsuite/projects/{netsuite_project_id}
Delete Project
DELETE
/api/netsuite/assets/{asset_id}
Delete Asset
DELETE
/api/netsuite/customers/{customer_id}
Delete Customer
GET
/api/netsuite/sales-orders/by-project-code
Get All Sales Order By Project Code
GET
/api/netsuite/subsidiaries
Get Subsidiaries
POST
/api/netsuite/refresh-master-data
Refresh Master Data
utilities 1
GET
/api/scheduler
Get Scheduler Jobs
email 4
POST
/api/email
Send Email
POST
/api/email-preview
Send Email Preview
GET
/api/email/{tracking_id}/status
Get Sent Email Status
GET
/api/email/{tracking_id}/pixel.gif
Track Sent Email Opened
deviations 8
GET
/api/deviations/filters
Get Global Deviations Filters
GET
/api/deviations/summary
Get Global Deviations Summary
GET
/api/deviations/{project_id}/filters
Get Project Deviations Filters
GET
/api/deviations/{project_id}/summary
Get Project Deviations Summary
GET
/api/deviations/{project_id}
Get Project Deviations
PATCH
/api/deviations/{project_id}
Update Project Deviations
GET
/api/deviations
Get Global Deviations
PATCH
/api/deviations
Update Global Deviations
confluence 1
GET
/api/common/unified-services
Get unified services as HTML table
misc 11
GET
/api/services/line-items
Get Service Line Items
GET
/api/services/line-items/{code}
Get Service Line Item
GET
/api/countriesdeprecated
Get Supported Countries
GET
/api/customersdeprecated
Get Customers
POST
/api/customersdeprecated
Create Customer
GET
/api/customers/subsidiaries/deprecated
Get Subsidiaries
GET
/api/integrations/vestas-cir/v1/{service_order_line_id}/validate
Validate SOL data before CIR submission.
GET
/api/integrations/vestas-cir/v1/{service_order_line_id}/status
Get latest CIR submission status for a SOL.
POST
/api/integrations/vestas-cir/v1/{service_order_line_id}
Submit service order line to Vestas CIR.
GET
/api/integrations/vestas-cir/v1/{service_order_line_id}/data
Fetch all files associated with a given service order line ID.
GET
/api/integrations/nordex-cir/v1/reports/{incident_number}/data
Fetch the raw inspection data behind one Nordex report.
turbines 7
GET
/api/turbines/turbine-manufacturers
Get Turbine Manufacturers
GET
/api/turbines/turbine-models
Get All Turbine Models
GET
/api/turbines/turbine-models/{manufacturer_id}
Get Turbine Models
POST
/api/turbines/refresh-cache
Refresh Turbine Data
GET
/api/turbines/blade-manufacturers
Get Blade Manufacturers
GET
/api/turbines/blade-models
Get All Blade Models
GET
/api/turbines/blade-models/{manufacturer_id}
Get Blade Models
users 2
GET
/api/usersdeprecated
Get Users
PATCH
/api/users/{user_id}
Update User Role
data-tracking 5
GET
/api/data-tracking/status-counts
Per-stage data tracking status counts for a batch of lines
POST
/api/data-tracking/service-order-lines/{service_order_line_id}
Create or extend the system workorder for service order line files
PATCH
/api/data-tracking/service-order-lines/{service_order_line_id}
Update data tracking statuses for service order line files
GET
/api/data-tracking/service-order-lines/{service_order_line_id}
List data tracking records for a service order line
GET
/api/data-tracking/files
List data tracking records across several service order lines
services 3
GET
/api/servicesdeprecated
Get Services
GET
/api/services/pre-job/questions/{service_code}deprecated
Get Pre Job Questions
GET
/api/services/{service_code}deprecated
Get Service
bamboohr.employees 1
GET
/api/bamboohr/v1/employees
List BambooHR Employees
maintainx.assets 1
GET
/api/maintainx/v1/assets
List MaintainX Assets
talentlms.users 1
GET
/api/talentlms/v1/users
List TalentLMS Users
payroll 6
POST
/api/v1/payroll/activities
Create Activity
GET
/api/v1/payroll/activities
List Activities
GET
/api/v1/payroll/activities/{id}
Get Activity
PATCH
/api/v1/payroll/activities/{id}
Update Activity
DELETE
/api/v1/payroll/activities/{id}
Delete Activity
GET
/api/v1/payroll/timesheets
List timesheets
active-workload 5
GET
/api/active-workload/service-order-lines
List Service Order Lines
GET
/api/active-workload/service-order-lines/{sol_id}
Get Service Order Line Detail
GET
/api/active-workload/work-orders
List Work Orders
GET
/api/active-workload/work-orders/{wo_id}
Get Work Order Detail
GET
/api/active-workload/filters
Get Filters
vis.inspections 5
GET
/api/vis/v1/inspections/{sol_id}/
Fetch inspection data for a given service order line ID.
GET
/api/vis/v1/inspections/{sol_id}/components/
Fetch components for a given inspection service order line ID.
POST
/api/vis/v1/inspections/{sol_id}/components/links/
Create component links for a given inspection service order line ID.
DELETE
/api/vis/v1/inspections/{sol_id}/components/links/
Delete component links for a given inspection service order line ID.
POST
/api/vis/v1/inspections/{sol_id}/authorize-media
Authorize Inspection Media
vis.pointclouds 1
GET
/api/vis/v1/pointclouds/{id}/{data_file}/
Fetch data file associated with a given pointcloud ID.
vis.rosbags 2
GET
/api/vis/v1/rosbags/{id}/distances/
Fetch distances associated with a given rosbag ID.
GET
/api/vis/v1/rosbags/{id}/ranges/{qr_code}/
Fetch ranges associated with a given rosbag ID and QR code.
vis.video-files 3
POST
/api/vis/v1/video-files/{id}/anomaly/
Create an anomaly associated with a given video file ID.
GET
/api/vis/v1/video-files/{id}/rosbags/
Fetch rosbags associated with a given video file ID.
GET
/api/vis/v1/video-files/{id}/pointclouds/
Fetch pointclouds associated with a given video file ID.
vis.root-photos 1
POST
/api/vis/v1/root-photos/{id}/anomaly/
Create an anomaly associated with a given root photo ID.
vis.external-photos 1
POST
/api/vis/v1/external-photos/{id}/anomaly/
Create an anomaly associated with a given external photo ID.
vis.ai-anomalies 5
POST
/api/vis/v1/ai-anomalies
Register an AI-detected defect (REST twin of registerAiDefect).
PATCH
/api/vis/v1/ai-anomalies/{id}/source-object
Set the source photo/video reference on an AI anomaly.
GET
/api/vis/v1/ai-anomalies/{id}
Fetch an AI anomaly by its own primary key.
GET
/api/vis/v1/ai-anomalies/by-defect-id/{defect_id}
Fetch an AI anomaly by the pipeline's inferencedefectid.
GET
/api/vis/v1/ai-anomalies/by-defect-uid/{defect_uid}
Fetch an AI anomaly by defectuid (external defects).
work-management.campaigns 10
POST
/api/work-management/campaigns/with-scope
Create Campaign With Scope
GET
/api/work-management/campaigns
List Campaigns
POST
/api/work-management/campaigns
Create Campaign
GET
/api/work-management/campaigns/{id}
Get Campaign
PATCH
/api/work-management/campaigns/{id}
Update Campaign
DELETE
/api/work-management/campaigns/{id}
Delete Campaign
POST
/api/work-management/campaigns/{id}/comments
Add Comment
DELETE
/api/work-management/campaigns/{id}/comments/{comment_id}
Delete Comment
POST
/api/work-management/campaigns/{id}/attach
Attach File
DELETE
/api/work-management/campaigns/{id}/detach/{storage_id}
Detach File
work-management.work-packages 11
POST
/api/work-management/work-packages/with-scope
Create Work Packages With Scope
GET
/api/work-management/work-packages/with-campaigns
List Work Packages With Campaigns
GET
/api/work-management/work-packages
List Work Packages
POST
/api/work-management/work-packages
Create Work Package
GET
/api/work-management/work-packages/{id}
Get Work Package
PATCH
/api/work-management/work-packages/{id}
Update Work Package
DELETE
/api/work-management/work-packages/{id}
Delete Work Package
POST
/api/work-management/work-packages/{id}/comments
Add Comment
DELETE
/api/work-management/work-packages/{id}/comments/{comment_id}
Delete Comment
POST
/api/work-management/work-packages/{id}/attach
Attach File
DELETE
/api/work-management/work-packages/{id}/detach/{storage_id}
Detach File
work-management.client-work-orders 11
GET
/api/work-management/client-work-orders
List Client Work Orders
POST
/api/work-management/client-work-orders
Create Client Work Order
GET
/api/work-management/client-work-orders/{id}
Get Client Work Order
PATCH
/api/work-management/client-work-orders/{id}
Update Client Work Order
DELETE
/api/work-management/client-work-orders/{id}
Delete Client Work Order
POST
/api/work-management/client-work-orders/complete
Complete Work Orders (and cascade linked anomalies)
POST
/api/work-management/client-work-orders/{id}/comments
Add Comment to Work Order
DELETE
/api/work-management/client-work-orders/{id}/comments/{comment_id}
Delete Comment from Work Order
POST
/api/work-management/client-work-orders/{id}/attach
Attach File to Work Order
DELETE
/api/work-management/client-work-orders/{id}/detach/{storage_id}
Detach File from Work Order
POST
/api/work-management/client-work-orders/{id}/apply-template
Apply Activity Template to Work Order
work-management.activities 10
GET
/api/work-management/cwo-activities
List Activities
POST
/api/work-management/cwo-activities
Create Activity
GET
/api/work-management/cwo-activities/{id}
Get Activity
PUT
/api/work-management/cwo-activities/{id}
Update Activity
DELETE
/api/work-management/cwo-activities/{id}
Delete Activity
POST
/api/work-management/cwo-activities/reorder
Reorder Activities
POST
/api/work-management/cwo-activities/{id}/comments
Add Comment to Activity
DELETE
/api/work-management/cwo-activities/{id}/comments/{comment_id}
Delete Comment from Activity
POST
/api/work-management/cwo-activities/{id}/attach
Attach File to Activity
DELETE
/api/work-management/cwo-activities/{id}/detach/{storage_id}
Detach File from Activity
work-management.activity-templates 5
GET
/api/work-management/activity-templates
List Activity Templates
POST
/api/work-management/activity-templates
Create Activity Template
GET
/api/work-management/activity-templates/{id}
Get Activity Template
PATCH
/api/work-management/activity-templates/{id}
Update Activity Template
DELETE
/api/work-management/activity-templates/{id}
Delete Activity Template
work-management.vendors 5
GET
/api/work-management/vendors
List Vendors
POST
/api/work-management/vendors
Create Vendor
GET
/api/work-management/vendors/{id}
Get Vendor
PATCH
/api/work-management/vendors/{id}
Update Vendor
DELETE
/api/work-management/vendors/{id}
Delete Vendor
work-management.task-types 5
GET
/api/work-management/task-types
List Task Types
POST
/api/work-management/task-types
Create Task Type
GET
/api/work-management/task-types/{id}
Get Task Type
PATCH
/api/work-management/task-types/{id}
Update Task Type
DELETE
/api/work-management/task-types/{id}
Delete Task Type
work-management.statuses 1
GET
/api/work-management/statuses
Get Status Options
work-management.anomaly-work-orders 2
POST
/api/work-management/work-orders
Create Work Orders for Anomalies
GET
/api/work-management/anomalies/{anomaly_id}/work-orders
Get Work Orders for Anomaly
planning.campaigns 5
GET
/api/planning/v1/campaigns
List Campaigns
POST
/api/planning/v1/campaigns
Create Campaign
GET
/api/planning/v1/campaigns/{id}
Get Campaign
PATCH
/api/planning/v1/campaigns/{id}
Update Campaign
DELETE
/api/planning/v1/campaigns/{id}
Delete Campaign
planning.projects 5
GET
/api/planning/v1/projects
List Projects
POST
/api/planning/v1/projects
Create Project
GET
/api/planning/v1/projects/{id}
Get Project
PATCH
/api/planning/v1/projects/{id}
Update Project
DELETE
/api/planning/v1/projects/{id}
Delete Project
planning.services 5
GET
/api/planning/v1/services
List Services
POST
/api/planning/v1/services
Create Service
GET
/api/planning/v1/services/{id}
Get Service
PATCH
/api/planning/v1/services/{id}
Update Service
DELETE
/api/planning/v1/services/{id}
Delete Service
planning.customer-vendors 5
GET
/api/planning/v1/customer-vendors
List CustomerVendors
POST
/api/planning/v1/customer-vendors
Create CustomerVendor
GET
/api/planning/v1/customer-vendors/{id}
Get CustomerVendor
PATCH
/api/planning/v1/customer-vendors/{id}
Update CustomerVendor
DELETE
/api/planning/v1/customer-vendors/{id}
Delete CustomerVendor
planning 2
POST
/api/planning/v1/service-orders/{id}/anomalies
Link anomalies to a service order
DELETE
/api/planning/v1/service-orders/{id}/anomalies/{anomaly_id}
Unlink an anomaly from a service order
planning.service-orders 5
GET
/api/planning/v1/service-orders
List ServiceOrders
POST
/api/planning/v1/service-orders
Create ServiceOrder
GET
/api/planning/v1/service-orders/{id}
Get ServiceOrder
PATCH
/api/planning/v1/service-orders/{id}
Update ServiceOrder
DELETE
/api/planning/v1/service-orders/{id}
Delete ServiceOrder
planning.work-order-types 5
GET
/api/planning/v1/work-order-types
List WorkOrderTypes
POST
/api/planning/v1/work-order-types
Create WorkOrderType
GET
/api/planning/v1/work-order-types/{id}
Get WorkOrderType
PATCH
/api/planning/v1/work-order-types/{id}
Update WorkOrderType
DELETE
/api/planning/v1/work-order-types/{id}
Delete WorkOrderType
planning.work-orders 5
GET
/api/planning/v1/work-orders
List WorkOrders
POST
/api/planning/v1/work-orders
Create WorkOrder
GET
/api/planning/v1/work-orders/{id}
Get WorkOrder
PATCH
/api/planning/v1/work-orders/{id}
Update WorkOrder
DELETE
/api/planning/v1/work-orders/{id}
Delete WorkOrder
planning.statuses 1
GET
/api/planning/v1/statuses
Get planning status catalogue
Schemas 1377
The contract defines 1377 schemas that model the data the API accepts and returns. The most detailed are AccountingOverviewQuery (86 properties), AccountingOverviewSummaryQuery (82 properties), AnomalyResponse (74 properties), AnomalyCreate (57 properties). Each schema is shown below with its type and property counts.
Success
object
Schema returned for successful operations. The success field is always true in this schema. Failed operations are represented by the :class:Error schema instea…
1 property
Error
object
Error response schema.
2 properties
2 required
ErrorCode
string
Error codes for API errors.
Authenticate
object
Schema for authentication.
3 properties
2 required
TokenType
string
Token type enum.
ClientLoginResponse
object
Response schema for client login, returning access token and project ID.
2 properties
2 required
ClientLoginRequest
object
Request schema for client login via project password.
1 property
1 required
PermissionCodename
string
All supported permission codenames in the system.
User
object
Schema for user details.
14 properties
9 required
UserCustomer
object
Customer the user has access to, with their roles at that customer.
5 properties
2 required
UserType
string
User classification based on customer relationships.
ManufacturerQueryParams
object
Query parameters for manufacturers endpoint.
3 properties
PaginationInput
object
3 properties
ManufacturerResponse
object
Schema for Manufacturer response.
3 properties
3 required
ManufacturerCreate
object
Schema for creating a Manufacturer.
1 property
1 required
ManufacturerUpdate
object
Schema for updating a Manufacturer.
1 property
ComponentModelQueryParams
object
Query parameters for component models endpoint.
4 properties
ComponentModelResponse
object
Schema for ManufacturerComponentModel response.
8 properties
5 required
ComponentTypeObject
object
Nested component type object for responses.
3 properties
2 required
ManufacturerObject
object
Nested manufacturer object for responses.
2 properties
2 required
ComponentModelCreate
object
Schema for creating a ManufacturerComponentModel.
6 properties
3 required
ComponentModelUpdate
object
Schema for updating a ManufacturerComponentModel.
6 properties
TurbineModelQueryParams
object
Query parameters for turbine models endpoint.
3 properties
TurbineModelResponse
object
Schema for TurbineModel response.
10 properties
6 required
TurbineModelCreate
object
Schema for creating a TurbineModel.
8 properties
2 required
TurbineModelUpdate
object
Schema for updating a TurbineModel.
8 properties
QueryParams
object
Common query parameters for list endpoints. Note: page and pagesize are handled by the @paginate decorator from builderapi.utils.
2 properties
ComponentTypeResponse
object
Schema for ComponentType response.
5 properties
3 required
RobotSetQueryParams
object
Query parameters for robot sets endpoint. Note: page and pagesize are handled by the @paginate decorator from builderapi.utils.
3 properties
RobotSetResponse
object
Schema for RobotSet response.
9 properties
3 required
RobotSetServiceNestedResponse
object
Nested response for service in robot set response (no timestamps in nested objects).
2 properties
2 required
RobotSetCreate
object
Schema for creating a RobotSet.
5 properties
1 required
RobotSetUpdate
object
Schema for updating a RobotSet.
5 properties
RobotSetServicesResponse
object
Schema for RobotSetServices response.
5 properties
5 required
ResourceSummary
object
Summary of dispatch resources.
3 properties
3 required
PositionObject
object
Nested Position object (no timestamps).
3 properties
3 required
ResourceServicePositionResponse
object
Schema for ResourceServicePosition response.
6 properties
6 required
ResourceServicePositionCreate
object
Schema for creating a ResourceServicePosition.
3 properties
3 required
ResourceServicePositionUpdate
object
Schema for updating a ResourceServicePosition.
3 properties
CertificateObject
object
Nested certificate object for responses.
2 properties
2 required
ResourceCertificateResponse
object
Schema for ResourceCertificate response.
11 properties
4 required
ResourceCertificateCreate
object
Schema for creating a ResourceCertificate under a resource.
8 properties
1 required
ResourceCertificateUpdate
object
Schema for updating a ResourceCertificate (partial). certificateid is intentionally omitted: the certificate a row points at is immutable. To assign a differen…
7 properties
ResourceQueryParams
object
Query parameters for resources endpoint.
4 properties
ResourceCertificateOutput
object
Output schema for a resource's certificate (embedded in ResourceResponse). Exposes every non-audit ResourceCertificate field. certificateid / certificatename /…
10 properties
3 required
ResourceResponse
object
Schema for Resource response.
12 properties
3 required
ResourceCertificateInput
object
Input schema for a resource's certificate (used in Resource create/update). Mirrors the writable non-audit fields of ResourceCertificate so the write surface m…
9 properties
ResourceCreate
object
Schema for creating a Resource. Either robotsetid or userid must be provided (but not both). The fullname and email fields are auto-populated from the referenc…
10 properties
ResourceUpdate
object
Schema for updating a Resource. Employment contract, qualifications, certificates, and the BambooHR / TalentLMS links can be updated. bamboohremployeeid and ta…
5 properties
ResourceSetQueryParams
object
Query parameters for resource sets endpoint.
2 properties
ResourceSetItemOutput
object
Output schema for resource set item in responses (no timestamps).
8 properties
4 required
ResourceSetResponse
object
Schema for ResourceSet response.
5 properties
3 required
ResourceSetCreate
object
Schema for creating a ResourceSet.
3 properties
1 required
ResourceSetItemInput
object
Input schema for a resource set item (technician or robot from core.Resource).
3 properties
2 required
ResourceSetUpdate
object
Schema for updating a ResourceSet.
3 properties
CountryQueryParams
object
Query parameters for countries endpoint (no pagination - returns all results).
2 properties
CountryResponse
object
Schema for Country response matching legacy /countries endpoint.
9 properties
4 required
ResolveCoordinatesResponse
object
Resolved geographic data from coordinates.
9 properties
ResolveCoordinatesRequest
object
Request body for resolving geographic data from coordinates.
3 properties
LocationQueryParams
object
Query parameters for locations endpoint.
5 properties
LocationType
string
Allowed location type values in location.
CountryObject
object
Nested country object for responses (no timestamps in nested objects).
3 properties
3 required
CurrencyIdCodeObject
object
Nested currency object with only id and code (no timestamps).
2 properties
2 required
CustomerObject
object
Nested customer object for responses (no timestamps).
5 properties
2 required
LocationCertificateOutput
object
Output schema for location certificate in responses.
3 properties
3 required
LocationResponse
object
Schema for Location response.
20 properties
4 required
TimezoneObject
object
Nested timezone object for responses (no timestamps in nested objects).
4 properties
2 required
LocationCertificateInput
object
Input schema for location certificate in create/update requests.
2 properties
1 required
LocationCreate
object
Schema for creating a Location.
17 properties
2 required
LocationUpdate
object
Schema for updating a Location.
17 properties
PricingUnitNestedResponse
object
Nested response for pricing unit in service response (no timestamps in nested objects).
3 properties
2 required
ServiceObject
object
Nested service object for responses (no timestamps).
4 properties
3 required
ServicePricingUnitResponse
object
Schema for ServicePricingUnit response.
5 properties
5 required
ServiceRelatedServiceResponse
object
Schema for ServiceRelatedService response.
4 properties
4 required
ServiceQueryParams
object
Query parameters for services endpoint. Note: page and pagesize are handled by the @paginate decorator from builderapi.utils.
6 properties
ServiceCategoryNestedResponse
object
Nested response for service category in service response.
2 properties
2 required
ServiceFamilyNestedResponse
object
Nested response for service family in service response.
3 properties
3 required
ServiceGroupNestedResponse
object
Nested response for service group in service response.
2 properties
2 required
ServiceResponse
object
Schema for Service response.
12 properties
7 required
ServiceCategoryResponse
object
Schema for ServiceCategory response.
4 properties
4 required
ServiceFamilyQueryParams
object
Query parameters for the service families endpoint.
3 properties
ServiceFamilyResponse
object
Schema for ServiceFamily response.
4 properties
4 required
ServiceGroupResponse
object
Schema for ServiceGroup response.
3 properties
3 required
PricingUnitResponse
object
Schema for PricingUnit response.
4 properties
3 required
ErpPartQueryParams
object
Query params for listing ERP parts.
6 properties
ErpPartCategoryObject
object
Nested item-category object for ERP part responses (no timestamps).
3 properties
3 required
ErpPartCodeObject
object
Nested Monitor part-classification code (no timestamps).
3 properties
3 required
ErpPartResponse
object
Schema for a synced Monitor ERP part.
9 properties
4 required
ErpPartUpdate
object
Schema for flagging an ERP part — only the category is editable.
1 property
ErpPartCodeResponse
object
Schema for a synced Monitor part-classification code.
4 properties
3 required
ItemCategoryResponse
object
One row in the core.itemcategory lookup.
3 properties
3 required
ServiceStandardItemQueryParams
object
Query params for listing standard-set lines.
5 properties
ErpPartObject
object
Nested ERP part object for responses (no timestamps).
5 properties
2 required
ServiceStandardItemResponse
object
Schema for one standard-set line of a service.
8 properties
7 required
ServiceStandardItemCreate
object
Schema for creating a standard-set line.
6 properties
2 required
ServiceStandardItemUpdate
object
Schema for updating a standard-set line.
6 properties
CertificateRequirementRuleQueryParams
object
Query params for listing certificate mapping rules.
8 properties
CertificateRequirementRuleResponse
object
One certificate mapping rule: (service | family | all) × region × customer → certificate.
9 properties
3 required
NestedIdName
object
Generic nested object with id and name (no timestamps).
2 properties
2 required
ServiceFamilyObject
object
Nested service-family object for responses (no timestamps).
3 properties
3 required
CertificateRequirementRuleCreate
object
Schema for creating a certificate mapping rule.
7 properties
1 required
CertificateRequirementRuleUpdate
object
Schema for updating a certificate mapping rule.
7 properties
CertificateRequirementGroupSave
object
Bulk save of one mapping group in a single transaction. Targets are (certificate × unit) pairs sharing region/customer/comment. Rules in existingruleids not ma…
7 properties
2 required
CertificateRequirementScopeUnit
object
One scope of a mapping group: a service, a family, or (both empty) all services.
2 properties
RelationshipTypeResponse
object
Schema for RelationshipType response.
4 properties
3 required
StandardQueryParams
object
Query parameters for standards endpoint.
4 properties
StandardResponse
object
Schema for Standard response.
5 properties
5 required
PositionQueryParams
object
Query parameters for positions endpoint.
3 properties
PositionResponse
object
Schema for Position response.
4 properties
4 required
PositionCreate
object
Schema for creating a Position.
2 properties
1 required
PositionUpdate
object
Schema for updating a Position.
2 properties
UserQueryParams
object
Query parameters for user list endpoint.
3 properties
UserCustomerObject
object
Nested customer reference for user responses.
2 properties
2 required
UserResponse
object
Schema for user list response.
8 properties
2 required
UserCreate
object
Schema for creating a user.
6 properties
3 required
UserUpdate
object
Schema for updating a user.
5 properties
IDWithName
object
Schema for ID with name.
2 properties
2 required
CustomerQueryParams
object
Query parameters for customers endpoint.
8 properties
CustomerTypeFilter
string
Which customer types a list returns. Every :class:CustomerType plus ALL. Kept separate from :class:CustomerType because ALL is a question a caller can ask, nev…
CurrencyObject
object
Nested currency object for responses (no timestamps in nested objects).
3 properties
3 required
CustomerResponse
object
Schema for Customer response.
19 properties
4 required
CustomerType
string
What kind of party a customer row represents. COMMERCIAL is an ordinary customer: billable, mirrored to NetSuite, and the answer every customer picker in the p…
ParentCustomerObject
object
Nested parent customer object for responses (no timestamps in nested objects).
2 properties
2 required
CustomerCreate
object
Schema for creating a Customer. Number is auto-generated. countryid, currencyid and netsuitesubsidiaryid are required of a commercial customer and meaningless…
16 properties
1 required
CustomerUpdate
object
Schema for updating a Customer.
15 properties
CustomerNetsuiteSubsidiary
object
Current NetSuite subsidiary for a customer (source of truth = NetSuite).
1 property
VendorQueryParams
object
Query parameters for vendors endpoint.
5 properties
ParentVendorObject
object
Nested parent vendor object for responses (no timestamps in nested objects).
2 properties
2 required
VendorResponse
object
Schema for Vendor response.
14 properties
4 required
VendorCreate
object
Schema for creating a Vendor. Number is auto-generated.
11 properties
1 required
VendorUpdate
object
Schema for updating a Vendor.
12 properties
CustomerContactResponse
object
Schema for CustomerContact response.
11 properties
4 required
CustomerContactCreate
object
Schema for creating a CustomerContact.
8 properties
1 required
CustomerContactUpdate
object
Schema for updating a CustomerContact.
8 properties
CustomerAddressResponse
object
Schema for CustomerAddress response.
13 properties
3 required
CustomerAddressCreate
object
Schema for creating a CustomerAddress.
10 properties
1 required
CustomerAddressType
string
Enum for customer address types.
CustomerAddressUpdate
object
Schema for updating a CustomerAddress.
10 properties
CustomerBankAccountResponse
object
Schema for CustomerBankAccount response.
10 properties
3 required
CustomerBankAccountCreate
object
Schema for creating a CustomerBankAccount.
7 properties
CustomerBankAccountUpdate
object
Schema for updating a CustomerBankAccount.
7 properties
CustomerLocationQueryParams
object
Query parameters for customer locations endpoint.
5 properties
CustomerLocationResponse
object
Schema for CustomerLocation response.
5 properties
4 required
LocationObjectWithType
object
Nested location object for responses (no timestamps), including type.
3 properties
1 required
RelationshipTypeObject
object
Nested relationship type object for responses (no timestamps).
3 properties
2 required
CustomerLocationCreate
object
Schema for sharing or creating a location in customer context.
21 properties
1 required
CustomerLocationCreateMode
string
Supported create flows for customer locations.
CustomerLocationUpdate
object
Schema for updating a CustomerLocation.
2 properties
CustomerLocationListQueryParams
object
Query parameters for the top-level customer-locations list endpoint. Powers the turbine-create picker on the frontend: given a location, fetch the customers li…
5 properties
CustomerUserResponse
object
Schema for CustomerUser response.
6 properties
5 required
UserObject
object
Nested user object for responses (no timestamps).
5 properties
2 required
CustomerUserCreate
object
Schema for creating a CustomerUser.
2 properties
1 required
CustomerUserUpdate
object
Schema for updating a CustomerUser.
2 properties
CustomerRoleResponse
object
Schema for CustomerRole response (assignable roles for a customer).
6 properties
4 required
CustomerTurbineQueryParams
object
Query parameters for customer turbines endpoint.
6 properties
CustomerTurbineResponse
object
Schema for CustomerTurbine response.
5 properties
4 required
LocationObject
object
Nested location object for responses (no timestamps).
3 properties
2 required
TurbineWithLocationObject
object
Nested turbine object with location for customer turbine responses.
3 properties
1 required
CustomerTurbineCreate
object
Schema for creating or sharing a turbine in customer context.
23 properties
1 required
CustomerTurbineCreateMode
string
Supported create flows for customer turbines.
PositionEnum
string
Enum for turbine component positions.
TurbineComponentInput
object
Schema for creating a TurbineComponent as part of Turbine creation. Note: turbineid and locationid are automatically set from the parent turbine.
8 properties
2 required
CustomerTurbineUpdate
object
Schema for updating a CustomerTurbine.
2 properties
DelayCategoryQueryParams
object
Query parameters for delay categories endpoint.
3 properties
DelayCategoryResponse
object
Schema for DelayCategory response.
6 properties
5 required
DelayCategoryCreate
object
Schema for creating a DelayCategory.
4 properties
1 required
DelayCategoryUpdate
object
Schema for updating a DelayCategory.
4 properties
DelayTypeQueryParams
object
Query parameters for delay types endpoint.
4 properties
DelayCategoryObject
object
Nested delay category object for responses (no timestamps).
2 properties
2 required
DelayTypeResponse
object
Schema for DelayType response.
8 properties
6 required
DelayTypeCreate
object
Schema for creating a DelayType.
6 properties
2 required
DelayTypeUpdate
object
Schema for updating a DelayType.
6 properties
DelayQueryParams
object
Query parameters for delays endpoint.
10 properties
DelayResponse
object
Schema for Delay response.
18 properties
4 required
DelayTypeObject
object
Nested delay type object for responses (no timestamps).
2 properties
2 required
ResourceObject
object
Nested resource object for responses (no timestamps).
2 properties
2 required
RobotSetObject
object
Nested robot set object for responses (no timestamps).
2 properties
2 required
DelayCreate
object
Schema for creating a Delay.
16 properties
3 required
DelayUpdate
object
Schema for updating a Delay.
16 properties
NotificationCategory
string
The unit a user unsubscribes from. Deliberately coarse — the groupings a person reasons about ("stop emailing me about anomalies"), not one entry per event. A…
NotificationQueryParams
object
Query params for notification list.
5 properties
NotificationResponse
object
Response schema for a notification (list and single endpoints alike).
17 properties
7 required
NotificationUnreadCountResponse
object
Response for unread notification count.
1 property
1 required
NotificationMarkAllReadResponse
object
Response for mark-all-read action.
1 property
1 required
NotificationSeenResponse
object
Response for the batch mark-as-seen action.
1 property
1 required
NotificationSeenRequest
object
Body for the batch mark-as-seen action. The cap stops one request issuing an unbounded UPDATE; the bell panel only ever reports the rows it rendered.
1 property
1 required
NotificationPreferenceItem
object
One category's channel opt-outs, used for both request and response. The response always carries every category; the upsert body requires both channels so an o…
3 properties
3 required
NotificationUpdate
object
Schema for updating notification read/archived status.
2 properties
EventResult
object
announced is False for an event that produced nothing this time.
1 property
1 required
EventRequest
object
An event id off the menu in EVENTS, plus that event's parameters.
2 properties
1 required
FileEntityLinkQueryParams
object
Query parameters for file entity links endpoint.
12 properties
FileEntityLinkResponse
object
Schema for FileEntityLink response.
14 properties
3 required
FileEntityLinkCreate
object
Schema for creating a FileEntityLink.
12 properties
1 required
FileEntityLinkUpdate
object
Schema for updating a FileEntityLink.
11 properties
TurbineImportResponse
object
2 properties
TurbineImportRowError
object
2 properties
2 required
TurbineQueryParams
object
Query parameters for turbines endpoint.
8 properties
TurbineModelObject
object
Nested turbine model object for responses.
2 properties
2 required
TurbineResponse
object
Schema for Turbine response.
21 properties
6 required
TurbineCreate
object
Schema for creating a Turbine.
19 properties
5 required
TurbineCustomerInput
object
Customer assignment payload entry for Turbine creation.
2 properties
1 required
TurbineUpdate
object
Schema for updating a Turbine.
17 properties
ComponentImportResponse
object
2 properties
ComponentImportRowError
object
2 properties
2 required
TurbineComponentReassignmentHistoryResponse
object
Response schema for a single blade component reassignment event.
4 properties
4 required
TurbineObject
object
Nested turbine object for responses.
2 properties
2 required
TurbineComponentQueryParams
object
Query parameters for turbine components endpoint.
7 properties
ManufacturerComponentModelObject
object
Nested manufacturer component model object for responses.
2 properties
2 required
TurbineComponentResponse
object
Schema for TurbineComponent response.
15 properties
6 required
TurbineComponentCreate
object
Schema for creating a TurbineComponent.
13 properties
3 required
TurbineComponentUpdate
object
Schema for updating a TurbineComponent.
13 properties
CertificateQueryParams
object
Query parameters for certificates endpoint.
6 properties
CertificateResponse
object
Schema for Certificate response.
10 properties
4 required
CertificateCreate
object
Schema for creating a Certificate.
8 properties
1 required
CertificateUpdate
object
Schema for updating a Certificate (partial).
8 properties
CertificateCategoryQueryParams
object
Query parameters for certificate-categories endpoint.
2 properties
CertificateCategoryResponse
object
Schema for CertificateCategory response.
6 properties
4 required
CertificateCategoryCreate
object
Schema for creating a CertificateCategory.
4 properties
1 required
CertificateCategoryUpdate
object
Schema for updating a CertificateCategory (partial).
4 properties
CertificateIssuerQueryParams
object
Query parameters for certificate-issuers endpoint.
4 properties
CertificateIssuerResponse
object
Schema for CertificateIssuer response.
11 properties
4 required
CertificateIssuerCreate
object
Schema for creating a CertificateIssuer.
9 properties
1 required
CertificateIssuerUpdate
object
Schema for updating a CertificateIssuer (partial).
9 properties
CertificateOfferingQueryParams
object
Query parameters for certificate-offerings endpoint.
5 properties
CertificateOfferingResponse
object
Schema for CertificateOffering response.
14 properties
5 required
CertificateOfferingCreate
object
Schema for creating a CertificateOffering.
12 properties
2 required
CertificateOfferingUpdate
object
Schema for updating a CertificateOffering (partial).
12 properties
CertificateExpenseQueryParams
object
Query parameters for certificate-expenses endpoint.
7 properties
CertificateExpenseStatus
string
Lifecycle of a certificate cost row.
CertificateExpenseResponse
object
Schema for CertificateExpense response.
17 properties
7 required
CertificateExpenseCreate
object
Schema for creating a CertificateExpense.
15 properties
4 required
CertificateExpenseUpdate
object
Schema for updating a CertificateExpense (partial).
15 properties
AnomalyComponentQueryParams
object
Query parameters for AnomalyComponent list.
3 properties
AnomalyComponentResponse
object
Schema for AnomalyComponent response.
5 properties
4 required
AnomalyTypeQueryParams
object
Query parameters for AnomalyType list.
4 properties
AnomalyTypeResponse
object
Schema for AnomalyType response.
5 properties
3 required
AnomalyRootCauseTypeQueryParams
object
Query parameters for AnomalyRootCauseType list.
2 properties
AnomalyRootCauseTypeResponse
object
Schema for AnomalyRootCauseType response.
3 properties
2 required
AnomalyParentTypeQueryParams
object
Query parameters for AnomalyParentType list.
2 properties
AnomalyParentTypeResponse
object
Schema for AnomalyParentType response.
3 properties
3 required
AnomalyMaterialQueryParams
object
Query parameters for AnomalyMaterial list.
3 properties
AnomalyMaterialResponse
object
Schema for AnomalyMaterial response.
4 properties
4 required
AnomalyComponentTypeMapQueryParams
object
Query parameters for AnomalyComponentTypeMap list.
4 properties
AnomalyComponentTypeMapResponse
object
Schema for AnomalyComponentTypeMap response.
2 properties
2 required
AnomalyRecommendationQueryParams
object
Query parameters for AnomalyRecommendation list.
4 properties
AnomalyRecommendationResponse
object
Schema for AnomalyRecommendation response.
6 properties
3 required
AnomalyRecommendationCreate
object
Schema for creating AnomalyRecommendation.
4 properties
1 required
AnomalyRecommendationUpdate
object
Schema for updating AnomalyRecommendation.
4 properties
AnomalyClientFieldQueryParams
object
Query parameters for AnomalyClientField list.
3 properties
AnomalyClientFieldResponse
object
Schema for AnomalyClientField response (customer custom-field definition).
9 properties
5 required
CustomerCustomFieldOption
object
One allowed option for a SELECT-type customer custom field.
2 properties
1 required
AnomalyClientFieldCreate
object
Schema for creating an AnomalyClientField.
3 properties
1 required
AnomalyClientFieldOption
object
One allowed option for a SELECT-type client field.
2 properties
1 required
AnomalyClientFieldUpdate
object
Schema for updating an AnomalyClientField.
3 properties
AnomalyFileQueryParams
object
Query parameters for Anomaly file list.
2 properties
FileResponse
object
Schema for File response.
5 properties
3 required
BodyFile
object
3 properties
2 required
BodyFileWrapper
object
Object form of a base64 upload request body. Wraps the file list together with optional batch-level additionalinformation metadata that is persisted on every F…
2 properties
1 required
AnomalyQueryParams
object
Query parameters for Anomaly list.
32 properties
AnomalyCustomValueOutput
object
Schema for a custom field value in an anomaly response.
5 properties
4 required
AnomalyResponse
object
Schema for Anomaly response.
74 properties
8 required
AnomalyCreate
object
Schema for creating Anomaly.
57 properties
2 required
AnomalyCustomValueInput
object
Schema for setting one custom field value on an anomaly.
2 properties
1 required
AnomalyUpdate
object
Schema for updating Anomaly.
56 properties
BladeDiagramAnomaly
object
Single anomaly data point for blade diagram rendering.
3 properties
1 required
BladeDiagramRequest
object
Request body for blade diagram image generation.
2 properties
2 required
CrossSectionRequest
object
Request body for cross-section image generation (single anomaly).
8 properties
4 required
TimezoneQueryParams
object
Query parameters for timezones endpoint.
2 properties
TimezoneResponse
object
Schema for Timezone response.
8 properties
4 required
CurrencyQueryParams
object
Query parameters for currencies endpoint.
2 properties
CurrencyResponse
object
Schema for Currency response.
4 properties
4 required
BusinessRegionQueryParams
object
Query parameters for business regions endpoint.
2 properties
BusinessRegionResponse
object
Schema for Business Region response.
3 properties
3 required
RegionQueryParams
object
Query parameters for regions endpoint.
2 properties
RegionResponse
object
Schema for Region response.
3 properties
3 required
TermsOfServiceQueryParams
object
Query parameters for Terms of Service endpoint.
4 properties
TermsOfServiceResponse
object
Schema for Terms of Service response.
7 properties
7 required
UserTosAcceptanceQueryParams
object
Query parameters for User ToS Acceptance endpoint.
3 properties
UserTosAcceptanceResponse
object
Schema for User ToS Acceptance response. Note: This is an immutable record, so only createdat is included (no updatedat).
6 properties
4 required
UserTosAcceptanceCreate
object
Schema for creating a User ToS Acceptance.
3 properties
1 required
DailyReportDownloadRequest
object
Request body for generating a daily report from the client portal.
2 properties
1 required
FinalReportDownloadRequest
object
Request body for generating a final (SOL) report from the client portal.
1 property
1 required
FinalReportStartResponse
object
Response after kicking off async final-report generation.
2 properties
2 required
CustomReportRequest
object
Request body for a custom report: the family and the selection (Ops Hub ids).
9 properties
1 required
CustomReportListQueryParams
object
Query parameters for the custom report list.
1 property
CustomReportSummary
object
One custom report request as the portal lists it.
7 properties
4 required
CustomReportService
object
One "Service" choice of a family: the service code and the label the portal shows.
2 properties
2 required
CustomReportType
object
One report family the portal may request, with the request fields it reads, its services and its cap.
5 properties
5 required
FinalReportStatusResponse
object
Polling response for an in-flight final-report generation.
4 properties
2 required
ProjectQuestionConfigQueryParams
object
Query parameters for project question configs endpoint.
6 properties
ProjectQuestionConfigResponse
object
Schema for ProjectQuestionConfig response.
13 properties
9 required
ProjectStatusQueryParams
object
Query parameters for project status endpoint.
3 properties
ProjectStatusResponse
object
Schema for ProjectStatus response.
6 properties
5 required
ReportTypeQueryParams
object
Query params for the ReportType readonly list.
3 properties
ReportTypeResponse
object
Schema for ReportType response (readonly lookup).
7 properties
6 required
PipedriveDealQueryParams
object
Query parameters for pipedrive-deals endpoint.
2 properties
PipedriveDealResponse
object
Schema for PipedriveDeal response. Returns parsed title (project code only, e.g., 'EDFR-5308' from 'EDFR-5308 IIN x6'). Deals without a valid title/project cod…
3 properties
3 required
ProjectPreJobAnswerResponse
object
Schema for ProjectPreJobAnswer response.
8 properties
6 required
ProjectPreJobAnswerBulkItem
object
Single item in a bulk update request — answer ID + fields to update.
5 properties
1 required
ProjectPreJobAnswerBulkUpdate
object
Schema for bulk-updating pre-job answers.
1 property
1 required
ProjectPreJobAnswerCreate
object
Schema for creating a ProjectPreJobAnswer.
5 properties
3 required
ProjectPreJobAnswerUpdate
object
Schema for updating a ProjectPreJobAnswer.
4 properties
ProjectBillingResponse
object
Schema for ProjectBilling response.
27 properties
3 required
ProjectContactObject
object
Nested project contact object for Project response (no timestamps).
4 properties
2 required
ProjectContactRole
string
All possible roles for ProjectContact (used in responses). Note: The backend historically uses the typo'd value REPORTRECEPIENT and we intentionally preserve i…
PurchaseOrderCustomerRef
object
Slim customer reference for PurchaseOrder responses. Intentionally does not nest the customer's own currency — a PO carries its own currency, independent of th…
3 properties
2 required
PurchaseOrderResponse
object
PurchaseOrder with its current version inlined for list/detail use.
6 properties
2 required
PurchaseOrderVersionObject
object
Nested purchase order version object (no timestamps).
6 properties
5 required
RfiBillingCompositeResponse
object
Project billing snapshot plus purchase orders linked for RFI Billing. updatedat is the canonical ProjectBilling row timestamp (same row as projectbilling).
5 properties
4 required
VendorObject
object
Nested vendor object for responses (no timestamps).
3 properties
2 required
ProjectBillingUpdate
object
Schema for updating a ProjectBilling (partial).
24 properties
RfiBillingCompositeUpdate
object
Partial update for the RFI Billing composite (ProjectBilling + linked POs). Use projectbilling with partial fields per excludeunset semantics. For linkedpurcha…
2 properties
PreJobSiteAnswerObject
object
Pre-job answer within a site response.
5 properties
4 required
PreJobSiteContactObject
object
Contact within a site response.
6 properties
1 required
PreJobSiteFileObject
object
File link within a site response.
3 properties
2 required
PreJobSiteLocationObject
object
Location details within a pre-job site response.
11 properties
2 required
PreJobSiteOMBuildingObject
object
O&M building address in the pre-job sites response.
10 properties
2 required
PreJobSiteObject
object
Single site (project location) in the pre-job sites response.
11 properties
2 required
PreJobSitesResponse
object
Top-level response for the pre-job sites aggregation endpoint.
2 properties
1 required
PreJobSuggestedCertificationObject
object
One certificate auto-assigned to a site by the certificate mapping rules.
3 properties
2 required
CustomerContactObject
object
Nested customer contact object for responses.
4 properties
2 required
CustomerLocationObject
object
Nested customer location object for responses.
3 properties
2 required
ProjectContactResponse
object
Schema for ProjectContact response.
7 properties
5 required
ProjectContactCreate
object
Schema for creating a ProjectContact.
4 properties
2 required
ProjectContactMutableRole
string
Roles allowed when creating or updating a ProjectContact. SITECONTACT remains migration-managed and read-only. QHSECONTACT is assignable through the API for pr…
ProjectContactUpdate
object
Schema for updating a ProjectContact.
4 properties
LocationObjectExpanded
object
Expanded location object with full details for ProjectLocation responses.
10 properties
1 required
ProjectLocationResponse
object
Schema for ProjectLocation response.
8 properties
4 required
ProjectLocationBulkCreate
object
Schema for bulk-creating ProjectLocations.
1 property
1 required
ProjectLocationServicesResponse
object
Services commercially available at one project location — the union of services on approved commercial-offer items and project scope items there. General-purpo…
3 properties
2 required
PreJobSiteCompositeCustomerLocationObject
object
CustomerLocation slice returned by the per-location pre-job composite GET.
5 properties
3 required
PreJobSiteCompositeResponse
object
Full pre-job payload for one project location (GET .../locations/{id}/pre-job). locationid in the route is ProjectLocation.id. Includes the CustomerLocation ro…
13 properties
3 required
PreJobSiteCompositeContactItem
object
One contact row in a composite PUT (upsert: set id to update, omit to create).
9 properties
PreJobSiteCompositeFileLinkPatch
object
File link upsert for pre-job instructions (FileEntityLink).
3 properties
1 required
PreJobSiteCompositeOMBuildingPatch
object
Partial upsert for this project location's O&M CustomerAddress (OMBUILDING). Persisted link is ProjectLocation.ombuildingcustomeraddress; composite writes do n…
10 properties
PreJobSiteCompositeUpdate
object
Partial update body for PUT .../locations/{id}/pre-job (all sections optional).
8 properties
PreJobPrefillSourceProject
object
Another project usable as a pre-job prefill source. Paginated list row.
5 properties
2 required
PreJobPrefillSourceSiteService
object
One service the source project has at the shared site (chip in the picker).
3 properties
2 required
PreJobPrefillSourceSite
object
One site on a source project, surfaced to the prefill picker. Paginated list row.
3 properties
2 required
ProjectLocationUpdate
object
Schema for updating a ProjectLocation.
3 properties
ReceptorListResponse
object
GET response: ordered receptor list for one blade.
1 property
ReceptorObject
object
Single receptor row in a GET response (includes updatedat).
7 properties
5 required
ReceptorItem
object
One receptor row in a sync (PUT) body for a single blade. A receptor is a TurbineComponent with componenttype Receptor or HV Receptor and parentturbinecomponen…
6 properties
1 required
ReceptorSyncBody
object
PUT body for /blades/{id}/receptors — replaces the full list.
1 property
BladeWithReceptorsObject
object
One blade plus its receptor children — building block for the turbine convenience GET that returns all blades + receptors in one round-trip.
2 properties
1 required
TurbineReceptorsResponse
object
GET /turbines/{id}/receptors — all blades + their receptors.
1 property
_ReceptorBladeSummary
object
3 properties
2 required
InitTurbineFromPresetResponse
object
POST /turbines/{id}/receptors/init-from-preset — summary + the refreshed per-turbine blade/receptor tree so the UI can re-render without a follow-up GET.
7 properties
6 required
InitTurbineFromPresetBody
object
POST body for /turbines/{id}/receptors/init-from-preset — picks which named preset to seed the turbine from.
1 property
1 required
ReceptorPresetListResponse
object
GET /turbine-models/{id}/receptor-presets — all presets.
1 property
ReceptorPresetObject
object
One named receptor preset belonging to a turbine model.
6 properties
4 required
ReceptorPresetResponse
object
GET / POST / PATCH single-preset response.
6 properties
4 required
ReceptorPresetCreate
object
POST body for creating a preset under a turbine model.
2 properties
1 required
ReceptorPresetUpdate
object
PATCH body for renaming / re-describing a preset.
2 properties
LpsResultBlade
object
3 properties
1 required
LpsResultBladeDataplate
object
Latest BLADEDATAPLATE image attached to a blade TurbineComponent.
2 properties
2 required
LpsResultCell
object
One side (SS or PS) of one receptor's measurement.
5 properties
LpsResultReceptor
object
7 properties
3 required
LpsResultsContextResponse
object
GET /service-order-lines/{solid}/lps-results — per-blade matrix.
3 properties
2 required
LpsResultsTurbineObject
object
3 properties
1 required
LpsResultsUpsertResponse
object
PUT response = the upsert count + the refreshed capture context.
4 properties
3 required
LpsResultsUpsertBody
object
1 property
1 required
LpsResultsUpsertCell
object
One row of the upsert payload.
6 properties
2 required
ProjectOfferResponse
object
Schema for ProjectOffer response.
18 properties
7 required
ProjectOfferSendForApprovalRequest
object
Body for sending a draft offer for approval.
1 property
ProjectOfferRejectRequest
object
Body for rejecting a pending offer.
1 property
1 required
ProjectOfferHistoryResponse
object
Schema for an offer history row (a non-draft offer version).
22 properties
8 required
ProjectOfferQueryParams
object
Query parameters for the project offers list endpoint.
4 properties
ProjectOfferCreate
object
Schema for creating a ProjectOffer.
14 properties
1 required
ProjectOfferUpdate
object
Schema for updating a ProjectOffer.
14 properties
ProjectBillingCreate
object
Schema for creating a ProjectBilling.
24 properties
ProjectReportRecipientObject
object
Nested report recipient object (a linked project contact).
4 properties
2 required
ProjectReportTypeResponse
object
Schema for ProjectReportType response.
8 properties
4 required
ReportTypeObject
object
Nested report type object (no timestamps).
3 properties
3 required
ProjectReportTypeCreate
object
Schema for creating a ProjectReportType.
5 properties
1 required
ProjectReportTypeUpdate
object
Schema for updating a ProjectReportType (partial).
4 properties
ProjectOfferItemQueryParams
object
Query parameters for project offer items endpoint.
5 properties
ProjectOfferItemResponse
object
Schema for ProjectOfferItem response.
20 properties
3 required
ProjectOfferItemCreate
object
Schema for creating a ProjectOfferItem.
18 properties
ProjectOfferItemUpdate
object
Schema for updating a ProjectOfferItem.
18 properties
CommercialOfferInboxQueryParams
object
Query parameters for the commercial-offer approvals inbox.
5 properties
CommercialOfferInboxRow
object
Cross-project approvals-inbox row: the latest non-draft offer per project.
15 properties
4 required
CommercialOfferInboxBulkApproveResponse
object
Response describing which offers were approved or skipped.
2 properties
2 required
CommercialOfferInboxBulkApproveRequest
object
Request payload for bulk commercial offer approval.
1 property
1 required
ProjectScopeItemQueryParams
object
Query parameters for project scope items endpoint.
4 properties
ProjectScopeItemResponse
object
Schema for ProjectScopeItem response.
13 properties
4 required
ProjectScopeLocationObject
object
Nested location object for scope rows, carrying geo-coordinates. Used as the map fallback when a turbine has no coordinates of its own (core.Location.latitude/…
5 properties
2 required
ProjectScopeTurbineComponentObject
object
Nested turbine component descriptor for project scope rows.
3 properties
2 required
ProjectScopeTurbineObject
object
Nested turbine object for scope rows, carrying geo-coordinates. Coordinates power the Project scope map view. They come straight off core.Turbine (latitude/lon…
4 properties
2 required
ScopeItemServiceOrderLineRef
object
A live SOL generated from a scope item (for linking from scope UIs).
3 properties
1 required
ProjectScopeItemCreate
object
Schema for creating a ProjectScopeItem.
8 properties
1 required
ProjectScopeItemUpdate
object
Schema for updating a ProjectScopeItem.
8 properties
ProjectScopeItemBulkCreate
object
Schema for bulk creating ProjectScopeItems for multiple turbines.
5 properties
3 required
ProjectResourceSetQueryParams
object
Query parameters for project resource sets endpoint.
5 properties
NestedIdOnly
object
Generic nested object with just id (no timestamps).
1 property
1 required
ProjectObject
object
Nested project object for responses (no timestamps).
2 properties
2 required
ProjectResourceSetItemOutput
object
Output schema for project resource set item in responses.
9 properties
3 required
ProjectResourceSetResponse
object
Schema for ProjectResourceSet response.
10 properties
3 required
ProjectResourceSetCreate
object
Schema for creating a ProjectResourceSet.
4 properties
1 required
ProjectResourceSetItemInput
object
Input schema for project resource set item in create/update requests.
6 properties
2 required
ProjectResourceSetUpdate
object
Schema for updating a ProjectResourceSet.
4 properties
MaterializePlannedInput
object
Body for promoting a planned resource set into a roster set.
2 properties
1 required
ProjectResourceSetActivityDay
object
One worked day of a project resource set within the queried window.
4 properties
1 required
ProjectResourceSetActivityDaysResponse
object
Per-set workorder-activity days for the execution overview team grid.
2 properties
1 required
ProjectPlannedResourceSetQueryParams
object
Query parameters for planned resource sets endpoint.
4 properties
ProjectPlannedResourceSetStatus
string
All planned-resource-set statuses (approval pipeline + deployment lifecycle). Mirrors core.models.projects.ProjectPlannedResourceSetStatus — keep both in sync.
ProjectPlannedResourceSetItemEmbeddedOutput
object
Embedded planned item: same shape as a PRS item plus approval status. resourceid widens to optional here and stays required on the roster base it inherits from…
10 properties
3 required
ProjectPlannedResourceSetResponse
object
Schema for ProjectPlannedResourceSet response.
10 properties
4 required
ProjectPlannedResourceSetCreate
object
Schema for creating a ProjectPlannedResourceSet.
4 properties
1 required
ProjectPlannedResourceSetUpdate
object
Schema for updating a ProjectPlannedResourceSet.
4 properties
ProjectPlannedResourceSetItemQueryParams
object
Query parameters for planned resource set items endpoint.
4 properties
ProjectPlannedResourceSetItemResponse
object
Schema for ProjectPlannedResourceSetItem response.
12 properties
5 required
ProjectPlannedResourceSetItemCreate
object
Schema for creating a ProjectPlannedResourceSetItem.
7 properties
1 required
ProjectPlannedResourceSetItemUpdate
object
Schema for updating a ProjectPlannedResourceSetItem.
7 properties
ProjectPlannedResourceSetItemCommitmentQueryParams
object
Query parameters for the planned scope commitments endpoint.
4 properties
ProjectPlannedResourceSetItemCommitmentResponse
object
Schema for planned scope commitment response.
7 properties
6 required
ProjectPlannedResourceSetItemCommitmentCreate
object
Schema for creating a planned scope commitment on a deployment leg.
4 properties
3 required
ProjectPlannedResourceSetItemCommitmentUpdate
object
Schema for updating a planned scope commitment.
4 properties
ProjectReadinessBucket
object
Readiness tally for tasks not tied to any planned resource set.
2 properties
2 required
ProjectReadinessResponse
object
Per-set + project-wide readiness tallies.
2 properties
2 required
ProjectReadinessSetTally
object
Readiness tally for a single planned resource set.
3 properties
3 required
BusinessTravelOrderListSchema
object
Schema for business travel order list response.
6 properties
3 required
BusinessTravelOrderCreateSchema
object
Schema for business travel order creation.
4 properties
3 required
BusinessTravelOrderAuditUser
object
Schema describing a user involved in BTO lifecycle events.
2 properties
BusinessTravelOrderDetailSchema
object
Schema for business travel order details. Business travel order is sent by specific set on specific service.
39 properties
6 required
ContactPerson
object
Schema for contact person.
4 properties
TeamMember
object
Schema for Aerones team member.
5 properties
TravelOrderStatus
string
Travel order status.
BusinessTravelOrderUpdateSchema
object
Schema for business travel order updates.
6 properties
BusinessTravelOrderBCLQuestionsSchema
object
BCL specific questions.
3 properties
BusinessTravelOrderICEQuestionsSchema
object
ICE specific questions.
5 properties
BusinessTravelOrderIINOFSQuestionsSchema
object
IIN-OFS specific questions.
9 properties
BusinessTravelOrderIINONSQuestionsSchema
object
IIN-ONS specific questions.
7 properties
BusinessTravelOrderLERQuestionsSchema
object
LER specific questions.
7 properties
BusinessTravelOrderLPSQuestionsSchema
object
LPS specific questions.
5 properties
BusinessTravelOrderQuestionsGeneralSchema
object
General questions applicable to any business travel order.
23 properties
BusinessTravelOrderQuestionsSchema
object
Schema for BTO questionnaire (both read and write operations).
10 properties
1 required
BusinessTravelOrderRATQuestionsSchema
object
RAT specific questions.
4 properties
BusinessTravelOrderTCLQuestionsSchema
object
TCL specific questions.
4 properties
BusinessTravelOrderVINQuestionsSchema
object
VIN specific questions.
2 properties
QuestionField
object
Schema for a single question field with checkbox and description.
2 properties
QuestionnaireRecipientResponse
object
Per-member email/questionnaire tracking for the roster's Email column. Only present for crew members provisioned a questionnaire row, which happens at send. qu…
7 properties
2 required
SiteContactResponse
object
One Pre-Job site contact for the internal set panel's contacts table. Same shape as the crew payload's contact rows. Sourced per project-location from the Pre-…
4 properties
SupervisorResponse
object
One assigned supervisor (an OpsHub user) for the supervisors panel chips.
3 properties
2 required
TeamMemberResponse
object
10 properties
TravelOrderResponse
object
51 properties
12 required
TravelOrderCreateSchema
object
8 properties
3 required
TravelOrderUpdateSchema
object
6 properties
ResendResult
object
2 properties
2 required
CategoryStatusResponse
object
2 properties
2 required
MemberProgressResponse
object
7 properties
6 required
QuestionAnswerResponse
object
5 properties
3 required
SubmitAnswerSchema
object
2 properties
1 required
TravelOrderAnswerValue
string
Canonical answer values, stored lowercase in the answers JSONB to match the design ids (yes | no | needinfo).
CrewAnswerSchema
object
5 properties
3 required
CrewContactSchema
object
4 properties
CrewMemberSchema
object
4 properties
1 required
CrewOverviewResponse
object
Self-contained payload the crew page renders from a single UUID GET. Order essentials + the visitor's own identity + their questionnaire + read-only overview (…
39 properties
5 required
CrewSubmitAnswerSchema
object
2 properties
1 required
CommunicationAttachment
object
A file attached to a communication note or task comment.
3 properties
3 required
CommunicationUser
object
Lightweight user reference used in communication payloads.
3 properties
2 required
ProjectCommentResponse
object
A single project communication note.
10 properties
4 required
ProjectCommentCreate
object
Create a project communication note.
4 properties
1 required
ProjectCommentUpdate
object
Edit a project communication note (author only).
4 properties
CommunicationFeedEntry
object
A unified feed entry — a project note or a surfaced task comment.
13 properties
5 required
MentionCandidate
object
One user available for @-mention in a Set Request note.
3 properties
2 required
RoleMemberListResponse
object
The people a role mention notifies, for the reader-facing role chip. Reuses MentionCandidate so one shape describes a person in the picker and in this list. to…
3 properties
1 required
MentionCandidateListResponse
object
1 property
ProjectScopeChangeRequestQueryParams
object
Query parameters for ProjectScopeChangeRequest list.
6 properties
ProjectScopeChangeRequestStatus
string
Approval-flow statuses for scope change requests.
ProjectScopeChangeRequestType
string
Enum for project scope change types.
ProjectScopeChangeRequestCustomFieldsOut
object
Read-side twin of the custom-fields schema — must never 500 a GET. customfields has no DB type constraint, so a legacy or hand-written row can violate the inpu…
7 properties
ProjectScopeChangeRequestOrigin
string
Which client created the scope change request.
ProjectScopeChangeRequestResponse
object
Schema for project scope change response.
33 properties
6 required
ScopeChangeAdditionalWorkorder
object
One replacement-service ServiceItem to generate on the new SOL. Each entry includes a ServiceItem id and optionally a narrowed list of turbine components. serv…
2 properties
1 required
ProjectScopeChangeRequestCreate
object
Schema for creating a project scope change. The service-replacement linkage (sourceserviceorderlineid and replacementserviceid) and evidence file references (e…
6 properties
2 required
ProjectScopeChangeRequestCustomFields
object
Structured customfields payload for a scope-change request. Inherits extra = "forbid" from the base Schema — unknown keys are rejected with 422. Adding a new k…
7 properties
ScopeChangeCurrentCondition
object
Blade condition found in the field, motivating the scope change.
15 properties
ScopeChangeInitialEvaluationCondition
object
Blade condition as assessed at the initial (pre-sale) evaluation.
13 properties
ProjectScopeChangeRequestUpdate
object
Fields editable on a request that still awaits its first (QC) review. The endpoint 422s on any other status — later review stages, APPROVED (the cascade ran) a…
6 properties
ProjectScopeChangeRequestApproveBody
object
Body for POST /project-scope-change-requests/{id}/approve.
2 properties
1 required
ProjectScopeChangeRequestWaitingStatus
string
The three review stages an approve/reject action may target.
ProjectScopeChangeRequestRejectBody
object
Body for POST /project-scope-change-requests/{id}/reject.
2 properties
2 required
ProjectQueryParams
object
Query parameters for projects endpoint.
19 properties
CountryWithRegionObject
object
CountryObject extended with region — only for responses that prefetch countryregion.
4 properties
3 required
ProjectLocationSummary
object
Summary of sites (locations) linked to a project for list/detail payloads.
3 properties
1 required
ProjectResponse
object
Schema for Project response.
31 properties
5 required
ProjectStatusObject
object
Nested project status object for responses (no timestamps).
2 properties
2 required
StandardObject
object
Nested core.standard object for responses (LPS / HVT templates).
4 properties
4 required
WarrantyCounterpartProjectObject
object
The project on the other side of a warranty relationship (no timestamps). Direction-neutral: the source project (on a WARRANTY project) or the warranty project…
4 properties
3 required
ProjectCreate
object
Schema for creating a Project.
20 properties
1 required
ProjectSearchResult
object
One global-search hit: a project row or a service-order-line (SOL) row. Project rows match on project code or an active linked location name; SOL rows match on…
8 properties
3 required
ProjectUpdate
object
Schema for updating a Project.
21 properties
ProjectOverviewReportRecipient
object
Report recipient (customer contact) shown on the project overview.
2 properties
ProjectOverviewResponse
object
Decoupled project overview payload (Core/dispatch-sourced).
21 properties
1 required
ProjectOverviewRoboticSet
object
Planned resource set name shown on the project overview.
1 property
1 required
ProjectOverviewSite
object
A project site with coordinates for the overview list.
3 properties
ProjectOverviewEdit
object
Editable project overview fields. Writes span Core + legacy tables. Only explicitly-sent keys are applied (excludeunset=True).
6 properties
ProjectOverviewFinancialsResponse
object
Decoupled project financial overview (Core + accounting).
8 properties
1 required
ProjectStatusHistoryEntry
object
A single project status transition (for the overview status timeline).
6 properties
ProjectValidateResponse
object
Response schema for project validation endpoint.
1 property
1 required
ProjectStatusOverride
object
Payload for the manual status-override action endpoint.
2 properties
2 required
ProjectPreJobReceivedUpdate
object
Payload for the pre-job-received action endpoint. Only the null-ness of prejobreceivedat is read: a non-null value marks the questionnaire as submitted (and lo…
1 property
1 required
PurchaseOrderQueryParams
object
Query params for PurchaseOrder list.
4 properties
PurchaseOrderCreate
object
Create a PurchaseOrder with its initial (v1) version. File is optional.
7 properties
5 required
PurchaseOrderUpdate
object
Partial update of the PurchaseOrder-level fields. Version-scoped fields (ordernumber, issuedate, amount) are immutable here — correct them by adding a new vers…
2 properties
PurchaseOrderVersionQueryParams
object
Query params for version list under a PO.
2 properties
PurchaseOrderVersionResponse
object
PurchaseOrderVersion response.
8 properties
7 required
PurchaseOrderVersionCreate
object
Add a new version (amendment) to an existing PO. File is optional.
4 properties
3 required
PurchaseOrderVersionUpdate
object
Partial update of a version's scalar fields. Does not change versionnumber or swap the attached file. To replace the file, use POST /purchase-order-versions/{i…
3 properties
PurchaseOrderVersionFileReplaceRequest
object
Replace the active file linked to a version.
1 property
1 required
PurchaseOrderProjectQueryParams
object
Query params for project link list under a PO.
1 property
PurchaseOrderProjectResponse
object
PurchaseOrderProject link response.
8 properties
4 required
PurchaseOrderProjectCreate
object
Link a project to a PO.
2 properties
1 required
PurchaseOrderProjectUpdate
object
Update the allocation for an existing PO-project link.
1 property
VehicleFleetSummary
object
Summary counts for the fleet vehicles dashboard.
5 properties
5 required
VehicleQueryParams
object
6 properties
NavirecLiveState
object
Live tracking snapshot for a vehicle, joined from Navirec by plate.
8 properties
2 required
VehicleInsuranceResponse
object
5 properties
3 required
VehicleResponse
object
18 properties
8 required
VehicleCreate
object
12 properties
4 required
VehicleUpdate
object
12 properties
VehicleInsuranceCreate
object
4 properties
3 required
VehicleInsuranceUpdate
object
4 properties
VehicleFleetAssignmentDiscrepancies
object
1 property
1 required
VehicleFleetAssignmentDiscrepancy
object
2 properties
2 required
VehicleFleetAssignmentQueryParams
object
6 properties
FocalxInspectionResponse
object
7 properties
3 required
VehicleFleetAssignmentReportResponse
object
10 properties
8 required
VehicleFleetAssignmentResponse
object
19 properties
7 required
VehicleFleetPlanSchema
object
8 properties
3 required
VehicleFleetAcceptSchema
object
12 properties
6 required
UserProjectsQueryParams
object
3 properties
3 required
UserProjectOverlap
object
4 properties
2 required
PlannerStatusResponse
object
1 property
1 required
PlannerStatusResult
object
6 properties
2 required
PlannerStatusItemInput
object
5 properties
1 required
PlannerStatusRequest
object
1 property
1 required
VehicleFleetAcceptPlannedSchema
object
6 properties
3 required
VehicleFleetUpdateSchema
object
6 properties
VehicleFleetReturnSchema
object
6 properties
3 required
VehicleFleetInvoiceQueryParams
object
7 properties
VehicleFleetInvoiceLineResponse
object
9 properties
4 required
VehicleFleetInvoiceResponse
object
9 properties
5 required
VehicleFleetInvoiceCreate
object
6 properties
4 required
VehicleFleetInvoiceLineCreate
object
7 properties
2 required
VehicleFleetInvoiceExtractedLine
object
6 properties
2 required
VehicleFleetInvoiceExtractionResponse
object
11 properties
1 required
VehicleFleetInvoiceLineUpdate
object
8 properties
2 required
VehicleFleetInvoiceUpdate
object
6 properties
FileResourceResponse
object
6 properties
4 required
ObdGpsDeviceQueryParams
object
2 properties
ObdGpsAssignmentVehicle
object
4 properties
4 required
ObdGpsDeviceAssignmentResponse
object
5 properties
2 required
ObdGpsDeviceResponse
object
7 properties
4 required
ObdGpsDeviceCreate
object
3 properties
2 required
ObdGpsDeviceAssignSchema
object
3 properties
1 required
ObdGpsDeviceEndAssignmentSchema
object
1 property
1 required
NavirecSyncErrorItem
object
2 properties
2 required
NavirecSyncResponse
object
4 properties
2 required
ObdGpsDeviceAssignmentFullResponse
object
7 properties
4 required
ObdGpsDeviceUpdate
object
3 properties
VehicleMapLocation
object
7 properties
7 required
VehicleMapLocationVehicle
object
6 properties
6 required
VehicleFleetLocationQueryParams
object
1 property
VehicleFleetLocationResponse
object
2 properties
2 required
ServiceOrderLineQueryParams
object
Query parameters for service order lines listing.
8 properties
ComponentTypeInfo
object
Nested component type info for service order line response.
2 properties
2 required
ProjectInfo
object
3 properties
1 required
ServiceOrderLineResponse
object
Response schema for a single service order line.
13 properties
1 required
TurbineComponentInfo
object
Nested turbine component info for service order line response.
2 properties
1 required
TurbineInfo
object
2 properties
1 required
FilterProjectOption
object
Project option for filters endpoint.
2 properties
1 required
FilterServiceOption
object
Service option for filters endpoint.
2 properties
1 required
FilterTurbineOption
object
Turbine option for filters endpoint.
2 properties
1 required
ServiceOrderLineFiltersResponse
object
Response schema for SOL filters endpoint.
3 properties
3 required
ServiceOrderLineDetailResponse
object
Detail schema for SOL context used in technician service results view.
13 properties
1 required
WorkorderQueryParams
object
Query parameters for workorders listing.
8 properties
WorkorderComponentTypeInfo
object
Nested component type info for workorder response.
2 properties
2 required
WorkorderProjectInfo
object
Nested project info for workorder response.
2 properties
1 required
WorkorderResponse
object
Response schema for a single workorder.
14 properties
1 required
WorkorderTurbineComponentInfo
object
Nested turbine component info for workorder response.
2 properties
1 required
WorkorderTurbineInfo
object
Nested turbine info for workorder response.
2 properties
1 required
FilterSolOption
object
SOL option for workorder filters endpoint.
2 properties
1 required
WorkorderFiltersResponse
object
Response schema for workorder filters endpoint.
4 properties
4 required
SolActivitiesQueryParams
object
Query parameters for SOL activities listing.
1 property
1 required
SolActivitiesPageResponse
object
Response schema for SOL activities page endpoint.
3 properties
2 required
SolActivityAssignedResources
object
Grouped assignment details for an activity.
4 properties
SolActivityResponse
object
Response schema for a single activity in the SOL activities view.
27 properties
3 required
SolInfo
object
SOL context info for the SOL activities page header.
20 properties
SolScopeChange
object
Scope-change context for SOL/workorder header banners. turbinecomponent is set for per-blade changes (the source line stays active and only that blade's work m…
4 properties
2 required
SolScopeChangeComponent
object
The blade a per-blade scope change applies to.
3 properties
1 required
SolScopeChangeLinkedSol
object
The counterpart SOL on the other side of a scope change.
3 properties
1 required
WorkorderActivityResourceLink
object
Resource assignment row on a workorder activity. Mirrors the dict shape returned by :py:attr:dispatch.models.WorkorderActivity.activityresources (one entry per…
5 properties
2 required
AvailableResourceInfo
object
Available resource option for activity assignment edit.
3 properties
1 required
WorkorderDetailResponse
object
Response schema for a single workorder detail.
19 properties
1 required
WorkorderResourceInfo
object
Nested resource info for workorder detail response.
4 properties
1 required
WorkorderRobotSetInfo
object
Available robot set option for workorder activity assignments.
2 properties
1 required
AvailableActivityResponse
object
Response schema for an available service item activity.
4 properties
2 required
ResourcePresetMember
object
A single member of a resource preset (ProjectResourceSet).
4 properties
2 required
ResourcePresetResponse
object
A project resource set available as a team preset.
4 properties
3 required
DashboardSummaryQueryParams
object
Query parameters for operations dashboard summary.
4 properties
DashboardSummaryResponse
object
Operations dashboard summary KPI payload.
7 properties
7 required
DashboardQueueQueryParams
object
Query parameters for operations dashboard queue.
6 properties
DashboardQueueItem
object
One queue row for operator review.
8 properties
1 required
ServiceResultRecord
object
Normalized service result record for dashboard and detail endpoints.
19 properties
7 required
ServiceResultStandardInfo
object
Nested standard metadata for a service result row.
3 properties
1 required
ServiceResultTemplateInfo
object
Nested template metadata for a service result row.
2 properties
1 required
ServiceResultTurbineComponentInfo
object
Nested turbine component metadata for a service result row.
2 properties
1 required
ServiceResultWorkorderInfo
object
Nested workorder metadata for a service result row.
3 properties
1 required
ServiceResultListQueryParams
object
Query parameters for SOL service results listing.
18 properties
ServiceResultMutationResponse
object
Mutation response for create/update service result endpoints.
1 property
1 required
ServiceResultCreateInput
object
Create payload for service results from technician SOL flow.
6 properties
1 required
BladeComponent
object
Turbine blade component reference for BCL upload tabs.
3 properties
1 required
ResultCaptureContextResponse
object
Context payload for technician result capture drawer/form.
21 properties
2 required
ResultCaptureStandard
object
Standard option for result capture.
4 properties
4 required
ResultCaptureTemplate
object
Template definition for result capture context.
6 properties
5 required
ResultCaptureTemplateField
object
Field configuration for dynamic result entry form.
10 properties
6 required
ResultCaptureThreshold
object
Threshold definition exposed to frontend for transparency.
6 properties
3 required
FinalizeServiceResponse
object
Response after finalizing a service order line.
4 properties
2 required
ServiceResultUpdateInput
object
Patch payload for service result records.
6 properties
SolCleaningImagesResponse
object
SOL-level cleaning image references keyed by category.
1 property
1 required
SolCleaningImagesInput
object
Patch payload for SOL cleaning images.
1 property
1 required
DailyReportSolQueryParams
object
Query parameters for the SOL preview table on the daily reports page.
6 properties
DailyReportSolResponse
object
Response schema for a single SOL in the daily reports preview.
33 properties
1 required
DailyReportSubmittedByUser
object
Submitted-by user identity for selected-date draft metadata.
2 properties
2 required
DownloadReportRequest
object
Request body for generating a daily report.
6 properties
1 required
SendReportResponse
object
Response payload for successful daily report send action.
4 properties
3 required
SendReportRequest
object
Request body for sending a daily report via the reporting engine.
7 properties
1 required
FinalReportRequest
object
Request body for generating a final report for a single SOL.
3 properties
1 required
FinalReportStateQueryParams
object
Query params for the final-report modal state endpoint.
1 property
1 required
FinalReportGenerationSummary
object
A single final-report generation, used in the modal state payload.
5 properties
2 required
FinalReportStateResponse
object
State the Final Report modal needs on open. latestcompleted drives the "Previously generated report" button and its tooltip; inprogress lets the modal resume t…
2 properties
DispatchServiceQuery
object
Query params for listing dispatch services.
2 properties
DispatchService
object
Dispatch service.
4 properties
2 required
ServiceItemQuery
object
Query params for listing service items.
3 properties
ServiceItem
object
Dispatch service item.
8 properties
2 required
ServiceItemActivityQuery
object
Query params for listing service item activities.
2 properties
ServiceItemActivity
object
Dispatch service item activity.
8 properties
1 required
ServiceItemActivityAttachment
object
File (image or video) attached to a service-item-activity instruction. Mirrors the GraphQL ServiceItemActivityAttachment type. url is an authenticated proxy UR…
6 properties
3 required
ServiceItemActivityInstruction
object
One ordered procedure step on a service-item-activity.
6 properties
2 required
ServiceItemActivityInstructionLink
object
Web link on a service-item-activity instruction.
4 properties
3 required
ServiceOrderQuery
object
Query params for listing service orders.
4 properties
ServiceOrderHeader
object
Dispatch service order header.
12 properties
3 required
ServiceOrderHeaderInput
object
Payload for creating/updating service order headers.
11 properties
ServiceOrderClientCount
object
Count of service orders by client.
2 properties
2 required
ServiceOrderSummary
object
Service order summary response.
3 properties
3 required
ServiceOrderTypeCount
object
Count of service orders by type.
2 properties
2 required
ServiceOrderLineQuery
object
Query params for listing service order lines.
8 properties
ServiceOrderLine
object
Dispatch service order line.
21 properties
1 required
ServiceOrderLineInput
object
Payload for creating/updating service order lines.
18 properties
WorkorderQuery
object
Query params for listing workorders.
10 properties
Workorder
object
Dispatch workorder.
26 properties
1 required
AdminWorkorderActivityInput
object
Input for admin workorder activities (simplified).
6 properties
1 required
WorkorderInput
object
Payload for creating/updating workorders.
22 properties
WorkorderSummary
object
Workorder summary response.
3 properties
3 required
WorkorderActivityCount
object
Workorder activity count.
2 properties
2 required
WorkorderActivityCountsResponse
object
Workorder activity counts response.
1 property
1 required
WorkorderActivityQuery
object
Query params for listing workorder activities.
4 properties
WorkorderActivity
object
Dispatch workorder activity.
24 properties
1 required
WorkorderActivityCreateInput
object
Payload for creating a workorder activity. Extends the base input with isoptional, which is only valid on create. Clients may send isoptional=True when a sibli…
24 properties
WorkorderBulkInput
object
Payload for bulk-creating workorders.
1 property
1 required
WorkorderCancelInput
object
Payload for cancelling a workorder.
1 property
1 required
WorkorderActivityInput
object
Payload for creating/updating workorder activities.
23 properties
DelayBulkTeamUpdateItem
object
Single delay team update item for bulk update.
3 properties
1 required
WorkorderActivityBulkUpdateInput
object
Payload for bulk-updating workorder activities (and optionally delay teams).
4 properties
WorkorderActivityBulkUpdateItem
object
Single workorder activity patch item for bulk update.
24 properties
1 required
WorkorderActivityTimeEdit
object
Audit row for a start/end datetime change on a workorder activity.
12 properties
4 required
WorkorderPlanQuery
object
Query params for listing workorder plans.
3 properties
WorkorderPlan
object
Dispatch workorder plan.
12 properties
6 required
WorkorderPlanInput
object
Payload for creating/updating workorder plans.
9 properties
WorkTimeLogQuery
object
Query params for listing work time logs.
9 properties
WorkTimeLog
object
Dispatch work time log.
27 properties
1 required
WorkTimeLogInput
object
Payload for creating/updating work time logs.
25 properties
WorkorderStatusChangeQuery
object
Query params for listing workorder status changes.
1 property
WorkorderStatusChange
object
Dispatch workorder status change log.
8 properties
1 required
WorkorderActivityMetadataQuery
object
Query params for listing workorder activity metadata.
1 property
WorkorderActivityMetadata
object
Dispatch workorder activity metadata entry.
3 properties
2 required
WorkorderActivityMetadataInput
object
Payload for creating workorder activity metadata.
2 properties
1 required
WorkorderActivityMetadataPatchInput
object
Payload for partially updating workorder activity metadata.
2 properties
BoardDataResponse
object
Full response for the dispatching board.
6 properties
3 required
BoardWorkorderActivityResponse
object
A workorder activity surfaced on the board. status / durationminutes drive the card's activity strip (a proportional coloured segment per activity). customfiel…
8 properties
1 required
BoardWorkorderResponse
object
A workorder for the dispatching board. actualstartdatetime is the earliest non-cancelled activity's own startdatetime -- null until the team actually starts wo…
22 properties
2 required
DispatchResourceSetResponse
object
A project resource set with its members.
7 properties
3 required
MissedPlanResponse
object
A planned slot the board still shows on its original day -- a historical, non-interactive record. kind MISSED: not completed by its planned day and returned to…
7 properties
6 required
PendingScopeCommitmentResponse
object
One PENDING scope-dispatch commitment (DISP-3249) -- no SOL/Workorder yet.
9 properties
5 required
ResourceSetMemberResponse
object
A member (resource) within a project resource set.
5 properties
3 required
ServiceOrderLineGroup
object
A service order line with its child workorders.
11 properties
2 required
WorkorderResourceResponse
object
A resource assigned to a workorder.
3 properties
2 required
BoardTurbineActivityGroupResponse
object
One activity group (ServiceItem phase) on a turbine, with how many of its activities are completed vs the total (excludes CANCELLED activities).
3 properties
3 required
BoardTurbineResponse
object
A project-scope turbine (WTG) with its combined status. status is a rollup of the turbine's non-cancelled workorders across the whole project (any date), indep…
4 properties
2 required
BoardTurbinesResponse
object
1 property
1 required
BacklogAssignmentCounts
object
Unassigned/assigned totals for the sidebar toggle (search scope only).
2 properties
2 required
BacklogCounts
object
Facet counts for the sidebar filter chips. Each facet is counted over the search + assignment scope BEFORE that facet's own filter is applied (standard facetin…
5 properties
4 required
BacklogFacetCount
object
One facet value with its count. List-of-objects rather than a value-keyed dict so the frontend's camel/snake response transform can't mangle enum-ish keys like…
2 properties
2 required
BacklogPageResponse
object
One page of the server-filtered sidebar work-order list.
4 properties
4 required
BoardWeatherResponse
object
Hourly weather for the dispatching day-Gantt. available is False (with an empty hours list) when the project's primary location has no coordinates or the forec…
6 properties
2 required
WeatherHourResponse
object
One hour of forecast weather for the project's location. Units reflect what the Gust gateway returns (assumed m/s for wind, degrees C for temperature/dew point…
8 properties
1 required
ProjectCoverageDay
object
One day's worth of resource-set coverage for a project.
2 properties
2 required
ProjectCoverageResponse
object
Per-project resource-set coverage for a date window. dailyfilled is a list of {date, filled} entries — list-of-objects rather than a date-keyed dict so the axi…
3 properties
3 required
AdoptionCell
object
One non-empty team-day. date is ISO YYYY-MM-DD in the project's local timezone; cells are a list, not a date-keyed dict, so the frontend camel-case interceptor…
5 properties
5 required
AdoptionLoggedItem
object
3 properties
2 required
AdoptionMissedItem
object
3 properties
2 required
AdoptionPendingItem
object
3 properties
1 required
AdoptionPerson
object
4 properties
3 required
AdoptionRow
object
10 properties
6 required
AdoptionTableResponse
object
4 properties
4 required
AdoptionWorkorderItem
object
5 properties
3 required
SupervisorOption
object
A BTO supervisor and the core projects they supervise (DISP-2905).
2 properties
2 required
AssignWorkorderPayload
object
Payload for assigning a workorder to resources on a datetime. assigneeresourceid optionally pins the workorder to a single individual within the set (ADMIN WOs…
5 properties
3 required
BulkAssignWorkordersPayload
object
Payload for bulk-assigning workorders to resources.
1 property
1 required
UnassignWorkorderPayload
object
Payload for unassigning a workorder.
1 property
1 required
UpdateAdminWorkorderResponse
object
4 properties
4 required
UpdateAdminWorkorderPayload
object
Payload for editing an existing ADMIN workorder's name/duration (DISP-2892). durationminutes only moves plannedenddatetime -- plannedstartdatetime (and therefo…
2 properties
2 required
SetWorkorderTurbinePayload
object
Payload for binding a turbine to a scope-dispatched workorder.
1 property
1 required
CreateAdminWorkorderResponse
object
Result of creating an ADMIN workorder.
5 properties
3 required
AdminActivityInput
object
One activity, shared by "create a new ADMIN workorder" (DISP-2379) and "add an activity to an already-created one" (addworkorderactivity below). estimateddurat…
3 properties
1 required
CreateAdminWorkorderPayload
object
Payload for creating an ADMIN workorder pinned to a single technician. An admin workorder is standalone work (no service order line) scoped to the currently-op…
6 properties
5 required
AddWorkorderActivityResponse
object
Result of adding an activity to an existing ADMIN workorder.
3 properties
2 required
UpdateWorkorderActivityResponse
object
5 properties
4 required
UpdateWorkorderActivityPayload
object
Payload for editing one activity on an existing ADMIN workorder (DISP-2892) -- name, duration, and the image-required toggle.
3 properties
1 required
ScopeGroupResponse
object
One scope bucket. remaining = total minus pending commitments and items already claimed by an actively dispatched workorder. defaultkpiminutes is the benchmark…
7 properties
6 required
CreateScopeWorkorderResponse
object
quantity independent pending commitments, window split evenly.
3 properties
3 required
ScopeDispatchCommitmentItem
object
One pending commitment row.
4 properties
4 required
CreateScopeWorkorderPayload
object
Payload for dispatching a team against a scope bucket. componenttypeid identifies which bucket's ProjectScopeItems this dispatch targets when a service spans m…
6 properties
4 required
ScopeCommitmentTurbineOption
object
A turbine this commitment can actually resolve to.
2 properties
1 required
ResolveScopeCommitmentPayload
object
turbinecomponentid disambiguates component-level buckets.
2 properties
1 required
RescheduleScopeCommitmentPayload
object
Payload for rescheduling (and optionally re-teaming) a still-pending scope-dispatch commitment.
3 properties
2 required
DayCommentaryResponse
object
One day-commentary entry.
6 properties
4 required
DayCommentaryPayload
object
Payload for a dispatcher's free-form note about one day (DISP-2285).
3 properties
2 required
ServiceKpiResponse
object
One service's KPI (benchmark duration) setting for a project (DISP-2988). kpiminutes is what the dispatching board actually uses for this service on this proje…
5 properties
5 required
SetServiceKpiPayload
object
Payload to set a project's KPI override for one service (DISP-2988).
1 property
1 required
TeamMessageAttachmentResponse
object
One image attached to a team message.
2 properties
1 required
TeamMessageResponse
object
A team message with its current (possibly still-pending) reaction.
10 properties
7 required
CreateTeamMessagePayload
object
Payload for a dispatcher message to a team, dated today or later (DISP-2288). Images are pre-uploaded via POST /core/v1/files/ (bare); their ids are passed her…
4 properties
3 required
PlatformClient
object
Definition of a client in the platform.
2 properties
2 required
PlatformClients
object
Definition of a list of clients in the platform.
1 property
1 required
DailyReport
object
Schema for daily report from Platform.
11 properties
6 required
DailyReportDay
object
Schema for a day's daily reports from Platform.
3 properties
1 required
DailyReportService
object
Schema for service in daily report.
3 properties
3 required
DailyReportWinchSet
object
Schema for winch set in daily report.
2 properties
2 required
DailyReportsResponse
object
Schema for daily reports response.
1 property
MissingReport
object
Schema for missing daily report from Platform.
4 properties
2 required
MissingReportWorkorder
object
Schema for workorder in missing report.
2 properties
2 required
ProjectListQuery
object
Query parameters for project list endpoint.
8 properties
Client
object
Schema for client.
2 properties
Country
object
Schema for Country.
3 properties
2 required
ProjectList
object
Schema for project list.
15 properties
6 required
UserStatus
string
Enum for user-defined project statuses.
WindparkProjectList
object
Schema for windpark in project list.
2 properties
Project
object
Schema for project.
19 properties
5 required
ProjectOfferStatus
string
Project level Offer status.
ProjectSiteSimple
object
Schema for project site information.
3 properties
ProjectPOST
object
Schema for project creation.
2 properties
ProjectServiceCode
object
Schema for a project service code entry with manufacturer/model context.
7 properties
2 required
ProjectPassword
object
Schema for project password.
1 property
1 required
ProjectEmailResponse
object
Schema for project email response.
2 properties
2 required
ProjectEmailRequest
object
Schema for project email request.
1 property
1 required
UserStatusPayload
object
Schema for updating userstatus.
2 properties
1 required
Customer
object
Schema for customer.
6 properties
1 required
RelatedProjectsQuery
object
Query parameters for related projects endpoint.
1 property
RelatedProject
object
Schema for related project with code, id, client name and match score.
4 properties
2 required
RelatedProjectsResponse
object
Schema for related projects response.
1 property
ProjectLead
object
Schema for project lead.
4 properties
ProjectRFIGeneralEdit
object
Schema for project general creation.
6 properties
ProjectRFIGeneral
object
Schema for project general.
7 properties
InvoicingMethod
string
Invoicing method definitions.
ProjectBilling
object
Schema for project billing. Currency is mandatory and defaults to EUR if not provided. All other fields are optional.
18 properties
PaymentTerms
string
Payment terms definitions.
ProjectBillingEdit
object
Schema for project billing update.
18 properties
ProjectPrefillQuery
object
Query parameters for project prefill endpoints.
1 property
1 required
Prefill_EmailStr_
object
2 properties
1 required
Prefill_InvoicingMethod_
object
2 properties
1 required
Prefill_bool_
object
2 properties
1 required
Prefill_float_
object
2 properties
1 required
Prefill_str_
object
2 properties
1 required
ProjectBillingPrefilled
object
Schema for project billing prefilled data.
14 properties
Coordinates
object
Schema for coordinates.
2 properties
2 required
ProjectSite
object
Schema for project site in RFI stage.
6 properties
2 required
ProjectSites
object
Schema for project sites. Project can contain multiple sites an each site is some collection of turbines. It is not given that all turbines from the site are i…
1 property
SiteAccessConditions
string
Condition definitions for site. The conditions primarily define some restrictions to access specific site. They primarily drive some costs and additional servi…
ProjectSiteEdit
object
Schema for project site edit in RFI stage.
6 properties
2 required
ProjectSitesEdit
object
Schema for project sites update.
1 property
1 required
FileAttachment
object
File attachment response. Defines the structure of a single file uploaded to the server.
3 properties
3 required
ProjectSiteAccess
object
Schema for project site access.
6 properties
ProjectSiteAccessEdit
object
Schema for project site access update.
6 properties
AssetGroupService
object
Single combination of asset group and it's assigned services within project.
11 properties
3 required
AssetGroupType
string
Asset group type definitions.
AssetServiceSelection
object
User selection of services for particular assets.
8 properties
3 required
CodeWithName
object
Schema for code and name.
2 properties
2 required
ProjectAssetGroup
object
Schema for assets of turbines and blades and their services.
1 property
ServiceCondition
object
Schema for service condition.
2 properties
2 required
ServiceConditionValue
object
Schema for describing specific service condition/level.
4 properties
2 required
AssetGroupServiceEdit
object
Single asset group edit on a single project.
11 properties
2 required
AssetServiceUserSelection
object
User selection of a particular service for specific asset group.
4 properties
2 required
ProjectAssetGroupEdit
object
Schema for editing assets of turbines and blades and their services.
1 property
1 required
ServiceConditionUserSelection
object
User selection of service condition.
3 properties
2 required
Prefill_AssetGroupService_
object
2 properties
1 required
ProjectAssetGroupPrefilled
object
Schema for prefilled asset groups.
1 property
ProjectAsset
object
Schema for a single project asset.
23 properties
17 required
ProjectAssetTableResponse
object
Schema for project assets table response.
1 property
1 required
ProjectAssetCreate
object
Schema for creating a new WTG asset.
9 properties
8 required
MessageWithSuccess
object
Success response schema with message.
2 properties
1 required
ProjectAssetPatch
object
Schema for patching a ProjectAsset. Only the fields that are provided will be updated. Other fields will remain unchanged.
5 properties
CustomerAssetFiles
object
Schema for customer asset files request.
1 property
1 required
CustomerAssetFilesList
object
Schema for customer asset files response.
1 property
1 required
CurrencyRef
object
Nested currency reference.
2 properties
2 required
ItemCoefficient
object
Schema for item coefficient information.
3 properties
3 required
LineItem
object
Schema for offer line item.
26 properties
1 required
Offer
object
Schema for project offer.
11 properties
5 required
OfferStatus
string
Individual offer level status.
PricingUnitRef
object
Nested pricing unit reference.
2 properties
2 required
ProjectOffer
object
Schema for project offer response.
1 property
1 required
ServiceRef
object
Nested service reference.
3 properties
2 required
OfferUpdate
object
Schema to set commercial values on the current draft offer.
5 properties
LineItemDiff
object
Schema for line item differences between offer versions.
20 properties
3 required
OfferChangeSummary
object
Schema for high-level changes between offer versions.
5 properties
3 required
OfferComparison
object
Schema for offer version comparison.
9 properties
7 required
OfferApprovalRequest
object
Schema for enhanced offer approval request.
1 property
OfferRejectRequest
object
Schema for offer rejection request.
1 property
1 required
ServiceLineItemCreate
object
Schema for creating a new commercial offer line item.
18 properties
1 required
LineItemUpdate
object
Schema for updating a line item. Bulk update is service-line-item only and rowid-based.
17 properties
LineItemsUpdate
object
Schema for updating multiple line items.
1 property
1 required
ServiceLineItemEdit
object
Schema for editable fields on service line items.
18 properties
ProjectBTO
object
Minimal BTO overview response schema, sourced entirely from Core.
11 properties
2 required
RamsDocumentResponse
object
Serialised RAMS document.
36 properties
17 required
RamsDocumentCreateBody
object
Body for creating a new RAMS document.
11 properties
2 required
RamsSetOption
object
5 properties
2 required
RamsSetOptionsResponse
object
1 property
RamsDocumentUpdateBody
object
Body for patching a RAMS document.
16 properties
RamsTechAckSummary
object
Per-technician acknowledgement summary for the internal detail panel.
5 properties
4 required
AckState
string
Per-person acknowledgement state on the signing roster.
RamsRosterCertificate
object
2 properties
2 required
RamsRosterEntry
object
12 properties
3 required
RamsRosterResponse
object
5 properties
1 required
RosterSource
string
Where the signing roster was derived from.
RamsSendSelectionBody
object
Optional recipient selection for the send-to-new-technicians top-up. technicianemails restricts the top-up to the chosen crew members; an omitted body (or None…
1 property
RamsDuplicateBody
object
Body for duplicating a RAMS document.
4 properties
RamsAttachmentResponse
object
Serialised RAMS attachment.
7 properties
6 required
RamsApprovalResponse
object
Serialised RAMS approval request.
14 properties
7 required
RamsStatusResponse
object
Lightweight status check response.
5 properties
1 required
RamsClientRespondBody
object
Body for client approval / rejection.
3 properties
1 required
RamsTemplateImageResponse
object
Serialised HSE-uploaded default image.
5 properties
5 required
RamsTemplateResponse
object
Serialised RAMS template.
15 properties
5 required
RamsTemplateCreateBody
object
Body for creating a new RAMS template. servicefamilyid (and the optional serviceid narrowing) fix what the template is for and are immutable afterwards; region…
7 properties
1 required
RamsTemplateResolvedResponse
object
Resolved template content for starting a new RAMS document.
6 properties
RamsTemplateScopeBody
object
New scope for a template (region / country / customer).
3 properties
RamsTemplateUpdateBody
object
Body for patching a RAMS template.
3 properties
DailyWeatherListResponse
object
Response schema for weather data list.
2 properties
2 required
DailyWeatherSchema
object
Schema for a single day's weather data.
6 properties
5 required
TimePeriodWeather
object
Weather values for a single time period.
3 properties
WeatherValueUpdate
object
Schema for updating a single weather value.
3 properties
2 required
WeatherResetRequest
object
Schema for resetting weather values to API values.
2 properties
AvailableServiceOption
object
A service option from core.Service.
3 properties
3 required
AvailableServicesResponse
object
Response schema for available services.
1 property
1 required
AvailableRobotSetOption
object
A robot set option from core.RobotSet.
2 properties
2 required
AvailableRobotSetsResponse
object
Response schema for available robot sets.
1 property
1 required
AvailableResourceOption
object
A resource option from core.Resource.
3 properties
1 required
AvailableResourcesResponse
object
Response schema for available resources.
1 property
1 required
ProjectRobotSetSchema
object
Schema for a robotic set.
9 properties
ResourceSetItemSchema
object
Schema for a resource set item (technician or robot from core.Resource).
7 properties
3 required
RobotSetsAndTeamsResponse
object
Response schema for robot sets and teams data.
1 property
1 required
ProjectRobotSetInput
object
Input schema for a robotic set.
7 properties
RobotSetsAndTeamsUpdate
object
Update schema for robot sets and teams.
1 property
1 required
AssetsServicesCompletion
object
Schema for assets/services forms completion data.
5 properties
5 required
FormCompletion
object
Schema for form completion data.
3 properties
3 required
PreJobCompletion
object
Schema for Pre-job forms completion data.
7 properties
7 required
ProjectOverviewPercentages
object
Schema for project overview completion percentages.
5 properties
5 required
RFICompletion
object
Schema for RFI forms completion data.
7 properties
7 required
TechnicianSimple
object
Simplified schema for technician with only essential fields.
4 properties
4 required
DuplicateScopeItem
object
A requested scope item that already has a live SOL (duplicate guard).
3 properties
2 required
ScopeItemGenerationResult
object
Result for a single scope item in service order generation.
4 properties
3 required
ServiceOrderGenerateResponse
object
Response from service order generation.
6 properties
OptionalServiceItemGeneration
object
Opt-in (and optionally narrow) for one optional ServiceItem. Used by the bulk service-order generation endpoint where required ServiceItems are auto-included;…
2 properties
1 required
ScopeItemGenerationConfig
object
Configuration for generating from a single scope item.
2 properties
1 required
ServiceOrderGenerateRequest
object
Request payload for generating service orders.
2 properties
1 required
GenerateLineWorkordersResponse
object
Response from generating additional workorders for a line.
1 property
ActivityOverride
object
Per-ServiceItem customization of which template activities get created.
3 properties
1 required
ComponentOverride
object
Per-ServiceItem narrowing of which turbine components get a workorder. Used by the line-level workorder generation endpoint, where the caller already specifies…
2 properties
1 required
GenerateLineWorkordersRequest
object
Request payload for generating additional workorders from a ServiceOrderLine.
6 properties
1 required
GenerationItem
object
A ProjectScopeItem record for generation selection.
14 properties
5 required
GenerationLocation
object
Location option for generation filter dropdown.
2 properties
2 required
GenerationService
object
Service option for generation filter dropdown.
6 properties
6 required
GenerationServiceItem
object
Service item info for workorder generation preview.
7 properties
4 required
ServiceOrderGenerationDataResponse
object
Response for GET generation data endpoint.
5 properties
5 required
TurbineComponentOption
object
A selectable turbine component for workorder generation.
4 properties
3 required
WorkorderBreakdownItem
object
Breakdown of workorders per service item with selectable components.
7 properties
3 required
FieldCompletedAtDebug
object
Tooltip data for SOL fieldcompletedat.
1 property
LineCompletedAtDebug
object
Tooltip data for SOL completedat (office finalization).
2 properties
ProjectServiceOrderListItem
object
Service order line for paginated list (without nested workorders).
23 properties
5 required
ServiceOrderDeleteCounts
object
Deletion counts for service order cleanup.
4 properties
4 required
ServiceOrderDeleteResponse
object
Response for service order deletion.
2 properties
2 required
ServiceOrderHeaderOption
object
Compact service order header for filter dropdowns.
2 properties
2 required
ServiceOrderLocation
object
Location summary for service order page.
2 properties
2 required
ServiceOrderSummaryResponse
object
Response for GET service order summary endpoint.
11 properties
1 required
CustomerCustomFieldResponse
object
A customer custom field definition, as any record's REST surface returns it. Serialized straight from a core.CustomerCustomField row. options is what the field…
9 properties
5 required
CustomerCustomValueResponse
object
One stored customer custom field value, embedded in its record's response.
5 properties
4 required
ServiceOrderLineDetail
object
Service order line detail response.
25 properties
3 required
ServiceOrderLineScopeChange
object
Scope-change context for a SOL (source or new-SOL side).
4 properties
2 required
ServiceOrderLineScopeChangeComponent
object
The blade a per-blade scope change applies to.
3 properties
1 required
ServiceOrderLineScopeChangeLinkedSol
object
The counterpart SOL on the other side of a scope change.
3 properties
1 required
WarrantyServiceOrderRef
object
A warranty SOL derived from this line (lives in the warranty project).
11 properties
1 required
CustomerCustomValueInput
object
One value to store against a customer custom field, on the record the URL names.
2 properties
1 required
ServiceOrderLineCustomerCustomFieldValuesReplace
object
The full set of customer custom field values to store on one line. Replace semantics: a field the viewer can see and leaves out is cleared, a field the viewer…
1 property
1 required
CreateWarrantyWorkResponse
object
Response from creating a warranty-work SOL.
12 properties
8 required
CreateWarrantyWorkRequest
object
Request payload to create a warranty-work SOL from this SOL. Targeting defaults to mirroring the original (component overrides and explicit component targeting…
3 properties
CompletedAtDebug
object
Breakdown of how the completion timestamp was derived.
3 properties
ServiceOrderLineWorkorder
object
Workorder for service order line detail.
14 properties
5 required
WorkorderDetail
object
Workorder detail response.
19 properties
2 required
WorkorderResource
object
Resource assigned to a workorder.
3 properties
1 required
WorkorderActivityDetail
object
Workorder activity response.
10 properties
1 required
AvailableActivity
object
Available activity option for workorder activity creation.
4 properties
2 required
ProjectWorkorderListItem
object
Workorder list item for project workorders tab.
13 properties
3 required
WorkorderNestedIdName
object
Nested object with id and name.
2 properties
1 required
WorkorderNestedIdSerial
object
Nested object with id and serial.
2 properties
1 required
AdminWorkorderActivity
object
Activity for admin workorder.
9 properties
1 required
AdminWorkorderAssignee
object
Assignee for admin workorder.
2 properties
1 required
AdminWorkorderDetail
object
Admin workorder detail response.
23 properties
3 required
UnplannedServiceItem
object
Unplanned service item that doesn't have a workorder yet.
7 properties
4 required
DeleteWorkorderResponse
object
Response from deleting an unplanned workorder.
2 properties
1 required
StatusChangeLogEntry
object
A single workorder status change log entry.
8 properties
1 required
CreateStatusChangeLogRequest
object
Request to create a new status change log entry.
4 properties
2 required
WorkorderStatusLogValue
string
Valid workorder status values for status change log entries.
SolStatusChangeLogGroup
object
Status change log entries grouped by workorder.
4 properties
2 required
BulkCreateStatusChangeLogRequest
object
Request to bulk-create status change log entries for multiple workorders.
2 properties
2 required
BulkDeleteStatusChangeLogRequest
object
Request to bulk soft-delete status change log entries.
1 property
1 required
TeamRequestLocationRef
object
2 properties
2 required
TeamRequestResponse
object
26 properties
8 required
TeamRequestServiceRef
object
One service this TR's set will perform (offer-scoped).
3 properties
2 required
TeamRequestSlotResponse
object
11 properties
2 required
TeamRequestCreate
object
8 properties
2 required
CertificateInfo
object
A pre-job-resolved cert (a Certificate row matched by name).
2 properties
2 required
SiteOptionsResponse
object
Services + cert preview for a project's commercial-offer scope. Services are sourced from ProjectOfferItem rows on the project's latest ProjectOffer. With proj…
3 properties
SiteServiceOption
object
One service priced on the project's latest commercial offer.
3 properties
2 required
RobotSetOptionResponse
object
6 properties
3 required
SetOptionsResponse
object
1 property
OfferPair
object
5 properties
4 required
OfferPairsResponse
object
1 property
TeamRequestUpdate
object
7 properties
CertDriftItem
object
One cert that's been added or removed in pre-job vs the TR snapshot.
2 properties
2 required
CertDriftResponse
object
Diff between TR's required-cert snapshot and pre-job's current set. canapply reflects the FSM rule that re-syncing certs once the TR has been sent to the plann…
5 properties
ResolveCertTokenPayload
object
Body for POST /team-requests/{id}/resolve-cert-token. The doc-controller picks one unresolved token and tells the server what to do with it: map it to an exist…
4 properties
2 required
TeamRequestDuplicate
object
5 properties
TeamRequestEventResponse
object
One row in the unified TR timeline. Carries the union of status-change and activity fields; the eventtype discriminator tells the frontend how to render it (ST…
11 properties
4 required
TeamRequestNoteCreate
object
POST .../notes body — free-form note with optional @-mentions. mentioneduserids is persisted as a sidecar list on the activity row so a later email-notificatio…
2 properties
1 required
TeamRequestSlotUpdate
object
Per-slot PATCH payload. Cert-set replace + lead-transfer.
2 properties
SlotRejectPayload
object
POST .../slots/{id}/reject body. Reason is persisted on the slot.
1 property
1 required
ApplicabilityResponse
object
5 properties
1 required
ProjectRequirementResponse
object
14 properties
7 required
ApplicabilityInput
object
Typed-FK applicability row. Scope is read from the populated columns; at most one of {projectid, turbineid}; project rows never carry customerid.
4 properties
ProjectRequirementCreate
object
5 properties
2 required
AssetOption
object
A pickable turbine (v1 assets are turbine-only).
2 properties
2 required
ProjectRequirementOptionsResponse
object
Pickable options for the modal: services from the project's latest offer + turbines from its scope items. currentprojectid is the resolved core id of the URL p…
3 properties
ServiceOption
object
3 properties
2 required
ProjectRequirementUpdate
object
5 properties
GateCheckResponse
object
2 properties
1 required
GateMissingRequirement
object
4 properties
3 required
FamiliarityResponse
object
4 properties
4 required
FamiliarityCreate
object
2 properties
1 required
CruProjectRequirementCreate
object
cru data-operator create. customerid is the requirement's owning (root) customer; null for Aerones-owned / project / turbine-general requirements.
6 properties
2 required
RequirementVersionResponse
object
4 properties
2 required
ItemCategoryListResponse
object
1 property
ItemListResponse
object
1 property
ItemResponse
object
One entry in the shared core.item catalog. Editable so PMs can fix typos in place instead of forking a new entry. source is informational — the FE tags user-ad…
5 properties
4 required
ItemCreate
object
2 properties
2 required
ItemUpdate
object
1 property
1 required
SetRequestInheritCandidate
object
A prior PICKEDUP SR (any project) whose lines can seed a new EXISTINGSET request for the same robot set.
8 properties
3 required
SetRequestInheritCandidateItem
object
One line of a prior SR, ready to copy into the create form.
7 properties
4 required
SetRequestItemSuggestion
object
Server-suggested item / PPE line for the create modal preview.
14 properties
SetRequestPrefillOptionsResponse
object
Read-only snapshot the create modal renders. Mirrors team-request's set-options shape but adds the item preview the PM can edit before submitting.
9 properties
1 required
SetRequestItemResponse
object
15 properties
2 required
SetRequestResponse
object
33 properties
6 required
SetRequestCreate
object
8 properties
1 required
SetRequestItemInput
object
One item / PPE line on a Set Request payload.
9 properties
SetRequestUpdate
object
4 properties
SetRequestEventResponse
object
One row in the unified Set Request timeline. Mirrors TeamRequestEventResponse shape so the FE can render notes, @-mentions, and history with the same component…
10 properties
4 required
SetRequestNoteCreate
object
POST .../notes body — free-form note with optional @-mentions.
3 properties
1 required
SetRequestApproveCurrent
object
2 properties
SetRequestChangeAndApprove
object
2 properties
1 required
SetRequestReject
object
2 properties
1 required
SetRequestReadinessToggle
object
1 property
SetDemobResponse
object
19 properties
6 required
SetDemobCreate
object
3 properties
2 required
SetDemobAnchorCandidate
object
A ROBOT PPRSI a manual demob can be anchored on (picker option).
6 properties
2 required
SetDemobEventResponse
object
9 properties
3 required
SetDemobApprove
object
2 properties
SetDemobAdjustDate
object
2 properties
1 required
SetDemobReject
object
1 property
1 required
SetDemobCancel
object
1 property
ProjectMeta
object
6 properties
6 required
RamsDocumentReadinessRow
object
9 properties
9 required
ReadinessResponse
object
4 properties
4 required
SetRequestReadinessRow
object
11 properties
11 required
TeamRequestReadinessRow
object
11 properties
11 required
UpcomingRotationResponse
object
One upcoming rotation, mapped for the frontend list. status is passed through from WMS unchanged (already normalized to pending / confirmed / cancelled); the f…
6 properties
1 required
SalesOrder
object
Schema for sales order.
11 properties
5 required
SalesOrderSourceSystem
integer
Source system for sales order creation.
SalesOrderPOST
object
Schema for sales order POST.
2 properties
CombinedSalesOrderStatus
object
Combined sales order creation and sync status schema.
4 properties
4 required
SalesOrderStatus
object
Sales order status schema - handles both creation and sync operations.
9 properties
1 required
TaskStatus
string
status enumeration.
SalesOrderLineItem
object
Schema for sales order line item.
26 properties
4 required
ServiceRate
object
Service and rate mapping schema.
4 properties
2 required
SalesOrderLineItemPart
object
Schema for sales order line item.
21 properties
4 required
SalesOrderLineItemTLNode
object
Sales Order Line Item top-level node in tree.
22 properties
5 required
Charge
object
Schema for charge.
38 properties
3 required
InvoiceSentStatus
string
Invoice sent status enum. Indicates whether a draft or final invoice document has been sent to the customer.
InvoiceStatus
string
Invoice status enum from NetSuite. These statuses come from NetSuite's transaction status table for invoice records. Values queried from transactionstatus tabl…
ChargeBulkPATCHItem
object
Schema for bulk PATCH charge item.
2 properties
2 required
ChargeStatusName
string
Charge status names matching NetSuite status IDs.
ChargeBulkDELETE
object
Schema for bulk DELETE charges.
1 property
1 required
EmailSendLogChargeResponse
object
A single charge included in a sent email, for the expanded row detail.
6 properties
6 required
EmailSendLogResponse
object
A single sent-email record for a project's accounting history.
10 properties
10 required
ChargeStatusSummary
object
All charges in one status on a sales order, aggregated.
3 properties
ChargeSummary
object
Pre-aggregated charge totals for a sales order, computed from local DB.
8 properties
5 required
ChargeTypeSummary
object
All charges of one charge type (service) on a sales order, aggregated.
5 properties
ChargePOST
object
Schema for POST charge.
16 properties
5 required
ChargePATCH
object
Schema for PATCH charge.
5 properties
ChargeBulkApproveResponse
object
Response for bulk-approve charges.
1 property
1 required
ChargeBulkApprove
object
Input for bulk-approving charges.
1 property
1 required
AccountingInvoice
object
Schema for invoice response with linked charges.
12 properties
8 required
AccountingInvoiceCharge
object
Schema for charge linked to an invoice.
8 properties
5 required
CreateInvoiceResponse
object
Schema for API response after invoice creation flow.
6 properties
1 required
CreateSalesOrderInvoicePOST
object
Schema for creating an invoice from a sales order.
2 properties
2 required
PatchStrValue
object
Patch string value.
2 properties
2 required
AssetPatchGET
object
Asset patch GET
2 properties
2 required
AssetPatchPATCH
object
Asset patch PATCH
1 property
1 required
IdleHourSubCategoryOption
object
An available sub-category option for idle-hour time windows.
2 properties
2 required
IdleHourTimeWindow
object
Schema for an idle-hour delay time window.
6 properties
2 required
IdleHourTimeWindowsResponse
object
Response wrapper for idle-hour time windows.
2 properties
SyncDelayChargesError
object
Error details for a failed delay charge sync.
2 properties
2 required
SyncDelayChargesResponse
object
Response schema for sync delay charges operation.
8 properties
8 required
AccountingComment
object
Schema for accounting comment response.
9 properties
7 required
AccountingCommentPOST
object
Schema for creating an accounting comment.
2 properties
2 required
AccountingCommentPATCH
object
Schema for updating an accounting comment.
2 properties
SuggestionDecisionSchema
object
Schema for suggestion decision response.
9 properties
7 required
SuggestionDecisionPOST
object
Schema for creating/updating a suggestion decision.
5 properties
4 required
SuggestionDecisionDELETE
object
Schema for deleting a suggestion decision.
4 properties
3 required
ActivitySegment
object
A time segment for the activity timeline.
6 properties
3 required
ExpectedChargeDetail
object
Detail for a single expected/approximate charge.
6 properties
4 required
TeamWorkloadDay
object
Schema for daily team workload summary.
7 properties
7 required
TeamWorkloadSetStatus
object
Schema for set workload status details.
24 properties
13 required
TeamWorkloadSuggestedCharge
object
Schema for suggested charge candidate with prefill details.
9 properties
1 required
TeamWorkloadSuggestedChargeAsset
object
Schema for suggested charge asset candidate.
6 properties
2 required
DelayItem
object
A single delay for a robot set on a given day.
7 properties
2 required
ChargedRevenueResponse
object
Response schema for charged revenue aggregation.
1 property
1 required
NSServiceCountry
object
NetSuite service country segment.
2 properties
2 required
TurbineProgressAsset
object
A turbine in the turbines charge progress panel.
14 properties
1 required
TurbineProgressCharge
object
One charge inside a charge-type group on an asset.
2 properties
1 required
TurbineProgressChargeGroup
object
One asset's charges of a single charge type (service), aggregated.
5 properties
TurbinesProgress
object
Turbine charge progress for a sales order, sourced from local DB.
3 properties
2 required
NSSubsidiaryListItem
object
NetSuite Subsidiary.
2 properties
2 required
ServiceRateItem
object
One service rate row per service for the OPSHUB sidebar. A service can be priced by several CO lines (one per asset). Those lines are collapsed into a single r…
8 properties
4 required
ChargeCreationContext
object
All data needed to open the charge creation modal — 100% local DB.
2 properties
ChargeCreationRobotSet
object
Robot set with id and name.
2 properties
2 required
ChargeCreationScopeItem
object
Scope item for charge creation. dispatchsolids contains all SOL IDs that the created charge will cover. For a blade-level scope item this is a single ID. For a…
5 properties
3 required
ChargeCreationService
object
Service with its scope items for charge creation.
6 properties
4 required
ScopeChargePOST
object
Request body for creating a charge from a scope item (OPSHUB flow).
8 properties
5 required
CommercialOfferListQuery
object
Query parameters for commercial offer list endpoint.
5 properties
CommercialOfferRow
object
Commercial offer summary row for table responses.
14 properties
8 required
CommercialOfferBulkApproveResponse
object
Response describing which offers were approved or skipped.
2 properties
2 required
CommercialOfferApproveRequest
object
Request payload for bulk commercial offer approval.
1 property
1 required
AccountingOverviewQuery
object
Query parameters for accounting overview endpoint.
86 properties
AccountingOverviewSortBy
string
Sortable fields for accounting overview.
ProjectRevenue
object
Schema for project revenue.
50 properties
2 required
AccountingOverviewSummaryQuery
object
Query parameters for accounting overview summary endpoint (without pagination).
82 properties
AccountingOverviewSummary
object
Summary schema for accounting overview aggregated data.
26 properties
2 required
AccountingOverviewFiltersQuery
object
Query parameters for accounting overview filters endpoint (date filters only).
2 properties
AccountingOverviewFilters
object
Filters schema for accounting overview unique values.
8 properties
8 required
MissingChargesTrackerQuery
object
Query parameters for missing charges tracker endpoint.
17 properties
MissingChargesAffectedProject
object
Project impacted by missing charges.
2 properties
2 required
MissingChargesTrackerResponse
object
Response for missing charges tracker endpoint.
23 properties
9 required
MissingDataReasonBadge
object
Badge showing reason for missing data.
2 properties
2 required
RobotSetMissingData
object
Missing data tracking for a robot set.
15 properties
7 required
MissingChargesSyncResponse
object
Response for missing charges sync endpoint.
5 properties
5 required
MissingChargesCacheStatus
object
Response for cache status endpoint.
3 properties
2 required
ChargeBulkReviewResponse
object
Response for bulk PM/customer review-status transitions.
1 property
1 required
ChargeBulkReview
object
Input for bulk PM/customer review-status transitions. Exactly one of ids or emailsendlogid must be set. ids names the charges directly; emailsendlogid resolves…
2 properties
NetSuiteLocalSyncResponse
object
Response schema for the NetSuite local DB sync operation.
7 properties
7 required
MissingChargesTrackerExportQuery
object
Query parameters for missing charges tracker export endpoint.
14 properties
NetSuiteDepartmentQueryParams
object
Query parameters for the NetSuite departments endpoint.
4 properties
NetSuiteDepartmentResponse
object
Schema for a NetSuiteDepartment response, the cost center mirror row.
12 properties
5 required
SalesOrderQueryParams
object
Query parameters for sales orders endpoint.
5 properties
SalesOrderResponse
object
Schema for SalesOrder response.
10 properties
2 required
SalesOrderCreate
object
Schema for creating a SalesOrder.
8 properties
SalesOrderUpdate
object
Schema for updating a SalesOrder.
7 properties
SalesOrderLineQueryParams
object
Query parameters for sales order lines endpoint.
3 properties
SalesOrderLineResponse
object
Schema for SalesOrderLine response.
8 properties
3 required
SalesOrderLineCreate
object
Schema for creating a SalesOrderLine.
6 properties
1 required
SalesOrderLineUpdate
object
Schema for updating a SalesOrderLine.
5 properties
SalesInvoiceQueryParams
object
Query parameters for sales invoices endpoint.
4 properties
SalesInvoiceResponse
object
Schema for SalesInvoice response.
10 properties
2 required
SalesInvoiceCreate
object
Schema for creating a SalesInvoice.
7 properties
SalesInvoiceUpdate
object
Schema for updating a SalesInvoice.
7 properties
ServiceChargeQueryParams
object
Query parameters for service charges endpoint.
6 properties
ServiceChargeResponse
object
Schema for ServiceCharge response.
19 properties
3 required
ServiceChargeCreate
object
Schema for creating a ServiceCharge.
17 properties
1 required
ServiceChargeUpdate
object
Schema for updating a ServiceCharge.
17 properties
1 required
BillingStatementQueryParams
object
Query parameters for billing statements endpoint.
6 properties
BillingStatementResponse
object
Schema for BillingStatement response.
9 properties
9 required
BillingStatementCreate
object
Schema for creating a BillingStatement.
6 properties
5 required
BillingStatementUpdate
object
Schema for updating a BillingStatement.
6 properties
NoteQueryParams
object
Query parameters for notes endpoint.
5 properties
NoteResponse
object
Schema for Note response.
8 properties
7 required
NoteCreate
object
Schema for creating a Note.
4 properties
3 required
NoteUpdate
object
Schema for updating a Note.
2 properties
FileList
object
Response schema for listing all files.
1 property
1 required
CoveragePublishedPayload
object
Payload WMS sends when a roster layer is published. projectcodes is the union of every projectcode with at least one assignment in the published layer's date r…
7 properties
7 required
TaskUpdatedPayload
object
Payload the travel app sends when one of its travel requests changes. Uses plain ninja.Schema (not the extra='forbid' REST base) on purpose: this is an inbound…
3 properties
1 required
_NotePayload
object
1 property
1 required
SalesOrdersByCodeGET
object
By project code.
1 property
1 required
Subsidiary
object
Subsidiary
6 properties
5 required
SchedulerJob
object
Schema for scheduler job details.
2 properties
2 required
SchedulerJobList
object
Schema for list of scheduler jobs.
1 property
1 required
SendEmailResponse
object
Response for a successful (or dev-mode-skipped) /email call.
2 properties
1 required
EmailContext
object
Define the template context for an email. Email context defines which template and with what variables are to be sent.
2 properties
1 required
EmailRequest
object
Incoming payload for sending a templated email.
7 properties
3 required
EmailTemplateNames
string
Definitions of available email templates.
SentEmailStatusResponse
object
Response for GET /email/{trackingid}/status.
3 properties
2 required
GlobalDeviationsFiltersQueryParams
object
Query parameters for GET /deviations/filters.
2 properties
CountryFilter
object
Country filter item with code and name.
2 properties
2 required
GlobalDeviationsFilters
object
Response schema for GET /deviations/filters.
3 properties
GlobalDeviationsSummaryQueryParams
object
Query parameters for GET /deviations/summary.
18 properties
GlobalPeriodTypeEnum
string
Global period type enumeration (weekly or monthly).
CurrencyAmounts
object
Financial amounts in multiple currencies.
3 properties
GlobalDeviationsSummary
object
Summary schema for global deviations aggregated data.
6 properties
6 required
ProjectDeviationsFiltersQueryParams
object
Query parameters for GET /deviations/{projectid}/filters.
2 properties
ProjectDeviationsFilters
object
Response schema for GET /deviations/{projectid}/filters.
2 properties
PeriodTypeEnum
string
Period type enumeration.
ProjectDeviationsSummaryQueryParams
object
Query parameters for GET /deviations/{projectid}/summary.
5 properties
ProjectDeviationsSummary
object
Summary schema for project-specific deviations aggregated data.
9 properties
9 required
DeviationsQueryParams
object
Query parameters for GET /deviations/{projectid}.
8 properties
ExportFormat
string
Export format options.
DeviationCategoryEnum
string
Deviation category enumeration. Internal categories (faultside = Internal): - Set Readiness, Rotation, Missing reports, Low performance, Sales, Planning, Healt…
DeviationRow
object
Single deviation row in response (daily or weekly).
16 properties
11 required
DeviationsListResponse
object
Response schema for GET /deviations/{projectid}.
6 properties
5 required
FaultSideEnum
string
Fault side enumeration.
Period
object
Period information for deviation rows.
5 properties
5 required
DeviationsPatchResponse
object
Response schema for PATCH /deviations/{projectid}.
3 properties
2 required
DeviationUpdateItem
object
Single deviation update in PATCH request.
4 properties
1 required
GlobalDeviationsQueryParams
object
Query parameters for GET /deviations.
21 properties
DeviationCountry
object
Country information for deviations.
3 properties
2 required
GlobalDeviationRow
object
Single row in global deviations response (one row per project per period).
19 properties
12 required
GlobalDeviationsListResponse
object
Response schema for GET /deviations.
4 properties
3 required
GlobalPeriod
object
Period information for global deviation rows.
6 properties
4 required
GlobalDeviationUpdateItem
object
Single global deviation update in PATCH request.
2 properties
1 required
UnifiedServices
object
Schema for unified services response.
1 property
1 required
ServiceLineItemQuery
object
Query params for service line items.
4 properties
ServiceLineItem
object
Schema for unified service line item.
6 properties
6 required
ServiceLineItemFull
object
Full schema including all available fields for unified service line item.
7 properties
7 required
TurbineManufacturer
object
Schema for turbine manufacturer.
3 properties
3 required
TurbineManufacturerResponse
object
Schema for turbine manufacturer list response.
1 property
1 required
LegacyTurbineModel
object
Schema for turbine model (legacy turbines API).
3 properties
3 required
LegacyTurbineModelResponse
object
Schema for turbine model list response (legacy turbines API).
1 property
1 required
RefreshResponse
object
Schema for refresh data response.
2 properties
2 required
BladeManufacturer
object
Schema for blade manufacturer.
2 properties
2 required
BladeManufacturerResponse
object
Schema for blade manufacturer list response.
1 property
1 required
LegacyBladeModel
object
Schema for blade model (legacy turbines API).
3 properties
3 required
LegacyBladeModelResponse
object
Schema for blade model list response (legacy turbines API).
1 property
1 required
UpdateUserRole
object
Schema for updating user role.
3 properties
CIRValidationIssueSchema
object
4 properties
4 required
CIRValidationResultSchema
object
2 properties
2 required
CIRSubmissionStatusSchema
object
7 properties
1 required
CIRSubmitResponseSchema
object
2 properties
2 required
AnomalyAIStatus
string
AI status for anomalies.
AnomalyFileSchema
object
2 properties
2 required
AnomalyRegisteredByType
string
Registered by classification for anomalies.
AnomalySchema
object
26 properties
23 required
BladePhotoSchema
object
3 properties
3 required
BladeSchema
object
8 properties
6 required
TurbineSchema
object
5 properties
5 required
VestasCIRDataSchema
object
6 properties
6 required
NordexActivityResourceSchema
object
4 properties
4 required
NordexActivitySchema
object
6 properties
6 required
NordexAnomalyFileSchema
object
4 properties
4 required
NordexAnomalySchema
object
25 properties
25 required
NordexCIRDataSchema
object
3 properties
3 required
NordexComponentModelSchema
object
2 properties
2 required
NordexCustomValueSchema
object
5 properties
5 required
NordexIdNameSchema
object
2 properties
2 required
NordexLocationSchema
object
1 property
1 required
NordexServiceOrderLineSchema
object
10 properties
10 required
NordexTurbineComponentSchema
object
5 properties
5 required
NordexTurbineSchema
object
3 properties
3 required
NordexWorkorderSchema
object
2 properties
2 required
DataTrackingStatusCountsResponse
object
Aggregated data-tracking status counters for a batch of lines.
4 properties
4 required
ServiceOrderLineStatusCounts
object
Per-stage status counters for a single service order line.
4 properties
3 required
DataTrackingResponse
object
Tracked file status response (flat, aggregated across stage rows).
22 properties
2 required
DataTrackingCreateRequest
object
Request body for creating a tracked file.
9 properties
1 required
DataTrackingStatus
string
Allowed API status values for data tracking updates.
DataTrackingUpdateRequest
object
Request body for updating a tracked file.
9 properties
1 required
DataTrackingBatchResponse
object
Tracked file status response carrying its owning service order line. Identical to :class:DataTrackingResponse plus serviceorderlineid, which the batch listing…
23 properties
3 required
ServiceQuery
object
Service query parameters.
2 properties
ServiceList
object
Schema for services on list.
3 properties
3 required
Addons
object
Schema for service addons.
1 property
ServicePreJobQuestionDefinition
object
Single definition of a pre job question that can be attached to service.
7 properties
3 required
ServicePreJobQuestionType
string
Allowed type of the pre job question.
Service
object
Schema for unified service.
7 properties
3 required
BambooHREmployeeQueryParams
object
Query parameters for the BambooHR employees list endpoint.
3 properties
BambooHREmployeeResponse
object
Row in the BambooHR employees list endpoint.
8 properties
3 required
AssetQueryParams
object
Query parameters for the MaintainX assets list endpoint.
4 properties
AssetResponse
object
Row in the MaintainX assets list endpoint.
5 properties
5 required
TalentLMSUserQueryParams
object
Query parameters for the TalentLMS users list endpoint.
3 properties
TalentLMSUserResponse
object
Row in the TalentLMS users list endpoint.
7 properties
3 required
PayType
string
PayrollActivityOut
object
15 properties
6 required
Status
string
PayrollActivityIn
object
11 properties
2 required
PayrollActivityPatchIn
object
9 properties
TimesheetQueryParams
object
7 properties
TimesheetEntryOut
object
21 properties
3 required
ActiveWorkloadSOLQueryParams
object
Query parameters for active workload service order lines listing.
13 properties
ActiveWorkloadSOLResponse
object
Response schema for a single service order line in the active workload list.
12 properties
1 required
CustomerInfo
object
2 properties
1 required
LocationInfo
object
6 properties
1 required
ActiveWorkloadSOLDetailResponse
object
Detail response for a service order line (modal).
13 properties
1 required
ResourceInfo
object
4 properties
1 required
ResourceSetInfo
object
2 properties
1 required
SOLWorkorderInfo
object
Nested WO info inside an SOL detail.
7 properties
1 required
ActiveWorkloadWOQueryParams
object
Query parameters for active workload work orders listing.
20 properties
ActiveWorkloadWOResponse
object
Response schema for a single work order in the active workload list.
18 properties
1 required
ComponentInfo
object
3 properties
1 required
InspectionSummary
object
3 properties
ServiceOrderLineInfo
object
6 properties
1 required
ActiveWorkloadWODetailResponse
object
Detail response for a work order (modal).
17 properties
1 required
InspectionComponentInfo
object
3 properties
2 required
InspectionDetail
object
6 properties
InspectionSectionInfo
object
6 properties
3 required
WOActivityInfo
object
Nested activity for WO detail.
9 properties
1 required
WOResourceSetDetail
object
Resource set with members for WO detail.
3 properties
1 required
WOResourceSetMember
object
Resource within a resource set.
4 properties
1 required
ActiveWorkloadFiltersResponse
object
Response schema for filter options endpoint.
11 properties
CountryFilterOption
object
2 properties
1 required
FilterStatusGroup
object
2 properties
ResourceSetFilterOption
object
1 property
1 required
WOTypeOption
object
2 properties
2 required
Filters
object
6 properties
Ordering
object
4 properties
ComponentSchema
object
4 properties
2 required
ExternalImageStatus
string
Review status of a single external photo. Mirrors LERImageStatus but stays a separate enum: external photos have no step/run concept, so the two review flows a…
ExternalPhotoLowResSchema
object
2 properties
1 required
ExternalPhotoSchema
object
19 properties
5 required
ExternalPhotoThumbnailSchema
object
2 properties
1 required
ExternalPhotoTileSchema
object
4 properties
3 required
ImageOrientation
string
ImageSide
string
Sides from which photos can be taken.
InspectionItemStatus
string
InspectionSchema
object
3 properties
2 required
LERImageStatus
string
LERInspectionStatus
string
Review status of a single LER inspection step run.
LERPhotoGroupSchema
object
2 properties
2 required
LERPhotoLowResSchema
object
2 properties
1 required
LERPhotoRunSchema
object
4 properties
3 required
LERPhotoSchema
object
17 properties
7 required
LERPhotoThumbnailSchema
object
2 properties
1 required
LERPhotoTileSchema
object
4 properties
3 required
POIPhotoLowResSchema
object
2 properties
1 required
POIPhotoSchema
object
15 properties
3 required
POIPhotoThumbnailSchema
object
2 properties
1 required
POIPhotoTileSchema
object
4 properties
3 required
RootPhotoLowResSchema
object
2 properties
1 required
RootPhotoSchema
object
15 properties
3 required
RootPhotoThumbnailSchema
object
2 properties
1 required
RootPhotoTileSchema
object
4 properties
3 required
SectionSchema
object
9 properties
4 required
VideoFileBlobKind
string
VideoFileBlobSchema
object
3 properties
2 required
VideoFileExtension
string
Expected video file formats from inspection data uploads.
VideoFileSchema
object
13 properties
4 required
VideoSnapshotSchema
object
4 properties
1 required
PostComponentLinkSchema
object
2 properties
2 required
RosbagBlobDistancesSchema
object
1 property
1 required
RosbagBlobRangesSchema
object
2 properties
2 required
RosbagSchema
object
1 property
1 required
RosbagBlobKind
string
RosbagBlobSchema
object
3 properties
2 required
AiAnomalyCoreSchema
object
The core.anomaly columns registration writes that vis.aianomaly lacks. A registration spans two tables, and until this existed the response showed only the vis…
25 properties
1 required
AiAnomalySchema
object
Response for a vis.AiAnomaly row — every column on the table. deletedat is deliberately omitted (soft-delete internals are never exposed); coreanomalyid is the…
27 properties
6 required
AiAnomalyRegisterSchema
object
Input for POST /vis/v1/ai-anomalies — the REST twin of registerAiDefect. Field names and semantics mirror the GraphQL RegisterAiDefectInput; both surfaces feed…
38 properties
AiAnomalySourceObjectSchema
object
Input for PATCH /vis/v1/ai-anomalies/{id}/source-object. The drone pipeline registers a defect before the portal has registered the photo it came from, so the…
2 properties
CampaignWithScopeResponse
object
2 properties
2 required
NestedCampaign
object
2 properties
2 required
NestedWorkPackage
object
3 properties
2 required
CampaignWithScopeCreate
object
Create a Campaign pre-scoped to a set of parks in one atomic call. Replaces AeroCore's best-effort multi-call orchestration (create Campaign, then N WorkPackag…
8 properties
2 required
CampaignQueryParams
object
3 properties
AttachmentResponse
object
4 properties
2 required
CampaignResponse
object
12 properties
5 required
CommentResponse
object
4 properties
2 required
CampaignCreate
object
7 properties
1 required
CampaignUpdate
object
7 properties
CommentCreate
object
1 property
1 required
AttachmentCreate
object
3 properties
1 required
WorkPackageScopeRow
object
3 properties
1 required
WorkPackageWithScopeResponse
object
1 property
1 required
WorkPackageWithScopeCreate
object
Create work package(s) pre-scoped to selected turbines (or a park) atomically. Productionises AeroCore's create-work-package-with-scope Track-2 shim (a per-tur…
11 properties
3 required
WorkPackageCampaignRow
object
A work package on a turbine, projected with its parent campaign. Feeds the Turbines-overview "active campaigns affecting" widget / side panel. Productionises A…
4 properties
4 required
WorkPackagesWithCampaignsResponse
object
1 property
1 required
WorkPackageQueryParams
object
6 properties
NestedSite
object
2 properties
2 required
NestedTurbine
object
2 properties
1 required
NestedTurbineComponent
object
2 properties
1 required
NestedVendor
object
2 properties
2 required
WorkPackageResponse
object
23 properties
6 required
WorkPackageCreate
object
13 properties
2 required
WorkPackageUpdate
object
13 properties
ClientWorkOrderQueryParams
object
13 properties
ClientWorkOrderResponse
object
28 properties
5 required
CwmActivityResponse
object
12 properties
3 required
ClientWorkOrderCreate
object
17 properties
1 required
ClientWorkOrderUpdate
object
16 properties
CompleteWorkOrderResult
object
Per-work-order outcome of the atomic complete + cascade (AECP-333).
5 properties
3 required
CompleteWorkOrdersResponse
object
1 property
1 required
CompleteWorkOrdersPayload
object
Mark one or more work orders complete (+ cascade linked anomalies).
2 properties
1 required
CwmApplyTemplatePayload
object
1 property
1 required
CwmActivityQueryParams
object
3 properties
CwmActivityCreate
object
7 properties
1 required
CwmActivityUpdate
object
6 properties
CwmActivityReorderPayload
object
2 properties
2 required
CwmActivityTemplateQueryParams
object
2 properties
CwmActivityTemplateResponse
object
4 properties
3 required
CwmActivityTemplateCreate
object
2 properties
1 required
CwmActivityTemplateUpdate
object
2 properties
CwmVendorQueryParams
object
3 properties
CwmVendorResponse
object
3 properties
3 required
CwmVendorCreate
object
1 property
1 required
CwmVendorUpdate
object
1 property
CwmTaskTypeQueryParams
object
3 properties
CwmTaskTypeResponse
object
3 properties
3 required
CwmTaskTypeCreate
object
1 property
1 required
CwmTaskTypeUpdate
object
1 property
StatusOption
object
3 properties
3 required
StatusesResponse
object
3 properties
3 required
AnomalyWorkOrderSummary
object
5 properties
3 required
AnomalyWorkOrdersResponse
object
1 property
1 required
AnomalyWorkOrdersCreatePayload
object
11 properties
1 required
PlanningCampaignQueryParams
object
4 properties
PlanningCampaignResponse
object
17 properties
6 required
PlanningNestedCurrency
object
3 properties
3 required
PlanningNestedCustomer
object
2 properties
2 required
PlanningCampaignCreate
object
12 properties
2 required
PlanningCampaignUpdate
object
11 properties
PlanningProjectQueryParams
object
5 properties
PlanningNestedCampaign
object
2 properties
2 required
PlanningNestedCoreProject
object
2 properties
2 required
PlanningProjectResponse
object
23 properties
6 required
PlanningProjectCreate
object
16 properties
2 required
PlanningProjectUpdate
object
15 properties
PlanningServiceQueryParams
object
5 properties
PlanningNestedCoreService
object
3 properties
2 required
PlanningServiceResponse
object
10 properties
6 required
PlanningServiceCreate
object
5 properties
2 required
PlanningServiceUpdate
object
4 properties
PlanningCustomerVendorQueryParams
object
3 properties
PlanningCustomerVendorResponse
object
7 properties
5 required
PlanningNestedVendor
object
2 properties
2 required
PlanningCustomerVendorCreate
object
2 properties
2 required
PlanningCustomerVendorUpdate
object
1 property
PlanningNestedCustomerVendor
object
3 properties
2 required
PlanningNestedProject
object
2 properties
2 required
PlanningNestedService
object
3 properties
2 required
PlanningServiceOrderResponse
object
27 properties
6 required
PlanningServiceOrderAnomalyLinkRequest
object
1 property
1 required
PlanningServiceOrderQueryParams
object
7 properties
PlanningServiceOrderCreate
object
19 properties
2 required
PlanningServiceOrderUpdate
object
18 properties
PlanningWorkOrderTypeQueryParams
object
3 properties
PlanningWorkOrderTypeResponse
object
7 properties
5 required
PlanningWorkOrderTypeCreate
object
3 properties
2 required
PlanningWorkOrderTypeUpdate
object
2 properties
PlanningWorkOrderQueryParams
object
6 properties
PlanningNestedServiceOrder
object
2 properties
1 required
PlanningNestedWorkOrderType
object
3 properties
2 required
PlanningWorkOrderResponse
object
18 properties
8 required
PlanningWorkOrderCreate
object
12 properties
4 required
PlanningWorkOrderUpdate
object
11 properties
PlanningStatusOption
object
3 properties
3 required
PlanningStatusesResponse
object
Authoritative planning status catalogue, one list per entity. Campaign, Project, ServiceOrder and WorkOrder all share the single unified PlanningStatus enum to…
4 properties
4 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
#Wind Energy#Operations#Work Orders#Turbines#Inspection
Where this information came from
This is an independent, third-party profile of Aerones Operations Hub API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.