← Technical API reference

Backend resource · STATIC DECLARATIONS

Operational Work Item API reference · mansoq-core

Static source contract for Operational Work Item: 4 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}/operational_work_items/. 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}/operational_work_items/ list declared/inherited method
GET /api/v1/facility/{facility_external_id}/operational_work_items/{external_id}/ retrieve declared/inherited method
POST /api/v1/facility/{facility_external_id}/operational_work_items/{external_id}/acknowledge/ acknowledge @action declaration
POST /api/v1/facility/{facility_external_id}/operational_work_items/{external_id}/resolve/ resolve @action declaration

list · GET

GET /api/v1/facility/{facility_external_id}/operational_work_items/ — 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: OperationalWorkItemReadSpec. 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
kind str true No extra constraint extracted
status str true No extra constraint extracted
priority str true No extra constraint extracted
title str true No extra constraint extracted
description str true No extra constraint extracted
related_resource_type str true No extra constraint extracted
related_resource_id UUID4 | None false No extra constraint extracted
assignee_role dict | None false No extra constraint extracted
assignee_organization dict | None false No extra constraint extracted
assigned_to dict | None false No extra constraint extracted
due_at datetime | None false No extra constraint extracted
resolved_at datetime | None false No extra constraint extracted
resolution dict 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}/operational_work_items/{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: OperationalWorkItemReadSpec. 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).

acknowledge · POST

POST /api/v1/facility/{facility_external_id}/operational_work_items/{external_id}/acknowledge/ — action acknowledge. 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

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: _invalid: work_item_assigned; _invalid: work_item_closed; PermissionDenied (dynamic detail; inspect source).

resolve · POST

POST /api/v1/facility/{facility_external_id}/operational_work_items/{external_id}/resolve/ — action resolve. 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

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

Field Type Required Constraints
note str false max_length: 1000

decorator request: OperationalWorkItemResolveSpec. 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: work_item_closed.

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.