← Technical API reference

Backend resource · STATIC DECLARATIONS

Report Upload API reference · mansoq-core-teleicu

Static source contract for Report Upload: 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-teleicu at /api/v1/template_reports/. verified core mount in config/urls.py This is an alternative core contract, not proof that the primary core uses the same behavior. 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/template_reports/ list declared/inherited method
GET /api/v1/template_reports/{external_id}/ retrieve declared/inherited method
POST /api/v1/template_reports/generate/ generate @action declaration
POST /api/v1/template_reports/{external_id}/archive/ archive @action declaration

list · GET

GET /api/v1/template_reports/ — action list. static contract extracted; runtime/permission/payload behavior review pending.

Directly observed request reads (these do not constitute a complete accepted-payload or requiredness guarantee):

Location Field Declared/inferred read type Requiredness evidence
query report_type not declared at read site not established
query associating_id not declared at read site not established

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

Field Type Required Constraints
meta dict false No extra constraint extracted
id UUID4 | None false No extra constraint extracted
name str true No extra constraint extracted
template dict true No extra constraint extracted
report_type str true No extra constraint extracted
associating_id str true No extra constraint extracted
archived_by UserSpec | None false No extra constraint extracted
archived_datetime datetime.datetime | None false No extra constraint extracted
upload_completed bool true No extra constraint extracted
is_archived bool | None false No extra constraint extracted
archive_reason str | None false No extra constraint extracted
created_date datetime.datetime true No extra constraint extracted
extension str true No extra constraint extracted
uploaded_by dict true No extra constraint extracted
mime_type str 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: report_type and associating_id are required.

retrieve · GET

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

Path and deployment-context parameters:

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

Directly observed request reads (these do not constitute a complete accepted-payload or requiredness guarantee):

Location Field Declared/inferred read type Requiredness evidence
query report_type not declared at read site not established
query associating_id not declared at read site not established

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

Field Type Required Constraints
meta dict false No extra constraint extracted
id UUID4 | None false No extra constraint extracted
name str true No extra constraint extracted
template dict true No extra constraint extracted
report_type str true No extra constraint extracted
associating_id str true No extra constraint extracted
archived_by UserSpec | None false No extra constraint extracted
archived_datetime datetime.datetime | None false No extra constraint extracted
upload_completed bool true No extra constraint extracted
is_archived bool | None false No extra constraint extracted
archive_reason str | None false No extra constraint extracted
created_date datetime.datetime true No extra constraint extracted
extension str true No extra constraint extracted
uploaded_by dict true No extra constraint extracted
mime_type str true No extra constraint extracted
signed_url str | None false No extra constraint extracted
read_signed_url str | None false No extra constraint extracted
internal_name str 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: report_type and associating_id are required.

generate · POST

POST /api/v1/template_reports/generate/ — action generate. static contract extracted; runtime/permission/payload behavior review pending.

Directly observed request reads (these do not constitute a complete accepted-payload or requiredness guarantee):

Location Field Declared/inferred read type Requiredness evidence
query report_type not declared at read site not established
query associating_id not declared at read site not established

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

Field Type Required Constraints
template_id UUID4 true No extra constraint extracted
associating_id UUID4 true No extra constraint extracted
output_format str | None false No extra constraint extracted
force bool false No extra constraint extracted
status_check bool false No extra constraint extracted

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

Observed authorization checks: can_generate_report_from_template. Helper/queryset evidence is included; this is not proof of complete security review.

Explicit response statuses in observed code: status.HTTP_201_CREATED, status.HTTP_409_CONFLICT. Other branches/framework exception handling may differ.

Declared refusal/error evidence: PermissionDenied: You are not authorized to generate reports; ValidationError: Template is not active; PermissionDenied: report_type and associating_id are required.

archive · POST

POST /api/v1/template_reports/{external_id}/archive/ — action archive. static contract extracted; runtime/permission/payload behavior review pending.

Path and deployment-context parameters:

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

Directly observed request reads (these do not constitute a complete accepted-payload or requiredness guarantee):

Location Field Declared/inferred read type Requiredness evidence
query report_type not declared at read site not established
query associating_id not declared at read site not established

decorator responses: ReportUploadListSpec. 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: report_type and associating_id are required.

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.