App\Entity\Csb\Document\Document
Resource class
Resource Metadata
Short name: "Document"
| Item operations | Attributes |
|---|---|
| api_admin_document_item | [ "normalization_context" => [ "groups" => [ "document:read" ] ] "method" => "GET" "path" => "/admin/documents/{id}" "requirements" => [ "id" => "\d+" ] "read" => [ "true" ] "output" => [ "true" ] "openapi_context" => [ "description" => "Retrieve document entity by id." "security" => [ [ "bearerAuth" => null ] ] "responses" => [ 200 => [ "description" => "Document resource." ] 401 => [ "description" => "JWT Token not found **(CSB JWT)**." ] 404 => [ "description" => "Resource not found." ] "5XX" => [ "description" => "Unexpected error." ] ] ] "input" => null "stateless" => null "input_formats" => [ "jsonld" => [ "application/ld+json" ] "json" => [ "application/json" ] "html" => [ "text/html" ] ] "output_formats" => [ "jsonld" => [ "application/ld+json" ] "json" => [ "application/json" ] "html" => [ "text/html" ] ] ] |
| api_document_edit | [ "denormalization_context" => [ "groups" => [ "document:write" ] ] "method" => "PUT" "path" => "/document/{id}/edit" "requirements" => [ "id" => "\d+" ] "controller" => "UpdateDocumentController::class" "read" => [ "false" ] "output" => [ "true" ] "openapi_context" => [ "security" => [ [ "bearerAuth" => null ] ] "summary" => "Upload a new document to replace an existant document in data base." "description" => """ Upload document(s) for the connected UserCsb.\n - Documents cannot exceed **10Mo**\n - Documents must be in one of the following mimetypes : **application/pdf, image/jpg, image/png, image/tiff, image/svg+xml**\n """ "parameters" => [ [ "in" => "path" "name" => "id" "schema" => [ "type" => "integer" ] "allowEmptyValue" => false "required" => true "description" => "Document id that will be replaced." ] ] "requestBody" => [ "required" => true "content" => [ "application/json" => [ "schema" => [ "type" => "object" "properties" => [ "documentTypeId" => [ "type" => "integer" "allowEmptyValue" => false "enum" => [ 4 9 12 13 14 15 16 17 ] "description" => "Type of document." ] "levelDoc" => [ "type" => "integer" "allowEmptyValue" => false "enum" => [ 0 1 ] "description" => """ Level of document, **for full descriptions, please refer to the documentations.**:\n * 0 : A complement document.\n * 1 : A mandatory document.\n """ ] "base64File" => [ "type" => "string" "allowEmptyValue" => false "description" => "Files selector." ] ] ] ] ] ] "responses" => [ 200 => [ "description" => "Document updated successfully." ] 400 => [ "description" => "Bad request." ] 401 => [ "description" => "JWT Token not found." ] "5XX" => [ "description" => "Unexpected error." ] ] ] "input" => null "stateless" => null "input_formats" => [ "jsonld" => [ "application/ld+json" ] "json" => [ "application/json" ] "html" => [ "text/html" ] ] "output_formats" => [ "jsonld" => [ "application/ld+json" ] "json" => [ "application/json" ] "html" => [ "text/html" ] ] ] |
| api_document_remove | [ "denormalization_context" => [ "groups" => [ "document:write" ] ] "method" => "DELETE" "path" => "/document/{id}/remove" "requirements" => [ "id" => "\d+" ] "controller" => "DocumentController::class" "read" => [ "false" ] "output" => [ "true" ] "openapi_context" => [ "security" => [ [ "bearerAuth" => null ] ] "summary" => "Delete (cancel) the selected document." "parameters" => [ [ "in" => "path" "name" => "id" "schema" => [ "type" => "integer" ] "allowEmptyValue" => false "required" => true "description" => "Document id to canceled." ] ] "requestBody" => [ "required" => false "content" => [] ] "responses" => [ 200 => [ "description" => "Document canceled successfully." ] 400 => [ "description" => "Bad request." ] 401 => [ "description" => "JWT Token not found." ] 406 => [ "description" => "Cannot canceled document ( not acceptable ), refer to the request cancel document endpoint." ] "5XX" => [ "description" => "Unexpected error." ] ] ] "input" => null "stateless" => null "input_formats" => [ "jsonld" => [ "application/ld+json" ] "json" => [ "application/json" ] "html" => [ "text/html" ] ] "output_formats" => [ "jsonld" => [ "application/ld+json" ] "json" => [ "application/json" ] "html" => [ "text/html" ] ] ] |
| api_admin_treezor_document_add | [ "method" => "POST" "path" => "/admin/treezor/document/{id}/add" "requirements" => [ "id" => "\d+" ] "controller" => "DocumentController::class" "read" => [ "false" ] "output" => [ "true" ] "openapi_context" => [ "security" => [ [ "bearerAuth" => null ] ] "summary" => "Send (create ) the selected document on Treezor Api." "parameters" => [ [ "in" => "path" "name" => "id" "schema" => [ "type" => "integer" ] "allowEmptyValue" => false "required" => true "description" => "Id document to be send to Treezor." ] ] "requestBody" => [ "required" => false "content" => [] ] "responses" => [ 201 => [ "description" => "Document send successfully." ] 400 => [ "description" => "Bad request." ] 401 => [ "description" => "JWT Token not found." ] 406 => [ "description" => "Cannot send document ( not acceptable )." ] 422 => [ "description" => "Unprocessable entity" ] "5XX" => [ "description" => "Unexpected error." ] ] ] "input" => null "stateless" => null "input_formats" => [ "jsonld" => [ "application/ld+json" ] "json" => [ "application/json" ] "html" => [ "text/html" ] ] "output_formats" => [ "jsonld" => [ "application/ld+json" ] "json" => [ "application/json" ] "html" => [ "text/html" ] ] ] |
| api_dowload_document | [ "method" => "GET" "path" => "/account/document/{id}/dowload" "requirements" => [ "id" => "\d+" ] "controller" => "DocumentController::class" "read" => [ "false" ] "output" => [ "true" ] "openapi_context" => [ "security" => [ [ "bearerAuth" => null ] ] "summary" => "Dowload userCsb document from remote server ." "parameters" => [ [ "in" => "path" "name" => "id" "schema" => [ "type" => "integer" ] "allowEmptyValue" => false "required" => true "description" => "Id document to be dowloaded." ] ] "requestBody" => [ "required" => false "content" => [] ] "responses" => [ 200 => [ "description" => "Ok." ] 400 => [ "description" => "Bad request." ] 401 => [ "description" => "JWT Token not found." ] "5XX" => [ "description" => "Unexpected error." ] ] ] "input" => null "stateless" => null "input_formats" => [ "jsonld" => [ "application/ld+json" ] "json" => [ "application/json" ] "html" => [ "text/html" ] ] "output_formats" => [ "jsonld" => [ "application/ld+json" ] "json" => [ "application/json" ] "html" => [ "text/html" ] ] ] |
| api_admin_dowload_document | [ "method" => "GET" "path" => "/admin/document/{id}/dowload" "requirements" => [ "id" => "\d+" ] "controller" => "DocumentController::class" "read" => [ "false" ] "output" => [ "true" ] "openapi_context" => [ "security" => [ [ "bearerAuth" => null ] ] "summary" => "Admin dowload userCsb document from remote server ." "parameters" => [ [ "in" => "path" "name" => "id" "schema" => [ "type" => "integer" ] "allowEmptyValue" => false "required" => true "description" => "Id document to be dowloaded." ] ] "requestBody" => [ "required" => false "content" => [] ] "responses" => [ 200 => [ "description" => "Ok." ] 400 => [ "description" => "Bad request." ] 401 => [ "description" => "JWT Token not found." ] "5XX" => [ "description" => "Unexpected error." ] ] ] "input" => null "stateless" => null "input_formats" => [ "jsonld" => [ "application/ld+json" ] "json" => [ "application/json" ] "html" => [ "text/html" ] ] "output_formats" => [ "jsonld" => [ "application/ld+json" ] "json" => [ "application/json" ] "html" => [ "text/html" ] ] ] |
| Collection operations | Attributes |
|---|---|
| api_admin_document_collection | [ "normalization_context" => [ "groups" => [ "document:read" ] ] "method" => "GET" "path" => "/admin/documents" "openapi_context" => [ "summary" => "Retrieve the docusments collection." "description" => "Return collection of documents." "security" => [ [ "bearerAuth" => null ] ] "responses" => [ 200 => [ "description" => "Document collection." ] 401 => [ "description" => "JWT Token not found **(CSB JWT)** | Not authorized." ] 404 => [ "description" => "Resource not found." ] "5XX" => [ "description" => "Unexpected error." ] ] ] "input" => null "output" => null "stateless" => null "input_formats" => [ "jsonld" => [ "application/ld+json" ] "json" => [ "application/json" ] "html" => [ "text/html" ] ] "output_formats" => [ "jsonld" => [ "application/ld+json" ] "json" => [ "application/json" ] "html" => [ "text/html" ] ] ] |
| api_account_documents | [ "normalization_context" => [ "groups" => [ "account:read" ] ] "method" => "GET" "path" => "/account/documents" "controller" => "DocumentController::class" "read" => [ "false" ] "output" => [ "true" ] "openapi_context" => [ "summary" => "Retrieve the docusments collection of the current auth user." "description" => "Return collection of documents." "security" => [ [ "bearerAuth" => null ] ] "responses" => [ 200 => [ "description" => "Document collection of the current auth user." ] 401 => [ "description" => "JWT Token not found ." ] 404 => [ "description" => "Resource not found." ] "5XX" => [ "description" => "Unexpected error." ] ] ] "input" => null "stateless" => null "input_formats" => [ "jsonld" => [ "application/ld+json" ] "json" => [ "application/json" ] "html" => [ "text/html" ] ] "output_formats" => [ "jsonld" => [ "application/ld+json" ] "json" => [ "application/json" ] "html" => [ "text/html" ] ] ] |
| api_document_add | [ "denormalization_context" => [ "groups" => [ "document:write" ] ] "method" => "POST" "path" => "/document/add" "controller" => "DocumentController::class" "read" => [ "false" ] "output" => [ "true" ] "openapi_context" => [ "security" => [ [ "bearerAuth" => null ] ] "summary" => "Add new Document" "description" => """ Upload document(s) for the connected UserCsb.\n - Documents cannot exceed **10Mo**\n - Documents must be in one of the following mimetypes : **application/pdf, image/jpg, image/png, image/tiff, image/svg+xml**\n """ "requestBody" => [ "required" => true "content" => [ "application/json" => [ "schema" => [ "type" => "object" "properties" => [ "documentTypeId" => [ "type" => "integer" "required" => true "allowEmptyValue" => false "enum" => [ 4 9 12 13 14 15 16 17 ] "description" => "Type of document." ] "levelDoc" => [ "type" => "integer" "required" => true "allowEmptyValue" => false "enum" => [ 0 1 ] "description" => """ Level of document, **for full descriptions, please refer to the documentations.**:\n * 0 : A complement document.\n * 1 : A mandatory document.\n """ ] "base64File" => [ "type" => "string" "required" => true "allowEmptyValue" => false "description" => "File encoded on base64." ] ] ] ] ] ] "responses" => [ 201 => [ "description" => "Document created successfully." ] 204 => [ "description" => "Document created successfully." ] 400 => [ "description" => "Bad request." ] 401 => [ "description" => "JWT Token not found." ] "5XX" => [ "description" => "Unexpected error." ] ] ] "input" => null "stateless" => null "input_formats" => [ "jsonld" => [ "application/ld+json" ] "json" => [ "application/json" ] "html" => [ "text/html" ] ] "output_formats" => [ "jsonld" => [ "application/ld+json" ] "json" => [ "application/json" ] "html" => [ "text/html" ] ] ] |
| api_admin_document_add | [ "denormalization_context" => [ "groups" => [ "document:write" ] ] "method" => "POST" "path" => "/admin/document/add" "controller" => "AdminDocumentController::class" "read" => [ "false" ] "output" => [ "true" ] "openapi_context" => [ "security" => [ [ "bearerAuth" => null ] ] "summary" => "Add new Document for a UserCsb." "description" => """ Upload document(s) for a UserCsb.\n - Documents cannot exceed **10Mo**\n - Documents must be in one of the following mimetypes : **application/pdf, image/jpg, image/png, image/tiff, image/svg+xml**\n """ "requestBody" => [ "required" => true "content" => [ "application/json" => [ "schema" => [ "type" => "object" "properties" => [ "documentTypeId" => [ "type" => "integer" "required" => true "allowEmptyValue" => false "enum" => [ 4 9 12 13 14 15 16 17 ] "description" => "Type of document." ] "levelDoc" => [ "type" => "integer" "required" => true "allowEmptyValue" => false "enum" => [ 0 1 ] "description" => """ Level of document, **for full descriptions, please refer to the documentations.**:\n * 0 : A complement document.\n * 1 : A mandatory document.\n """ ] "base64File" => [ "type" => "string" "required" => true "allowEmptyValue" => false "description" => "File encoded on base64." ] "userId" => [ "type" => "integer" "required" => true "allowEmptyValue" => false "description" => "UserCsb Id." ] ] ] ] ] ] "responses" => [ 201 => [ "description" => "Document created successfully." ] 204 => [ "description" => "Document created successfully." ] 400 => [ "description" => "Bad request." ] 401 => [ "description" => "JWT Token not found." ] "5XX" => [ "description" => "Unexpected error." ] ] ] "input" => null "stateless" => null "input_formats" => [ "jsonld" => [ "application/ld+json" ] "json" => [ "application/json" ] "html" => [ "text/html" ] ] "output_formats" => [ "jsonld" => [ "application/ld+json" ] "json" => [ "application/json" ] "html" => [ "text/html" ] ] ] |
| Filters | |
|---|---|
| No available filter declared for this resource. |
| Attributes | |
|---|---|
| pagination_client_items_per_page | true |
| pagination_items_per_page | 10 |
| input | null |
| output | null |
Data Providers
No calls to collection data provider have been recorded.
No calls to item data provider have been recorded.
No calls to subresource data provider have been recorded.
Data Persisters
No calls to data persister have been recorded.