Backend resource · STATIC DECLARATIONS
File Upload API reference · mansoq-core
Static source contract for File Upload: 8 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/files/. 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/files/ |
list | declared/inherited method |
| POST | /api/v1/files/ |
create | declared/inherited method |
| GET | /api/v1/files/{external_id}/ |
retrieve | declared/inherited method |
| PUT | /api/v1/files/{external_id}/ |
update | declared/inherited method |
| PATCH | /api/v1/files/{external_id}/ |
partial_update | declared/inherited method |
| POST | /api/v1/files/{external_id}/mark_upload_completed/ |
mark_upload_completed | @action declaration |
| POST | /api/v1/files/{external_id}/archive/ |
archive | @action declaration |
| POST | /api/v1/files/upload-file/ |
upload_file | @action declaration |
list · GET
GET /api/v1/files/ — 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 | file_type |
not declared at read site | not established |
| query | associating_id |
not declared at read site | not established |
response: FileUploadListSpec. 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 |
| file_type | FileTypeChoices | true | No extra constraint extracted |
| file_category | FileCategoryChoices | 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 | None | false | No extra constraint extracted |
| created_by | dict | None | false | No extra constraint extracted |
| updated_by | dict | None | false | 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: Cannot filter files.
create · POST
POST /api/v1/files/ — action create. 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 | file_type |
not declared at read site | not established |
| query | associating_id |
not declared at read site | not established |
| body | form_submission |
not declared at read site | not established |
request: FileUploadCreateSpec. 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 |
| original_name | str | true | No extra constraint extracted |
| file_type | FileTypeChoices | true | No extra constraint extracted |
| file_category | FileCategoryChoices | true | No extra constraint extracted |
| associating_id | str | true | No extra constraint extracted |
| mime_type | str | true | No extra constraint extracted |
response: FileUploadRetrieveSpec. 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 |
| file_type | FileTypeChoices | true | No extra constraint extracted |
| file_category | FileCategoryChoices | 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 | None | false | No extra constraint extracted |
| created_by | dict | None | false | No extra constraint extracted |
| updated_by | dict | None | false | 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: Cannot filter files.
retrieve · GET
GET /api/v1/files/{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 | file_type |
not declared at read site | not established |
| query | associating_id |
not declared at read site | not established |
response: FileUploadRetrieveSpec. 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: Cannot filter files.
update · PUT
PUT /api/v1/files/{external_id}/ — action update. 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 | file_type |
not declared at read site | not established |
| query | associating_id |
not declared at read site | not established |
request: FileUploadUpdateSpec. 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 |
response: FileUploadRetrieveSpec. 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: Cannot filter files.
partial_update · PATCH
PATCH /api/v1/files/{external_id}/ — action partial_update. 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 | file_type |
not declared at read site | not established |
| query | associating_id |
not declared at read site | not established |
request: FileUploadUpdateSpec. 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.
response: FileUploadRetrieveSpec. 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: Cannot filter files.
mark_upload_completed · POST
POST /api/v1/files/{external_id}/mark_upload_completed/ — action mark_upload_completed. 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 | file_type |
not declared at read site | not established |
| query | associating_id |
not declared at read site | not established |
decorator responses: FileUploadListSpec. 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: Cannot filter files.
archive · POST
POST /api/v1/files/{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 | file_type |
not declared at read site | not established |
| query | associating_id |
not declared at read site | not established |
decorator responses: FileUploadListSpec. 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: Cannot filter files.
upload_file · POST
POST /api/v1/files/upload-file/ — action upload_file. 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 |
|---|---|---|---|
| body | original_name |
not declared at read site | not established |
| body | file_data |
not declared at read site | not established |
| body | name |
not declared at read site | not established |
| body | associating_id |
not declared at read site | not established |
| body | file_type |
not declared at read site | not established |
| body | file_category |
not declared at read site | not established |
| query | file_type |
not declared at read site | not established |
| query | associating_id |
not declared at read site | not established |
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: ValidationError: Missing required fields: 'original_name' or 'file_data'; ValidationError (dynamic detail; inspect source); PermissionDenied: Cannot filter files.
Conditional gates: mime_type not in settings.ALLOWED_MIME_TYPES.
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.
- repositories/platform/mansoq-core/config/api_router.py:204
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/file_upload.py:119
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/base.py:168
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/file_upload.py:150
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/base.py:161
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/base.py:330
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/base.py:158
- repositories/platform/mansoq-core/mansoq/emr/resources/file_upload/spec.py:76
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/base.py:136
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/file_upload.py:134
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/base.py:142
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/base.py:130
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/base.py:346
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/base.py:98
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/base.py:139
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/base.py:325
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/base.py:352
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/base.py:349
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/base.py:95
- repositories/platform/mansoq-core/mansoq/emr/resources/file_upload/spec.py:42
- repositories/platform/mansoq-core/mansoq/emr/resources/file_upload/spec.py:105
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/base.py:83
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/base.py:80
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/base.py:77
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/base.py:214
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/file_upload.py:142
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/base.py:228
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/base.py:201
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/base.py:335
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/base.py:180
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/base.py:222
- repositories/platform/mansoq-core/mansoq/emr/resources/file_upload/spec.py:38
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/base.py:218
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/file_upload.py:178
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/file_upload.py:194
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/file_upload.py:214