{"schemaVersion":"1.0","sourceCommit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca","sourceVisibility":"private","article":{"id":"api-mansoq-scribe-fileuploadviewset-b251f656","title":"File Upload API reference · mansoq-scribe","summary":"Static source contract for File Upload: 4 declared or inherited operation mappings, schema/field evidence and authorization/refusal references. Deployment and behavioral review remain explicit.","module":"IT & integrations","roles":["IT administrator","Developer","Integration engineer"],"facilities":["All configured facility types"],"kind":"reference","minutes":3,"prerequisites":["Use the API contract from the installed deployment and an authorized synthetic test environment.","Confirm facility/organization scope, action permissions and optional app enablement.","This reference is static source evidence; complete payload, authorization, failure and end-to-end review remains recorded as pending."],"steps":[],"sections":[{"title":"Declared route and availability","body":"This resource is declared in **mansoq-scribe** at `/api/{installed_plugin_prefix}/scribe_file/`. plugin/local mount; actual prefix and enablement require deployment verification A registered path and an indexed handler do not prove deployment availability, user permission or production readiness."},{"title":"Operation map","body":"| Method | Path | Action | Evidence |\n| --- | --- | --- | --- |\n| POST | `/api/{installed_plugin_prefix}/scribe_file/` | create | standard external DRF mixin; library behavior review pending |\n| GET | `/api/{installed_plugin_prefix}/scribe_file/{external_id}/` | retrieve | standard external DRF mixin; library behavior review pending |\n| PUT | `/api/{installed_plugin_prefix}/scribe_file/{external_id}/` | update | standard external DRF mixin; library behavior review pending |\n| PATCH | `/api/{installed_plugin_prefix}/scribe_file/{external_id}/` | partial_update | standard external DRF mixin; library behavior review pending |"},{"title":"create · POST","body":"**POST /api/{installed_plugin_prefix}/scribe_file/** — action `create`. static contract extracted; runtime/permission/payload behavior review pending.\n\nPath and deployment-context parameters:\n\n| Location | Parameter | Type | Required |\n| --- | --- | --- | --- |\n| deployment mount | installed_plugin_prefix | deployment-selected mount prefix | true |\n\n**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.\n\n**Class policy declarations:** permission_classes: IsAuthenticated."},{"title":"retrieve · GET","body":"**GET /api/{installed_plugin_prefix}/scribe_file/{external_id}/** — action `retrieve`. static contract extracted; runtime/permission/payload behavior review pending.\n\nPath and deployment-context parameters:\n\n| Location | Parameter | Type | Required |\n| --- | --- | --- | --- |\n| deployment mount | installed_plugin_prefix | deployment-selected mount prefix | true |\n| path | external_id | router lookup string; semantic ID validation requires handler/schema review | true |\n\n**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.\n\n**Class policy declarations:** permission_classes: IsAuthenticated."},{"title":"update · PUT","body":"**PUT /api/{installed_plugin_prefix}/scribe_file/{external_id}/** — action `update`. static contract extracted; runtime/permission/payload behavior review pending.\n\nPath and deployment-context parameters:\n\n| Location | Parameter | Type | Required |\n| --- | --- | --- | --- |\n| deployment mount | installed_plugin_prefix | deployment-selected mount prefix | true |\n| path | external_id | router lookup string; semantic ID validation requires handler/schema review | true |\n\n**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.\n\n**Class policy declarations:** permission_classes: IsAuthenticated."},{"title":"partial_update · PATCH","body":"**PATCH /api/{installed_plugin_prefix}/scribe_file/{external_id}/** — action `partial_update`. static contract extracted; runtime/permission/payload behavior review pending.\n\nPath and deployment-context parameters:\n\n| Location | Parameter | Type | Required |\n| --- | --- | --- | --- |\n| deployment mount | installed_plugin_prefix | deployment-selected mount prefix | true |\n| path | external_id | router lookup string; semantic ID validation requires handler/schema review | true |\n\n**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.\n\n**Class policy declarations:** permission_classes: IsAuthenticated."},{"title":"Integration review checklist","body":"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."}],"troubleshooting":[{"problem":"A declared route is unavailable or a request is rejected","solution":"Compare the installed revision, actual API schema, optional plugin mount, HTTP-method restrictions and recorded validation/permission evidence. Do not bypass a refusal or send a production transaction to test documentation."}],"sources":[{"path":"repositories/teleicu/mansoq-scribe/mansoq_scribe/urls.py","line":10,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},{"path":"repositories/teleicu/mansoq-scribe/mansoq_scribe/viewsets/scribe_file.py","line":18,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}],"related":["it-api-contract","it-api-auth","security-rcm-roles"],"verification":"Static API contract — behavior review pending","version":"f6e9f05f76d4","apiReferenceIds":["backend-resource-f7ad6ef7b251f656","backend-resource-f7ad6ef7b251f656:POST:create","backend-resource-f7ad6ef7b251f656:GET:retrieve","backend-resource-f7ad6ef7b251f656:PUT:update","backend-resource-f7ad6ef7b251f656:PATCH:partial_update"]},"backend":{"resources":[{"id":"backend-resource-f7ad6ef7b251f656","localPrefix":"scribe_file","viewset":"FileUploadViewSet","classId":"repositories/teleicu/mansoq-scribe:mansoq_scribe.viewsets.scribe_file.FileUploadViewSet","basename":null,"source":{"path":"repositories/teleicu/mansoq-scribe/mansoq_scribe/urls.py","line":10,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"conditions":[],"repository":"repositories/teleicu/mansoq-scribe","classSource":{"path":"repositories/teleicu/mansoq-scribe/mansoq_scribe/viewsets/scribe_file.py","line":18,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"description":"","path":"/api/{installed_plugin_prefix}/scribe_file/","mountStatus":"plugin/local mount; actual prefix and enablement require deployment verification","operationIds":["backend-resource-f7ad6ef7b251f656:POST:create","backend-resource-f7ad6ef7b251f656:GET:retrieve","backend-resource-f7ad6ef7b251f656:PUT:update","backend-resource-f7ad6ef7b251f656:PATCH:partial_update"],"unresolvedViewset":false,"reviewStatus":"registered resource enumerated; behavioral review pending"}],"operations":[{"id":"backend-resource-f7ad6ef7b251f656:POST:create","resourceId":"backend-resource-f7ad6ef7b251f656","repository":"repositories/teleicu/mansoq-scribe","boundary":"optional-plugin/local-service","method":"POST","path":"/api/{installed_plugin_prefix}/scribe_file/","declaredPattern":"/api/{installed_plugin_prefix}/scribe_file/","action":"create","viewset":"FileUploadViewSet","classId":"repositories/teleicu/mansoq-scribe:mansoq_scribe.viewsets.scribe_file.FileUploadViewSet","detail":false,"allowedByDeclaredHttpMethods":true,"mountStatus":"plugin/local mount; actual prefix and enablement require deployment verification","routeEvidence":{"path":"repositories/teleicu/mansoq-scribe/mansoq_scribe/urls.py","line":10,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"handlerSource":null,"registrationConditions":[],"evidenceKind":"standard external DRF mixin; library behavior review pending","methodEvidenceIds":[],"schemaIds":{},"classPermissionEvidence":[{"kind":"permission_classes","declaration":["IsAuthenticated"],"source":{"path":"repositories/teleicu/mansoq-scribe/mansoq_scribe/viewsets/scribe_file.py","line":27,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}}],"filterEvidence":[{"name":"filter_backends","value":[null],"source":{"path":"repositories/teleicu/mansoq-scribe/mansoq_scribe/viewsets/scribe_file.py","line":29,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}},{"name":"file_category","type":"filters.CharFilter","lookup":null,"source":{"path":"repositories/teleicu/mansoq-scribe/mansoq_scribe/viewsets/scribe_file.py","line":16,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}}],"reviewStatus":"static contract extracted; runtime/permission/payload behavior review pending","pathParameters":[{"name":"installed_plugin_prefix","in":"deployment mount","type":"deployment-selected mount prefix","required":true,"source":{"path":"repositories/teleicu/mansoq-scribe/mansoq_scribe/urls.py","line":10,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}}]},{"id":"backend-resource-f7ad6ef7b251f656:GET:retrieve","resourceId":"backend-resource-f7ad6ef7b251f656","repository":"repositories/teleicu/mansoq-scribe","boundary":"optional-plugin/local-service","method":"GET","path":"/api/{installed_plugin_prefix}/scribe_file/{external_id}/","declaredPattern":"/api/{installed_plugin_prefix}/scribe_file/{external_id}/","action":"retrieve","viewset":"FileUploadViewSet","classId":"repositories/teleicu/mansoq-scribe:mansoq_scribe.viewsets.scribe_file.FileUploadViewSet","detail":true,"allowedByDeclaredHttpMethods":true,"mountStatus":"plugin/local mount; actual prefix and enablement require deployment verification","routeEvidence":{"path":"repositories/teleicu/mansoq-scribe/mansoq_scribe/urls.py","line":10,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"handlerSource":null,"registrationConditions":[],"evidenceKind":"standard external DRF mixin; library behavior review pending","methodEvidenceIds":[],"schemaIds":{},"classPermissionEvidence":[{"kind":"permission_classes","declaration":["IsAuthenticated"],"source":{"path":"repositories/teleicu/mansoq-scribe/mansoq_scribe/viewsets/scribe_file.py","line":27,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}}],"filterEvidence":[{"name":"filter_backends","value":[null],"source":{"path":"repositories/teleicu/mansoq-scribe/mansoq_scribe/viewsets/scribe_file.py","line":29,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}},{"name":"file_category","type":"filters.CharFilter","lookup":null,"source":{"path":"repositories/teleicu/mansoq-scribe/mansoq_scribe/viewsets/scribe_file.py","line":16,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}}],"reviewStatus":"static contract extracted; runtime/permission/payload behavior review pending","pathParameters":[{"name":"installed_plugin_prefix","in":"deployment mount","type":"deployment-selected mount prefix","required":true,"source":{"path":"repositories/teleicu/mansoq-scribe/mansoq_scribe/urls.py","line":10,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}},{"name":"external_id","in":"path","type":"router lookup string; semantic ID validation requires handler/schema review","required":true,"source":{"path":"repositories/teleicu/mansoq-scribe/mansoq_scribe/urls.py","line":10,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}}]},{"id":"backend-resource-f7ad6ef7b251f656:PUT:update","resourceId":"backend-resource-f7ad6ef7b251f656","repository":"repositories/teleicu/mansoq-scribe","boundary":"optional-plugin/local-service","method":"PUT","path":"/api/{installed_plugin_prefix}/scribe_file/{external_id}/","declaredPattern":"/api/{installed_plugin_prefix}/scribe_file/{external_id}/","action":"update","viewset":"FileUploadViewSet","classId":"repositories/teleicu/mansoq-scribe:mansoq_scribe.viewsets.scribe_file.FileUploadViewSet","detail":true,"allowedByDeclaredHttpMethods":true,"mountStatus":"plugin/local mount; actual prefix and enablement require deployment verification","routeEvidence":{"path":"repositories/teleicu/mansoq-scribe/mansoq_scribe/urls.py","line":10,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"handlerSource":null,"registrationConditions":[],"evidenceKind":"standard external DRF mixin; library behavior review pending","methodEvidenceIds":[],"schemaIds":{},"classPermissionEvidence":[{"kind":"permission_classes","declaration":["IsAuthenticated"],"source":{"path":"repositories/teleicu/mansoq-scribe/mansoq_scribe/viewsets/scribe_file.py","line":27,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}}],"filterEvidence":[{"name":"filter_backends","value":[null],"source":{"path":"repositories/teleicu/mansoq-scribe/mansoq_scribe/viewsets/scribe_file.py","line":29,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}},{"name":"file_category","type":"filters.CharFilter","lookup":null,"source":{"path":"repositories/teleicu/mansoq-scribe/mansoq_scribe/viewsets/scribe_file.py","line":16,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}}],"reviewStatus":"static contract extracted; runtime/permission/payload behavior review pending","pathParameters":[{"name":"installed_plugin_prefix","in":"deployment mount","type":"deployment-selected mount prefix","required":true,"source":{"path":"repositories/teleicu/mansoq-scribe/mansoq_scribe/urls.py","line":10,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}},{"name":"external_id","in":"path","type":"router lookup string; semantic ID validation requires handler/schema review","required":true,"source":{"path":"repositories/teleicu/mansoq-scribe/mansoq_scribe/urls.py","line":10,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}}]},{"id":"backend-resource-f7ad6ef7b251f656:PATCH:partial_update","resourceId":"backend-resource-f7ad6ef7b251f656","repository":"repositories/teleicu/mansoq-scribe","boundary":"optional-plugin/local-service","method":"PATCH","path":"/api/{installed_plugin_prefix}/scribe_file/{external_id}/","declaredPattern":"/api/{installed_plugin_prefix}/scribe_file/{external_id}/","action":"partial_update","viewset":"FileUploadViewSet","classId":"repositories/teleicu/mansoq-scribe:mansoq_scribe.viewsets.scribe_file.FileUploadViewSet","detail":true,"allowedByDeclaredHttpMethods":true,"mountStatus":"plugin/local mount; actual prefix and enablement require deployment verification","routeEvidence":{"path":"repositories/teleicu/mansoq-scribe/mansoq_scribe/urls.py","line":10,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"handlerSource":null,"registrationConditions":[],"evidenceKind":"standard external DRF mixin; library behavior review pending","methodEvidenceIds":[],"schemaIds":{},"classPermissionEvidence":[{"kind":"permission_classes","declaration":["IsAuthenticated"],"source":{"path":"repositories/teleicu/mansoq-scribe/mansoq_scribe/viewsets/scribe_file.py","line":27,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}}],"filterEvidence":[{"name":"filter_backends","value":[null],"source":{"path":"repositories/teleicu/mansoq-scribe/mansoq_scribe/viewsets/scribe_file.py","line":29,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}},{"name":"file_category","type":"filters.CharFilter","lookup":null,"source":{"path":"repositories/teleicu/mansoq-scribe/mansoq_scribe/viewsets/scribe_file.py","line":16,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}}],"reviewStatus":"static contract extracted; runtime/permission/payload behavior review pending","pathParameters":[{"name":"installed_plugin_prefix","in":"deployment mount","type":"deployment-selected mount prefix","required":true,"source":{"path":"repositories/teleicu/mansoq-scribe/mansoq_scribe/urls.py","line":10,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}},{"name":"external_id","in":"path","type":"router lookup string; semantic ID validation requires handler/schema review","required":true,"source":{"path":"repositories/teleicu/mansoq-scribe/mansoq_scribe/urls.py","line":10,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}}]}],"methodEvidence":[],"schemas":[],"frameworkSettings":[]},"frontend":{"operations":[],"schemas":[]},"services":{"operations":[]},"boundaries":[]}