SimOops docs
API reference · spine

API reference

Every endpoint the platform exposes — generated from the OpenAPI schema, never hand-edited. This is a static reference; there is no live “try it” here.

generated from docs-site/src/generated/openapi.json 1d98ecb13f02620 operations68 tags

Authentication

Keycloak OIDC — send a Bearer JWT. A handful of /public endpoints are unauthenticated, for the login UI only.

Base path & coordinates

Everything is under /api. Geometry crosses the wire as WGS84 ({lon, lat}); the server stores EPSG:3857.

Response shapes

List endpoints return an array directly; create / update return the object; delete returns 204.

Errors

Failures use one envelope: { "error": { "detail", "code" } } — note the double nesting.

actions 9

  • GET
    /api/sites/{site_id}/actionsList Actions
    list_actions_api_sites__site_id__actions_get
  • POST
    /api/sites/{site_id}/actionsCreate Action
    create_action_api_sites__site_id__actions_post
  • GET
    /api/sites/{site_id}/actions/{action_id}Get Action
    get_action_api_sites__site_id__actions__action_id__get
  • POST
    /api/sites/{site_id}/actions/{action_id}/acceptAccept Action
    accept_action_api_sites__site_id__actions__action_id__accept_post
  • POST
    /api/sites/{site_id}/actions/{action_id}/cancelCancel Action
    cancel_action_api_sites__site_id__actions__action_id__cancel_post
  • POST
    /api/sites/{site_id}/actions/{action_id}/close-outClose Out Action
    close_out_action_api_sites__site_id__actions__action_id__close_out_post
  • POST
    /api/sites/{site_id}/actions/{action_id}/evidenceUpload Action Evidence
    upload_action_evidence_api_sites__site_id__actions__action_id__evidence_post
  • GET
    /api/sites/{site_id}/actions/{action_id}/evidence/{evidence_id}/downloadDownload Action Evidence
    download_action_evidence_api_sites__site_id__actions__action_id__evidence__evidence_id__download_get
  • POST
    /api/sites/{site_id}/actions/{action_id}/rejectReject Action
    reject_action_api_sites__site_id__actions__action_id__reject_post

active-areas 19

  • GET
    /api/active-areas/List Active Areas
    list_active_areas_api_active_areas__get
  • POST
    /api/active-areas/Create Active Area
    create_active_area_api_active_areas__post
  • DELETE
    /api/active-areas/{area_id}Delete Active Area
    delete_active_area_api_active_areas__area_id__delete
  • GET
    /api/active-areas/{area_id}Get Active Area
    get_active_area_api_active_areas__area_id__get
  • PATCH
    /api/active-areas/{area_id}Update Active Area
    update_active_area_api_active_areas__area_id__patch
  • POST
    /api/active-areas/{area_id}/convert-to-scheduleConvert Active Area To Schedule
    convert_active_area_to_schedule_api_active_areas__area_id__convert_to_schedule_post
  • GET
    /api/active-areas/{area_id}/versionsList Active Area Versions
    list_active_area_versions_api_active_areas__area_id__versions_get
  • GET
    /api/active-areas/at-timeList Active Areas At Time
    list_active_areas_at_time_api_active_areas_at_time_get
  • POST
    /api/active-areas/copy-from-rangeCopy Active Areas From Range
    copy_active_areas_from_range_api_active_areas_copy_from_range_post
  • POST
    /api/active-areas/floor-fillCreate Floor Fill Group
    create_floor_fill_group_api_active_areas_floor_fill_post
  • DELETE
    /api/active-areas/floor-fill/{group_id}Delete Floor Fill Group
    delete_floor_fill_group_api_active_areas_floor_fill__group_id__delete
  • POST
    /api/active-areas/floor-fill/{group_id}/regenerateRegenerate Floor Fill Group
    regenerate_floor_fill_group_api_active_areas_floor_fill__group_id__regenerate_post
  • POST
    /api/active-areas/scheduleCreate Active Area Schedule
    create_active_area_schedule_api_active_areas_schedule_post
  • DELETE
    /api/active-areas/schedule-group/{group_id}Delete Active Area Schedule Group
    delete_active_area_schedule_group_api_active_areas_schedule_group__group_id__delete
  • GET
    /api/active-areas/schedule-group/{group_id}Get Active Area Schedule Group
    get_active_area_schedule_group_api_active_areas_schedule_group__group_id__get
  • PATCH
    /api/active-areas/schedule-group/{group_id}Update Active Area Schedule Group
    update_active_area_schedule_group_api_active_areas_schedule_group__group_id__patch
  • POST
    /api/active-areas/schedule-group/{group_id}/finish-earlyFinish Area Schedule Early
    finish_area_schedule_early_api_active_areas_schedule_group__group_id__finish_early_post
  • GET
    /api/active-areas/schedule-group/{group_id}/future-occurrencesCount Area Future Occurrences
    count_area_future_occurrences_api_active_areas_schedule_group__group_id__future_occurrences_get
  • PUT
    /api/active-areas/schedule-group/{group_id}/reconcileReconcile Active Area Schedule Group
    reconcile_active_area_schedule_group_api_active_areas_schedule_group__group_id__reconcile_put

admin 3

  • POST
    /api/admin/email/bounceReceive Bounce
    receive_bounce_api_admin_email_bounce_post
  • GET
    /api/admin/email/suppressionsList Suppressions
    list_suppressions_api_admin_email_suppressions_get
  • POST
    /api/admin/email/suppressions/{email}/clearClear Suppression
    clear_suppression_api_admin_email_suppressions__email__clear_post

alerts 8

  • GET
    /api/alerts/List Alerts
    list_alerts_api_alerts__get
  • POST
    /api/alerts/Create Alert
    create_alert_api_alerts__post
  • DELETE
    /api/alerts/{alert_id}Delete Alert
    delete_alert_api_alerts__alert_id__delete
  • GET
    /api/alerts/{alert_id}Get Alert
    get_alert_api_alerts__alert_id__get
  • PATCH
    /api/alerts/{alert_id}Update Alert
    update_alert_api_alerts__alert_id__patch
  • GET
    /api/alerts/{alert_id}/activityGet Activity
    get_activity_api_alerts__alert_id__activity_get
  • POST
    /api/alerts/{alert_id}/resolveResolve Alert
    resolve_alert_api_alerts__alert_id__resolve_post
  • POST
    /api/alerts/{alert_id}/unresolveUnresolve Alert
    unresolve_alert_api_alerts__alert_id__unresolve_post

analysis 1

  • POST
    /api/analysis/change-pointsCompute Change Points
    compute_change_points_api_analysis_change_points_post

audit 4

  • GET
    /api/audit/entity/{entity_type}/{entity_id}Get Entity History
    get_entity_history_api_audit_entity__entity_type___entity_id__get
  • POST
    /api/audit/revert/{entry_id}Revert To Entry
    revert_to_entry_api_audit_revert__entry_id__post
  • GET
    /api/audit/site/{site_id}Get Site Audit Log
    get_site_audit_log_api_audit_site__site_id__get
  • GET
    /api/audit/site/{site_id}/timelineGet Site Revision Timeline
    get_site_revision_timeline_api_audit_site__site_id__timeline_get

auth 2

  • POST
    /api/auth/change-passwordChange Password
    change_password_api_auth_change_password_post
  • GET
    /api/auth/meGet Me
    get_me_api_auth_me_get

blockers 19

  • GET
    /api/sites/{site_id}/blockersList Blockers
    list_blockers_api_sites__site_id__blockers_get
  • POST
    /api/sites/{site_id}/blockersDeclare Blocker
    declare_blocker_api_sites__site_id__blockers_post
  • DELETE
    /api/sites/{site_id}/blockers/{blocker_id}Soft Delete Blocker
    soft_delete_blocker_api_sites__site_id__blockers__blocker_id__delete
  • GET
    /api/sites/{site_id}/blockers/{blocker_id}Get Blocker
    get_blocker_api_sites__site_id__blockers__blocker_id__get
  • POST
    /api/sites/{site_id}/blockers/{blocker_id}/acknowledgeAcknowledge Blocker
    acknowledge_blocker_api_sites__site_id__blockers__blocker_id__acknowledge_post
  • POST
    /api/sites/{site_id}/blockers/{blocker_id}/affectedSet Affected Refs
    set_affected_refs_api_sites__site_id__blockers__blocker_id__affected_post
  • POST
    /api/sites/{site_id}/blockers/{blocker_id}/archiveArchive Blocker
    archive_blocker_api_sites__site_id__blockers__blocker_id__archive_post
  • POST
    /api/sites/{site_id}/blockers/{blocker_id}/confirmConfirm Blocker
    confirm_blocker_api_sites__site_id__blockers__blocker_id__confirm_post
  • GET
    /api/sites/{site_id}/blockers/{blocker_id}/eventsList Blocker Events
    list_blocker_events_api_sites__site_id__blockers__blocker_id__events_get
  • POST
    /api/sites/{site_id}/blockers/{blocker_id}/evidenceUpload Blocker Evidence
    upload_blocker_evidence_api_sites__site_id__blockers__blocker_id__evidence_post
  • DELETE
    /api/sites/{site_id}/blockers/{blocker_id}/evidence/{evidence_id}Delete Blocker Evidence
    delete_blocker_evidence_api_sites__site_id__blockers__blocker_id__evidence__evidence_id__delete
  • GET
    /api/sites/{site_id}/blockers/{blocker_id}/evidence/{evidence_id}/downloadDownload Blocker Evidence
    download_blocker_evidence_api_sites__site_id__blockers__blocker_id__evidence__evidence_id__download_get
  • POST
    /api/sites/{site_id}/blockers/{blocker_id}/rejectReject Blocker
    reject_blocker_api_sites__site_id__blockers__blocker_id__reject_post
  • POST
    /api/sites/{site_id}/blockers/{blocker_id}/resolveResolve Blocker
    resolve_blocker_api_sites__site_id__blockers__blocker_id__resolve_post
  • POST
    /api/sites/{site_id}/blockers/{blocker_id}/responsibleSet Responsible
    set_responsible_api_sites__site_id__blockers__blocker_id__responsible_post
  • POST
    /api/sites/{site_id}/blockers/{blocker_id}/restoreRestore Blocker
    restore_blocker_api_sites__site_id__blockers__blocker_id__restore_post
  • POST
    /api/sites/{site_id}/blockers/{blocker_id}/updateUpdate Blocker
    update_blocker_api_sites__site_id__blockers__blocker_id__update_post
  • GET
    /api/sites/{site_id}/blockers/affected-suggestionsSuggest Affected Refs
    suggest_affected_refs_api_sites__site_id__blockers_affected_suggestions_get
  • POST
    /api/sites/{site_id}/blockers/suggestSuggest Blocker
    suggest_blocker_api_sites__site_id__blockers_suggest_post

clash-consequences 3

  • GET
    /api/clash-consequences/List Consequences
    list_consequences_api_clash_consequences__get
  • PUT
    /api/clash-consequences/Upsert Consequence
    upsert_consequence_api_clash_consequences__put
  • DELETE
    /api/clash-consequences/{clash_rule_id}Delete Consequence
    delete_consequence_api_clash_consequences__clash_rule_id__delete

clash-rules 14

  • GET
    /api/clash-rulesList Clash Rules
    list_clash_rules_api_clash_rules_get
  • POST
    /api/clash-rulesCreate Clash Rule
    create_clash_rule_api_clash_rules_post
  • DELETE
    /api/clash-rules/{rule_id}Delete Clash Rule
    delete_clash_rule_api_clash_rules__rule_id__delete
  • GET
    /api/clash-rules/{rule_id}Get Clash Rule
    get_clash_rule_api_clash_rules__rule_id__get
  • PATCH
    /api/clash-rules/{rule_id}Update Clash Rule
    update_clash_rule_api_clash_rules__rule_id__patch
  • GET
    /api/clash-rules/{rule_id}/diffDiff Rule Versions
    diff_rule_versions_api_clash_rules__rule_id__diff_get
  • GET
    /api/clash-rules/{rule_id}/dslGet Rule Dsl
    get_rule_dsl_api_clash_rules__rule_id__dsl_get
  • GET
    /api/clash-rules/{rule_id}/historyGet Rule History
    get_rule_history_api_clash_rules__rule_id__history_get
  • POST
    /api/clash-rules/{rule_id}/revert/{version}Revert Rule To Version
    revert_rule_to_version_api_clash_rules__rule_id__revert__version__post
  • GET
    /api/clash-rules/{rule_id}/versions/{version}Get Rule Version
    get_rule_version_api_clash_rules__rule_id__versions__version__get
  • POST
    /api/clash-rules/detectDetect Clashes
    detect_clashes_api_clash_rules_detect_post
  • POST
    /api/clash-rules/dsl/previewPreview Rule Dsl
    preview_rule_dsl_api_clash_rules_dsl_preview_post
  • POST
    /api/clash-rules/importImport Rules From Yaml
    import_rules_from_yaml_api_clash_rules_import_post
  • POST
    /api/clash-rules/load-defaultsLoad Default Rules
    load_default_rules_api_clash_rules_load_defaults_post

clashes 9

  • GET
    /api/clashesList Clashes
    list_clashes_api_clashes_get
  • GET
    /api/clashes/at-timeList Clashes At Time
    list_clashes_at_time_api_clashes_at_time_get
  • POST
    /api/clashes/declare-blockerDeclare Blocker From Clash
    declare_blocker_from_clash_api_clashes_declare_blocker_post
  • GET
    /api/clashes/episodesList Clash Episodes
    list_clash_episodes_api_clashes_episodes_get
  • DELETE
    /api/clashes/stanceClear Stance Endpoint
    clear_stance_endpoint_api_clashes_stance_delete
  • POST
    /api/clashes/stanceSet Stance Endpoint
    set_stance_endpoint_api_clashes_stance_post
  • POST
    /api/clashes/stance/bulkSet Stance Bulk Endpoint
    set_stance_bulk_endpoint_api_clashes_stance_bulk_post
  • GET
    /api/clashes/unresolvedList Unresolved Clash Episodes
    list_unresolved_clash_episodes_api_clashes_unresolved_get
  • GET
    /api/clashes/unresolved/summaryUnresolved Clash Episode Summary
    unresolved_clash_episode_summary_api_clashes_unresolved_summary_get

completion-records 8

  • GET
    /api/sites/{site_id}/completion-recordsList Completion Records
    list_completion_records_api_sites__site_id__completion_records_get
  • POST
    /api/sites/{site_id}/completion-recordsMark Complete
    mark_complete_api_sites__site_id__completion_records_post
  • GET
    /api/sites/{site_id}/completion-records/{record_id}Get Completion Record
    get_completion_record_api_sites__site_id__completion_records__record_id__get
  • POST
    /api/sites/{site_id}/completion-records/{record_id}/evidenceUpload Completion Evidence
    upload_completion_evidence_api_sites__site_id__completion_records__record_id__evidence_post
  • DELETE
    /api/sites/{site_id}/completion-records/{record_id}/evidence/{evidence_id}Delete Completion Evidence
    delete_completion_evidence_api_sites__site_id__completion_records__record_id__evidence__evidence_id__delete
  • GET
    /api/sites/{site_id}/completion-records/{record_id}/evidence/{evidence_id}/downloadDownload Completion Evidence
    download_completion_evidence_api_sites__site_id__completion_records__record_id__evidence__evidence_id__download_get
  • POST
    /api/sites/{site_id}/completion-records/bulkBulk Mark Complete
    bulk_mark_complete_api_sites__site_id__completion_records_bulk_post
  • POST
    /api/sites/{site_id}/completion-records/revertRevert Completion
    revert_completion_api_sites__site_id__completion_records_revert_post

contractors 12

  • GET
    /api/contractors/List Contractors
    list_contractors_api_contractors__get
  • POST
    /api/contractors/Create Contractor
    create_contractor_api_contractors__post
  • DELETE
    /api/contractors/{contractor_id}Delete Contractor
    delete_contractor_api_contractors__contractor_id__delete
  • PATCH
    /api/contractors/{contractor_id}Update Contractor
    update_contractor_api_contractors__contractor_id__patch
  • DELETE
    /api/contractors/{contractor_id}/logoDelete Contractor Logo
    delete_contractor_logo_api_contractors__contractor_id__logo_delete
  • PUT
    /api/contractors/{contractor_id}/logoUpload Contractor Logo
    upload_contractor_logo_api_contractors__contractor_id__logo_put
  • GET
    /api/contractors/{contractor_id}/logo/imageGet Contractor Logo Image
    get_contractor_logo_image_api_contractors__contractor_id__logo_image_get
  • GET
    /api/contractors/{contractor_id}/oversightGet Contractor Oversight
    get_contractor_oversight_api_contractors__contractor_id__oversight_get
  • POST
    /api/contractors/{contractor_id}/oversightCreate Contractor Oversight
    create_contractor_oversight_api_contractors__contractor_id__oversight_post
  • DELETE
    /api/contractors/{contractor_id}/oversight/{subordinate_id}Delete Contractor Oversight
    delete_contractor_oversight_api_contractors__contractor_id__oversight__subordinate_id__delete
  • GET
    /api/contractors/oversightList Site Oversight
    list_site_oversight_api_contractors_oversight_get
  • GET
    /api/contractors/publicList Contractors Public
    list_contractors_public_api_contractors_public_get

deliveries 21

  • GET
    /api/deliveries/List Deliveries
    list_deliveries_api_deliveries__get
  • POST
    /api/deliveries/Create Delivery
    create_delivery_api_deliveries__post
  • DELETE
    /api/deliveries/{delivery_id}Delete Delivery
    delete_delivery_api_deliveries__delivery_id__delete
  • GET
    /api/deliveries/{delivery_id}Get Delivery
    get_delivery_api_deliveries__delivery_id__get
  • PATCH
    /api/deliveries/{delivery_id}Update Delivery
    update_delivery_api_deliveries__delivery_id__patch
  • GET
    /api/deliveries/{delivery_id}/documentsList Delivery Documents
    list_delivery_documents_api_deliveries__delivery_id__documents_get
  • POST
    /api/deliveries/{delivery_id}/documentsUpload Delivery Document
    upload_delivery_document_api_deliveries__delivery_id__documents_post
  • DELETE
    /api/deliveries/{delivery_id}/documents/{document_id}Delete Delivery Document
    delete_delivery_document_api_deliveries__delivery_id__documents__document_id__delete
  • POST
    /api/deliveries/{delivery_id}/documents/{document_id}/confirmConfirm Delivery Document Draft
    confirm_delivery_document_draft_api_deliveries__delivery_id__documents__document_id__confirm_post
  • GET
    /api/deliveries/{delivery_id}/documents/{document_id}/downloadDownload Delivery Document
    download_delivery_document_api_deliveries__delivery_id__documents__document_id__download_get
  • POST
    /api/deliveries/{delivery_id}/documents/{document_id}/extractExtract Delivery Document
    extract_delivery_document_api_deliveries__delivery_id__documents__document_id__extract_post
  • GET
    /api/deliveries/{delivery_id}/line-itemsList Delivery Line Items
    list_delivery_line_items_api_deliveries__delivery_id__line_items_get
  • POST
    /api/deliveries/{delivery_id}/line-itemsCreate Delivery Line Item
    create_delivery_line_item_api_deliveries__delivery_id__line_items_post
  • DELETE
    /api/deliveries/{delivery_id}/line-items/{item_id}Delete Delivery Line Item
    delete_delivery_line_item_api_deliveries__delivery_id__line_items__item_id__delete
  • PATCH
    /api/deliveries/{delivery_id}/line-items/{item_id}Update Delivery Line Item
    update_delivery_line_item_api_deliveries__delivery_id__line_items__item_id__patch
  • POST
    /api/deliveries/{delivery_id}/receiveReceive Delivery
    receive_delivery_api_deliveries__delivery_id__receive_post
  • DELETE
    /api/deliveries/{delivery_id}/receiving-completeUncomplete Delivery Receiving
    uncomplete_delivery_receiving_api_deliveries__delivery_id__receiving_complete_delete
  • POST
    /api/deliveries/{delivery_id}/receiving-completeComplete Delivery Receiving
    complete_delivery_receiving_api_deliveries__delivery_id__receiving_complete_post
  • GET
    /api/deliveries/{delivery_id}/stock-lotsList Delivery Stock Lots
    list_delivery_stock_lots_api_deliveries__delivery_id__stock_lots_get
  • GET
    /api/deliveries/at-timeList Deliveries At Time
    list_deliveries_at_time_api_deliveries_at_time_get
  • GET
    /api/deliveries/extraction/availabilityGet Extraction Availability
    get_extraction_availability_api_deliveries_extraction_availability_get

dependency-violations 2

  • GET
    /api/dependency-violations/List Dependency Violations
    list_dependency_violations_api_dependency_violations__get
  • POST
    /api/dependency-violations/{episode_id}/declare-blockerDeclare Blocker From Violation
    declare_blocker_from_violation_api_dependency_violations__episode_id__declare_blocker_post

diag 4

  • POST
    /api/diag/auth-eventPost Auth Event
    post_auth_event_api_diag_auth_event_post
  • GET
    /api/diag/client-configGet Client Config
    get_client_config_api_diag_client_config_get
  • POST
    /api/diag/client-eventsPost Client Events
    post_client_events_api_diag_client_events_post
  • GET
    /api/diag/logsGet Recent Logs
    get_recent_logs_api_diag_logs_get

discussions 8

  • GET
    /api/sites/{site_id}/discussions/{subject_kind}/{subject_id}/commentsList Comments
    list_comments_api_sites__site_id__discussions__subject_kind___subject_id__comments_get
  • POST
    /api/sites/{site_id}/discussions/{subject_kind}/{subject_id}/commentsPost Comment
    post_comment_api_sites__site_id__discussions__subject_kind___subject_id__comments_post
  • DELETE
    /api/sites/{site_id}/discussions/{subject_kind}/{subject_id}/comments/{comment_id}Delete Comment
    delete_comment_api_sites__site_id__discussions__subject_kind___subject_id__comments__comment_id__delete
  • PATCH
    /api/sites/{site_id}/discussions/{subject_kind}/{subject_id}/comments/{comment_id}Edit Comment
    edit_comment_api_sites__site_id__discussions__subject_kind___subject_id__comments__comment_id__patch
  • POST
    /api/sites/{site_id}/discussions/{subject_kind}/{subject_id}/comments/{comment_id}/attachmentsAdd Attachment
    add_attachment_api_sites__site_id__discussions__subject_kind___subject_id__comments__comment_id__attachments_post
  • DELETE
    /api/sites/{site_id}/discussions/{subject_kind}/{subject_id}/comments/{comment_id}/attachments/{attachment_id}Remove Attachment
    remove_attachment_api_sites__site_id__discussions__subject_kind___subject_id__comments__comment_id__attachments__attachment_id__delete
  • GET
    /api/sites/{site_id}/discussions/{subject_kind}/{subject_id}/comments/{comment_id}/attachments/{attachment_id}/downloadDownload Attachment
    download_attachment_api_sites__site_id__discussions__subject_kind___subject_id__comments__comment_id__attachments__attachment_id__download_get
  • GET
    /api/sites/{site_id}/discussions/{subject_kind}/{subject_id}/comments/{comment_id}/revisionsList Revisions
    list_revisions_api_sites__site_id__discussions__subject_kind___subject_id__comments__comment_id__revisions_get

evidence-packs 8

  • GET
    /api/evidence-packs/jobs/{job_id}Get Pack Job
    get_pack_job_api_evidence_packs_jobs__job_id__get
  • GET
    /api/evidence-packs/jobs/{job_id}/downloadDownload Pack Job
    download_pack_job_api_evidence_packs_jobs__job_id__download_get
  • GET
    /api/sites/{site_id}/evidence-packsList Evidence Packs
    list_evidence_packs_api_sites__site_id__evidence_packs_get
  • POST
    /api/sites/{site_id}/evidence-packsCreate Evidence Pack
    create_evidence_pack_api_sites__site_id__evidence_packs_post
  • GET
    /api/sites/{site_id}/evidence-packs/{pack_id}Get Evidence Pack
    get_evidence_pack_api_sites__site_id__evidence_packs__pack_id__get
  • GET
    /api/sites/{site_id}/evidence-packs/{pack_id}/attestations/{attestation_id}/verifyVerify Evidence Pack Attestation
    verify_evidence_pack_attestation_api_sites__site_id__evidence_packs__pack_id__attestations__attestation_id__verify_get
  • POST
    /api/sites/{site_id}/evidence-packs/{pack_id}/generateGenerate Evidence Pack
    generate_evidence_pack_api_sites__site_id__evidence_packs__pack_id__generate_post
  • GET
    /api/sites/{site_id}/evidence-packs/record-classesList Record Classes
    list_record_classes_api_sites__site_id__evidence_packs_record_classes_get

exports 1

  • GET
    /api/exports/geojsonExport Geojson
    export_geojson_api_exports_geojson_get

floor_plans 16

  • GET
    /api/floor-plans/{feature_id}List Floor Plans
    list_floor_plans_api_floor_plans__feature_id__get
  • GET
    /api/floor-plans/{feature_id}/{level_index}Get Floor Plan
    get_floor_plan_api_floor_plans__feature_id___level_index__get
  • DELETE
    /api/floor-plans/{floor_plan_id}Delete Floor Plan
    delete_floor_plan_api_floor_plans__floor_plan_id__delete
  • GET
    /api/floor-plans/{floor_plan_id}/imageGet Floor Plan Image
    get_floor_plan_image_api_floor_plans__floor_plan_id__image_get
  • PATCH
    /api/floor-plans/{floor_plan_id}/placementUpdate Floor Plan Placement
    update_floor_plan_placement_api_floor_plans__floor_plan_id__placement_patch
  • POST
    /api/floor-plans/{floor_plan_id}/reprocess-vectorReprocess Vector Floor Plan
    reprocess_vector_floor_plan_api_floor_plans__floor_plan_id__reprocess_vector_post
  • GET
    /api/floor-plans/{floor_plan_id}/vector.geojsonGet Floor Plan Vector
    get_floor_plan_vector_api_floor_plans__floor_plan_id__vector_geojson_get
  • PATCH
    /api/floor-plans/{floor_plan_id}/visibilityUpdate Floor Plan Visibility
    update_floor_plan_visibility_api_floor_plans__floor_plan_id__visibility_patch
  • GET
    /api/floor-plans/at-timeList Floor Plans At Time
    list_floor_plans_at_time_api_floor_plans_at_time_get
  • GET
    /api/floor-plans/by-siteList Floor Plans By Site
    list_floor_plans_by_site_api_floor_plans_by_site_get
  • POST
    /api/floor-plans/import-dxfImport Dxf Floor Plans
    import_dxf_floor_plans_api_floor_plans_import_dxf_post
  • GET
    /api/floor-plans/import-dxf/activeGet Active Import Dxf
    get_active_import_dxf_api_floor_plans_import_dxf_active_get
  • POST
    /api/floor-plans/import-dxf/inspectInspect Dxf
    inspect_dxf_api_floor_plans_import_dxf_inspect_post
  • GET
    /api/floor-plans/import-dxf/progress/{session_id}Get Import Dxf Progress
    get_import_dxf_progress_api_floor_plans_import_dxf_progress__session_id__get
  • POST
    /api/floor-plans/uploadUpload Floor Plan
    upload_floor_plan_api_floor_plans_upload_post
  • POST
    /api/floor-plans/upload-imageUpload Floor Plan Image
    upload_floor_plan_image_api_floor_plans_upload_image_post

geometadata 7

  • GET
    /api/geometadata/layersList Layers
    list_layers_api_geometadata_layers_get
  • POST
    /api/geometadata/layersCreate Layer
    create_layer_api_geometadata_layers_post
  • DELETE
    /api/geometadata/layers/{layer_id}Delete Layer
    delete_layer_api_geometadata_layers__layer_id__delete
  • GET
    /api/geometadata/layers/{layer_id}Get Layer
    get_layer_api_geometadata_layers__layer_id__get
  • PATCH
    /api/geometadata/layers/{layer_id}Update Layer
    update_layer_api_geometadata_layers__layer_id__patch
  • GET
    /api/geometadata/layers/{layer_id}/featuresList Features
    list_features_api_geometadata_layers__layer_id__features_get
  • POST
    /api/geometadata/layers/uploadUpload Geometadata Layer
    upload_geometadata_layer_api_geometadata_layers_upload_post

geometry 10

  • POST
    /api/geometry/check-overlapsCheck Overlaps
    check_overlaps_api_geometry_check_overlaps_post
  • POST
    /api/geometry/cut-holeCut Hole
    cut_hole_api_geometry_cut_hole_post
  • POST
    /api/geometry/cut-hole-freeformCut Hole Freeform
    cut_hole_freeform_api_geometry_cut_hole_freeform_post
  • GET
    /api/geometry/defaultsList Layer Type Defaults
    list_layer_type_defaults_api_geometry_defaults_get
  • PATCH
    /api/geometry/defaultsUpdate Layer Type Default
    update_layer_type_default_api_geometry_defaults_patch
  • GET
    /api/geometry/history/{feature_id}Get Feature History
    get_feature_history_api_geometry_history__feature_id__get
  • GET
    /api/geometry/pending-cuts/{feature_id}Get Pending Cuts
    get_pending_cuts_api_geometry_pending_cuts__feature_id__get
  • POST
    /api/geometry/reapply-cut/{history_id}Reapply Cut
    reapply_cut_api_geometry_reapply_cut__history_id__post
  • GET
    /api/geometry/rulesList Layer Type Rules
    list_layer_type_rules_api_geometry_rules_get
  • POST
    /api/geometry/undo-cut/{history_id}Undo Cut
    undo_cut_api_geometry_undo_cut__history_id__post

health 3

  • GET
    /api/healthHealth check
    healthcheck_api_health_get
  • GET
    /api/health/liveLiveness probe
    liveness_api_health_live_get
  • GET
    /api/health/readyReadiness probe
    readiness_api_health_ready_get

import 3

  • POST
    /api/import/executeExecute Import
    execute_import_api_import_execute_post
  • GET
    /api/import/template/{entity_type}Download Template
    download_template_api_import_template__entity_type__get
  • POST
    /api/import/validateValidate Import
    validate_import_api_import_validate_post

incidents 33

  • GET
    /api/incidentsList Incidents Cross Site
    list_incidents_cross_site_api_incidents_get
  • GET
    /api/incidents/export.csvExport Incidents Csv
    export_incidents_csv_api_incidents_export_csv_get
  • GET
    /api/sites/{site_id}/incident-cause-typesList Incident Cause Types
    list_incident_cause_types_api_sites__site_id__incident_cause_types_get
  • POST
    /api/sites/{site_id}/incident-cause-typesCreate Incident Cause Type
    create_incident_cause_type_api_sites__site_id__incident_cause_types_post
  • POST
    /api/sites/{site_id}/incident-cause-types/{cause_type_id}/updateUpdate Incident Cause Type
    update_incident_cause_type_api_sites__site_id__incident_cause_types__cause_type_id__update_post
  • GET
    /api/sites/{site_id}/incidentsList Site Incidents
    list_site_incidents_api_sites__site_id__incidents_get
  • POST
    /api/sites/{site_id}/incidentsCreate Incident
    create_incident_api_sites__site_id__incidents_post
  • DELETE
    /api/sites/{site_id}/incidents/{incident_id}Delete Draft Incident
    delete_draft_incident_api_sites__site_id__incidents__incident_id__delete
  • GET
    /api/sites/{site_id}/incidents/{incident_id}Get Incident
    get_incident_api_sites__site_id__incidents__incident_id__get
  • POST
    /api/sites/{site_id}/incidents/{incident_id}/amend-classificationAmend Incident Classification
    amend_incident_classification_api_sites__site_id__incidents__incident_id__amend_classification_post
  • POST
    /api/sites/{site_id}/incidents/{incident_id}/approveApprove Incident
    approve_incident_api_sites__site_id__incidents__incident_id__approve_post
  • POST
    /api/sites/{site_id}/incidents/{incident_id}/assign-investigatorAssign Incident Investigator
    assign_incident_investigator_api_sites__site_id__incidents__incident_id__assign_investigator_post
  • POST
    /api/sites/{site_id}/incidents/{incident_id}/causesAdd Incident Cause
    add_incident_cause_api_sites__site_id__incidents__incident_id__causes_post
  • DELETE
    /api/sites/{site_id}/incidents/{incident_id}/causes/{cause_id}Remove Incident Cause
    remove_incident_cause_api_sites__site_id__incidents__incident_id__causes__cause_id__delete
  • POST
    /api/sites/{site_id}/incidents/{incident_id}/causes/{cause_id}/updateUpdate Incident Cause
    update_incident_cause_api_sites__site_id__incidents__incident_id__causes__cause_id__update_post
  • POST
    /api/sites/{site_id}/incidents/{incident_id}/evidenceUpload Incident Evidence
    upload_incident_evidence_api_sites__site_id__incidents__incident_id__evidence_post
  • DELETE
    /api/sites/{site_id}/incidents/{incident_id}/evidence/{evidence_id}Delete Incident Evidence
    delete_incident_evidence_api_sites__site_id__incidents__incident_id__evidence__evidence_id__delete
  • GET
    /api/sites/{site_id}/incidents/{incident_id}/evidence/{evidence_id}/downloadDownload Incident Evidence
    download_incident_evidence_api_sites__site_id__incidents__incident_id__evidence__evidence_id__download_get
  • POST
    /api/sites/{site_id}/incidents/{incident_id}/investigation-scalarsUpdate Incident Investigation Scalars
    update_incident_investigation_scalars_api_sites__site_id__incidents__incident_id__investigation_scalars_post
  • POST
    /api/sites/{site_id}/incidents/{incident_id}/involvedSet Involved Entities
    set_involved_entities_api_sites__site_id__incidents__incident_id__involved_post
  • GET
    /api/sites/{site_id}/incidents/{incident_id}/pdfGet Incident Pdf
    get_incident_pdf_api_sites__site_id__incidents__incident_id__pdf_get
  • GET
    /api/sites/{site_id}/incidents/{incident_id}/pdf/downloadDownload Incident Pdf
    download_incident_pdf_api_sites__site_id__incidents__incident_id__pdf_download_get
  • POST
    /api/sites/{site_id}/incidents/{incident_id}/raise-actionRaise Incident Action
    raise_incident_action_api_sites__site_id__incidents__incident_id__raise_action_post
  • POST
    /api/sites/{site_id}/incidents/{incident_id}/rate-investigationRate Incident Investigation
    rate_incident_investigation_api_sites__site_id__incidents__incident_id__rate_investigation_post
  • POST
    /api/sites/{site_id}/incidents/{incident_id}/rejectReject Incident
    reject_incident_api_sites__site_id__incidents__incident_id__reject_post
  • POST
    /api/sites/{site_id}/incidents/{incident_id}/request-detailRequest Incident Detail
    request_incident_detail_api_sites__site_id__incidents__incident_id__request_detail_post
  • POST
    /api/sites/{site_id}/incidents/{incident_id}/restoreRestore Incident
    restore_incident_api_sites__site_id__incidents__incident_id__restore_post
  • POST
    /api/sites/{site_id}/incidents/{incident_id}/reviewReview Incident
    review_incident_api_sites__site_id__incidents__incident_id__review_post
  • POST
    /api/sites/{site_id}/incidents/{incident_id}/soft-deleteSoft Delete Incident
    soft_delete_incident_api_sites__site_id__incidents__incident_id__soft_delete_post
  • POST
    /api/sites/{site_id}/incidents/{incident_id}/submitSubmit Incident
    submit_incident_api_sites__site_id__incidents__incident_id__submit_post
  • POST
    /api/sites/{site_id}/incidents/{incident_id}/updateUpdate Incident
    update_incident_api_sites__site_id__incidents__incident_id__update_post
  • POST
    /api/sites/{site_id}/incidents/captureCapture Incident
    capture_incident_api_sites__site_id__incidents_capture_post
  • POST
    /api/sites/{site_id}/incidents/from-observation/{observation_id}Escalate Observation To Incident
    escalate_observation_to_incident_api_sites__site_id__incidents_from_observation__observation_id__post

inspections 15

  • GET
    /api/sites/{site_id}/inspection-templatesList Inspection Templates
    list_inspection_templates_api_sites__site_id__inspection_templates_get
  • POST
    /api/sites/{site_id}/inspection-templatesCreate Inspection Template
    create_inspection_template_api_sites__site_id__inspection_templates_post
  • PATCH
    /api/sites/{site_id}/inspection-templates/{template_id}Update Inspection Template
    update_inspection_template_api_sites__site_id__inspection_templates__template_id__patch
  • GET
    /api/sites/{site_id}/inspectionsList Inspections
    list_inspections_api_sites__site_id__inspections_get
  • POST
    /api/sites/{site_id}/inspectionsCreate Inspection
    create_inspection_api_sites__site_id__inspections_post
  • DELETE
    /api/sites/{site_id}/inspections/{inspection_id}Delete Inspection
    delete_inspection_api_sites__site_id__inspections__inspection_id__delete
  • GET
    /api/sites/{site_id}/inspections/{inspection_id}Get Inspection
    get_inspection_api_sites__site_id__inspections__inspection_id__get
  • POST
    /api/sites/{site_id}/inspections/{inspection_id}/evidenceUpload Inspection Evidence
    upload_inspection_evidence_api_sites__site_id__inspections__inspection_id__evidence_post
  • DELETE
    /api/sites/{site_id}/inspections/{inspection_id}/evidence/{evidence_id}Delete Inspection Evidence
    delete_inspection_evidence_api_sites__site_id__inspections__inspection_id__evidence__evidence_id__delete
  • GET
    /api/sites/{site_id}/inspections/{inspection_id}/evidence/{evidence_id}/downloadDownload Inspection Evidence
    download_inspection_evidence_api_sites__site_id__inspections__inspection_id__evidence__evidence_id__download_get
  • GET
    /api/sites/{site_id}/inspections/{inspection_id}/export/pdfExport Inspection Pdf
    export_inspection_pdf_api_sites__site_id__inspections__inspection_id__export_pdf_get
  • PATCH
    /api/sites/{site_id}/inspections/{inspection_id}/itemsAnswer Inspection Items
    answer_inspection_items_api_sites__site_id__inspections__inspection_id__items_patch
  • POST
    /api/sites/{site_id}/inspections/{inspection_id}/submitSubmit Inspection
    submit_inspection_api_sites__site_id__inspections__inspection_id__submit_post
  • GET
    /api/sites/{site_id}/inspections/template-versions/{version_id}Get Inspection Template Version
    get_inspection_template_version_api_sites__site_id__inspections_template_versions__version_id__get
  • GET
    /api/sites/{site_id}/inspections/templatesList Inspection Templates
    list_inspection_templates_api_sites__site_id__inspections_templates_get

invite-links 6

  • DELETE
    /api/invite-links/{link_id}Revoke Invite Link
    revoke_invite_link_api_invite_links__link_id__delete
  • POST
    /api/invite-links/accept/{token}Accept Invite Link
    accept_invite_link_api_invite_links_accept__token__post
  • POST
    /api/invite-links/register/{token}Register Via Invite Link
    register_via_invite_link_api_invite_links_register__token__post
  • GET
    /api/invite-links/sites/{site_id}List Invite Links
    list_invite_links_api_invite_links_sites__site_id__get
  • POST
    /api/invite-links/sites/{site_id}Create Invite Link
    create_invite_link_api_invite_links_sites__site_id__post
  • GET
    /api/invite-links/validate/{token}Validate Invite Link
    validate_invite_link_api_invite_links_validate__token__get

invites 4

  • DELETE
    /api/invites/{invite_id}Revoke Invite
    revoke_invite_api_invites__invite_id__delete
  • POST
    /api/invites/{invite_id}/resendResend Invite
    resend_invite_api_invites__invite_id__resend_post
  • GET
    /api/invites/sites/{site_id}List Invites
    list_invites_api_invites_sites__site_id__get
  • POST
    /api/invites/sites/{site_id}Create Invite
    create_invite_api_invites_sites__site_id__post

label-styles 2

  • GET
    /api/sites/{site_id}/label-styles/Get Label Styles
    get_label_styles_api_sites__site_id__label_styles__get
  • PUT
    /api/sites/{site_id}/label-styles/Upsert Label Styles
    upsert_label_styles_api_sites__site_id__label_styles__put

learning 1

  • GET
    /api/learning/clips/{clip_id}Get Learning Clip
    get_learning_clip_api_learning_clips__clip_id__get

lost-time 1

  • GET
    /api/lost-timeGet Lost Time
    get_lost_time_api_lost_time_get

materials 5

  • GET
    /api/materials/List Materials
    list_materials_api_materials__get
  • POST
    /api/materials/Create Material
    create_material_api_materials__post
  • DELETE
    /api/materials/{material_id}Delete Material
    delete_material_api_materials__material_id__delete
  • PATCH
    /api/materials/{material_id}Update Material
    update_material_api_materials__material_id__patch
  • GET
    /api/materials/unit-suggestionsMaterial Unit Suggestions
    material_unit_suggestions_api_materials_unit_suggestions_get

memberships 3

  • DELETE
    /api/memberships/{membership_id}Reject Member
    reject_member_api_memberships__membership_id__delete
  • POST
    /api/memberships/{membership_id}/approveApprove Member
    approve_member_api_memberships__membership_id__approve_post
  • GET
    /api/memberships/sites/{site_id}/pendingList Pending Members
    list_pending_members_api_memberships_sites__site_id__pending_get

notification-prefs 3

  • DELETE
    /api/notification-prefs/{kind}/{channel}Clear Pref
    clear_pref_api_notification_prefs__kind___channel__delete
  • PATCH
    /api/notification-prefs/{kind}/{channel}Set Pref
    set_pref_api_notification_prefs__kind___channel__patch
  • GET
    /api/notification-prefs/effectiveGet Effective
    get_effective_api_notification_prefs_effective_get

notification-rules 10

  • GET
    /api/notification-rules/List Rules
    list_rules_api_notification_rules__get
  • POST
    /api/notification-rules/Create Rule
    create_rule_api_notification_rules__post
  • DELETE
    /api/notification-rules/{rule_id}Delete Rule
    delete_rule_api_notification_rules__rule_id__delete
  • GET
    /api/notification-rules/{rule_id}Get Rule
    get_rule_api_notification_rules__rule_id__get
  • PATCH
    /api/notification-rules/{rule_id}Update Rule
    update_rule_api_notification_rules__rule_id__patch
  • POST
    /api/notification-rules/{rule_id}/cloneClone Rule
    clone_rule_api_notification_rules__rule_id__clone_post
  • POST
    /api/notification-rules/{rule_id}/enabledSet Enabled
    set_enabled_api_notification_rules__rule_id__enabled_post
  • GET
    /api/notification-rules/{rule_id}/versionsList Versions
    list_versions_api_notification_rules__rule_id__versions_get
  • GET
    /api/notification-rules/event-schemasGet Event Schemas
    get_event_schemas_api_notification_rules_event_schemas_get
  • POST
    /api/notification-rules/preview-recipientsPreview Recipients Route
    preview_recipients_route_api_notification_rules_preview_recipients_post

notifications 6

  • GET
    /api/notifications/List Notifications
    list_notifications_api_notifications__get
  • POST
    /api/notifications/_test_dispatchTest Dispatch
    test_dispatch_api_notifications__test_dispatch_post
  • GET
    /api/notifications/{notification_id}Get Notification
    get_notification_api_notifications__notification_id__get
  • POST
    /api/notifications/{notification_id}/mark-readMark Read
    mark_read_api_notifications__notification_id__mark_read_post
  • POST
    /api/notifications/mark-all-readMark All Read
    mark_all_read_api_notifications_mark_all_read_post
  • GET
    /api/notifications/unread-countGet Unread Count
    get_unread_count_api_notifications_unread_count_get

observations 25

  • GET
    /api/observationsList Observations Cross Site
    list_observations_cross_site_api_observations_get
  • GET
    /api/observations/export.csvExport Observations Csv
    export_observations_csv_api_observations_export_csv_get
  • GET
    /api/sites/{site_id}/observation-capture-linksList Capture Links
    list_capture_links_api_sites__site_id__observation_capture_links_get
  • POST
    /api/sites/{site_id}/observation-capture-linksCreate Capture Link
    create_capture_link_api_sites__site_id__observation_capture_links_post
  • DELETE
    /api/sites/{site_id}/observation-capture-links/{link_id}Revoke Capture Link
    revoke_capture_link_api_sites__site_id__observation_capture_links__link_id__delete
  • GET
    /api/sites/{site_id}/observation-categoriesList Observation Categories
    list_observation_categories_api_sites__site_id__observation_categories_get
  • POST
    /api/sites/{site_id}/observation-categoriesCreate Observation Category
    create_observation_category_api_sites__site_id__observation_categories_post
  • POST
    /api/sites/{site_id}/observation-categories/{category_id}/updateUpdate Observation Category
    update_observation_category_api_sites__site_id__observation_categories__category_id__update_post
  • GET
    /api/sites/{site_id}/observationsList Site Observations
    list_site_observations_api_sites__site_id__observations_get
  • POST
    /api/sites/{site_id}/observationsCreate Observation
    create_observation_api_sites__site_id__observations_post
  • GET
    /api/sites/{site_id}/observations/{observation_id}Get Observation
    get_observation_api_sites__site_id__observations__observation_id__get
  • POST
    /api/sites/{site_id}/observations/{observation_id}/discardDiscard Observation
    discard_observation_api_sites__site_id__observations__observation_id__discard_post
  • POST
    /api/sites/{site_id}/observations/{observation_id}/evidenceUpload Observation Evidence
    upload_observation_evidence_api_sites__site_id__observations__observation_id__evidence_post
  • DELETE
    /api/sites/{site_id}/observations/{observation_id}/evidence/{evidence_id}Delete Observation Evidence
    delete_observation_evidence_api_sites__site_id__observations__observation_id__evidence__evidence_id__delete
  • GET
    /api/sites/{site_id}/observations/{observation_id}/evidence/{evidence_id}/downloadDownload Observation Evidence
    download_observation_evidence_api_sites__site_id__observations__observation_id__evidence__evidence_id__download_get
  • POST
    /api/sites/{site_id}/observations/{observation_id}/involvedSet Involved Entities
    set_involved_entities_api_sites__site_id__observations__observation_id__involved_post
  • POST
    /api/sites/{site_id}/observations/{observation_id}/re-rateRe Rate Observation
    re_rate_observation_api_sites__site_id__observations__observation_id__re_rate_post
  • POST
    /api/sites/{site_id}/observations/{observation_id}/reclassifyReclassify Observation
    reclassify_observation_api_sites__site_id__observations__observation_id__reclassify_post
  • POST
    /api/sites/{site_id}/observations/{observation_id}/reopenReopen Observation
    reopen_observation_api_sites__site_id__observations__observation_id__reopen_post
  • POST
    /api/sites/{site_id}/observations/{observation_id}/resolveResolve Observation
    resolve_observation_api_sites__site_id__observations__observation_id__resolve_post
  • POST
    /api/sites/{site_id}/observations/{observation_id}/restoreRestore Observation
    restore_observation_api_sites__site_id__observations__observation_id__restore_post
  • POST
    /api/sites/{site_id}/observations/{observation_id}/soft-deleteSoft Delete Observation
    soft_delete_observation_api_sites__site_id__observations__observation_id__soft_delete_post
  • POST
    /api/sites/{site_id}/observations/{observation_id}/triageTriage Accept Observation
    triage_accept_observation_api_sites__site_id__observations__observation_id__triage_post
  • POST
    /api/sites/{site_id}/observations/{observation_id}/undiscardUndiscard Observation
    undiscard_observation_api_sites__site_id__observations__observation_id__undiscard_post
  • POST
    /api/sites/{site_id}/observations/{observation_id}/updateUpdate Observation
    update_observation_api_sites__site_id__observations__observation_id__update_post

observations-public 6

  • GET
    /api/observe/{token}Get Capture Context
    get_capture_context_api_observe__token__get
  • POST
    /api/observe/{token}/observationsSubmit Public Observation
    submit_public_observation_api_observe__token__observations_post
  • POST
    /api/observe/{token}/observations/{observation_id}/evidenceUpload Public Observation Photo
    upload_public_observation_photo_api_observe__token__observations__observation_id__evidence_post
  • POST
    /api/observe/resolveResolve Geofenced Sites
    resolve_geofenced_sites_api_observe_resolve_post
  • POST
    /api/observe/session/{session_token}/observationsSubmit Geofence Observation
    submit_geofence_observation_api_observe_session__session_token__observations_post
  • POST
    /api/observe/session/{session_token}/observations/{observation_id}/evidenceUpload Geofence Observation Photo
    upload_geofence_observation_photo_api_observe_session__session_token__observations__observation_id__evidence_post

orders 14

  • GET
    /api/orders/List Orders
    list_orders_api_orders__get
  • POST
    /api/orders/Create Order
    create_order_api_orders__post
  • DELETE
    /api/orders/{order_id}Delete Order
    delete_order_api_orders__order_id__delete
  • GET
    /api/orders/{order_id}Get Order
    get_order_api_orders__order_id__get
  • PATCH
    /api/orders/{order_id}Update Order
    update_order_api_orders__order_id__patch
  • POST
    /api/orders/{order_id}/linesCreate Order Line
    create_order_line_api_orders__order_id__lines_post
  • DELETE
    /api/orders/{order_id}/lines/{line_id}Delete Order Line
    delete_order_line_api_orders__order_id__lines__line_id__delete
  • PATCH
    /api/orders/{order_id}/lines/{line_id}Update Order Line
    update_order_line_api_orders__order_id__lines__line_id__patch
  • GET
    /api/orders/documentsList Order Documents
    list_order_documents_api_orders_documents_get
  • POST
    /api/orders/documentsUpload Order Document
    upload_order_document_api_orders_documents_post
  • DELETE
    /api/orders/documents/{document_id}Delete Order Document
    delete_order_document_api_orders_documents__document_id__delete
  • POST
    /api/orders/documents/{document_id}/confirmConfirm Order Document
    confirm_order_document_api_orders_documents__document_id__confirm_post
  • GET
    /api/orders/documents/{document_id}/downloadDownload Order Document
    download_order_document_api_orders_documents__document_id__download_get
  • POST
    /api/orders/documents/{document_id}/extractExtract Order Document Route
    extract_order_document_route_api_orders_documents__document_id__extract_post

permits 55

  • GET
    /api/permitsList Permits
    list_permits_api_permits_get
  • GET
    /api/permits/applicationsList Permit Applications
    list_permit_applications_api_permits_applications_get
  • POST
    /api/permits/applicationsCreate Permit Application
    create_permit_application_api_permits_applications_post
  • DELETE
    /api/permits/applications/{permit_id}Delete Permit Application
    delete_permit_application_api_permits_applications__permit_id__delete
  • GET
    /api/permits/applications/{permit_id}Get Permit Application
    get_permit_application_api_permits_applications__permit_id__get
  • PATCH
    /api/permits/applications/{permit_id}Update Permit Application
    update_permit_application_api_permits_applications__permit_id__patch
  • POST
    /api/permits/applications/{permit_id}/approveApprove Permit Application
    approve_permit_application_api_permits_applications__permit_id__approve_post
  • POST
    /api/permits/applications/{permit_id}/attachmentsUpload Permit Attachment
    upload_permit_attachment_api_permits_applications__permit_id__attachments_post
  • DELETE
    /api/permits/applications/{permit_id}/attachments/{attachment_id}Delete Permit Attachment
    delete_permit_attachment_api_permits_applications__permit_id__attachments__attachment_id__delete
  • GET
    /api/permits/applications/{permit_id}/attachments/{attachment_id}/downloadDownload Permit Attachment
    download_permit_attachment_api_permits_applications__permit_id__attachments__attachment_id__download_get
  • GET
    /api/permits/applications/{permit_id}/audit.csvExport Permit Audit Csv
    export_permit_audit_csv_api_permits_applications__permit_id__audit_csv_get
  • POST
    /api/permits/applications/{permit_id}/close-outClose Out Permit Application
    close_out_permit_application_api_permits_applications__permit_id__close_out_post
  • POST
    /api/permits/applications/{permit_id}/countersignCountersign Permit Application
    countersign_permit_application_api_permits_applications__permit_id__countersign_post
  • GET
    /api/permits/applications/{permit_id}/documentGet Permit Document
    get_permit_document_api_permits_applications__permit_id__document_get
  • POST
    /api/permits/applications/{permit_id}/endorseEndorse Permit Application
    endorse_permit_application_api_permits_applications__permit_id__endorse_post
  • GET
    /api/permits/applications/{permit_id}/entitiesList Permit Linked Entities
    list_permit_linked_entities_api_permits_applications__permit_id__entities_get
  • GET
    /api/permits/applications/{permit_id}/entities/groupedList Permit Linked Groups
    list_permit_linked_groups_api_permits_applications__permit_id__entities_grouped_get
  • GET
    /api/permits/applications/{permit_id}/extensionsList Permit Extensions
    list_permit_extensions_api_permits_applications__permit_id__extensions_get
  • POST
    /api/permits/applications/{permit_id}/extensionsRequest Permit Extension
    request_permit_extension_api_permits_applications__permit_id__extensions_post
  • POST
    /api/permits/applications/{permit_id}/hand-backHand Back Permit Application
    hand_back_permit_application_api_permits_applications__permit_id__hand_back_post
  • POST
    /api/permits/applications/{permit_id}/issueIssue Permit Application
    issue_permit_application_api_permits_applications__permit_id__issue_post
  • POST
    /api/permits/applications/{permit_id}/linkLink Permit Entities
    link_permit_entities_api_permits_applications__permit_id__link_post
  • POST
    /api/permits/applications/{permit_id}/reissueReissue Permit Application
    reissue_permit_application_api_permits_applications__permit_id__reissue_post
  • POST
    /api/permits/applications/{permit_id}/rejectReject Permit Application
    reject_permit_application_api_permits_applications__permit_id__reject_post
  • POST
    /api/permits/applications/{permit_id}/request-correctionsRequest Corrections Permit Application
    request_corrections_permit_application_api_permits_applications__permit_id__request_corrections_post
  • POST
    /api/permits/applications/{permit_id}/submitSubmit Permit Application
    submit_permit_application_api_permits_applications__permit_id__submit_post
  • POST
    /api/permits/applications/{permit_id}/unlinkUnlink Permit Entity
    unlink_permit_entity_api_permits_applications__permit_id__unlink_post
  • POST
    /api/permits/applications/{permit_id}/withdrawWithdraw Permit Application
    withdraw_permit_application_api_permits_applications__permit_id__withdraw_post
  • GET
    /api/permits/applications/clash-badgesList Permit Clash Badges
    list_permit_clash_badges_api_permits_applications_clash_badges_get
  • POST
    /api/permits/applications/close-out-bulkClose Out Permits Bulk
    close_out_permits_bulk_api_permits_applications_close_out_bulk_post
  • POST
    /api/permits/applications/familySpawn Permit Family
    spawn_permit_family_api_permits_applications_family_post
  • POST
    /api/permits/applications/inlineCo Create Inline Permit
    co_create_inline_permit_api_permits_applications_inline_post
  • GET
    /api/permits/applications/walletList Wallet Permits
    list_wallet_permits_api_permits_applications_wallet_get
  • GET
    /api/permits/appointmentsList Permit Appointments
    list_permit_appointments_api_permits_appointments_get
  • POST
    /api/permits/appointmentsCreate Permit Appointment
    create_permit_appointment_api_permits_appointments_post
  • DELETE
    /api/permits/appointments/{appointment_id}Revoke Permit Appointment
    revoke_permit_appointment_api_permits_appointments__appointment_id__delete
  • GET
    /api/permits/configGet Permit Config
    get_permit_config_api_permits_config_get
  • PUT
    /api/permits/configUpdate Permit Config
    update_permit_config_api_permits_config_put
  • POST
    /api/permits/config/regimeApply Permit Regime Endpoint
    apply_permit_regime_endpoint_api_permits_config_regime_post
  • POST
    /api/permits/extensions/{request_id}/approveApprove Permit Extension
    approve_permit_extension_api_permits_extensions__request_id__approve_post
  • POST
    /api/permits/extensions/{request_id}/rejectReject Permit Extension
    reject_permit_extension_api_permits_extensions__request_id__reject_post
  • GET
    /api/permits/formatsList Formats
    list_formats_api_permits_formats_get
  • POST
    /api/permits/re-resolveRe Resolve Locations
    re_resolve_locations_api_permits_re_resolve_post
  • GET
    /api/permits/setsList Permit Sets
    list_permit_sets_api_permits_sets_get
  • DELETE
    /api/permits/sets/{set_id}Delete Permit Set
    delete_permit_set_api_permits_sets__set_id__delete
  • GET
    /api/permits/typesList Permit Types
    list_permit_types_api_permits_types_get
  • POST
    /api/permits/typesCreate Permit Type
    create_permit_type_api_permits_types_post
  • PATCH
    /api/permits/types/{type_id}Update Permit Type
    update_permit_type_api_permits_types__type_id__patch
  • POST
    /api/permits/uploadUpload Permits
    upload_permits_api_permits_upload_post
  • GET
    /api/permits/workflowGet Workflow
    get_workflow_api_permits_workflow_get
  • DELETE
    /api/permits/workflow/{definition_id}Delete Workflow
    delete_workflow_api_permits_workflow__definition_id__delete
  • PUT
    /api/permits/workflow/{definition_id}Save Workflow
    save_workflow_api_permits_workflow__definition_id__put
  • POST
    /api/permits/workflow/cloneClone Workflow
    clone_workflow_api_permits_workflow_clone_post
  • GET
    /api/permits/workflow/definitionsList Workflow Definitions
    list_workflow_definitions_api_permits_workflow_definitions_get
  • GET
    /api/permits/workflow/registryGet Workflow Registry
    get_workflow_registry_api_permits_workflow_registry_get

planner 3

  • GET
    /api/planner/activitiesPlanner Activities
    planner_activities_api_planner_activities_get
  • POST
    /api/planner/matrixPlanner Matrix
    planner_matrix_api_planner_matrix_post
  • GET
    /api/planner/place-aggregatesPlanner Place Aggregates
    planner_place_aggregates_api_planner_place_aggregates_get

plant 16

  • GET
    /api/plantList Plant
    list_plant_api_plant_get
  • POST
    /api/plantCreate Plant
    create_plant_api_plant_post
  • DELETE
    /api/plant/{plant_id}Delete Plant
    delete_plant_api_plant__plant_id__delete
  • GET
    /api/plant/{plant_id}Get Plant
    get_plant_api_plant__plant_id__get
  • PATCH
    /api/plant/{plant_id}Update Plant
    update_plant_api_plant__plant_id__patch
  • POST
    /api/plant/{plant_id}/convert-to-scheduleConvert Plant To Schedule
    convert_plant_to_schedule_api_plant__plant_id__convert_to_schedule_post
  • GET
    /api/plant/at-timeList Plant At Time
    list_plant_at_time_api_plant_at_time_get
  • POST
    /api/plant/copy-from-rangeCopy Plant From Range
    copy_plant_from_range_api_plant_copy_from_range_post
  • POST
    /api/plant/create-scheduleCreate Plant Schedule
    create_plant_schedule_api_plant_create_schedule_post
  • DELETE
    /api/plant/position-group/{source_plant_id}Delete Plant Position Group
    delete_plant_position_group_api_plant_position_group__source_plant_id__delete
  • DELETE
    /api/plant/schedule-group/{group_id}Delete Plant Schedule Group
    delete_plant_schedule_group_api_plant_schedule_group__group_id__delete
  • GET
    /api/plant/schedule-group/{group_id}Get Plant Schedule Group
    get_plant_schedule_group_api_plant_schedule_group__group_id__get
  • PATCH
    /api/plant/schedule-group/{group_id}Update Plant Schedule Group
    update_plant_schedule_group_api_plant_schedule_group__group_id__patch
  • POST
    /api/plant/schedule-group/{group_id}/finish-earlyFinish Plant Schedule Early
    finish_plant_schedule_early_api_plant_schedule_group__group_id__finish_early_post
  • GET
    /api/plant/schedule-group/{group_id}/future-occurrencesCount Plant Future Occurrences
    count_plant_future_occurrences_api_plant_schedule_group__group_id__future_occurrences_get
  • PUT
    /api/plant/schedule-group/{group_id}/reconcileReconcile Plant Schedule Group
    reconcile_plant_schedule_group_api_plant_schedule_group__group_id__reconcile_put

points-of-interest 5

  • GET
    /api/pois/List Pois
    list_pois_api_pois__get
  • POST
    /api/pois/Create Poi
    create_poi_api_pois__post
  • DELETE
    /api/pois/{poi_id}Delete Poi
    delete_poi_api_pois__poi_id__delete
  • PATCH
    /api/pois/{poi_id}Update Poi
    update_poi_api_pois__poi_id__patch
  • GET
    /api/pois/at-timeList Pois At Time
    list_pois_at_time_api_pois_at_time_get

programmes 15

  • GET
    /api/programmes/List Programmes
    list_programmes_api_programmes__get
  • POST
    /api/programmes/Create Programme
    create_programme_api_programmes__post
  • DELETE
    /api/programmes/{programme_id}Delete Programme
    delete_programme_api_programmes__programme_id__delete
  • GET
    /api/programmes/{programme_id}Get Programme
    get_programme_api_programmes__programme_id__get
  • PATCH
    /api/programmes/{programme_id}Update Programme
    update_programme_api_programmes__programme_id__patch
  • GET
    /api/programmes/{programme_id}/band-mappingsList Band Mappings
    list_band_mappings_api_programmes__programme_id__band_mappings_get
  • PUT
    /api/programmes/{programme_id}/band-mappingsPut Band Mappings
    put_band_mappings_api_programmes__programme_id__band_mappings_put
  • POST
    /api/programmes/{programme_id}/promotePromote
    promote_api_programmes__programme_id__promote_post
  • POST
    /api/programmes/{programme_id}/promote/previewPromote Preview
    promote_preview_api_programmes__programme_id__promote_preview_post
  • GET
    /api/programmes/{programme_id}/revisionsList Revisions
    list_revisions_api_programmes__programme_id__revisions_get
  • POST
    /api/programmes/{programme_id}/revisionsUpload Revision Route
    upload_revision_route_api_programmes__programme_id__revisions_post
  • DELETE
    /api/programmes/{programme_id}/revisions/{revision_id}Delete Revision
    delete_revision_api_programmes__programme_id__revisions__revision_id__delete
  • GET
    /api/programmes/{programme_id}/revisions/{revision_id}/activitiesList Revision Activities
    list_revision_activities_api_programmes__programme_id__revisions__revision_id__activities_get
  • POST
    /api/programmes/{programme_id}/sync/applySync Apply
    sync_apply_api_programmes__programme_id__sync_apply_post
  • GET
    /api/programmes/{programme_id}/sync/previewSync Preview
    sync_preview_api_programmes__programme_id__sync_preview_get

push 4

  • GET
    /api/push/configGet Push Config
    get_push_config_api_push_config_get
  • DELETE
    /api/push/subscriptionsDelete Subscription
    delete_subscription_api_push_subscriptions_delete
  • GET
    /api/push/subscriptionsList Subscriptions
    list_subscriptions_api_push_subscriptions_get
  • PUT
    /api/push/subscriptionsPut Subscription
    put_subscription_api_push_subscriptions_put

rams 18

  • GET
    /api/sites/{site_id}/ramsList Documents
    list_documents_api_sites__site_id__rams_get
  • POST
    /api/sites/{site_id}/ramsCreate Document
    create_document_api_sites__site_id__rams_post
  • GET
    /api/sites/{site_id}/rams/{document_id}Get Document
    get_document_api_sites__site_id__rams__document_id__get
  • GET
    /api/sites/{site_id}/rams/{document_id}/rebriefing-deltaGet Rebriefing Delta
    get_rebriefing_delta_api_sites__site_id__rams__document_id__rebriefing_delta_get
  • POST
    /api/sites/{site_id}/rams/{document_id}/revisionsUpload Revision
    upload_revision_api_sites__site_id__rams__document_id__revisions_post
  • GET
    /api/sites/{site_id}/rams/{document_id}/revisions/{revision_id}/capture-linksList Capture Links
    list_capture_links_api_sites__site_id__rams__document_id__revisions__revision_id__capture_links_get
  • POST
    /api/sites/{site_id}/rams/{document_id}/revisions/{revision_id}/capture-linksMint Capture Link
    mint_capture_link_api_sites__site_id__rams__document_id__revisions__revision_id__capture_links_post
  • DELETE
    /api/sites/{site_id}/rams/{document_id}/revisions/{revision_id}/capture-links/{link_id}Revoke Capture Link
    revoke_capture_link_api_sites__site_id__rams__document_id__revisions__revision_id__capture_links__link_id__delete
  • GET
    /api/sites/{site_id}/rams/{document_id}/revisions/{revision_id}/capture-links/{link_id}/presence-codeGet Capture Link Presence Code
    get_capture_link_presence_code_api_sites__site_id__rams__document_id__revisions__revision_id__capture_links__link_id__presence_code_get
  • GET
    /api/sites/{site_id}/rams/{document_id}/revisions/{revision_id}/downloadDownload Revision
    download_revision_api_sites__site_id__rams__document_id__revisions__revision_id__download_get
  • POST
    /api/sites/{site_id}/rams/{document_id}/revisions/{revision_id}/reviewsRecord Review
    record_review_api_sites__site_id__rams__document_id__revisions__revision_id__reviews_post
  • GET
    /api/sites/{site_id}/rams/{document_id}/revisions/{revision_id}/signaturesList Briefing Signatures
    list_briefing_signatures_api_sites__site_id__rams__document_id__revisions__revision_id__signatures_get
  • POST
    /api/sites/{site_id}/rams/{document_id}/revisions/{revision_id}/signaturesRecord Briefing Signature
    record_briefing_signature_api_sites__site_id__rams__document_id__revisions__revision_id__signatures_post
  • POST
    /api/sites/{site_id}/rams/{document_id}/revisions/{revision_id}/verdictRecord Verdict
    record_verdict_api_sites__site_id__rams__document_id__revisions__revision_id__verdict_post
  • GET
    /api/sites/{site_id}/rams/permissionsGet Site Rams Permissions
    get_site_rams_permissions_api_sites__site_id__rams_permissions_get
  • GET
    /api/sites/{site_id}/rams/review-disciplinesList Review Disciplines
    list_review_disciplines_api_sites__site_id__rams_review_disciplines_get
  • POST
    /api/sites/{site_id}/rams/review-disciplinesCreate Review Discipline
    create_review_discipline_api_sites__site_id__rams_review_disciplines_post
  • POST
    /api/sites/{site_id}/rams/review-disciplines/{discipline_id}/updateUpdate Review Discipline
    update_review_discipline_api_sites__site_id__rams_review_disciplines__discipline_id__update_post

rams-public 4

  • GET
    /api/rams-briefing/{token}Get Briefing Context
    get_briefing_context_api_rams_briefing__token__get
  • GET
    /api/rams-briefing/{token}/fileDownload Briefing File
    download_briefing_file_api_rams_briefing__token__file_get
  • POST
    /api/rams-briefing/{token}/signaturesSign Briefing
    sign_briefing_api_rams_briefing__token__signatures_post
  • GET
    /api/rams-briefing/{token}/whoamiBriefing Identity Probe
    briefing_identity_probe_api_rams_briefing__token__whoami_get

reference-features 12

  • POST
    /api/reference-features/admin/cleanup-versionsCleanup Old Versions
    cleanup_old_versions_api_reference_features_admin_cleanup_versions_post
  • GET
    /api/reference-features/areasList Areas
    list_areas_api_reference_features_areas_get
  • GET
    /api/reference-features/building-at-pointQuery Building At Point
    query_building_at_point_api_reference_features_building_at_point_get
  • GET
    /api/reference-features/buildings-at-pointQuery Buildings At Point
    query_buildings_at_point_api_reference_features_buildings_at_point_get
  • GET
    /api/reference-features/featuresList Features By Type
    list_features_by_type_api_reference_features_features_get
  • DELETE
    /api/reference-features/features/{feature_id}Delete Feature
    delete_feature_api_reference_features_features__feature_id__delete
  • GET
    /api/reference-features/features/{feature_id}Get Feature
    get_feature_api_reference_features_features__feature_id__get
  • PATCH
    /api/reference-features/features/{feature_id}Update Feature
    update_feature_api_reference_features_features__feature_id__patch
  • GET
    /api/reference-features/features/{feature_id}/at-timeGet Feature At Time
    get_feature_at_time_api_reference_features_features__feature_id__at_time_get
  • GET
    /api/reference-features/features/{feature_id}/historyGet Feature History
    get_feature_history_api_reference_features_features__feature_id__history_get
  • GET
    /api/reference-features/features/at-timeList Features At Time
    list_features_at_time_api_reference_features_features_at_time_get
  • POST
    /api/reference-features/zonesCreate Zone Feature
    create_zone_feature_api_reference_features_zones_post

reports 15

  • GET
    /api/reports/jobs/{job_id}Get Export Job
    get_export_job_api_reports_jobs__job_id__get
  • GET
    /api/reports/jobs/{job_id}/downloadDownload Export Job
    download_export_job_api_reports_jobs__job_id__download_get
  • GET
    /api/reports/sessionsList Sessions
    list_sessions_api_reports_sessions_get
  • POST
    /api/reports/sessionsCreate Session
    create_session_api_reports_sessions_post
  • DELETE
    /api/reports/sessions/{session_id}Delete Session
    delete_session_api_reports_sessions__session_id__delete
  • GET
    /api/reports/sessions/{session_id}Get Session
    get_session_api_reports_sessions__session_id__get
  • PATCH
    /api/reports/sessions/{session_id}Update Session
    update_session_api_reports_sessions__session_id__patch
  • POST
    /api/reports/sessions/{session_id}/completeComplete Session
    complete_session_api_reports_sessions__session_id__complete_post
  • POST
    /api/reports/sessions/{session_id}/export/docxExport Docx
    export_docx_api_reports_sessions__session_id__export_docx_post
  • POST
    /api/reports/sessions/{session_id}/export/pdfExport Pdf
    export_pdf_api_reports_sessions__session_id__export_pdf_post
  • POST
    /api/reports/sessions/{session_id}/refresh-contextRefresh Context
    refresh_context_api_reports_sessions__session_id__refresh_context_post
  • GET
    /api/reports/templatesList Templates
    list_templates_api_reports_templates_get
  • POST
    /api/reports/templatesCreate Template
    create_template_api_reports_templates_post
  • DELETE
    /api/reports/templates/{template_id}Delete Template
    delete_template_api_reports_templates__template_id__delete
  • GET
    /api/reports/templates/{template_id}Get Template
    get_template_api_reports_templates__template_id__get

rule-profiles 9

  • GET
    /api/rule-profilesList Rule Profiles
    list_rule_profiles_api_rule_profiles_get
  • POST
    /api/rule-profilesCreate Rule Profile
    create_rule_profile_api_rule_profiles_post
  • DELETE
    /api/rule-profiles/{profile_id}Delete Rule Profile
    delete_rule_profile_api_rule_profiles__profile_id__delete
  • GET
    /api/rule-profiles/{profile_id}Get Rule Profile
    get_rule_profile_api_rule_profiles__profile_id__get
  • PATCH
    /api/rule-profiles/{profile_id}Update Rule Profile
    update_rule_profile_api_rule_profiles__profile_id__patch
  • POST
    /api/rule-profiles/{profile_id}/activateActivate Profile
    activate_profile_api_rule_profiles__profile_id__activate_post
  • POST
    /api/rule-profiles/{profile_id}/cloneClone Profile
    clone_profile_api_rule_profiles__profile_id__clone_post
  • GET
    /api/rule-profiles/{profile_id}/rulesList Profile Rules
    list_profile_rules_api_rule_profiles__profile_id__rules_get
  • POST
    /api/rule-profiles/{profile_id}/sync-system-rulesSync System Rules
    sync_system_rules_api_rule_profiles__profile_id__sync_system_rules_post

shifts 3

  • GET
    /api/shifts/List Shifts
    list_shifts_api_shifts__get
  • POST
    /api/shifts/Create Shift
    create_shift_api_shifts__post
  • DELETE
    /api/shifts/{shift_id}Delete Shift
    delete_shift_api_shifts__shift_id__delete

site_maps 8

  • GET
    /api/site-maps/{site_map_id}Get Site Map
    get_site_map_api_site_maps__site_map_id__get
  • POST
    /api/site-maps/{site_map_id}/calibrateCalibrate Site Map
    calibrate_site_map_api_site_maps__site_map_id__calibrate_post
  • GET
    /api/site-maps/{site_map_id}/imageGet Site Map Image
    get_site_map_image_api_site_maps__site_map_id__image_get
  • GET
    /api/site-maps/sites/{site_id}/activation-historyGet Activation History
    get_activation_history_api_site_maps_sites__site_id__activation_history_get
  • GET
    /api/site-maps/sites/{site_id}/active-at-timeGet Active Map At Time
    get_active_map_at_time_api_site_maps_sites__site_id__active_at_time_get
  • PUT
    /api/site-maps/sites/{site_id}/active-mapSet Active Site Map
    set_active_site_map_api_site_maps_sites__site_id__active_map_put
  • GET
    /api/site-maps/sites/{site_id}/mapsList Site Maps
    list_site_maps_api_site_maps_sites__site_id__maps_get
  • POST
    /api/site-maps/uploadUpload Site Map
    upload_site_map_api_site_maps_upload_post

sites 16

  • GET
    /api/sites/List Sites
    list_sites_api_sites__get
  • POST
    /api/sites/Create Site
    create_site_api_sites__post
  • DELETE
    /api/sites/{site_id}Delete Site
    delete_site_api_sites__site_id__delete
  • GET
    /api/sites/{site_id}Get Site
    get_site_api_sites__site_id__get
  • PATCH
    /api/sites/{site_id}Update Site
    update_site_api_sites__site_id__patch
  • DELETE
    /api/sites/{site_id}/boundaryClear Site Boundary
    clear_site_boundary_api_sites__site_id__boundary_delete
  • GET
    /api/sites/{site_id}/boundaryGet Site Boundary
    get_site_boundary_api_sites__site_id__boundary_get
  • PUT
    /api/sites/{site_id}/boundarySet Site Boundary
    set_site_boundary_api_sites__site_id__boundary_put
  • POST
    /api/sites/{site_id}/lockSet Data Lock
    set_data_lock_api_sites__site_id__lock_post
  • PUT
    /api/sites/{site_id}/main-contractorSet Main Contractor
    set_main_contractor_api_sites__site_id__main_contractor_put
  • GET
    /api/sites/{site_id}/membersList Site Members
    list_site_members_api_sites__site_id__members_get
  • DELETE
    /api/sites/{site_id}/nukeNuke Site Data
    nuke_site_data_api_sites__site_id__nuke_delete
  • PUT
    /api/sites/{site_id}/observation-thresholdSet Observation Threshold
    set_observation_threshold_api_sites__site_id__observation_threshold_put
  • PUT
    /api/sites/{site_id}/oversight-transitiveSet Oversight Transitive
    set_oversight_transitive_api_sites__site_id__oversight_transitive_put
  • GET
    /api/sites/{site_id}/snapshot-revisionGet Snapshot Revision Summary
    get_snapshot_revision_summary_api_sites__site_id__snapshot_revision_get
  • GET
    /api/sites/publicList Sites Public
    list_sites_public_api_sites_public_get

smart-groups 7

  • GET
    /api/smart-groups/List Smart Groups
    list_smart_groups_api_smart_groups__get
  • POST
    /api/smart-groups/Create Smart Group
    create_smart_group_api_smart_groups__post
  • DELETE
    /api/smart-groups/{group_id}Delete Smart Group
    delete_smart_group_api_smart_groups__group_id__delete
  • GET
    /api/smart-groups/{group_id}Get Smart Group
    get_smart_group_api_smart_groups__group_id__get
  • PATCH
    /api/smart-groups/{group_id}Update Smart Group
    update_smart_group_api_smart_groups__group_id__patch
  • GET
    /api/smart-groups/{group_id}/evaluateEvaluate Smart Group
    evaluate_smart_group_api_smart_groups__group_id__evaluate_get
  • POST
    /api/smart-groups/evaluateEvaluate Adhoc Query
    evaluate_adhoc_query_api_smart_groups_evaluate_post

snags 12

  • GET
    /api/sites/{site_id}/snagsList Snags
    list_snags_api_sites__site_id__snags_get
  • POST
    /api/sites/{site_id}/snagsRaise Snag
    raise_snag_api_sites__site_id__snags_post
  • GET
    /api/sites/{site_id}/snags/{snag_id}Get Snag
    get_snag_api_sites__site_id__snags__snag_id__get
  • POST
    /api/sites/{site_id}/snags/{snag_id}/closeClose Snag
    close_snag_api_sites__site_id__snags__snag_id__close_post
  • POST
    /api/sites/{site_id}/snags/{snag_id}/evidenceUpload Snag Evidence
    upload_snag_evidence_api_sites__site_id__snags__snag_id__evidence_post
  • DELETE
    /api/sites/{site_id}/snags/{snag_id}/evidence/{evidence_id}Delete Snag Evidence
    delete_snag_evidence_api_sites__site_id__snags__snag_id__evidence__evidence_id__delete
  • GET
    /api/sites/{site_id}/snags/{snag_id}/evidence/{evidence_id}/downloadDownload Snag Evidence
    download_snag_evidence_api_sites__site_id__snags__snag_id__evidence__evidence_id__download_get
  • POST
    /api/sites/{site_id}/snags/{snag_id}/evidence/adoptAdopt Completion Evidence
    adopt_completion_evidence_api_sites__site_id__snags__snag_id__evidence_adopt_post
  • POST
    /api/sites/{site_id}/snags/{snag_id}/resolving-refSet Resolving Ref
    set_resolving_ref_api_sites__site_id__snags__snag_id__resolving_ref_post
  • POST
    /api/sites/{site_id}/snags/{snag_id}/restoreRestore Snag
    restore_snag_api_sites__site_id__snags__snag_id__restore_post
  • POST
    /api/sites/{site_id}/snags/{snag_id}/soft-deleteSoft Delete Snag
    soft_delete_snag_api_sites__site_id__snags__snag_id__soft_delete_post
  • POST
    /api/sites/{site_id}/snags/{snag_id}/updateUpdate Snag
    update_snag_api_sites__site_id__snags__snag_id__update_post

stock 13

  • GET
    /api/stock/balances/by-materialList Material Balances
    list_material_balances_api_stock_balances_by_material_get
  • GET
    /api/stock/balances/by-placeList Place Balances
    list_place_balances_api_stock_balances_by_place_get
  • GET
    /api/stock/eventsList Stock Events
    list_stock_events_api_stock_events_get
  • GET
    /api/stock/events/{event_id}/evidenceList Stock Event Evidence
    list_stock_event_evidence_api_stock_events__event_id__evidence_get
  • POST
    /api/stock/events/{event_id}/evidenceUpload Stock Event Evidence
    upload_stock_event_evidence_api_stock_events__event_id__evidence_post
  • GET
    /api/stock/events/{event_id}/evidence/{evidence_id}/downloadDownload Stock Event Evidence
    download_stock_event_evidence_api_stock_events__event_id__evidence__evidence_id__download_get
  • GET
    /api/stock/lotsList Site Stock Lots
    list_site_stock_lots_api_stock_lots_get
  • POST
    /api/stock/lots/{lot_id}/adjustmentPost Stock Adjustment
    post_stock_adjustment_api_stock_lots__lot_id__adjustment_post
  • POST
    /api/stock/lots/{lot_id}/consumptionPost Stock Consumption
    post_stock_consumption_api_stock_lots__lot_id__consumption_post
  • GET
    /api/stock/lots/{lot_id}/eventsList Stock Lot Events
    list_stock_lot_events_api_stock_lots__lot_id__events_get
  • POST
    /api/stock/lots/{lot_id}/lossPost Stock Loss
    post_stock_loss_api_stock_lots__lot_id__loss_post
  • POST
    /api/stock/lots/{lot_id}/transferTransfer Stock Lot
    transfer_stock_lot_api_stock_lots__lot_id__transfer_post
  • GET
    /api/stock/on-handList On Hand Stock
    list_on_hand_stock_api_stock_on_hand_get

stock-thresholds 3

  • GET
    /api/stock/thresholdsList Stock Thresholds
    list_stock_thresholds_api_stock_thresholds_get
  • PUT
    /api/stock/thresholdsUpsert Stock Threshold
    upsert_stock_threshold_api_stock_thresholds_put
  • DELETE
    /api/stock/thresholds/{rule_id}Delete Stock Threshold
    delete_stock_threshold_api_stock_thresholds__rule_id__delete

tasks 5

  • GET
    /api/tasks/List Tasks
    list_tasks_api_tasks__get
  • POST
    /api/tasks/{task_id}/acknowledgeAcknowledge Task
    acknowledge_task_api_tasks__task_id__acknowledge_post
  • POST
    /api/tasks/{task_id}/resolveResolve Task
    resolve_task_api_tasks__task_id__resolve_post
  • GET
    /api/tasks/action-kindsAction Kinds
    action_kinds_api_tasks_action_kinds_get
  • GET
    /api/tasks/unread-countUnread Count
    unread_count_api_tasks_unread_count_get

text-labels 5

  • GET
    /api/text-labels/List Text Labels
    list_text_labels_api_text_labels__get
  • POST
    /api/text-labels/Create Text Label
    create_text_label_api_text_labels__post
  • DELETE
    /api/text-labels/{label_id}Delete Text Label
    delete_text_label_api_text_labels__label_id__delete
  • PATCH
    /api/text-labels/{label_id}Update Text Label
    update_text_label_api_text_labels__label_id__patch
  • GET
    /api/text-labels/at-timeList Text Labels At Time
    list_text_labels_at_time_api_text_labels_at_time_get

threshold-rules 11

  • GET
    /api/threshold-rules/List Rules
    list_rules_api_threshold_rules__get
  • POST
    /api/threshold-rules/Create Rule
    create_rule_api_threshold_rules__post
  • DELETE
    /api/threshold-rules/{rule_id}Delete Rule
    delete_rule_api_threshold_rules__rule_id__delete
  • GET
    /api/threshold-rules/{rule_id}Get Rule
    get_rule_api_threshold_rules__rule_id__get
  • PATCH
    /api/threshold-rules/{rule_id}Update Rule
    update_rule_api_threshold_rules__rule_id__patch
  • POST
    /api/threshold-rules/{rule_id}/cloneClone Rule
    clone_rule_api_threshold_rules__rule_id__clone_post
  • POST
    /api/threshold-rules/{rule_id}/enabledSet Enabled
    set_enabled_api_threshold_rules__rule_id__enabled_post
  • GET
    /api/threshold-rules/{rule_id}/stateGet State
    get_state_api_threshold_rules__rule_id__state_get
  • GET
    /api/threshold-rules/{rule_id}/versionsList Versions
    list_versions_api_threshold_rules__rule_id__versions_get
  • GET
    /api/threshold-rules/data-source-schemasGet Data Source Schemas
    get_data_source_schemas_api_threshold_rules_data_source_schemas_get
  • POST
    /api/threshold-rules/preview-recipientsPreview Recipients Route
    preview_recipients_route_api_threshold_rules_preview_recipients_post

tiles 10

  • GET
    /api/tiles/floor-plan/{floor_plan_id}/{tms}/{z}/{x}/{y}.{ext}Floor Plan Tile With Tms
    floor_plan_tile_with_tms_api_tiles_floor_plan__floor_plan_id___tms___z___x___y___ext__get
  • GET
    /api/tiles/floor-plan/{floor_plan_id}/{z}/{x}/{y}.{ext}Floor Plan Tile
    floor_plan_tile_api_tiles_floor_plan__floor_plan_id___z___x___y___ext__get
  • GET
    /api/tiles/floor-plan/{floor_plan_id}/tilejson.jsonFloor Plan Tilejson
    floor_plan_tilejson_api_tiles_floor_plan__floor_plan_id__tilejson_json_get
  • GET
    /api/tiles/info/{site_map_id}Raster Info
    raster_info_api_tiles_info__site_map_id__get
  • GET
    /api/tiles/raster/{site_map_id}/{z}/{x}/{y}.{ext}Raster Tile
    raster_tile_api_tiles_raster__site_map_id___z___x___y___ext__get
  • GET
    /api/tiles/raster/{site_map_id}/tilejson.jsonRaster Tilejson
    raster_tilejson_api_tiles_raster__site_map_id__tilejson_json_get
  • GET
    /api/tiles/sites/{site_id}/preview.webpSite Preview
    site_preview_api_tiles_sites__site_id__preview_webp_get
  • GET
    /api/tiles/vector/{site_id}/plants/{z}/{x}/{y}.mvtPlants Mvt
    plants_mvt_api_tiles_vector__site_id__plants__z___x___y__mvt_get
  • GET
    /api/tiles/vector/{site_id}/tokens/{z}/{x}/{y}.mvtTokens Mvt
    tokens_mvt_api_tiles_vector__site_id__tokens__z___x___y__mvt_get
  • GET
    /api/tiles/vector/{site_id}/zones/{z}/{x}/{y}.mvtZones Mvt
    zones_mvt_api_tiles_vector__site_id__zones__z___x___y__mvt_get

users 1

  • GET
    /api/users/bulkGet Users Bulk
    get_users_bulk_api_users_bulk_get

weather 4

  • GET
    /api/weather/sites/{site_id}/currentGet Current Weather
    get_current_weather_api_weather_sites__site_id__current_get
  • GET
    /api/weather/sites/{site_id}/forecastGet Forecast
    get_forecast_api_weather_sites__site_id__forecast_get
  • GET
    /api/weather/sites/{site_id}/historyGet History
    get_history_api_weather_sites__site_id__history_get
  • GET
    /api/weather/sites/{site_id}/timelineGet Timeline
    get_timeline_api_weather_sites__site_id__timeline_get

websocket 1

  • GET
    /api/ws/statsWebsocket Stats
    websocket_stats_api_ws_stats_get

work-candidates 1

  • POST
    /api/sites/{site_id}/work-candidatesList Work Candidates
    list_work_candidates_api_sites__site_id__work_candidates_post

work-dependencies 3

  • GET
    /api/work-dependencies/List Work Dependencies
    list_work_dependencies_api_work_dependencies__get
  • POST
    /api/work-dependencies/Create Work Dependency
    create_work_dependency_api_work_dependencies__post
  • DELETE
    /api/work-dependencies/{dependency_id}Delete Work Dependency
    delete_work_dependency_api_work_dependencies__dependency_id__delete

work-lines 18

  • GET
    /api/work-lines/List Work Lines
    list_work_lines_api_work_lines__get
  • POST
    /api/work-lines/Create Work Line
    create_work_line_api_work_lines__post
  • DELETE
    /api/work-lines/{line_id}Delete Work Line
    delete_work_line_api_work_lines__line_id__delete
  • GET
    /api/work-lines/{line_id}Get Work Line
    get_work_line_api_work_lines__line_id__get
  • PATCH
    /api/work-lines/{line_id}Update Work Line
    update_work_line_api_work_lines__line_id__patch
  • POST
    /api/work-lines/{line_id}/attachAttach Token
    attach_token_api_work_lines__line_id__attach_post
  • POST
    /api/work-lines/{line_id}/closeClose Work Line
    close_work_line_api_work_lines__line_id__close_post
  • GET
    /api/work-lines/{line_id}/close-impactWork Line Close Impact
    work_line_close_impact_api_work_lines__line_id__close_impact_get
  • POST
    /api/work-lines/{line_id}/detachDetach Token
    detach_token_api_work_lines__line_id__detach_post
  • POST
    /api/work-lines/{line_id}/detach-programmeDetach Programme
    detach_programme_api_work_lines__line_id__detach_programme_post
  • POST
    /api/work-lines/{line_id}/evidenceUpload Work Line Evidence
    upload_work_line_evidence_api_work_lines__line_id__evidence_post
  • DELETE
    /api/work-lines/{line_id}/evidence/{evidence_id}Delete Work Line Evidence
    delete_work_line_evidence_api_work_lines__line_id__evidence__evidence_id__delete
  • GET
    /api/work-lines/{line_id}/evidence/{evidence_id}/downloadDownload Work Line Evidence
    download_work_line_evidence_api_work_lines__line_id__evidence__evidence_id__download_get
  • POST
    /api/work-lines/{line_id}/re-keyRe Key
    re_key_api_work_lines__line_id__re_key_post
  • POST
    /api/work-lines/{line_id}/reopenReopen Work Line
    reopen_work_line_api_work_lines__line_id__reopen_post
  • POST
    /api/work-lines/{line_id}/startStart Work Line
    start_work_line_api_work_lines__line_id__start_post
  • POST
    /api/work-lines/promotePromote Token
    promote_token_api_work_lines_promote_post
  • GET
    /api/work-lines/varianceWork Line Variance
    work_line_variance_api_work_lines_variance_get

workers 15

  • GET
    /api/workers/List Workers
    list_workers_api_workers__get
  • POST
    /api/workers/Create Worker
    create_worker_api_workers__post
  • DELETE
    /api/workers/{worker_id}Delete Worker
    delete_worker_api_workers__worker_id__delete
  • PATCH
    /api/workers/{worker_id}Update Worker
    update_worker_api_workers__worker_id__patch
  • POST
    /api/workers/{worker_id}/convert-to-scheduleConvert Worker To Schedule
    convert_worker_to_schedule_api_workers__worker_id__convert_to_schedule_post
  • GET
    /api/workers/at-timeList Workers At Time
    list_workers_at_time_api_workers_at_time_get
  • DELETE
    /api/workers/batchBatch Delete Workers
    batch_delete_workers_api_workers_batch_delete
  • POST
    /api/workers/copy-from-rangeCopy Workers From Range
    copy_workers_from_range_api_workers_copy_from_range_post
  • POST
    /api/workers/create-scheduleCreate Worker Schedule
    create_worker_schedule_api_workers_create_schedule_post
  • DELETE
    /api/workers/schedule-group/{group_id}Delete Worker Schedule Group
    delete_worker_schedule_group_api_workers_schedule_group__group_id__delete
  • GET
    /api/workers/schedule-group/{group_id}Get Worker Schedule Group
    get_worker_schedule_group_api_workers_schedule_group__group_id__get
  • PATCH
    /api/workers/schedule-group/{group_id}Update Worker Schedule Group
    update_worker_schedule_group_api_workers_schedule_group__group_id__patch
  • POST
    /api/workers/schedule-group/{group_id}/finish-earlyFinish Worker Schedule Early
    finish_worker_schedule_early_api_workers_schedule_group__group_id__finish_early_post
  • GET
    /api/workers/schedule-group/{group_id}/future-occurrencesCount Worker Future Occurrences
    count_worker_future_occurrences_api_workers_schedule_group__group_id__future_occurrences_get
  • PUT
    /api/workers/schedule-group/{group_id}/reconcileReconcile Worker Schedule Group
    reconcile_worker_schedule_group_api_workers_schedule_group__group_id__reconcile_put
Generated from source · SimOops living system reference