{ "openapi": "3.1.0", "info": { "title": "Transfer API", "description": "HTTP API of A-Cube Transfer: upload endpoints to submit files to the transfer pipeline, and a read-only API exposing uploads, transfer documents, violations and lineage. Authenticate every request with a JWT issued by the A-Cube common API (Authorization: Bearer).", "version": "1.0.0" }, "servers": [ { "url": "/", "description": "" } ], "paths": { "/target-documents": { "get": { "operationId": "api_target-documents_get_collection", "tags": [ "TransferDocument" ], "responses": { "200": { "description": "TransferDocument collection", "content": { "application/ld+json": { "schema": { "type": "object", "description": "TransferDocument.TransferDocumentOutput.jsonld collection.", "allOf": [ { "$ref": "#/components/schemas/HydraCollectionBaseSchema" }, { "type": "object", "required": [ "member" ], "properties": { "member": { "type": "array", "items": { "$ref": "#/components/schemas/TransferDocument.TransferDocumentOutput.jsonld" } } } } ] } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TransferDocument.TransferDocumentOutput" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TransferDocument.TransferDocumentOutput.html" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TransferDocument.TransferDocumentOutput.xml" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TransferDocument.TransferDocumentOutput.xml" } } }, "application/octet-stream": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TransferDocument.TransferDocumentOutput.raw" } } } } } }, "summary": "Retrieves the collection of TransferDocument resources.", "description": "Retrieves the collection of TransferDocument resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": true }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "schema": { "type": "integer", "default": 30, "minimum": 0, "maximum": 100 }, "style": "form", "explode": true }, { "name": "role", "in": "query", "description": "TransferDocument role", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": true }, { "name": "role[]", "in": "query", "description": "TransferDocument role", "required": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "deepObject", "explode": true }, { "name": "status", "in": "query", "description": "TransferDocument status", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": true }, { "name": "status[]", "in": "query", "description": "TransferDocument status", "required": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "deepObject", "explode": true }, { "name": "transmission_node", "in": "query", "description": "TransferDocument transmission_node", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": true }, { "name": "transmission_node[]", "in": "query", "description": "TransferDocument transmission_node", "required": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "deepObject", "explode": true }, { "name": "transmission_outcome", "in": "query", "description": "TransferDocument transmission_outcome", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": true }, { "name": "transmission_outcome[]", "in": "query", "description": "TransferDocument transmission_outcome", "required": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "deepObject", "explode": true }, { "name": "type", "in": "query", "description": "TransferDocument type", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": true }, { "name": "type[]", "in": "query", "description": "TransferDocument type", "required": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "deepObject", "explode": true }, { "name": "created_at[gt]", "in": "query", "description": "TransferDocument created_at", "required": false, "deprecated": false, "schema": { "type": "object", "properties": { "gt": { "type": "string" }, "gte": { "type": "string" }, "lt": { "type": "string" }, "lte": { "type": "string" }, "ne": { "type": "string" } } }, "style": "form", "explode": true }, { "name": "created_at[gte]", "in": "query", "description": "TransferDocument created_at", "required": false, "deprecated": false, "schema": { "type": "object", "properties": { "gt": { "type": "string" }, "gte": { "type": "string" }, "lt": { "type": "string" }, "lte": { "type": "string" }, "ne": { "type": "string" } } }, "style": "form", "explode": true }, { "name": "created_at[lt]", "in": "query", "description": "TransferDocument created_at", "required": false, "deprecated": false, "schema": { "type": "object", "properties": { "gt": { "type": "string" }, "gte": { "type": "string" }, "lt": { "type": "string" }, "lte": { "type": "string" }, "ne": { "type": "string" } } }, "style": "form", "explode": true }, { "name": "created_at[lte]", "in": "query", "description": "TransferDocument created_at", "required": false, "deprecated": false, "schema": { "type": "object", "properties": { "gt": { "type": "string" }, "gte": { "type": "string" }, "lt": { "type": "string" }, "lte": { "type": "string" }, "ne": { "type": "string" } } }, "style": "form", "explode": true }, { "name": "created_at[ne]", "in": "query", "description": "TransferDocument created_at", "required": false, "deprecated": false, "schema": { "type": "object", "properties": { "gt": { "type": "string" }, "gte": { "type": "string" }, "lt": { "type": "string" }, "lte": { "type": "string" }, "ne": { "type": "string" } } }, "style": "form", "explode": true }, { "name": "transmitted_at[gt]", "in": "query", "description": "TransferDocument transmitted_at", "required": false, "deprecated": false, "schema": { "type": "object", "properties": { "gt": { "type": "string" }, "gte": { "type": "string" }, "lt": { "type": "string" }, "lte": { "type": "string" }, "ne": { "type": "string" } } }, "style": "form", "explode": true }, { "name": "transmitted_at[gte]", "in": "query", "description": "TransferDocument transmitted_at", "required": false, "deprecated": false, "schema": { "type": "object", "properties": { "gt": { "type": "string" }, "gte": { "type": "string" }, "lt": { "type": "string" }, "lte": { "type": "string" }, "ne": { "type": "string" } } }, "style": "form", "explode": true }, { "name": "transmitted_at[lt]", "in": "query", "description": "TransferDocument transmitted_at", "required": false, "deprecated": false, "schema": { "type": "object", "properties": { "gt": { "type": "string" }, "gte": { "type": "string" }, "lt": { "type": "string" }, "lte": { "type": "string" }, "ne": { "type": "string" } } }, "style": "form", "explode": true }, { "name": "transmitted_at[lte]", "in": "query", "description": "TransferDocument transmitted_at", "required": false, "deprecated": false, "schema": { "type": "object", "properties": { "gt": { "type": "string" }, "gte": { "type": "string" }, "lt": { "type": "string" }, "lte": { "type": "string" }, "ne": { "type": "string" } } }, "style": "form", "explode": true }, { "name": "transmitted_at[ne]", "in": "query", "description": "TransferDocument transmitted_at", "required": false, "deprecated": false, "schema": { "type": "object", "properties": { "gt": { "type": "string" }, "gte": { "type": "string" }, "lt": { "type": "string" }, "lte": { "type": "string" }, "ne": { "type": "string" } } }, "style": "form", "explode": true }, { "name": "sortBy[created_at]", "in": "query", "description": "TransferDocument sortBy[created_at]", "required": false, "deprecated": false, "schema": { "type": "string", "enum": [ "asc", "desc", "ASC", "DESC" ] }, "style": "form", "explode": true }, { "name": "sortBy[transmitted_at]", "in": "query", "description": "TransferDocument sortBy[transmitted_at]", "required": false, "deprecated": false, "schema": { "type": "string", "enum": [ "asc", "desc", "ASC", "DESC" ] }, "style": "form", "explode": true }, { "name": "exists[violations]", "in": "query", "description": "TransferDocument exists[violations]", "required": false, "deprecated": false, "schema": { "type": "boolean" }, "style": "form", "explode": true } ] } }, "/transfer-documents": { "get": { "operationId": "api_transfer-documents_get_collection", "tags": [ "TransferDocument" ], "responses": { "200": { "description": "TransferDocument collection", "content": { "application/ld+json": { "schema": { "type": "object", "description": "TransferDocument.TransferDocumentOutput.jsonld collection.", "allOf": [ { "$ref": "#/components/schemas/HydraCollectionBaseSchema" }, { "type": "object", "required": [ "member" ], "properties": { "member": { "type": "array", "items": { "$ref": "#/components/schemas/TransferDocument.TransferDocumentOutput.jsonld" } } } } ] } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TransferDocument.TransferDocumentOutput" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TransferDocument.TransferDocumentOutput.html" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TransferDocument.TransferDocumentOutput.xml" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TransferDocument.TransferDocumentOutput.xml" } } }, "application/octet-stream": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TransferDocument.TransferDocumentOutput.raw" } } } } } }, "summary": "Retrieves the collection of TransferDocument resources.", "description": "Retrieves the collection of TransferDocument resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": true }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "schema": { "type": "integer", "default": 30, "minimum": 0, "maximum": 100 }, "style": "form", "explode": true }, { "name": "role", "in": "query", "description": "TransferDocument role", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": true }, { "name": "role[]", "in": "query", "description": "TransferDocument role", "required": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "deepObject", "explode": true }, { "name": "status", "in": "query", "description": "TransferDocument status", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": true }, { "name": "status[]", "in": "query", "description": "TransferDocument status", "required": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "deepObject", "explode": true }, { "name": "transmission_node", "in": "query", "description": "TransferDocument transmission_node", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": true }, { "name": "transmission_node[]", "in": "query", "description": "TransferDocument transmission_node", "required": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "deepObject", "explode": true }, { "name": "transmission_outcome", "in": "query", "description": "TransferDocument transmission_outcome", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": true }, { "name": "transmission_outcome[]", "in": "query", "description": "TransferDocument transmission_outcome", "required": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "deepObject", "explode": true }, { "name": "type", "in": "query", "description": "TransferDocument type", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": true }, { "name": "type[]", "in": "query", "description": "TransferDocument type", "required": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "deepObject", "explode": true }, { "name": "created_at[gt]", "in": "query", "description": "TransferDocument created_at", "required": false, "deprecated": false, "schema": { "type": "object", "properties": { "gt": { "type": "string" }, "gte": { "type": "string" }, "lt": { "type": "string" }, "lte": { "type": "string" }, "ne": { "type": "string" } } }, "style": "form", "explode": true }, { "name": "created_at[gte]", "in": "query", "description": "TransferDocument created_at", "required": false, "deprecated": false, "schema": { "type": "object", "properties": { "gt": { "type": "string" }, "gte": { "type": "string" }, "lt": { "type": "string" }, "lte": { "type": "string" }, "ne": { "type": "string" } } }, "style": "form", "explode": true }, { "name": "created_at[lt]", "in": "query", "description": "TransferDocument created_at", "required": false, "deprecated": false, "schema": { "type": "object", "properties": { "gt": { "type": "string" }, "gte": { "type": "string" }, "lt": { "type": "string" }, "lte": { "type": "string" }, "ne": { "type": "string" } } }, "style": "form", "explode": true }, { "name": "created_at[lte]", "in": "query", "description": "TransferDocument created_at", "required": false, "deprecated": false, "schema": { "type": "object", "properties": { "gt": { "type": "string" }, "gte": { "type": "string" }, "lt": { "type": "string" }, "lte": { "type": "string" }, "ne": { "type": "string" } } }, "style": "form", "explode": true }, { "name": "created_at[ne]", "in": "query", "description": "TransferDocument created_at", "required": false, "deprecated": false, "schema": { "type": "object", "properties": { "gt": { "type": "string" }, "gte": { "type": "string" }, "lt": { "type": "string" }, "lte": { "type": "string" }, "ne": { "type": "string" } } }, "style": "form", "explode": true }, { "name": "transmitted_at[gt]", "in": "query", "description": "TransferDocument transmitted_at", "required": false, "deprecated": false, "schema": { "type": "object", "properties": { "gt": { "type": "string" }, "gte": { "type": "string" }, "lt": { "type": "string" }, "lte": { "type": "string" }, "ne": { "type": "string" } } }, "style": "form", "explode": true }, { "name": "transmitted_at[gte]", "in": "query", "description": "TransferDocument transmitted_at", "required": false, "deprecated": false, "schema": { "type": "object", "properties": { "gt": { "type": "string" }, "gte": { "type": "string" }, "lt": { "type": "string" }, "lte": { "type": "string" }, "ne": { "type": "string" } } }, "style": "form", "explode": true }, { "name": "transmitted_at[lt]", "in": "query", "description": "TransferDocument transmitted_at", "required": false, "deprecated": false, "schema": { "type": "object", "properties": { "gt": { "type": "string" }, "gte": { "type": "string" }, "lt": { "type": "string" }, "lte": { "type": "string" }, "ne": { "type": "string" } } }, "style": "form", "explode": true }, { "name": "transmitted_at[lte]", "in": "query", "description": "TransferDocument transmitted_at", "required": false, "deprecated": false, "schema": { "type": "object", "properties": { "gt": { "type": "string" }, "gte": { "type": "string" }, "lt": { "type": "string" }, "lte": { "type": "string" }, "ne": { "type": "string" } } }, "style": "form", "explode": true }, { "name": "transmitted_at[ne]", "in": "query", "description": "TransferDocument transmitted_at", "required": false, "deprecated": false, "schema": { "type": "object", "properties": { "gt": { "type": "string" }, "gte": { "type": "string" }, "lt": { "type": "string" }, "lte": { "type": "string" }, "ne": { "type": "string" } } }, "style": "form", "explode": true }, { "name": "sortBy[created_at]", "in": "query", "description": "TransferDocument sortBy[created_at]", "required": false, "deprecated": false, "schema": { "type": "string", "enum": [ "asc", "desc", "ASC", "DESC" ] }, "style": "form", "explode": true }, { "name": "sortBy[transmitted_at]", "in": "query", "description": "TransferDocument sortBy[transmitted_at]", "required": false, "deprecated": false, "schema": { "type": "string", "enum": [ "asc", "desc", "ASC", "DESC" ] }, "style": "form", "explode": true }, { "name": "exists[violations]", "in": "query", "description": "TransferDocument exists[violations]", "required": false, "deprecated": false, "schema": { "type": "boolean" }, "style": "form", "explode": true } ] } }, "/transfer-documents/{id}": { "get": { "operationId": "api_transfer-documents_id_get", "tags": [ "TransferDocument" ], "responses": { "200": { "description": "TransferDocument resource", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/TransferDocument.TransferDocumentOutput.jsonld" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TransferDocument.TransferDocumentOutput" } }, "text/html": { "schema": { "$ref": "#/components/schemas/TransferDocument.TransferDocumentOutput.html" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/TransferDocument.TransferDocumentOutput.xml" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/TransferDocument.TransferDocumentOutput.xml" } }, "application/octet-stream": { "schema": { "$ref": "#/components/schemas/TransferDocument.TransferDocumentOutput.raw" } } } }, "404": { "description": "Not found", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": {} } }, "summary": "Retrieves a TransferDocument resource.", "description": "Retrieves a TransferDocument resource.", "parameters": [ { "name": "id", "in": "path", "description": "TransferDocument identifier", "required": true, "deprecated": false, "schema": { "type": "string" }, "style": "simple", "explode": false } ] } }, "/transfer-documents/{id}/download": { "get": { "operationId": "api_transfer-documents_iddownload_get", "tags": [ "TransferDocument" ], "responses": { "200": { "description": "The transfer document file", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } }, "404": { "description": "Transfer document or file not found" } }, "summary": "Download transfer document file", "description": "Download the file of a transfer document: the source file, an intermediate file, or the target document sent for transmission.", "parameters": [ { "name": "id", "in": "path", "description": "TransferDocument identifier", "required": true, "deprecated": false, "schema": { "type": "string" }, "style": "simple", "explode": false } ] } }, "/transfer-documents/{id}/lineage": { "get": { "operationId": "api_transfer-documents_idlineage_get", "tags": [ "TransferDocument" ], "responses": { "204": { "description": "TransferDocument resource" }, "404": { "description": "Not found", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": {} } }, "summary": "Retrieves a TransferDocument resource.", "description": "Retrieves a TransferDocument resource.", "parameters": [ { "name": "id", "in": "path", "description": "TransferDocument identifier", "required": true, "deprecated": false, "schema": { "type": "string" }, "style": "simple", "explode": false } ] } }, "/uploads/{uploadId}/transfer-documents": { "get": { "operationId": "api_uploads_uploadIdtransfer-documents_get_collection", "tags": [ "TransferDocument" ], "responses": { "200": { "description": "TransferDocument collection", "content": { "application/ld+json": { "schema": { "type": "object", "description": "TransferDocument.TransferDocumentOutput.jsonld collection.", "allOf": [ { "$ref": "#/components/schemas/HydraCollectionBaseSchema" }, { "type": "object", "required": [ "member" ], "properties": { "member": { "type": "array", "items": { "$ref": "#/components/schemas/TransferDocument.TransferDocumentOutput.jsonld" } } } } ] } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TransferDocument.TransferDocumentOutput" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TransferDocument.TransferDocumentOutput.html" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TransferDocument.TransferDocumentOutput.xml" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TransferDocument.TransferDocumentOutput.xml" } } }, "application/octet-stream": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TransferDocument.TransferDocumentOutput.raw" } } } } } }, "summary": "Retrieves the collection of TransferDocument resources.", "description": "Retrieves the collection of TransferDocument resources.", "parameters": [ { "name": "uploadId", "in": "path", "description": "Upload identifier", "required": true, "deprecated": false, "schema": { "type": "string" }, "style": "simple", "explode": false }, { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": true }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "schema": { "type": "integer", "default": 30, "minimum": 0, "maximum": 100 }, "style": "form", "explode": true }, { "name": "role", "in": "query", "description": "TransferDocument role", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": true }, { "name": "role[]", "in": "query", "description": "TransferDocument role", "required": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "deepObject", "explode": true }, { "name": "status", "in": "query", "description": "TransferDocument status", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": true }, { "name": "status[]", "in": "query", "description": "TransferDocument status", "required": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "deepObject", "explode": true }, { "name": "transmission_node", "in": "query", "description": "TransferDocument transmission_node", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": true }, { "name": "transmission_node[]", "in": "query", "description": "TransferDocument transmission_node", "required": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "deepObject", "explode": true }, { "name": "transmission_outcome", "in": "query", "description": "TransferDocument transmission_outcome", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": true }, { "name": "transmission_outcome[]", "in": "query", "description": "TransferDocument transmission_outcome", "required": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "deepObject", "explode": true }, { "name": "type", "in": "query", "description": "TransferDocument type", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": true }, { "name": "type[]", "in": "query", "description": "TransferDocument type", "required": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "deepObject", "explode": true }, { "name": "created_at[gt]", "in": "query", "description": "TransferDocument created_at", "required": false, "deprecated": false, "schema": { "type": "object", "properties": { "gt": { "type": "string" }, "gte": { "type": "string" }, "lt": { "type": "string" }, "lte": { "type": "string" }, "ne": { "type": "string" } } }, "style": "form", "explode": true }, { "name": "created_at[gte]", "in": "query", "description": "TransferDocument created_at", "required": false, "deprecated": false, "schema": { "type": "object", "properties": { "gt": { "type": "string" }, "gte": { "type": "string" }, "lt": { "type": "string" }, "lte": { "type": "string" }, "ne": { "type": "string" } } }, "style": "form", "explode": true }, { "name": "created_at[lt]", "in": "query", "description": "TransferDocument created_at", "required": false, "deprecated": false, "schema": { "type": "object", "properties": { "gt": { "type": "string" }, "gte": { "type": "string" }, "lt": { "type": "string" }, "lte": { "type": "string" }, "ne": { "type": "string" } } }, "style": "form", "explode": true }, { "name": "created_at[lte]", "in": "query", "description": "TransferDocument created_at", "required": false, "deprecated": false, "schema": { "type": "object", "properties": { "gt": { "type": "string" }, "gte": { "type": "string" }, "lt": { "type": "string" }, "lte": { "type": "string" }, "ne": { "type": "string" } } }, "style": "form", "explode": true }, { "name": "created_at[ne]", "in": "query", "description": "TransferDocument created_at", "required": false, "deprecated": false, "schema": { "type": "object", "properties": { "gt": { "type": "string" }, "gte": { "type": "string" }, "lt": { "type": "string" }, "lte": { "type": "string" }, "ne": { "type": "string" } } }, "style": "form", "explode": true }, { "name": "transmitted_at[gt]", "in": "query", "description": "TransferDocument transmitted_at", "required": false, "deprecated": false, "schema": { "type": "object", "properties": { "gt": { "type": "string" }, "gte": { "type": "string" }, "lt": { "type": "string" }, "lte": { "type": "string" }, "ne": { "type": "string" } } }, "style": "form", "explode": true }, { "name": "transmitted_at[gte]", "in": "query", "description": "TransferDocument transmitted_at", "required": false, "deprecated": false, "schema": { "type": "object", "properties": { "gt": { "type": "string" }, "gte": { "type": "string" }, "lt": { "type": "string" }, "lte": { "type": "string" }, "ne": { "type": "string" } } }, "style": "form", "explode": true }, { "name": "transmitted_at[lt]", "in": "query", "description": "TransferDocument transmitted_at", "required": false, "deprecated": false, "schema": { "type": "object", "properties": { "gt": { "type": "string" }, "gte": { "type": "string" }, "lt": { "type": "string" }, "lte": { "type": "string" }, "ne": { "type": "string" } } }, "style": "form", "explode": true }, { "name": "transmitted_at[lte]", "in": "query", "description": "TransferDocument transmitted_at", "required": false, "deprecated": false, "schema": { "type": "object", "properties": { "gt": { "type": "string" }, "gte": { "type": "string" }, "lt": { "type": "string" }, "lte": { "type": "string" }, "ne": { "type": "string" } } }, "style": "form", "explode": true }, { "name": "transmitted_at[ne]", "in": "query", "description": "TransferDocument transmitted_at", "required": false, "deprecated": false, "schema": { "type": "object", "properties": { "gt": { "type": "string" }, "gte": { "type": "string" }, "lt": { "type": "string" }, "lte": { "type": "string" }, "ne": { "type": "string" } } }, "style": "form", "explode": true }, { "name": "sortBy[created_at]", "in": "query", "description": "TransferDocument sortBy[created_at]", "required": false, "deprecated": false, "schema": { "type": "string", "enum": [ "asc", "desc", "ASC", "DESC" ] }, "style": "form", "explode": true }, { "name": "sortBy[transmitted_at]", "in": "query", "description": "TransferDocument sortBy[transmitted_at]", "required": false, "deprecated": false, "schema": { "type": "string", "enum": [ "asc", "desc", "ASC", "DESC" ] }, "style": "form", "explode": true }, { "name": "exists[violations]", "in": "query", "description": "TransferDocument exists[violations]", "required": false, "deprecated": false, "schema": { "type": "boolean" }, "style": "form", "explode": true } ] } }, "/it/dirs": { "get": { "operationId": "transfer_it_dirs", "tags": [ "TransferUpload" ], "responses": { "200": { "description": "The list of directories buckets", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TransferUpload.DirectoryBucketOutput" } } } } } }, "summary": "Get a list of all directories buckets", "description": "Get a list of all directories buckets", "parameters": [ { "name": "bucket", "in": "query", "description": "The bucket name", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": true }, { "name": "prefix", "in": "query", "description": "The prefix", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": true }, { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": true }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "schema": { "type": "integer", "default": 30, "minimum": 0, "maximum": 100 }, "style": "form", "explode": true } ] } }, "/it/upload": { "post": { "operationId": "transfer_it_upload", "tags": [ "TransferUpload" ], "responses": { "202": { "description": "The file has been uploaded", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/TransferUpload.jsonld" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TransferUpload" } }, "text/html": { "schema": { "$ref": "#/components/schemas/TransferUpload.html" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/TransferUpload.xml" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/TransferUpload.xml" } }, "application/octet-stream": { "schema": { "$ref": "#/components/schemas/TransferUpload.raw" } } }, "links": {} }, "400": { "description": "Invalid input", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": {} }, "422": { "description": "An error occurred", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation" } } }, "links": {} } }, "summary": "Upload a file for IT project", "description": "Upload a file for IT project", "parameters": [], "requestBody": { "description": "The new TransferUpload resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransferUpload.TransferUploadInput" } } }, "required": true } } }, "/pl/dirs": { "get": { "operationId": "transfer_pl_dirs", "tags": [ "TransferUpload" ], "responses": { "200": { "description": "The list of directories buckets", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TransferUpload.DirectoryBucketOutput" } } } } } }, "summary": "Get a list of all directories buckets", "description": "Get a list of all directories buckets", "parameters": [ { "name": "bucket", "in": "query", "description": "The bucket name", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": true }, { "name": "prefix", "in": "query", "description": "The prefix", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": true }, { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": true }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "schema": { "type": "integer", "default": 30, "minimum": 0, "maximum": 100 }, "style": "form", "explode": true } ] } }, "/pl/upload": { "post": { "operationId": "transfer_pl_upload", "tags": [ "TransferUpload" ], "responses": { "202": { "description": "The file has been uploaded", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/TransferUpload.jsonld" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TransferUpload" } }, "text/html": { "schema": { "$ref": "#/components/schemas/TransferUpload.html" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/TransferUpload.xml" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/TransferUpload.xml" } }, "application/octet-stream": { "schema": { "$ref": "#/components/schemas/TransferUpload.raw" } } }, "links": {} }, "400": { "description": "Invalid input", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": {} }, "422": { "description": "An error occurred", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation" } } }, "links": {} } }, "summary": "Upload a file for PL project", "description": "Upload a file for PL project", "parameters": [], "requestBody": { "description": "The new TransferUpload resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransferUpload.TransferUploadInput" } } }, "required": true } } }, "/upload": { "post": { "operationId": "transfer_upload", "tags": [ "TransferUpload" ], "responses": { "202": { "description": "The upload receipt", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransferUpload.UploadReceipt" } } }, "headers": { "Location": { "in": "header", "description": "URI of the created upload receipt.", "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { "type": "string", "format": "uri-reference" }, "style": "simple", "explode": false, "allowReserved": false } }, "links": {} }, "400": { "description": "Invalid input", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": {} }, "422": { "description": "An error occurred", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation" } } }, "links": {} } }, "summary": "Create a client upload receipt", "description": "Stores the source object and returns a receipt that can be read immediately.", "parameters": [], "requestBody": { "description": "The new TransferUpload resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransferUpload.UploadReceiptInput" } } }, "required": true } } }, "/uploads": { "get": { "operationId": "api_uploads_get_collection", "tags": [ "Upload" ], "responses": { "200": { "description": "Upload collection", "content": { "application/ld+json": { "schema": { "type": "object", "description": "Upload.UploadOutput.jsonld collection.", "allOf": [ { "$ref": "#/components/schemas/HydraCollectionBaseSchema" }, { "type": "object", "required": [ "member" ], "properties": { "member": { "type": "array", "items": { "$ref": "#/components/schemas/Upload.UploadOutput.jsonld" } } } } ] } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Upload.UploadOutput" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Upload.UploadOutput.html" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Upload.UploadOutput.xml" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Upload.UploadOutput.xml" } } }, "application/octet-stream": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Upload.UploadOutput.raw" } } } } } }, "summary": "Retrieves the collection of Upload resources.", "description": "Retrieves the collection of Upload resources.", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "schema": { "type": "integer", "default": 1 }, "style": "form", "explode": true }, { "name": "itemsPerPage", "in": "query", "description": "The number of items per page", "required": false, "deprecated": false, "schema": { "type": "integer", "default": 30, "minimum": 0, "maximum": 100 }, "style": "form", "explode": true }, { "name": "e2e_id", "in": "query", "description": "Exact, case-sensitive client identifier within the existing owner scope. Returns all matching uploads, including duplicates.", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": true }, { "name": "e2e_id[]", "in": "query", "description": "Exact, case-sensitive client identifier within the existing owner scope. Returns all matching uploads, including duplicates.", "required": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "deepObject", "explode": true }, { "name": "status", "in": "query", "description": "Upload status", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": true }, { "name": "status[]", "in": "query", "description": "Upload status", "required": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "deepObject", "explode": true }, { "name": "source_type", "in": "query", "description": "Upload source_type", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": true }, { "name": "source_type[]", "in": "query", "description": "Upload source_type", "required": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "deepObject", "explode": true }, { "name": "destination_project", "in": "query", "description": "Upload destination_project", "required": false, "deprecated": false, "schema": { "type": "string" }, "style": "form", "explode": true }, { "name": "destination_project[]", "in": "query", "description": "Upload destination_project", "required": false, "deprecated": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "deepObject", "explode": true }, { "name": "ingested_at[gt]", "in": "query", "description": "Upload ingested_at", "required": false, "deprecated": false, "schema": { "type": "object", "properties": { "gt": { "type": "string" }, "gte": { "type": "string" }, "lt": { "type": "string" }, "lte": { "type": "string" }, "ne": { "type": "string" } } }, "style": "form", "explode": true }, { "name": "ingested_at[gte]", "in": "query", "description": "Upload ingested_at", "required": false, "deprecated": false, "schema": { "type": "object", "properties": { "gt": { "type": "string" }, "gte": { "type": "string" }, "lt": { "type": "string" }, "lte": { "type": "string" }, "ne": { "type": "string" } } }, "style": "form", "explode": true }, { "name": "ingested_at[lt]", "in": "query", "description": "Upload ingested_at", "required": false, "deprecated": false, "schema": { "type": "object", "properties": { "gt": { "type": "string" }, "gte": { "type": "string" }, "lt": { "type": "string" }, "lte": { "type": "string" }, "ne": { "type": "string" } } }, "style": "form", "explode": true }, { "name": "ingested_at[lte]", "in": "query", "description": "Upload ingested_at", "required": false, "deprecated": false, "schema": { "type": "object", "properties": { "gt": { "type": "string" }, "gte": { "type": "string" }, "lt": { "type": "string" }, "lte": { "type": "string" }, "ne": { "type": "string" } } }, "style": "form", "explode": true }, { "name": "ingested_at[ne]", "in": "query", "description": "Upload ingested_at", "required": false, "deprecated": false, "schema": { "type": "object", "properties": { "gt": { "type": "string" }, "gte": { "type": "string" }, "lt": { "type": "string" }, "lte": { "type": "string" }, "ne": { "type": "string" } } }, "style": "form", "explode": true }, { "name": "completed_at[gt]", "in": "query", "description": "Upload completed_at", "required": false, "deprecated": false, "schema": { "type": "object", "properties": { "gt": { "type": "string" }, "gte": { "type": "string" }, "lt": { "type": "string" }, "lte": { "type": "string" }, "ne": { "type": "string" } } }, "style": "form", "explode": true }, { "name": "completed_at[gte]", "in": "query", "description": "Upload completed_at", "required": false, "deprecated": false, "schema": { "type": "object", "properties": { "gt": { "type": "string" }, "gte": { "type": "string" }, "lt": { "type": "string" }, "lte": { "type": "string" }, "ne": { "type": "string" } } }, "style": "form", "explode": true }, { "name": "completed_at[lt]", "in": "query", "description": "Upload completed_at", "required": false, "deprecated": false, "schema": { "type": "object", "properties": { "gt": { "type": "string" }, "gte": { "type": "string" }, "lt": { "type": "string" }, "lte": { "type": "string" }, "ne": { "type": "string" } } }, "style": "form", "explode": true }, { "name": "completed_at[lte]", "in": "query", "description": "Upload completed_at", "required": false, "deprecated": false, "schema": { "type": "object", "properties": { "gt": { "type": "string" }, "gte": { "type": "string" }, "lt": { "type": "string" }, "lte": { "type": "string" }, "ne": { "type": "string" } } }, "style": "form", "explode": true }, { "name": "completed_at[ne]", "in": "query", "description": "Upload completed_at", "required": false, "deprecated": false, "schema": { "type": "object", "properties": { "gt": { "type": "string" }, "gte": { "type": "string" }, "lt": { "type": "string" }, "lte": { "type": "string" }, "ne": { "type": "string" } } }, "style": "form", "explode": true }, { "name": "sortBy[ingested_at]", "in": "query", "description": "Upload sortBy[ingested_at]", "required": false, "deprecated": false, "schema": { "type": "string", "enum": [ "asc", "desc", "ASC", "DESC" ] }, "style": "form", "explode": true }, { "name": "sortBy[status]", "in": "query", "description": "Upload sortBy[status]", "required": false, "deprecated": false, "schema": { "type": "string", "enum": [ "asc", "desc", "ASC", "DESC" ] }, "style": "form", "explode": true } ] } }, "/uploads/{id}": { "get": { "operationId": "api_uploads_id_get", "tags": [ "Upload" ], "responses": { "200": { "description": "Upload resource", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Upload.UploadOutput.jsonld" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Upload.UploadOutput" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Upload.UploadOutput.html" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Upload.UploadOutput.xml" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Upload.UploadOutput.xml" } }, "application/octet-stream": { "schema": { "$ref": "#/components/schemas/Upload.UploadOutput.raw" } } } }, "404": { "description": "Not found", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "links": {} } }, "summary": "Retrieves a Upload resource.", "description": "Retrieves a Upload resource.", "parameters": [ { "name": "id", "in": "path", "description": "Upload identifier", "required": true, "deprecated": false, "schema": { "type": "string" }, "style": "simple", "explode": false } ] } } }, "components": { "schemas": { "ConstraintViolation": { "type": "object", "description": "Unprocessable entity", "properties": { "status": { "default": 422, "type": "integer" }, "violations": { "type": "array", "items": { "type": "object", "properties": { "propertyPath": { "type": "string", "description": "The property path of the violation" }, "message": { "type": "string", "description": "The message associated with the violation" }, "code": { "type": "string", "description": "The code of the violation" }, "hint": { "type": "string", "description": "An extra hint to understand the violation" }, "payload": { "type": "object", "additionalProperties": true, "description": "The serialized payload of the violation" } }, "required": [ "propertyPath", "message" ] } }, "detail": { "readOnly": true, "type": "string" }, "type": { "readOnly": true, "type": "string" }, "title": { "readOnly": true, "type": [ "string", "null" ] }, "instance": { "readOnly": true, "type": [ "string", "null" ] } } }, "ConstraintViolation.jsonld": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "properties": { "status": { "default": 422, "type": "integer" }, "violations": { "type": "array", "items": { "type": "object", "properties": { "propertyPath": { "type": "string", "description": "The property path of the violation" }, "message": { "type": "string", "description": "The message associated with the violation" }, "code": { "type": "string", "description": "The code of the violation" }, "hint": { "type": "string", "description": "An extra hint to understand the violation" }, "payload": { "type": "object", "additionalProperties": true, "description": "The serialized payload of the violation" } }, "required": [ "propertyPath", "message" ] } }, "detail": { "readOnly": true, "type": "string" }, "description": { "readOnly": true, "type": "string" }, "type": { "readOnly": true, "type": "string" }, "title": { "readOnly": true, "type": [ "string", "null" ] }, "instance": { "readOnly": true, "type": [ "string", "null" ] } } } ], "description": "Unprocessable entity" }, "Error": { "type": "object", "description": "A representation of common errors.", "properties": { "title": { "readOnly": true, "description": "A short, human-readable summary of the problem.", "type": [ "string", "null" ] }, "detail": { "readOnly": true, "description": "A human-readable explanation specific to this occurrence of the problem.", "type": [ "string", "null" ] }, "status": { "type": [ "integer", "null" ], "examples": [ 404 ], "default": 400 }, "instance": { "readOnly": true, "description": "A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.", "type": [ "string", "null" ] }, "type": { "readOnly": true, "description": "A URI reference that identifies the problem type", "type": "string" } } }, "Error.jsonld": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "properties": { "title": { "readOnly": true, "description": "A short, human-readable summary of the problem.", "type": [ "string", "null" ] }, "detail": { "readOnly": true, "description": "A human-readable explanation specific to this occurrence of the problem.", "type": [ "string", "null" ] }, "status": { "type": [ "integer", "null" ], "examples": [ 404 ], "default": 400 }, "instance": { "readOnly": true, "description": "A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.", "type": [ "string", "null" ] }, "type": { "readOnly": true, "description": "A URI reference that identifies the problem type", "type": "string" }, "description": { "readOnly": true, "type": [ "string", "null" ] } } } ], "description": "A representation of common errors." }, "HydraCollectionBaseSchema": { "allOf": [ { "$ref": "#/components/schemas/HydraCollectionBaseSchemaNoPagination" }, { "type": "object", "properties": { "view": { "type": "object", "properties": { "@id": { "type": "string", "format": "iri-reference" }, "@type": { "type": "string" }, "first": { "type": [ "string", "null" ], "format": "iri-reference" }, "last": { "type": [ "string", "null" ], "format": "iri-reference" }, "previous": { "type": [ "string", "null" ], "format": "iri-reference" }, "next": { "type": [ "string", "null" ], "format": "iri-reference" } }, "example": { "@id": "string", "@type": "string", "first": "string", "last": "string", "previous": "string", "next": "string" } } } } ] }, "HydraCollectionBaseSchemaNoPagination": { "type": "object", "properties": { "totalItems": { "type": "integer", "minimum": 0 }, "search": { "type": "object", "properties": { "@type": { "type": "string" }, "template": { "type": "string" }, "variableRepresentation": { "type": "string" }, "mapping": { "type": "array", "items": { "type": "object", "properties": { "@type": { "type": "string" }, "variable": { "type": "string" }, "property": { "type": [ "string", "null" ] }, "required": { "type": "boolean" } } } } } } } }, "HydraItemBaseSchema": { "type": "object", "properties": { "@context": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "@vocab": { "type": "string" }, "hydra": { "type": "string", "enum": [ "http://www.w3.org/ns/hydra/core#" ] } }, "required": [ "@vocab", "hydra" ], "additionalProperties": true } ] }, "@id": { "type": "string" }, "@type": { "type": "string" } }, "required": [ "@id", "@type" ] }, "TransferDocument.TransferDocumentOutput": { "type": "object", "properties": { "id": { "description": "Document identifier (UUID v7).", "type": "string" }, "upload": { "description": "IRI of the upload this document belongs to.", "type": "string" }, "source_document": { "description": "IRI of the document this one derives from, when any.", "type": [ "string", "null" ] }, "owner_id": { "description": "A-Cube account that owns the document.", "type": "integer" }, "role": { "description": "Stage of the document in the transfer pipeline.", "type": "string", "enum": [ "source", "intermediate", "target" ] }, "type": { "description": "Product of the document, when classified.", "type": [ "string", "null" ], "enum": [ "invoice", "ddt", null ] }, "file_name": { "description": "Original file name.", "type": "string" }, "file_format": { "description": "File format (e.g. xml, csv).", "type": "string" }, "bucket_name": { "description": "S3 bucket holding the file.", "type": "string" }, "s3_key": { "description": "S3 object key of the file.", "type": "string" }, "content_md5hash": { "description": "MD5 hash of the file content.", "type": "string" }, "byte_size": { "description": "File size in bytes.", "type": "integer" }, "status": { "description": "Current lifecycle status.", "type": "string", "enum": [ "new", "processing", "processed", "transmitting", "transmitted", "failed" ] }, "transmission_node": { "description": "Transmission node, when transmitted.", "type": [ "string", "null" ] }, "transmission_uuid": { "description": "Transmission identifier, when transmitted.", "type": [ "string", "null" ] }, "transmission_outcome": { "description": "Transmission outcome, when transmitted.", "type": [ "string", "null" ], "enum": [ "pending", "ok", "error", null ] }, "document_iri": { "description": "IRI of the produced document in the destination service.", "type": [ "string", "null" ] }, "violations": { "description": "Validation/processing violations, when the document failed.", "type": "array", "items": { "$ref": "#/components/schemas/TransferViolationOutput" } }, "created_at": { "description": "When the document was created (ISO-8601).", "type": "string", "format": "date-time" }, "transmitted_at": { "description": "When the document was transmitted (ISO-8601), when any.", "type": [ "string", "null" ], "format": "date-time" } } }, "TransferDocument.TransferDocumentOutput.html": { "type": "object", "properties": { "id": { "description": "Document identifier (UUID v7).", "type": "string" }, "upload": { "description": "IRI of the upload this document belongs to.", "type": "string" }, "source_document": { "description": "IRI of the document this one derives from, when any.", "type": [ "string", "null" ] }, "owner_id": { "description": "A-Cube account that owns the document.", "type": "integer" }, "role": { "description": "Stage of the document in the transfer pipeline.", "type": "string", "enum": [ "source", "intermediate", "target" ] }, "type": { "description": "Product of the document, when classified.", "type": [ "string", "null" ], "enum": [ "invoice", "ddt", null ] }, "file_name": { "description": "Original file name.", "type": "string" }, "file_format": { "description": "File format (e.g. xml, csv).", "type": "string" }, "bucket_name": { "description": "S3 bucket holding the file.", "type": "string" }, "s3_key": { "description": "S3 object key of the file.", "type": "string" }, "content_md5hash": { "description": "MD5 hash of the file content.", "type": "string" }, "byte_size": { "description": "File size in bytes.", "type": "integer" }, "status": { "description": "Current lifecycle status.", "type": "string", "enum": [ "new", "processing", "processed", "transmitting", "transmitted", "failed" ] }, "transmission_node": { "description": "Transmission node, when transmitted.", "type": [ "string", "null" ] }, "transmission_uuid": { "description": "Transmission identifier, when transmitted.", "type": [ "string", "null" ] }, "transmission_outcome": { "description": "Transmission outcome, when transmitted.", "type": [ "string", "null" ], "enum": [ "pending", "ok", "error", null ] }, "document_iri": { "description": "IRI of the produced document in the destination service.", "type": [ "string", "null" ] }, "violations": { "description": "Validation/processing violations, when the document failed.", "type": "array", "items": { "$ref": "#/components/schemas/TransferViolationOutput.html" } }, "created_at": { "description": "When the document was created (ISO-8601).", "type": "string", "format": "date-time" }, "transmitted_at": { "description": "When the document was transmitted (ISO-8601), when any.", "type": [ "string", "null" ], "format": "date-time" } } }, "TransferDocument.TransferDocumentOutput.jsonld": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "properties": { "id": { "description": "Document identifier (UUID v7).", "type": "string" }, "upload": { "description": "IRI of the upload this document belongs to.", "type": "string" }, "source_document": { "description": "IRI of the document this one derives from, when any.", "type": [ "string", "null" ] }, "owner_id": { "description": "A-Cube account that owns the document.", "type": "integer" }, "role": { "description": "Stage of the document in the transfer pipeline.", "type": "string", "enum": [ "source", "intermediate", "target" ] }, "type": { "description": "Product of the document, when classified.", "type": [ "string", "null" ], "enum": [ "invoice", "ddt", null ] }, "file_name": { "description": "Original file name.", "type": "string" }, "file_format": { "description": "File format (e.g. xml, csv).", "type": "string" }, "bucket_name": { "description": "S3 bucket holding the file.", "type": "string" }, "s3_key": { "description": "S3 object key of the file.", "type": "string" }, "content_md5hash": { "description": "MD5 hash of the file content.", "type": "string" }, "byte_size": { "description": "File size in bytes.", "type": "integer" }, "status": { "description": "Current lifecycle status.", "type": "string", "enum": [ "new", "processing", "processed", "transmitting", "transmitted", "failed" ] }, "transmission_node": { "description": "Transmission node, when transmitted.", "type": [ "string", "null" ] }, "transmission_uuid": { "description": "Transmission identifier, when transmitted.", "type": [ "string", "null" ] }, "transmission_outcome": { "description": "Transmission outcome, when transmitted.", "type": [ "string", "null" ], "enum": [ "pending", "ok", "error", null ] }, "document_iri": { "description": "IRI of the produced document in the destination service.", "type": [ "string", "null" ] }, "violations": { "description": "Validation/processing violations, when the document failed.", "type": "array", "items": { "$ref": "#/components/schemas/TransferViolationOutput.jsonld" } }, "created_at": { "description": "When the document was created (ISO-8601).", "type": "string", "format": "date-time" }, "transmitted_at": { "description": "When the document was transmitted (ISO-8601), when any.", "type": [ "string", "null" ], "format": "date-time" } } } ] }, "TransferDocument.TransferDocumentOutput.raw": { "type": "object", "properties": { "id": { "description": "Document identifier (UUID v7).", "type": "string" }, "upload": { "description": "IRI of the upload this document belongs to.", "type": "string" }, "source_document": { "description": "IRI of the document this one derives from, when any.", "type": [ "string", "null" ] }, "owner_id": { "description": "A-Cube account that owns the document.", "type": "integer" }, "role": { "description": "Stage of the document in the transfer pipeline.", "type": "string", "enum": [ "source", "intermediate", "target" ] }, "type": { "description": "Product of the document, when classified.", "type": [ "string", "null" ], "enum": [ "invoice", "ddt", null ] }, "file_name": { "description": "Original file name.", "type": "string" }, "file_format": { "description": "File format (e.g. xml, csv).", "type": "string" }, "bucket_name": { "description": "S3 bucket holding the file.", "type": "string" }, "s3_key": { "description": "S3 object key of the file.", "type": "string" }, "content_md5hash": { "description": "MD5 hash of the file content.", "type": "string" }, "byte_size": { "description": "File size in bytes.", "type": "integer" }, "status": { "description": "Current lifecycle status.", "type": "string", "enum": [ "new", "processing", "processed", "transmitting", "transmitted", "failed" ] }, "transmission_node": { "description": "Transmission node, when transmitted.", "type": [ "string", "null" ] }, "transmission_uuid": { "description": "Transmission identifier, when transmitted.", "type": [ "string", "null" ] }, "transmission_outcome": { "description": "Transmission outcome, when transmitted.", "type": [ "string", "null" ], "enum": [ "pending", "ok", "error", null ] }, "document_iri": { "description": "IRI of the produced document in the destination service.", "type": [ "string", "null" ] }, "violations": { "description": "Validation/processing violations, when the document failed.", "type": "array", "items": { "$ref": "#/components/schemas/TransferViolationOutput.raw" } }, "created_at": { "description": "When the document was created (ISO-8601).", "type": "string", "format": "date-time" }, "transmitted_at": { "description": "When the document was transmitted (ISO-8601), when any.", "type": [ "string", "null" ], "format": "date-time" } } }, "TransferDocument.TransferDocumentOutput.xml": { "type": "object", "properties": { "id": { "description": "Document identifier (UUID v7).", "type": "string" }, "upload": { "description": "IRI of the upload this document belongs to.", "type": "string" }, "source_document": { "description": "IRI of the document this one derives from, when any.", "type": [ "string", "null" ] }, "owner_id": { "description": "A-Cube account that owns the document.", "type": "integer" }, "role": { "description": "Stage of the document in the transfer pipeline.", "type": "string", "enum": [ "source", "intermediate", "target" ] }, "type": { "description": "Product of the document, when classified.", "type": [ "string", "null" ], "enum": [ "invoice", "ddt", null ] }, "file_name": { "description": "Original file name.", "type": "string" }, "file_format": { "description": "File format (e.g. xml, csv).", "type": "string" }, "bucket_name": { "description": "S3 bucket holding the file.", "type": "string" }, "s3_key": { "description": "S3 object key of the file.", "type": "string" }, "content_md5hash": { "description": "MD5 hash of the file content.", "type": "string" }, "byte_size": { "description": "File size in bytes.", "type": "integer" }, "status": { "description": "Current lifecycle status.", "type": "string", "enum": [ "new", "processing", "processed", "transmitting", "transmitted", "failed" ] }, "transmission_node": { "description": "Transmission node, when transmitted.", "type": [ "string", "null" ] }, "transmission_uuid": { "description": "Transmission identifier, when transmitted.", "type": [ "string", "null" ] }, "transmission_outcome": { "description": "Transmission outcome, when transmitted.", "type": [ "string", "null" ], "enum": [ "pending", "ok", "error", null ] }, "document_iri": { "description": "IRI of the produced document in the destination service.", "type": [ "string", "null" ] }, "violations": { "description": "Validation/processing violations, when the document failed.", "type": "array", "items": { "$ref": "#/components/schemas/TransferViolationOutput.xml" } }, "created_at": { "description": "When the document was created (ISO-8601).", "type": "string", "format": "date-time" }, "transmitted_at": { "description": "When the document was transmitted (ISO-8601), when any.", "type": [ "string", "null" ], "format": "date-time" } } }, "TransferUpload": { "type": "object" }, "TransferUpload.UploadReceiptInput": { "type": "object", "required": [ "country", "file_name", "content" ], "properties": { "country": { "enum": [ "IT", "PL" ], "description": "Destination country.", "example": "PL", "type": "string" }, "file_name": { "maxLength": 255, "description": "Original basename. Its extension (csv, json, p7m, pdf, txt, xml, zip) picks the processing flow.", "example": "invoice.json", "type": "string" }, "content": { "description": "Strictly base64 encoded file content.", "type": "string" }, "e2e_id": { "maxLength": 255, "pattern": "^([\\x20-\\x7E]*(?![\\s\\S]).*)$", "description": "Optional client identifier, preserved exactly and searchable through the e2e_id filter on GET /uploads. Maximum 255 printable ASCII characters, spaces allowed inside but not at the start or at the end. Empty or null means no identifier.", "example": "a1b2c3d4", "type": [ "string", "null" ] } } }, "TransferUpload.DirectoryBucketOutput": { "type": "object", "properties": { "dirs": { "type": [ "array", "null" ], "items": { "type": "string" } }, "root_dir": { "type": "string" } } }, "TransferUpload.TransferUploadInput": { "type": "object", "required": [ "path", "content" ], "properties": { "path": { "pattern": "^([0-9a-zA-Z!\\-_.*\\'()/]+)$", "description": "The path to the file in the destination filesystem.", "example": "path/to/file.csv", "type": "string" }, "content": { "description": "Base64 encoded content of the file.", "type": "string" }, "e2e_id": { "maxLength": 255, "pattern": "^([\\x20-\\x7E]*(?![\\s\\S]).*)$", "description": "Optional client identifier, preserved exactly and searchable through the e2e_id filter on GET /uploads. Maximum 255 printable ASCII characters, spaces allowed inside but not at the start or at the end. Empty or null means no identifier.", "example": "a1b2c3d4", "type": [ "string", "null" ] } } }, "TransferUpload.UploadReceipt": { "type": "object", "properties": { "id": { "description": "Upload identifier (UUID v7).", "type": "string" }, "e2e_id": { "description": "Client-provided upload identifier, or null when not supplied.", "type": [ "string", "null" ] }, "status": { "description": "Current lifecycle status.", "type": "string", "enum": [ "pending", "ingested", "processing", "completed", "partial", "failed" ] } } }, "TransferUpload.UploadReceipt.html": { "type": "object", "properties": { "id": { "description": "Upload identifier (UUID v7).", "type": "string" }, "e2e_id": { "description": "Client-provided upload identifier, or null when not supplied.", "type": [ "string", "null" ] }, "status": { "description": "Current lifecycle status.", "type": "string", "enum": [ "pending", "ingested", "processing", "completed", "partial", "failed" ] } } }, "TransferUpload.UploadReceipt.jsonld": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "properties": { "id": { "description": "Upload identifier (UUID v7).", "type": "string" }, "e2e_id": { "description": "Client-provided upload identifier, or null when not supplied.", "type": [ "string", "null" ] }, "status": { "description": "Current lifecycle status.", "type": "string", "enum": [ "pending", "ingested", "processing", "completed", "partial", "failed" ] } } } ] }, "TransferUpload.UploadReceipt.raw": { "type": "object", "properties": { "id": { "description": "Upload identifier (UUID v7).", "type": "string" }, "e2e_id": { "description": "Client-provided upload identifier, or null when not supplied.", "type": [ "string", "null" ] }, "status": { "description": "Current lifecycle status.", "type": "string", "enum": [ "pending", "ingested", "processing", "completed", "partial", "failed" ] } } }, "TransferUpload.UploadReceipt.xml": { "type": "object", "properties": { "id": { "description": "Upload identifier (UUID v7).", "type": "string" }, "e2e_id": { "description": "Client-provided upload identifier, or null when not supplied.", "type": [ "string", "null" ] }, "status": { "description": "Current lifecycle status.", "type": "string", "enum": [ "pending", "ingested", "processing", "completed", "partial", "failed" ] } } }, "TransferUpload.html": { "type": "object" }, "TransferUpload.jsonld": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object" } ] }, "TransferUpload.raw": { "type": "object" }, "TransferUpload.xml": { "type": "object" }, "TransferViolationOutput": { "type": "object", "properties": { "code": { "description": "Machine-readable error code.", "example": "INPUT_FIELD_MISSING", "type": "string" }, "field": { "description": "Input field that caused the error, when applicable.", "type": [ "string", "null" ] }, "value": { "description": "Offending value, when applicable.", "type": [ "string", "null" ] }, "message": { "description": "Human-readable error message.", "type": "string" }, "context": { "description": "Extra structured context, e.g. the CSV row number.", "type": [ "object", "null" ], "additionalProperties": { "type": "string" } }, "occurred_at": { "description": "When the violation occurred (ISO-8601).", "example": "2026-06-15T15:30:07+00:00", "type": [ "string", "null" ] } } }, "TransferViolationOutput.html": { "type": "object", "properties": { "code": { "description": "Machine-readable error code.", "example": "INPUT_FIELD_MISSING", "type": "string" }, "field": { "description": "Input field that caused the error, when applicable.", "type": [ "string", "null" ] }, "value": { "description": "Offending value, when applicable.", "type": [ "string", "null" ] }, "message": { "description": "Human-readable error message.", "type": "string" }, "context": { "description": "Extra structured context, e.g. the CSV row number.", "type": [ "object", "null" ], "additionalProperties": { "type": "string" } }, "occurred_at": { "description": "When the violation occurred (ISO-8601).", "example": "2026-06-15T15:30:07+00:00", "type": [ "string", "null" ] } } }, "TransferViolationOutput.jsonld": { "type": "object", "properties": { "code": { "description": "Machine-readable error code.", "example": "INPUT_FIELD_MISSING", "type": "string" }, "field": { "description": "Input field that caused the error, when applicable.", "type": [ "string", "null" ] }, "value": { "description": "Offending value, when applicable.", "type": [ "string", "null" ] }, "message": { "description": "Human-readable error message.", "type": "string" }, "context": { "description": "Extra structured context, e.g. the CSV row number.", "type": [ "object", "null" ], "additionalProperties": { "type": "string" } }, "occurred_at": { "description": "When the violation occurred (ISO-8601).", "example": "2026-06-15T15:30:07+00:00", "type": [ "string", "null" ] } } }, "TransferViolationOutput.raw": { "type": "object", "properties": { "code": { "description": "Machine-readable error code.", "example": "INPUT_FIELD_MISSING", "type": "string" }, "field": { "description": "Input field that caused the error, when applicable.", "type": [ "string", "null" ] }, "value": { "description": "Offending value, when applicable.", "type": [ "string", "null" ] }, "message": { "description": "Human-readable error message.", "type": "string" }, "context": { "description": "Extra structured context, e.g. the CSV row number.", "type": [ "object", "null" ], "additionalProperties": { "type": "string" } }, "occurred_at": { "description": "When the violation occurred (ISO-8601).", "example": "2026-06-15T15:30:07+00:00", "type": [ "string", "null" ] } } }, "TransferViolationOutput.xml": { "type": "object", "properties": { "code": { "description": "Machine-readable error code.", "example": "INPUT_FIELD_MISSING", "type": "string" }, "field": { "description": "Input field that caused the error, when applicable.", "type": [ "string", "null" ] }, "value": { "description": "Offending value, when applicable.", "type": [ "string", "null" ] }, "message": { "description": "Human-readable error message.", "type": "string" }, "context": { "description": "Extra structured context, e.g. the CSV row number.", "type": [ "object", "null" ], "additionalProperties": { "type": "string" } }, "occurred_at": { "description": "When the violation occurred (ISO-8601).", "example": "2026-06-15T15:30:07+00:00", "type": [ "string", "null" ] } } }, "Upload.UploadOutput": { "type": "object", "properties": { "id": { "description": "Upload identifier (UUID v7).", "type": "string" }, "owner_id": { "description": "A-Cube account that owns the upload.", "type": "integer" }, "subaccount_id": { "description": "Subaccount the upload belongs to, when any.", "type": [ "integer", "null" ] }, "e2e_id": { "description": "Client-provided upload identifier, or null when not supplied.", "type": [ "string", "null" ] }, "file_name": { "description": "Original file name.", "type": "string" }, "file_format": { "description": "File format (e.g. xml, csv).", "type": "string" }, "destination_project": { "description": "Destination project of the upload.", "type": "string" }, "source_type": { "description": "How the upload entered the system.", "type": "string", "enum": [ "SFTP", "API", "EMAIL" ] }, "status": { "description": "Current lifecycle status.", "type": "string", "enum": [ "pending", "ingested", "processing", "completed", "partial", "failed" ] }, "ingested_at": { "description": "When the upload was ingested (ISO-8601).", "type": [ "string", "null" ], "format": "date-time" }, "completed_at": { "description": "When the upload completed (ISO-8601), when any.", "type": [ "string", "null" ], "format": "date-time" }, "errors": { "description": "Ingestion errors, when the upload failed.", "type": [ "array", "null" ], "items": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "Upload.UploadOutput.html": { "type": "object", "properties": { "id": { "description": "Upload identifier (UUID v7).", "type": "string" }, "owner_id": { "description": "A-Cube account that owns the upload.", "type": "integer" }, "subaccount_id": { "description": "Subaccount the upload belongs to, when any.", "type": [ "integer", "null" ] }, "e2e_id": { "description": "Client-provided upload identifier, or null when not supplied.", "type": [ "string", "null" ] }, "file_name": { "description": "Original file name.", "type": "string" }, "file_format": { "description": "File format (e.g. xml, csv).", "type": "string" }, "destination_project": { "description": "Destination project of the upload.", "type": "string" }, "source_type": { "description": "How the upload entered the system.", "type": "string", "enum": [ "SFTP", "API", "EMAIL" ] }, "status": { "description": "Current lifecycle status.", "type": "string", "enum": [ "pending", "ingested", "processing", "completed", "partial", "failed" ] }, "ingested_at": { "description": "When the upload was ingested (ISO-8601).", "type": [ "string", "null" ], "format": "date-time" }, "completed_at": { "description": "When the upload completed (ISO-8601), when any.", "type": [ "string", "null" ], "format": "date-time" }, "errors": { "description": "Ingestion errors, when the upload failed.", "type": [ "array", "null" ], "items": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "Upload.UploadOutput.jsonld": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object", "properties": { "id": { "description": "Upload identifier (UUID v7).", "type": "string" }, "owner_id": { "description": "A-Cube account that owns the upload.", "type": "integer" }, "subaccount_id": { "description": "Subaccount the upload belongs to, when any.", "type": [ "integer", "null" ] }, "e2e_id": { "description": "Client-provided upload identifier, or null when not supplied.", "type": [ "string", "null" ] }, "file_name": { "description": "Original file name.", "type": "string" }, "file_format": { "description": "File format (e.g. xml, csv).", "type": "string" }, "destination_project": { "description": "Destination project of the upload.", "type": "string" }, "source_type": { "description": "How the upload entered the system.", "type": "string", "enum": [ "SFTP", "API", "EMAIL" ] }, "status": { "description": "Current lifecycle status.", "type": "string", "enum": [ "pending", "ingested", "processing", "completed", "partial", "failed" ] }, "ingested_at": { "description": "When the upload was ingested (ISO-8601).", "type": [ "string", "null" ], "format": "date-time" }, "completed_at": { "description": "When the upload completed (ISO-8601), when any.", "type": [ "string", "null" ], "format": "date-time" }, "errors": { "description": "Ingestion errors, when the upload failed.", "type": [ "array", "null" ], "items": { "type": "object", "additionalProperties": { "type": "string" } } } } } ] }, "Upload.UploadOutput.raw": { "type": "object", "properties": { "id": { "description": "Upload identifier (UUID v7).", "type": "string" }, "owner_id": { "description": "A-Cube account that owns the upload.", "type": "integer" }, "subaccount_id": { "description": "Subaccount the upload belongs to, when any.", "type": [ "integer", "null" ] }, "e2e_id": { "description": "Client-provided upload identifier, or null when not supplied.", "type": [ "string", "null" ] }, "file_name": { "description": "Original file name.", "type": "string" }, "file_format": { "description": "File format (e.g. xml, csv).", "type": "string" }, "destination_project": { "description": "Destination project of the upload.", "type": "string" }, "source_type": { "description": "How the upload entered the system.", "type": "string", "enum": [ "SFTP", "API", "EMAIL" ] }, "status": { "description": "Current lifecycle status.", "type": "string", "enum": [ "pending", "ingested", "processing", "completed", "partial", "failed" ] }, "ingested_at": { "description": "When the upload was ingested (ISO-8601).", "type": [ "string", "null" ], "format": "date-time" }, "completed_at": { "description": "When the upload completed (ISO-8601), when any.", "type": [ "string", "null" ], "format": "date-time" }, "errors": { "description": "Ingestion errors, when the upload failed.", "type": [ "array", "null" ], "items": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "Upload.UploadOutput.xml": { "type": "object", "properties": { "id": { "description": "Upload identifier (UUID v7).", "type": "string" }, "owner_id": { "description": "A-Cube account that owns the upload.", "type": "integer" }, "subaccount_id": { "description": "Subaccount the upload belongs to, when any.", "type": [ "integer", "null" ] }, "e2e_id": { "description": "Client-provided upload identifier, or null when not supplied.", "type": [ "string", "null" ] }, "file_name": { "description": "Original file name.", "type": "string" }, "file_format": { "description": "File format (e.g. xml, csv).", "type": "string" }, "destination_project": { "description": "Destination project of the upload.", "type": "string" }, "source_type": { "description": "How the upload entered the system.", "type": "string", "enum": [ "SFTP", "API", "EMAIL" ] }, "status": { "description": "Current lifecycle status.", "type": "string", "enum": [ "pending", "ingested", "processing", "completed", "partial", "failed" ] }, "ingested_at": { "description": "When the upload was ingested (ISO-8601).", "type": [ "string", "null" ], "format": "date-time" }, "completed_at": { "description": "When the upload completed (ISO-8601), when any.", "type": [ "string", "null" ], "format": "date-time" }, "errors": { "description": "Ingestion errors, when the upload failed.", "type": [ "array", "null" ], "items": { "type": "object", "additionalProperties": { "type": "string" } } } } } }, "responses": {}, "parameters": {}, "examples": {}, "requestBodies": {}, "headers": {}, "securitySchemes": { "Bearer": { "type": "apiKey", "description": "Value for the Authorization header parameter.", "name": "Authorization", "in": "header" } } }, "security": [ { "Bearer": [] } ], "tags": [ { "name": "TransferUpload", "description": "Resource 'TransferUpload' operations." }, { "name": "TransferDocument", "description": "Resource 'TransferDocument' operations." }, { "name": "Upload", "description": "Resource 'Upload' operations." } ], "webhooks": {} }