← Technical API reference

Backend resource · STATIC DECLARATIONS

Automation Policy API reference · mansoq-core

Static source contract for Automation Policy: 3 declared or inherited operation mappings, schema/field evidence and authorization/refusal references. Deployment and behavioral review remain explicit.

Static API contract — behavior review pending. Source baseline f6e9f05f76d4.

Enable JavaScript to inspect structured operation, parameter, schema and permission evidence. Download this reference and its evidence.

Declared route and availability

This resource is declared in mansoq-core at /api/v1/facility/{facility_external_id}/automation_policies/. verified core mount in config/urls.py A registered path and an indexed handler do not prove deployment availability, user permission or production readiness.

Operation map

Method Path Action Evidence
GET /api/v1/facility/{facility_external_id}/automation_policies/ list declared/inherited method
GET /api/v1/facility/{facility_external_id}/automation_policies/{external_id}/ retrieve declared/inherited method
PATCH /api/v1/facility/{facility_external_id}/automation_policies/{external_id}/ partial_update declared/inherited method

list · GET

GET /api/v1/facility/{facility_external_id}/automation_policies/ — action list. static contract extracted; runtime/permission/payload behavior review pending.

Path and deployment-context parameters:

Location Parameter Type Required
path facility_external_id router lookup string; semantic ID validation requires handler/schema review true

response: AutomationPolicyReadSpec. Declared fields below; inherited fields are retained in the schema inventory.

Field Type Required Constraints
meta dict false No extra constraint extracted
id UUID4 true No extra constraint extracted
automation_key str true No extra constraint extracted
capability_key str true No extra constraint extracted
status AutomationPolicyStatus true No extra constraint extracted
config dict true No extra constraint extracted
quiet_hours dict | None false No extra constraint extracted
escalation_after_minutes int | None false No extra constraint extracted
assignee_role dict | None false No extra constraint extracted
assignee_organization dict | None false No extra constraint extracted
approved_by dict | None false No extra constraint extracted
approved_at datetime | None false No extra constraint extracted
policy_version int true No extra constraint extracted
registered bool true No extra constraint extracted
created_date datetime true No extra constraint extracted
modified_date datetime true No extra constraint extracted

Authorization: no literal permission name was resolved in the bounded handler/helper traversal. Authentication, inherited policies, object/facility scoping and middleware still require review; this does not mean public access.

Declared refusal/error evidence: PermissionDenied (dynamic detail; inspect source).

retrieve · GET

GET /api/v1/facility/{facility_external_id}/automation_policies/{external_id}/ — action retrieve. static contract extracted; runtime/permission/payload behavior review pending.

Path and deployment-context parameters:

Location Parameter Type Required
path facility_external_id router lookup string; semantic ID validation requires handler/schema review true
path external_id router lookup string; semantic ID validation requires handler/schema review true

response: AutomationPolicyRetrieveSpec. Declared fields below; inherited fields are retained in the schema inventory.

Field Type Required Constraints
meta dict false No extra constraint extracted
id UUID4 true No extra constraint extracted
automation_key str true No extra constraint extracted
capability_key str true No extra constraint extracted
status AutomationPolicyStatus true No extra constraint extracted
config dict true No extra constraint extracted
quiet_hours dict | None false No extra constraint extracted
escalation_after_minutes int | None false No extra constraint extracted
assignee_role dict | None false No extra constraint extracted
assignee_organization dict | None false No extra constraint extracted
approved_by dict | None false No extra constraint extracted
approved_at datetime | None false No extra constraint extracted
policy_version int true No extra constraint extracted
registered bool true No extra constraint extracted
created_date datetime true No extra constraint extracted
modified_date datetime true No extra constraint extracted
config_schema dict | None false No extra constraint extracted

Authorization: no literal permission name was resolved in the bounded handler/helper traversal. Authentication, inherited policies, object/facility scoping and middleware still require review; this does not mean public access.

Declared refusal/error evidence: PermissionDenied (dynamic detail; inspect source).

partial_update · PATCH

PATCH /api/v1/facility/{facility_external_id}/automation_policies/{external_id}/ — action partial_update. static contract extracted; runtime/permission/payload behavior review pending.

Path and deployment-context parameters:

Location Parameter Type Required
path facility_external_id router lookup string; semantic ID validation requires handler/schema review true
path external_id router lookup string; semantic ID validation requires handler/schema review true

response: AutomationPolicyRetrieveSpec. Declared fields below; inherited fields are retained in the schema inventory.

The declared field table is shown at its first occurrence in this reference; this operation links the same schema.

body validation: AutomationPolicyUpdateSpec. Declared fields below; inherited fields are retained in the schema inventory.

Field Type Required Constraints
status AutomationPolicyStatus | None false No extra constraint extracted
config dict | None false No extra constraint extracted
quiet_hours dict | None false No extra constraint extracted
escalation_after_minutes int | None false gt: 0
assignee_role UUID4 | None false No extra constraint extracted
assignee_organization UUID4 | None false No extra constraint extracted

decorator request: AutomationPolicyUpdateSpec. Declared fields below; inherited fields are retained in the schema inventory.

The declared field table is shown at its first occurrence in this reference; this operation links the same schema.

Authorization: no literal permission name was resolved in the bounded handler/helper traversal. Authentication, inherited policies, object/facility scoping and middleware still require review; this does not mean public access.

Declared refusal/error evidence: PermissionDenied (dynamic detail; inspect source); _invalid: status_required; _invalid: automation_unregistered; _invalid: config_invalid; _invalid: assignee_role_not_found; _invalid: assignee_organization_not_found.

Integration review checklist

Confirm the installed route and full schema; review authentication, organization/facility scoping, all accepted fields, value-state and date/time semantics, idempotency, pagination, response/exception branches and the allowed correction/reversal workflow. Test positive and negative cases with synthetic data. This source reference does not establish external certification or replace an illustrated user procedure.

Pinned source evidence

Links require access to the private source repository.