RESTAPI:OpenAPICode: Unterschied zwischen den Versionen
Aus Cryptshare Documentation
(Hartwigr änderte das Inhaltsmodell der Seite RESTAPI:OpenAPICode von „Wikitext“ nach „JSON“) Markierung: Änderung des Inhaltsmodells |
(Update to 6.0.0-RC1 (Rest-API V1.8)) |
||
| Zeile 3: | Zeile 3: | ||
"info": { | "info": { | ||
"title": "Cryptshare REST API", | "title": "Cryptshare REST API", | ||
"description": "REST API of Cryptshare Server | "description": "REST API of Cryptshare Server.", | ||
"version": "1. | "version": "1.8" | ||
}, | }, | ||
"servers": [ | "servers": [ | ||
| Zeile 54: | Zeile 54: | ||
"name": "terms-of-use", | "name": "terms-of-use", | ||
"description": "Operations to retrieve resources and information regarding the terms of use." | "description": "Operations to retrieve resources and information regarding the terms of use." | ||
}, | |||
{ | |||
"name": "transfer", | |||
"description": "Operations to check existing transfers." | |||
}, | }, | ||
{ | { | ||
| Zeile 61: | Zeile 65: | ||
{ | { | ||
"name": "transfer-session", | "name": "transfer-session", | ||
"description": "Operations to create and access new transfers." | "description": "Operations to create and access new transfers. Transfer sessions may only be modified using the same verification token they were created with." | ||
}, | }, | ||
{ | { | ||
| Zeile 75: | Zeile 79: | ||
], | ], | ||
"summary": "Requests a generated client id that can be used for all operations that require a client id.", | "summary": "Requests a generated client id that can be used for all operations that require a client id.", | ||
"operationId": " | "operationId": "getVerificationStatusUsingGET", | ||
"parameters": [ | "parameters": [ | ||
{ | { | ||
| Zeile 96: | Zeile 100: | ||
"application/json": { | "application/json": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/ | "$ref": "#/components/schemas/ResponseOfClientId", | ||
"exampleSetFlag": true | "exampleSetFlag": true | ||
}, | }, | ||
| Zeile 160: | Zeile 164: | ||
], | ], | ||
"summary": "Returns the CORS status for the given product and requesting origin.", | "summary": "Returns the CORS status for the given product and requesting origin.", | ||
"operationId": " | "operationId": "getCorsStatusUsingGET_6", | ||
"parameters": [ | "parameters": [ | ||
{ | { | ||
| Zeile 386: | Zeile 390: | ||
} | } | ||
}, | }, | ||
" | "500": { | ||
"description": "Server error occurred.\n * | "description": "Server error occurred. \n * 5000 - Service threw an exception that cannot be handled otherwise (e.g. Database error).", | ||
"content": { | "content": { | ||
"application/json": { | "application/json": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/Error", | "$ref": "#/components/schemas/Error", | ||
"exampleSetFlag": | "exampleSetFlag": false | ||
}, | }, | ||
"exampleSetFlag": false | "exampleSetFlag": false | ||
| Zeile 398: | Zeile 402: | ||
} | } | ||
}, | }, | ||
" | "501": { | ||
"description": "Server error occurred. \n * | "description": "Server error occurred.\n * 5001 - Unsupported operation: QUICK\n * 5002 - Unsupported operation: eID", | ||
"content": { | "content": { | ||
"application/json": { | "application/json": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/Error", | "$ref": "#/components/schemas/Error", | ||
"exampleSetFlag": | "exampleSetFlag": true | ||
}, | }, | ||
"exampleSetFlag": false | "exampleSetFlag": false | ||
| Zeile 419: | Zeile 423: | ||
], | ], | ||
"summary": "Returns a CSV file download stream including the checksums of all files in the transfer. \nTo customize the locale of the checksums, the 'Accept-Language' header can be used.", | "summary": "Returns a CSV file download stream including the checksums of all files in the transfer. \nTo customize the locale of the checksums, the 'Accept-Language' header can be used.", | ||
"operationId": " | "operationId": "downloadChecksumsUsingGET", | ||
"parameters": [ | "parameters": [ | ||
{ | { | ||
| Zeile 539: | Zeile 543: | ||
} | } | ||
}, | }, | ||
" | "500": { | ||
"description": "Server error occurred.\n * | "description": "Server error occurred. \n * 5000 - Service threw an exception that cannot be handled otherwise (e.g. Database error).", | ||
"content": { | "content": { | ||
"application/json": { | "application/json": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/Error", | "$ref": "#/components/schemas/Error", | ||
"exampleSetFlag": | "exampleSetFlag": false | ||
}, | }, | ||
"exampleSetFlag": false | "exampleSetFlag": false | ||
| Zeile 551: | Zeile 555: | ||
} | } | ||
}, | }, | ||
" | "501": { | ||
"description": "Server error occurred. \n * | "description": "Server error occurred.\n * 5001 - Unsupported operation: QUICK\n * 5002 - Unsupported operation: eID", | ||
"content": { | "content": { | ||
"application/json": { | "application/json": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/Error", | "$ref": "#/components/schemas/Error", | ||
"exampleSetFlag": | "exampleSetFlag": true | ||
}, | }, | ||
"exampleSetFlag": false | "exampleSetFlag": false | ||
| Zeile 572: | Zeile 576: | ||
], | ], | ||
"summary": "Returns an EML file download stream including the confidential message with attachments embedded.", | "summary": "Returns an EML file download stream including the confidential message with attachments embedded.", | ||
"operationId": " | "operationId": "downloadEmlUsingGET_5", | ||
"parameters": [ | "parameters": [ | ||
{ | { | ||
| Zeile 704: | Zeile 708: | ||
} | } | ||
}, | }, | ||
" | "500": { | ||
"description": "Server error occurred.\n * | "description": "Server error occurred. \n * 5000 - Service threw an exception that cannot be handled otherwise (e.g. Database error).", | ||
"content": { | "content": { | ||
"application/json": { | "application/json": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/Error", | "$ref": "#/components/schemas/Error", | ||
"exampleSetFlag": | "exampleSetFlag": false | ||
}, | }, | ||
"exampleSetFlag": false | "exampleSetFlag": false | ||
| Zeile 716: | Zeile 720: | ||
} | } | ||
}, | }, | ||
" | "501": { | ||
"description": "Server error occurred. \n * | "description": "Server error occurred.\n * 5001 - Unsupported operation: QUICK\n * 5002 - Unsupported operation: eID", | ||
"content": { | "content": { | ||
"application/json": { | "application/json": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/Error", | "$ref": "#/components/schemas/Error", | ||
"exampleSetFlag": | "exampleSetFlag": true | ||
}, | }, | ||
"exampleSetFlag": false | "exampleSetFlag": false | ||
| Zeile 737: | Zeile 741: | ||
], | ], | ||
"summary": "Returns the transfer files information. Note that the `href` of the returned transfer files additionally includes the general parameters that are usually sent via headers for convenience. If the password was specified, it is also included in the `href`.", | "summary": "Returns the transfer files information. Note that the `href` of the returned transfer files additionally includes the general parameters that are usually sent via headers for convenience. If the password was specified, it is also included in the `href`.", | ||
"operationId": " | "operationId": "getTransferFilesInformationUsingGET", | ||
"parameters": [ | "parameters": [ | ||
{ | { | ||
| Zeile 857: | Zeile 861: | ||
} | } | ||
}, | }, | ||
" | "500": { | ||
"description": "Server error occurred.\n * | "description": "Server error occurred. \n * 5000 - Service threw an exception that cannot be handled otherwise (e.g. Database error).", | ||
"content": { | "content": { | ||
"application/json": { | "application/json": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/Error", | "$ref": "#/components/schemas/Error", | ||
"exampleSetFlag": | "exampleSetFlag": false | ||
}, | }, | ||
"exampleSetFlag": false | "exampleSetFlag": false | ||
| Zeile 869: | Zeile 873: | ||
} | } | ||
}, | }, | ||
" | "501": { | ||
"description": "Server error occurred. \n * | "description": "Server error occurred.\n * 5001 - Unsupported operation: QUICK\n * 5002 - Unsupported operation: eID", | ||
"content": { | "content": { | ||
"application/json": { | "application/json": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/Error", | "$ref": "#/components/schemas/Error", | ||
"exampleSetFlag": | "exampleSetFlag": true | ||
}, | }, | ||
"exampleSetFlag": false | "exampleSetFlag": false | ||
| Zeile 890: | Zeile 894: | ||
], | ], | ||
"summary": "Returns a file download stream for a transfer file.", | "summary": "Returns a file download stream for a transfer file.", | ||
"operationId": " | "operationId": "downloadSingleFileUsingGET_8", | ||
"parameters": [ | "parameters": [ | ||
{ | { | ||
| Zeile 1.021: | Zeile 1.025: | ||
} | } | ||
}, | }, | ||
" | "500": { | ||
"description": "Server error occurred.\n * | "description": "Server error occurred. \n * 5000 - Service threw an exception that cannot be handled otherwise (e.g. Database error).", | ||
"content": { | "content": { | ||
"application/json": { | "application/json": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/Error", | "$ref": "#/components/schemas/Error", | ||
"exampleSetFlag": | "exampleSetFlag": false | ||
}, | }, | ||
"exampleSetFlag": false | "exampleSetFlag": false | ||
| Zeile 1.033: | Zeile 1.037: | ||
} | } | ||
}, | }, | ||
" | "501": { | ||
"description": "Server error occurred. \n * | "description": "Server error occurred.\n * 5001 - Unsupported operation: QUICK\n * 5002 - Unsupported operation: eID", | ||
"content": { | "content": { | ||
"application/json": { | "application/json": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/Error", | "$ref": "#/components/schemas/Error", | ||
"exampleSetFlag": | "exampleSetFlag": true | ||
}, | }, | ||
"exampleSetFlag": false | "exampleSetFlag": false | ||
| Zeile 1.185: | Zeile 1.189: | ||
} | } | ||
}, | }, | ||
" | "500": { | ||
"description": "Server error occurred.\n * | "description": "Server error occurred. \n * 5000 - Service threw an exception that cannot be handled otherwise (e.g. Database error).", | ||
"content": { | "content": { | ||
"application/json": { | "application/json": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/Error", | "$ref": "#/components/schemas/Error", | ||
"exampleSetFlag": | "exampleSetFlag": false | ||
}, | }, | ||
"exampleSetFlag": false | "exampleSetFlag": false | ||
| Zeile 1.197: | Zeile 1.201: | ||
} | } | ||
}, | }, | ||
" | "501": { | ||
"description": "Server error occurred. \n * | "description": "Server error occurred.\n * 5001 - Unsupported operation: QUICK\n * 5002 - Unsupported operation: eID", | ||
"content": { | "content": { | ||
"application/json": { | "application/json": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/Error", | "$ref": "#/components/schemas/Error", | ||
"exampleSetFlag": | "exampleSetFlag": true | ||
}, | }, | ||
"exampleSetFlag": false | "exampleSetFlag": false | ||
| Zeile 1.218: | Zeile 1.222: | ||
], | ], | ||
"summary": "Returns the imprint content.", | "summary": "Returns the imprint content.", | ||
"operationId": " | "operationId": "getImprintUsingGET_3", | ||
"parameters": [ | "parameters": [ | ||
{ | { | ||
| Zeile 1.314: | Zeile 1.318: | ||
], | ], | ||
"summary": "Returns a list of installed language packs for the specified product.", | "summary": "Returns a list of installed language packs for the specified product.", | ||
"operationId": " | "operationId": "getAllLanguagePacksUsingGET_9", | ||
"parameters": [ | "parameters": [ | ||
{ | { | ||
| Zeile 1.529: | Zeile 1.533: | ||
], | ], | ||
"summary": "Returns a resource (stream) of certain resource of a language pack.", | "summary": "Returns a resource (stream) of certain resource of a language pack.", | ||
"operationId": " | "operationId": "getLanguagePackFileUsingGET_9", | ||
"parameters": [ | "parameters": [ | ||
{ | { | ||
| Zeile 1.637: | Zeile 1.641: | ||
], | ], | ||
"summary": "Returns the logging settings for the given product and client.", | "summary": "Returns the logging settings for the given product and client.", | ||
"operationId": " | "operationId": "getLoggingSettingsUsingGET", | ||
"parameters": [ | "parameters": [ | ||
{ | { | ||
| Zeile 1.730: | Zeile 1.734: | ||
"get": { | "get": { | ||
"tags": [ | "tags": [ | ||
"password | "password" | ||
], | ], | ||
"summary": " | "summary": "Returns a generated, valid password.", | ||
"operationId": " | "operationId": "generatePasswordUsingGET_8", | ||
"parameters": [ | "parameters": [ | ||
{ | { | ||
| Zeile 1.754: | Zeile 1.758: | ||
"application/json": { | "application/json": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/ | "$ref": "#/components/schemas/ResponseOfPasswordWrapper", | ||
"exampleSetFlag": true | "exampleSetFlag": true | ||
}, | }, | ||
| Zeile 1.825: | Zeile 1.829: | ||
"post": { | "post": { | ||
"tags": [ | "tags": [ | ||
"password | "password" | ||
], | ], | ||
"summary": " | "summary": "Requests the validation of a given password against the current password requirements.", | ||
"operationId": " | "operationId": "validatePasswordUsingPOST_6", | ||
"parameters": [ | "parameters": [ | ||
{ | { | ||
| Zeile 1.847: | Zeile 1.851: | ||
"application/json": { | "application/json": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/ | "$ref": "#/components/schemas/PasswordWrapper", | ||
"exampleSetFlag": true | "exampleSetFlag": true | ||
}, | }, | ||
| Zeile 1.933: | Zeile 1.937: | ||
"get": { | "get": { | ||
"tags": [ | "tags": [ | ||
"password | "password" | ||
], | ], | ||
"summary": " | "summary": "Returns the currently active password requirements.", | ||
"operationId": " | "operationId": "getPasswordRequirementsUsingGET_7", | ||
"parameters": [ | "parameters": [ | ||
{ | { | ||
| Zeile 2.032: | Zeile 2.036: | ||
"logging" | "logging" | ||
], | ], | ||
"summary": " | "summary": "Creates a single log message on the Cryptshare Server for the purpose of remote logging.", | ||
"operationId": " | "operationId": "addLogEventUsingPOST_4", | ||
"parameters": [ | "parameters": [ | ||
{ | { | ||
| Zeile 2.127: | Zeile 2.131: | ||
], | ], | ||
"summary": "Returns information about the provided terms of use.", | "summary": "Returns information about the provided terms of use.", | ||
"operationId": " | "operationId": "getUsageTermsUsingGET_5", | ||
"parameters": [ | "parameters": [ | ||
{ | { | ||
| Zeile 2.217: | Zeile 2.221: | ||
} | } | ||
}, | }, | ||
"/users/{email-address}/ | "/users/{email-address}/transfers": { | ||
" | "get": { | ||
"tags": [ | "tags": [ | ||
"transfer- | "transfer-controller" | ||
], | ], | ||
"summary": " | "summary": "Returns a list of transfers for this sender. The latest transfers are shown first. The transfer only contain the ID, the state, a link to the details.", | ||
"operationId": " | "operationId": "getAllTransfersUsingGET_2", | ||
"parameters": [ | "parameters": [ | ||
{ | { | ||
"name": "email-address", | "name": "email-address", | ||
"in": "path", | "in": "path", | ||
"description": " | "description": "email-address", | ||
"required": true, | "required": true, | ||
"style": "simple", | "style": "simple", | ||
| Zeile 2.237: | Zeile 2.241: | ||
}, | }, | ||
{ | { | ||
"$ref": "#/components/parameters/ClientId" | "name": "page-size", | ||
}, | "in": "query", | ||
{ | "description": "Size of the page. Max number of transfers returned per page. Default page size: 10, maximum page size: 100.", | ||
"$ref": "#/components/parameters/MajorVersion" | "required": false, | ||
"style": "form", | |||
"schema": { | |||
"type": "integer", | |||
"format": "int32", | |||
"exampleSetFlag": true | |||
} | |||
}, | |||
{ | |||
"name": "page", | |||
"in": "query", | |||
"description": "Pagination index, 1-indexed. Default page: 1.", | |||
"required": false, | |||
"style": "form", | |||
"schema": { | |||
"type": "integer", | |||
"format": "int32", | |||
"exampleSetFlag": true | |||
} | |||
}, | |||
{ | |||
"$ref": "#/components/parameters/ClientId" | |||
}, | |||
{ | |||
"$ref": "#/components/parameters/MajorVersion" | |||
}, | }, | ||
{ | { | ||
| Zeile 2.249: | Zeile 2.277: | ||
} | } | ||
], | ], | ||
"responses": { | "responses": { | ||
"200": { | "200": { | ||
"description": " | "description": "OK.", | ||
"content": { | "content": { | ||
"application/json": { | "application/json": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/ | "$ref": "#/components/schemas/ResponseOfListOfTransferBasicInfoDto", | ||
"exampleSetFlag": true | "exampleSetFlag": true | ||
}, | }, | ||
| Zeile 2.274: | Zeile 2.291: | ||
}, | }, | ||
"400": { | "400": { | ||
"description": "A required parameter was not specified or a parameter had an invalid content.\n * 1002 - Missing required request parameter/header (e.g. X-CS-ClientId).\n * 1004 - Invalid request parameter/header value (expected, but wrong format/syntax) (e.g. unknown product key).\n * 1005 - Invalid path variable (e.g. productKey, | "description": "A required parameter was not specified or a parameter had an invalid content.\n * 1002 - Missing required request parameter/header (e.g. X-CS-ClientId).\n * 1004 - Invalid request parameter/header value (expected, but wrong format/syntax) (e.g. unknown product key).\n * 1005 - Invalid path variable (e.g. productKey, emailAddress).", | ||
"content": { | "content": { | ||
"application/json": { | "application/json": { | ||
| Zeile 2.285: | Zeile 2.302: | ||
} | } | ||
}, | }, | ||
" | "401": { | ||
"description": "The client is not allowed to perform the requested operation.\n * | "description": "The client is not allowed to perform the requested operation.\n * 3002 - The provided verification token differs from the verification token used for patching the transfer.", | ||
"content": { | "content": { | ||
"application/json": { | "application/json": { | ||
| Zeile 2.297: | Zeile 2.314: | ||
} | } | ||
}, | }, | ||
" | "403": { | ||
"description": "The requested | "description": "The client is not allowed to perform the requested operation.\n * 3001 - Product not licensed.", | ||
"content": { | "content": { | ||
"application/json": { | "application/json": { | ||
| Zeile 2.309: | Zeile 2.326: | ||
} | } | ||
}, | }, | ||
"500": { | "404": { | ||
"description": "The requested resource was not found.\n * 1006 - Specified endpoint does not exist.\n * 2004 - Specified version is not supported.", | |||
"content": { | |||
"application/json": { | |||
"schema": { | |||
"$ref": "#/components/schemas/Error", | |||
"exampleSetFlag": true | |||
}, | |||
"exampleSetFlag": false | |||
} | |||
} | |||
}, | |||
"500": { | |||
"description": "Server error occurred. \n * 5000 - Service threw an exception that cannot be handled otherwise (e.g. Database error).", | "description": "Server error occurred. \n * 5000 - Service threw an exception that cannot be handled otherwise (e.g. Database error).", | ||
"content": { | "content": { | ||
| Zeile 2.329: | Zeile 2.358: | ||
} | } | ||
}, | }, | ||
"/users/{email-address}/ | "/users/{email-address}/transfers/{tracking-id}": { | ||
" | "get": { | ||
"tags": [ | "tags": [ | ||
"transfer | "transfer" | ||
], | ], | ||
"summary": " | "summary": "Returns the details of a given transfer for its sender, including processing errors.", | ||
"operationId": " | "operationId": "getTransferDetailsUsingGET_5", | ||
"parameters": [ | "parameters": [ | ||
{ | { | ||
"name": "email-address", | "name": "email-address", | ||
"in": "path", | "in": "path", | ||
"description": "User | "description": "User that sent this transfer.", | ||
"required": true, | |||
"style": "simple", | |||
"schema": { | |||
"type": "string", | |||
"exampleSetFlag": true | |||
} | |||
}, | |||
{ | |||
"name": "tracking-id", | |||
"in": "path", | |||
"description": "The tracking ID.", | |||
"required": true, | "required": true, | ||
"style": "simple", | "style": "simple", | ||
| Zeile 2.361: | Zeile 2.401: | ||
} | } | ||
], | ], | ||
"responses": { | "responses": { | ||
" | "200": { | ||
"description": " | "description": "OK.", | ||
}, | "content": { | ||
"application/json": { | |||
"schema": { | |||
"$ref": "#/components/schemas/ResponseOfTransferStatus", | |||
"exampleSetFlag": true | |||
}, | |||
"exampleSetFlag": false | |||
} | |||
} | |||
}, | |||
"400": { | "400": { | ||
"description": "A required parameter was not specified or a parameter had an invalid content.\n * 1002 - Missing required request parameter/header (e.g. X-CS-ClientId).\n * 1004 - Invalid request parameter/header value (expected, but wrong format/syntax) (e.g. unknown product key).\n * 1005 - Invalid path variable (e.g. productKey, emailAddress).", | "description": "A required parameter was not specified or a parameter had an invalid content.\n * 1002 - Missing required request parameter/header (e.g. X-CS-ClientId).\n * 1004 - Invalid request parameter/header value (expected, but wrong format/syntax) (e.g. unknown product key).\n * 1005 - Invalid path variable (e.g. productKey, emailAddress).", | ||
"content": { | |||
"application/json": { | |||
"schema": { | |||
"$ref": "#/components/schemas/Error", | |||
"exampleSetFlag": true | |||
}, | |||
"exampleSetFlag": false | |||
} | |||
} | |||
}, | |||
"401": { | |||
"description": "The client is not allowed to perform the requested operation.\n * 3002 - The provided verification token differs from the verification token used for patching the transfer.", | |||
"content": { | "content": { | ||
"application/json": { | "application/json": { | ||
| Zeile 2.389: | Zeile 2.439: | ||
}, | }, | ||
"403": { | "403": { | ||
"description": "The client is not allowed to perform the requested operation.\n * 3001 - Product not licensed | "description": "The client is not allowed to perform the requested operation.\n * 3001 - Product not licensed.", | ||
"content": { | "content": { | ||
"application/json": { | "application/json": { | ||
| Zeile 2.432: | Zeile 2.482: | ||
} | } | ||
}, | }, | ||
"/users/{email-address}/transfer- | "/users/{email-address}/transfer-policy": { | ||
" | "post": { | ||
"tags": [ | "tags": [ | ||
"transfer- | "transfer-policy" | ||
], | ], | ||
"summary": "Requests | "summary": "Requests the policy for the user as sender and the given recipients.", | ||
"operationId": " | "operationId": "requestPolicyUsingPOST_9", | ||
"parameters": [ | "parameters": [ | ||
{ | { | ||
| Zeile 2.444: | Zeile 2.494: | ||
"in": "path", | "in": "path", | ||
"description": "User to send as.", | "description": "User to send as.", | ||
"required": true, | "required": true, | ||
"style": "simple", | "style": "simple", | ||
| Zeile 2.475: | Zeile 2.514: | ||
} | } | ||
], | ], | ||
"responses": { | "requestBody": { | ||
"200": { | "content": { | ||
"description": " | "application/json": { | ||
"schema": { | |||
"$ref": "#/components/schemas/TransferPolicyRequest", | |||
"exampleSetFlag": true | |||
}, | |||
"exampleSetFlag": false | |||
} | |||
} | |||
}, | |||
"responses": { | |||
"200": { | |||
"description": "Success.", | |||
"content": { | "content": { | ||
"application/json": { | "application/json": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/ | "$ref": "#/components/schemas/ResponseOfTransferPolicyResult", | ||
"exampleSetFlag": true | "exampleSetFlag": true | ||
}, | }, | ||
| Zeile 2.489: | Zeile 2.539: | ||
}, | }, | ||
"400": { | "400": { | ||
"description": "A required parameter was not specified or a parameter had an invalid content.\n * 1002 - Missing required request parameter/header (e.g. X-CS-ClientId).\n * 1004 - Invalid request parameter/header value (expected, but wrong format/syntax) (e.g. unknown product key).\n * 1005 - Invalid path variable (e.g. productKey, | "description": "A required parameter was not specified or a parameter had an invalid content.\n * 1002 - Missing required request parameter/header (e.g. X-CS-ClientId).\n * 1004 - Invalid request parameter/header value (expected, but wrong format/syntax) (e.g. unknown product key).\n * 1005 - Invalid path variable (e.g. productKey, email-address).", | ||
"content": { | "content": { | ||
"application/json": { | "application/json": { | ||
| Zeile 2.513: | Zeile 2.551: | ||
}, | }, | ||
"403": { | "403": { | ||
"description": "The client is not allowed to perform the requested operation.\n * | "description": "The client is not allowed to perform the requested operation.\n * 3010 - Email address and (possibly) IP address of the sender is rejected by policy.", | ||
"content": { | "content": { | ||
"application/json": { | "application/json": { | ||
| Zeile 2.554: | Zeile 2.592: | ||
} | } | ||
] | ] | ||
}, | } | ||
" | }, | ||
"/users/{email-address}/transfer-sessions": { | |||
"post": { | |||
"tags": [ | "tags": [ | ||
"transfer-session" | "transfer-session" | ||
], | ], | ||
"summary": " | "summary": "Creates a new transfer session.\nInitial values for the sender and recipient languages can be set by using the 'Accept-Language' header.", | ||
"operationId": " | "operationId": "createSessionUsingPOST_6", | ||
"parameters": [ | "parameters": [ | ||
{ | { | ||
| Zeile 2.574: | Zeile 2.614: | ||
}, | }, | ||
{ | { | ||
"$ref": "#/components/parameters/ClientId" | |||
}, | |||
{ | |||
"$ref": "#/components/parameters/MajorVersion" | |||
}, | |||
"$ref": "#/components/parameters/ClientId" | |||
}, | |||
{ | |||
"$ref": "#/components/parameters/MajorVersion" | |||
}, | |||
{ | { | ||
"$ref": "#/components/parameters/MinimumMinorApiVersion" | "$ref": "#/components/parameters/MinimumMinorApiVersion" | ||
| Zeile 2.601: | Zeile 2.630: | ||
"application/json": { | "application/json": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/ | "$ref": "#/components/schemas/TransferSessionCreationOptions", | ||
"exampleSetFlag": true | "exampleSetFlag": true | ||
}, | }, | ||
| Zeile 2.609: | Zeile 2.638: | ||
}, | }, | ||
"responses": { | "responses": { | ||
" | "201": { | ||
"description": " | "description": "Created the transfer session. The 'Location' header will contain the URL of the created session." | ||
}, | }, | ||
"400": { | "400": { | ||
| Zeile 2.634: | Zeile 2.654: | ||
}, | }, | ||
"403": { | "403": { | ||
"description": "The client is not allowed to perform the requested operation.\n * 3001 - Product not licensed.\n ", | "description": "The client is not allowed to perform the requested operation.\n * 3001 - Product not licensed.\n * 3010 - Sender rejected by policy.\n * 3011 - Recipient and sender combination rejected by policy.", | ||
"content": { | "content": { | ||
"application/json": { | "application/json": { | ||
| Zeile 2.647: | Zeile 2.667: | ||
"404": { | "404": { | ||
"description": "The requested resource was not found.\n * 1006 - Specified endpoint does not exist.\n * 2004 - Specified version is not supported.", | "description": "The requested resource was not found.\n * 1006 - Specified endpoint does not exist.\n * 2004 - Specified version is not supported.", | ||
"content": { | "content": { | ||
"application/json": { | "application/json": { | ||
| Zeile 2.689: | Zeile 2.697: | ||
} | } | ||
}, | }, | ||
"/users/{email-address}/transfer-sessions/{tracking-id} | "/users/{email-address}/transfer-sessions/{tracking-id}": { | ||
" | "get": { | ||
"tags": [ | "tags": [ | ||
"transfer-session" | "transfer-session" | ||
], | ], | ||
"summary": " | "summary": "Returns an existing transfer session. Note that all properties will be present.", | ||
"operationId": " | "operationId": "getSessionUsingGET_4", | ||
"parameters": [ | "parameters": [ | ||
{ | { | ||
| Zeile 2.732: | Zeile 2.740: | ||
} | } | ||
], | ], | ||
"responses": { | "responses": { | ||
" | "200": { | ||
"description": " | "description": "OK.", | ||
"content": { | "content": { | ||
"application/json": { | "application/json": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/ | "$ref": "#/components/schemas/ResponseOfTransferSession", | ||
"exampleSetFlag": true | "exampleSetFlag": true | ||
}, | }, | ||
| Zeile 2.758: | Zeile 2.755: | ||
"400": { | "400": { | ||
"description": "A required parameter was not specified or a parameter had an invalid content.\n * 1002 - Missing required request parameter/header (e.g. X-CS-ClientId).\n * 1004 - Invalid request parameter/header value (expected, but wrong format/syntax) (e.g. unknown product key).\n * 1005 - Invalid path variable (e.g. productKey, emailAddress).", | "description": "A required parameter was not specified or a parameter had an invalid content.\n * 1002 - Missing required request parameter/header (e.g. X-CS-ClientId).\n * 1004 - Invalid request parameter/header value (expected, but wrong format/syntax) (e.g. unknown product key).\n * 1005 - Invalid path variable (e.g. productKey, emailAddress).", | ||
"content": { | |||
"application/json": { | |||
"schema": { | |||
"$ref": "#/components/schemas/Error", | |||
"exampleSetFlag": true | |||
}, | |||
"exampleSetFlag": false | |||
} | |||
} | |||
}, | |||
"401": { | |||
"description": "The client is not allowed to perform the requested operation.\n * 3002 - The provided verification token differs from the verification token used for patching the transfer.", | |||
"content": { | "content": { | ||
"application/json": { | "application/json": { | ||
| Zeile 2.769: | Zeile 2.778: | ||
}, | }, | ||
"403": { | "403": { | ||
"description": "The client is not allowed to perform the requested operation.\n * 3001 - Product not licensed | "description": "The client is not allowed to perform the requested operation.\n * 3001 - Product not licensed.", | ||
"content": { | "content": { | ||
"application/json": { | "application/json": { | ||
| Zeile 2.810: | Zeile 2.819: | ||
} | } | ||
] | ] | ||
}, | |||
"post": { | |||
" | |||
"tags": [ | "tags": [ | ||
"transfer-session" | "transfer-session" | ||
], | ], | ||
"summary": " | "summary": "Submits an existing transfer session. Returns the location where the finalized transfer can be inspected", | ||
"operationId": " | "operationId": "finalizeSessionUsingPOST_8", | ||
"parameters": [ | "parameters": [ | ||
{ | { | ||
| Zeile 2.843: | Zeile 2.850: | ||
}, | }, | ||
{ | { | ||
"$ref": "#/components/parameters/ClientId" | |||
"$ref": "#/components/parameters/ClientId" | |||
}, | }, | ||
{ | { | ||
| Zeile 2.867: | Zeile 2.863: | ||
], | ], | ||
"responses": { | "responses": { | ||
" | "201": { | ||
"description": " | "description": "Created." | ||
}, | }, | ||
"400": { | "400": { | ||
| Zeile 2.883: | Zeile 2.879: | ||
}, | }, | ||
"403": { | "403": { | ||
"description": "The client is not allowed to perform the requested operation.\n * 3001 - Product not licensed.\n | "description": "The client is not allowed to perform the requested operation.\n * 3001 - Product not licensed.\n ", | ||
"content": { | "content": { | ||
"application/json": { | "application/json": { | ||
| Zeile 2.896: | Zeile 2.892: | ||
"404": { | "404": { | ||
"description": "The requested resource was not found.\n * 1006 - Specified endpoint does not exist.\n * 2004 - Specified version is not supported.", | "description": "The requested resource was not found.\n * 1006 - Specified endpoint does not exist.\n * 2004 - Specified version is not supported.", | ||
"content": { | |||
"application/json": { | |||
"schema": { | |||
"$ref": "#/components/schemas/Error", | |||
"exampleSetFlag": true | |||
}, | |||
"exampleSetFlag": false | |||
} | |||
} | |||
}, | |||
"409": { | |||
"description": "Validation of parameters failed.\n * 2001 - Some given values cannot be applied due to transfer rule restrictions.", | |||
"content": { | "content": { | ||
"application/json": { | "application/json": { | ||
| Zeile 2.924: | Zeile 2.932: | ||
} | } | ||
] | ] | ||
}, | |||
"delete": { | |||
" | |||
"tags": [ | "tags": [ | ||
" | "transfer-session" | ||
], | ], | ||
"summary": " | "summary": "Deletes an existing transfer session.", | ||
"operationId": " | "operationId": "deleteSessionUsingDELETE_1", | ||
"parameters": [ | "parameters": [ | ||
{ | { | ||
"name": "email-address", | "name": "email-address", | ||
"in": "path", | "in": "path", | ||
"description": " | "description": "User to send as.", | ||
"required": true, | "required": true, | ||
"style": "simple", | "style": "simple", | ||
| Zeile 2.946: | Zeile 2.952: | ||
}, | }, | ||
{ | { | ||
"name": " | "name": "tracking-id", | ||
"in": " | "in": "path", | ||
"description": "The | "description": "The tracking ID.", | ||
"required": | "required": true, | ||
"style": "simple", | |||
"schema": { | "schema": { | ||
"type": "string", | "type": "string", | ||
| Zeile 2.969: | Zeile 2.976: | ||
], | ], | ||
"responses": { | "responses": { | ||
" | "204": { | ||
"description": " | "description": "No Content.", | ||
"content": { | "content": { | ||
" | "*/*": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/ | "$ref": "#/components/schemas/ResponseOfVoid", | ||
"exampleSetFlag": true | "exampleSetFlag": true | ||
}, | }, | ||
| Zeile 2.982: | Zeile 2.989: | ||
}, | }, | ||
"400": { | "400": { | ||
"description": "A required parameter was not specified or a parameter had an invalid content.\n * 1002 - Missing required request parameter/header (e.g. X-CS-ClientId).\n * 1004 - Invalid request parameter/header value (expected, but wrong format/syntax) (e.g. unknown product key).\n * 1005 - Invalid path variable (e.g. productKey, | "description": "A required parameter was not specified or a parameter had an invalid content.\n * 1002 - Missing required request parameter/header (e.g. X-CS-ClientId).\n * 1004 - Invalid request parameter/header value (expected, but wrong format/syntax) (e.g. unknown product key).\n * 1005 - Invalid path variable (e.g. productKey, emailAddress).", | ||
"content": { | "content": { | ||
"application/json": { | "application/json": { | ||
| Zeile 2.993: | Zeile 3.000: | ||
} | } | ||
}, | }, | ||
" | "401": { | ||
"description": "The client is not allowed to perform the requested operation | "description": "The client is not allowed to perform the requested operation.\n * 3002 - The provided verification token differs from the verification token used for patching the transfer.", | ||
"content": { | "content": { | ||
"application/json": { | "application/json": { | ||
| Zeile 3.005: | Zeile 3.012: | ||
} | } | ||
}, | }, | ||
" | "403": { | ||
"description": "The requested | "description": "The client is not allowed to perform the requested operation.\n * 3001 - Product not licensed.", | ||
"content": { | "content": { | ||
"application/json": { | "application/json": { | ||
| Zeile 3.017: | Zeile 3.024: | ||
} | } | ||
}, | }, | ||
" | "404": { | ||
"description": " | "description": "The requested resource was not found.\n * 1006 - Specified endpoint does not exist.\n * 2004 - Specified version is not supported.", | ||
"content": { | "content": { | ||
"application/json": { | "application/json": { | ||
| Zeile 3.041: | Zeile 3.048: | ||
} | } | ||
} | } | ||
} | }, | ||
"security": [ | |||
{ | |||
"verification": [] | |||
" | } | ||
] | |||
}, | |||
"patch": { | |||
"tags": [ | "tags": [ | ||
" | "transfer-session" | ||
], | ], | ||
"summary": " | "summary": "Edits an existing transfer session.", | ||
"operationId": " | "operationId": "editSessionUsingPATCH_7", | ||
"parameters": [ | "parameters": [ | ||
{ | { | ||
"name": "email-address", | "name": "email-address", | ||
"in": "path", | "in": "path", | ||
"description": " | "description": "User to send as.", | ||
"required": true, | |||
"style": "simple", | |||
"schema": { | |||
"type": "string", | |||
"exampleSetFlag": true | |||
} | |||
}, | |||
{ | |||
"name": "tracking-id", | |||
"in": "path", | |||
"description": "The tracking ID.", | |||
"required": true, | "required": true, | ||
"style": "simple", | "style": "simple", | ||
| Zeile 3.076: | Zeile 3.097: | ||
} | } | ||
], | ], | ||
"responses": { | "requestBody": { | ||
"200": { | "content": { | ||
"description": "OK.", | "application/json": { | ||
"schema": { | |||
"$ref": "#/components/schemas/TransferSessionPatchable", | |||
"exampleSetFlag": true | |||
}, | |||
"exampleSetFlag": false | |||
} | |||
} | |||
}, | |||
"responses": { | |||
"200": { | |||
"description": "OK.", | |||
"content": { | "content": { | ||
"application/json": { | "application/json": { | ||
"schema": { | "schema": { | ||
" | "$ref": "#/components/schemas/ResponseOfTransferSession", | ||
"exampleSetFlag": true | "exampleSetFlag": true | ||
}, | }, | ||
| Zeile 3.090: | Zeile 3.122: | ||
}, | }, | ||
"400": { | "400": { | ||
"description": "A required parameter was not specified or a parameter had an invalid content.\n * 1002 - Missing required request parameter/header (e.g. X-CS-ClientId).\n * 1004 - Invalid request parameter/header value (expected, but wrong format/syntax) (e.g. unknown product key).\n * 1005 - Invalid path variable (e.g. productKey, | "description": "A required parameter was not specified or a parameter had an invalid content.\n * 1002 - Missing required request parameter/header (e.g. X-CS-ClientId).\n * 1004 - Invalid request parameter/header value (expected, but wrong format/syntax) (e.g. unknown product key).\n * 1005 - Invalid path variable (e.g. productKey, emailAddress).", | ||
"content": { | "content": { | ||
"application/json": { | "application/json": { | ||
| Zeile 3.102: | Zeile 3.134: | ||
}, | }, | ||
"403": { | "403": { | ||
"description": "The client is not allowed to perform the requested operation.\n * 3001 - Product not licensed.", | "description": "The client is not allowed to perform the requested operation.\n * 3001 - Product not licensed.\n ", | ||
"content": { | "content": { | ||
"application/json": { | "application/json": { | ||
| Zeile 3.125: | Zeile 3.157: | ||
} | } | ||
}, | }, | ||
" | "409": { | ||
"description": " | "description": "Validation of parameters failed.\n * 2001 - Some given values cannot be applied due to transfer rule restrictions.", | ||
"content": { | "content": { | ||
"application/json": { | "application/json": { | ||
| Zeile 3.148: | Zeile 3.180: | ||
} | } | ||
} | } | ||
} | } | ||
} | }, | ||
"security": [ | |||
{ | |||
"verification": [] | |||
} | |||
] | |||
} | } | ||
}, | }, | ||
"/users/{email-address}/ | "/users/{email-address}/transfer-sessions/{tracking-id}/files": { | ||
"post": { | "post": { | ||
"tags": [ | "tags": [ | ||
" | "transfer-session" | ||
], | ], | ||
"summary": "Creates a | "summary": "Creates a new transfer file.", | ||
"operationId": " | "operationId": "createFileUsingPOST_8", | ||
"parameters": [ | "parameters": [ | ||
{ | { | ||
"name": "email-address", | "name": "email-address", | ||
"in": "path", | "in": "path", | ||
"description": " | "description": "User to send as.", | ||
"required": true, | |||
"style": "simple", | |||
"schema": { | |||
"type": "string", | |||
"exampleSetFlag": true | |||
} | |||
}, | |||
{ | |||
"name": "tracking-id", | |||
"in": "path", | |||
"description": "The tracking ID.", | |||
"required": true, | "required": true, | ||
"style": "simple", | "style": "simple", | ||
| Zeile 3.200: | Zeile 3.236: | ||
"application/json": { | "application/json": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/ | "$ref": "#/components/schemas/TransferFileCreationOptionsReq", | ||
"exampleSetFlag": true | "exampleSetFlag": true | ||
}, | }, | ||
| Zeile 3.208: | Zeile 3.244: | ||
}, | }, | ||
"responses": { | "responses": { | ||
" | "201": { | ||
"description": " | "description": "Created the transfer file. The 'Location' header will contain the URL of the created file.", | ||
"content": { | "content": { | ||
"application/json": { | "application/json": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/ | "$ref": "#/components/schemas/ResponseOfTransferFileCreationOptions", | ||
"exampleSetFlag": true | "exampleSetFlag": true | ||
}, | }, | ||
| Zeile 3.221: | Zeile 3.257: | ||
}, | }, | ||
"400": { | "400": { | ||
"description": "A required parameter was not specified or a parameter had an invalid content.\n * 1002 - Missing required request parameter/header (e.g. X-CS-ClientId).\n * 1004 - Invalid request parameter/header value (expected, but wrong format/syntax) (e.g. unknown product key).\n * 1005 - Invalid path variable (e.g. productKey, | "description": "A required parameter was not specified or a parameter had an invalid content.\n * 1002 - Missing required request parameter/header (e.g. X-CS-ClientId).\n * 1004 - Invalid request parameter/header value (expected, but wrong format/syntax) (e.g. unknown product key).\n * 1005 - Invalid path variable (e.g. productKey, emailAddress).", | ||
"content": { | "content": { | ||
"application/json": { | "application/json": { | ||
| Zeile 3.233: | Zeile 3.269: | ||
}, | }, | ||
"403": { | "403": { | ||
"description": "The client is not allowed to perform the requested operation.\n * 3001 - Product not licensed.\n * | "description": "The client is not allowed to perform the requested operation.\n * 3001 - Product not licensed.\n * 3011 - Recipient and sender combination rejected by policy.", | ||
"content": { | "content": { | ||
"application/json": { | "application/json": { | ||
| Zeile 3.246: | Zeile 3.282: | ||
"404": { | "404": { | ||
"description": "The requested resource was not found.\n * 1006 - Specified endpoint does not exist.\n * 2004 - Specified version is not supported.", | "description": "The requested resource was not found.\n * 1006 - Specified endpoint does not exist.\n * 2004 - Specified version is not supported.", | ||
"content": { | "content": { | ||
"application/json": { | "application/json": { | ||
| Zeile 3.291: | Zeile 3.303: | ||
} | } | ||
} | } | ||
} | } | ||
}, | }, | ||
" | "security": [ | ||
{ | |||
"verification": [] | |||
" | |||
} | } | ||
}, | ] | ||
" | } | ||
}, | |||
"/users/{email-address}/transfer-sessions/{tracking-id}/files/{file-id}": { | |||
" | "delete": { | ||
" | "tags": [ | ||
"transfer-session" | |||
], | |||
"summary": "Deletes an existing file from a transfer session.", | |||
"operationId": "deleteFileUsingDELETE_9", | |||
"parameters": [ | |||
{ | |||
"name": "email-address", | |||
"description": " | "in": "path", | ||
" | "description": "User to send as.", | ||
"required": true, | |||
"style": "simple", | |||
"schema": { | |||
"type": "string", | |||
"exampleSetFlag": true | |||
} | |||
}, | |||
{ | |||
"name": "tracking-id", | |||
"in": "path", | |||
"description": "The tracking ID.", | |||
"required": true, | |||
"style": "simple", | |||
"schema": { | |||
"type": "string", | |||
"exampleSetFlag": true | |||
} | |||
}, | }, | ||
"name": | { | ||
" | "name": "file-id", | ||
"description": " | "in": "path", | ||
" | "description": "The file ID to delete.", | ||
" | "required": true, | ||
"style": "simple", | |||
"schema": { | |||
"type": "string", | |||
"exampleSetFlag": true | |||
} | |||
}, | |||
{ | |||
"$ref": "#/components/parameters/ClientId" | |||
}, | |||
{ | |||
"$ref": "#/components/parameters/MajorVersion" | |||
}, | |||
{ | |||
"$ref": "#/components/parameters/MinimumMinorApiVersion" | |||
" | |||
" | |||
}, | }, | ||
{ | |||
" | "$ref": "#/components/parameters/ProductKey" | ||
} | } | ||
], | |||
" | "responses": { | ||
"204": { | |||
"description": "No Content.", | |||
"content": { | |||
"*/*": { | |||
"schema": { | |||
"$ref": "#/components/schemas/ResponseOfVoid", | |||
"exampleSetFlag": true | |||
}, | |||
"exampleSetFlag": false | |||
} | |||
} | |||
}, | }, | ||
" | "400": { | ||
"description": "A required parameter was not specified or a parameter had an invalid content.\n * 1002 - Missing required request parameter/header (e.g. X-CS-ClientId).\n * 1004 - Invalid request parameter/header value (expected, but wrong format/syntax) (e.g. unknown product key).\n * 1005 - Invalid path variable (e.g. productKey, emailAddress).", | |||
"description": " | "content": { | ||
"application/json": { | |||
" | "schema": { | ||
" | "$ref": "#/components/schemas/Error", | ||
"exampleSetFlag": true | |||
}, | |||
"exampleSetFlag": false | |||
} | |||
} | |||
}, | }, | ||
" | "403": { | ||
" | "description": "The client is not allowed to perform the requested operation.\n * 3001 - Product not licensed.\n ", | ||
"description": " | "content": { | ||
" | "application/json": { | ||
"schema": { | |||
" | "$ref": "#/components/schemas/Error", | ||
" | "exampleSetFlag": true | ||
}, | |||
"exampleSetFlag": false | |||
} | |||
} | |||
}, | |||
"404": { | |||
"description": "The requested resource was not found.\n * 1006 - Specified endpoint does not exist.\n * 2004 - Specified version is not supported.", | |||
"content": { | |||
"application/json": { | |||
"schema": { | |||
"$ref": "#/components/schemas/Error", | |||
"exampleSetFlag": true | |||
}, | |||
"exampleSetFlag": false | |||
} | |||
} | |||
}, | |||
"500": { | |||
"description": "Server error occurred. \n * 5000 - Service threw an exception that cannot be handled otherwise (e.g. Database error).", | |||
"content": { | |||
"application/json": { | |||
"schema": { | |||
"$ref": "#/components/schemas/Error", | |||
"exampleSetFlag": false | |||
}, | |||
"exampleSetFlag": false | |||
} | |||
} | |||
} | } | ||
}, | }, | ||
" | "security": [ | ||
}, | { | ||
" | "verification": [] | ||
" | } | ||
" | ] | ||
" | } | ||
}, | |||
" | "/users/{email-address}/transfer-sessions/{tracking-id}/files/{file-id}/content": { | ||
"description": " | "put": { | ||
" | "tags": [ | ||
"exampleSetFlag": true | "transfer-session" | ||
], | |||
"summary": "Puts raw binary data to a transfer file. If data was already written to this file, it is replaced. Clients may want to stream the data if fitting.", | |||
"operationId": "putFileUsingPUT_4", | |||
"parameters": [ | |||
{ | |||
"name": "email-address", | |||
"in": "path", | |||
"description": "User to send as.", | |||
"required": true, | |||
"style": "simple", | |||
"schema": { | |||
"type": "string", | |||
"exampleSetFlag": true | |||
} | |||
}, | }, | ||
" | { | ||
" | "name": "tracking-id", | ||
"description": "The | "in": "path", | ||
" | "description": "The tracking ID.", | ||
"exampleSetFlag": true | "required": true, | ||
"style": "simple", | |||
"schema": { | |||
"type": "string", | |||
"exampleSetFlag": true | |||
} | |||
}, | }, | ||
"id" | { | ||
" | "name": "file-id", | ||
"description": " | "in": "path", | ||
" | "description": "The file ID to write data for.", | ||
"exampleSetFlag": true | "required": true, | ||
"style": "simple", | |||
"schema": { | |||
"type": "string", | |||
"exampleSetFlag": true | |||
} | |||
}, | |||
{ | |||
"$ref": "#/components/parameters/ClientId" | |||
}, | }, | ||
{ | |||
" | "$ref": "#/components/parameters/MajorVersion" | ||
}, | }, | ||
{ | |||
" | "$ref": "#/components/parameters/MinimumMinorApiVersion" | ||
}, | }, | ||
{ | |||
" | "$ref": "#/components/parameters/ProductKey" | ||
} | } | ||
], | |||
" | "responses": { | ||
"200": { | |||
"description": "Ok." | |||
}, | |||
"400": { | |||
"description": "A required parameter was not specified or a parameter had an invalid content.\n * 1002 - Missing required request parameter/header (e.g. X-CS-ClientId).\n * 1004 - Invalid request parameter/header value (expected, but wrong format/syntax) (e.g. unknown product key).\n * 1005 - Invalid path variable (e.g. productKey, emailAddress).", | |||
" | "content": { | ||
" | "application/json": { | ||
" | "schema": { | ||
"$ref": "#/components/schemas/Error", | |||
"exampleSetFlag": true | |||
}, | |||
"exampleSetFlag": false | |||
} | |||
} | |||
}, | }, | ||
" | "403": { | ||
" | "description": "The client is not allowed to perform the requested operation.\n * 3001 - Product not licensed.\n * 3011 - Recipient and sender combination rejected by policy.", | ||
" | "content": { | ||
"application/json": { | |||
"schema": { | |||
"$ref": "#/components/schemas/Error", | |||
"exampleSetFlag": true | |||
}, | |||
"exampleSetFlag": false | |||
} | |||
} | |||
}, | }, | ||
" | "404": { | ||
" | "description": "The requested resource was not found.\n * 1006 - Specified endpoint does not exist.\n * 2004 - Specified version is not supported.", | ||
"description": " | "content": { | ||
" | "application/json": { | ||
"schema": { | |||
"$ref": "#/components/schemas/Error", | |||
"exampleSetFlag": true | |||
}, | |||
"exampleSetFlag": false | |||
} | |||
} | |||
}, | |||
"500": { | |||
"description": "Server error occurred. \n * 5000 - Service threw an exception that cannot be handled otherwise (e.g. Database error).", | |||
"content": { | |||
"application/json": { | |||
"schema": { | |||
"$ref": "#/components/schemas/Error", | |||
"exampleSetFlag": false | |||
}, | |||
"exampleSetFlag": false | |||
} | |||
} | |||
} | } | ||
}, | }, | ||
" | "security": [ | ||
{ | |||
"verification": [] | |||
" | |||
} | } | ||
}, | ] | ||
} | |||
}, | |||
"/users/{email-address}/verification": { | |||
" | "get": { | ||
" | "tags": [ | ||
" | "verification" | ||
], | |||
"description": " | "summary": "Returns if an active verification for the provided mail exists, and what verification methods are available.", | ||
" | "operationId": "getVerificationStatusUsingGET_15", | ||
"parameters": [ | |||
{ | |||
"name": "email-address", | |||
"in": "path", | |||
"description": "email-address", | |||
"required": true, | |||
"style": "simple", | |||
"schema": { | |||
"type": "string", | |||
"exampleSetFlag": true | |||
} | |||
}, | |||
{ | |||
"name": "X-CS-VerificationToken", | |||
"in": "header", | |||
"description": "The verification token to check.", | |||
"required": false, | |||
"schema": { | |||
"type": "string", | |||
"exampleSetFlag": true | |||
} | |||
}, | }, | ||
{ | |||
" | "$ref": "#/components/parameters/ClientId" | ||
}, | |||
{ | |||
" | "$ref": "#/components/parameters/MajorVersion" | ||
}, | |||
{ | |||
"$ref": "#/components/parameters/MinimumMinorApiVersion" | |||
}, | |||
{ | |||
"$ref": "#/components/parameters/ProductKey" | |||
" | |||
} | } | ||
], | ], | ||
" | "responses": { | ||
"200": { | |||
" | "description": "OK.", | ||
" | "content": { | ||
" | "application/json": { | ||
"schema": { | |||
"$ref": "#/components/schemas/ResponseOfVerificationStatus", | |||
"exampleSetFlag": true | |||
}, | |||
"exampleSetFlag": false | |||
} | |||
} | |||
}, | |||
" | "400": { | ||
" | "description": "A required parameter was not specified or a parameter had an invalid content.\n * 1002 - Missing required request parameter/header (e.g. X-CS-ClientId).\n * 1004 - Invalid request parameter/header value (expected, but wrong format/syntax) (e.g. unknown product key).\n * 1005 - Invalid path variable (e.g. productKey, mail).", | ||
" | "content": { | ||
"application/json": { | |||
"schema": { | |||
"$ref": "#/components/schemas/Error", | |||
"exampleSetFlag": true | |||
}, | |||
"exampleSetFlag": false | |||
} | |||
} | } | ||
}, | }, | ||
" | "403": { | ||
"description": "The client is not allowed to perform the requested operation.\n * 3001 - Product not licensed.\n * 3002 - Invalid verification data.", | |||
"description": " | "content": { | ||
" | "application/json": { | ||
"schema": { | |||
"$ref": "#/components/schemas/Error", | |||
"exampleSetFlag": true | |||
}, | |||
"exampleSetFlag": false | |||
} | |||
} | |||
}, | }, | ||
" | "404": { | ||
"description": "The requested resource was not found.\n * 1006 - Specified endpoint does not exist.\n * 2004 - Specified version is not supported.", | |||
"description": " | "content": { | ||
" | "application/json": { | ||
"schema": { | |||
"$ref": "#/components/schemas/Error", | |||
"exampleSetFlag": true | |||
}, | |||
"exampleSetFlag": false | |||
} | |||
} | |||
}, | }, | ||
" | "500": { | ||
"description": "Server error occurred. \n * 5000 - Service threw an exception that cannot be handled otherwise (e.g. Database error).", | |||
"description": " | "content": { | ||
"application/json": { | |||
"schema": { | |||
"$ref": "#/components/schemas/Error", | |||
"exampleSetFlag": false | |||
}, | |||
"exampleSetFlag": false | |||
} | |||
" | |||
" | |||
} | } | ||
}, | }, | ||
" | "501": { | ||
" | "description": "Server error occurred.", | ||
" | "content": { | ||
"application/json": { | |||
"schema": { | |||
"$ref": "#/components/schemas/Error", | |||
"exampleSetFlag": true | |||
}, | |||
"exampleSetFlag": false | |||
} | |||
} | |||
} | } | ||
}, | } | ||
} | |||
}, | |||
" | "/users/{email-address}/verification/code/email": { | ||
" | "post": { | ||
"tags": [ | |||
" | "verification" | ||
], | |||
"summary": "Requests a sender verification verification code to be sent via mail. Note that repeated access in quick succession may cause rate limiting. Note that previously created verification codes may be invalidated. \nTo customize the locale of the mail, the 'Accept-Language' header can be used.", | |||
"operationId": "generateVerificationCodeUsingPOST_2", | |||
"parameters": [ | |||
{ | |||
"name": "email-address", | |||
"in": "path", | |||
"description": "email-address", | |||
"required": true, | |||
"style": "simple", | |||
"schema": { | |||
"type": "string", | |||
"exampleSetFlag": true | |||
" | |||
" | |||
" | |||
" | |||
"exampleSetFlag": | |||
} | } | ||
}, | }, | ||
{ | |||
" | "$ref": "#/components/parameters/ClientId" | ||
}, | |||
" | { | ||
"$ref": "#/components/parameters/MajorVersion" | |||
}, | |||
{ | |||
"$ref": "#/components/parameters/MinimumMinorApiVersion" | |||
}, | }, | ||
{ | |||
"$ref": "#/components/parameters/ProductKey" | |||
} | } | ||
], | ], | ||
" | "responses": { | ||
"200": { | |||
"description": "OK." | |||
" | |||
"description": " | |||
}, | }, | ||
" | "400": { | ||
"description": "A required parameter was not specified or a parameter had an invalid content.\n * 1002 - Missing required request parameter/header (e.g. X-CS-ClientId).\n * 1004 - Invalid request parameter/header value (expected, but wrong format/syntax) (e.g. unknown product key).\n * 1005 - Invalid path variable (e.g. productKey, mail).", | |||
"description": " | "content": { | ||
"application/json": { | |||
"schema": { | |||
"$ref": "#/components/schemas/Error", | |||
"exampleSetFlag": true | |||
}, | |||
"exampleSetFlag": false | |||
} | |||
} | |||
}, | }, | ||
" | "403": { | ||
"description": "The client is not allowed to perform the requested operation.\n * 3001 - Product not licensed.", | |||
"description": " | "content": { | ||
" | "application/json": { | ||
"schema": { | |||
"$ref": "#/components/schemas/Error", | |||
"exampleSetFlag": true | |||
}, | |||
"exampleSetFlag": false | |||
} | |||
} | } | ||
}, | }, | ||
" | "404": { | ||
"description": "The requested resource was not found.\n * 1006 - Specified endpoint does not exist.\n * 2004 - Specified version is not supported.", | |||
"description": " | "content": { | ||
" | "application/json": { | ||
"schema": { | |||
"$ref": "#/components/schemas/Error", | |||
"exampleSetFlag": true | |||
}, | |||
"exampleSetFlag": false | |||
} | |||
} | } | ||
}, | }, | ||
" | "429": { | ||
"description": "Too Many Requests.\n * 2007 - Request rejected because there are too many requests at the same time", | |||
"description": " | "content": { | ||
" | "application/json": { | ||
"schema": { | |||
"$ref": "#/components/schemas/Error", | |||
"exampleSetFlag": true | |||
}, | |||
"exampleSetFlag": false | |||
} | |||
} | |||
}, | |||
" | "500": { | ||
" | "description": "Server error occurred. \n * 5000 - Service threw an exception that cannot be handled otherwise (e.g. Database error).", | ||
" | "content": { | ||
"application/json": { | |||
"schema": { | |||
"$ref": "#/components/schemas/Error", | |||
"exampleSetFlag": false | |||
}, | |||
"exampleSetFlag": false | |||
} | |||
} | } | ||
}, | }, | ||
" | "501": { | ||
" | "description": "Server error occurred.", | ||
" | "content": { | ||
"application/json": { | |||
"schema": { | |||
"$ref": "#/components/schemas/Error", | |||
"exampleSetFlag": true | |||
}, | |||
"exampleSetFlag": false | |||
} | |||
} | |||
} | } | ||
}, | } | ||
" | } | ||
}, | |||
"/users/{email-address}/verification/token": { | |||
" | "post": { | ||
" | "tags": [ | ||
"verification" | |||
], | |||
" | "summary": "Creates a verification token. Note that repeated access in quick succession may cause rate limiting.", | ||
"$ref": "#/components/ | "operationId": "createVerificationTokenUsingPOST_3", | ||
" | "parameters": [ | ||
{ | |||
"name": "email-address", | |||
"in": "path", | |||
"description": "email-address", | |||
"required": true, | |||
"style": "simple", | |||
"schema": { | |||
"type": "string", | |||
"exampleSetFlag": true | |||
} | |||
}, | |||
{ | |||
"$ref": "#/components/parameters/ClientId" | |||
}, | |||
{ | |||
"$ref": "#/components/parameters/MajorVersion" | |||
}, | |||
{ | |||
"$ref": "#/components/parameters/MinimumMinorApiVersion" | |||
}, | }, | ||
{ | |||
" | "$ref": "#/components/parameters/ProductKey" | ||
} | } | ||
], | |||
" | "requestBody": { | ||
"content": { | |||
"application/json": { | |||
"schema": { | |||
"$ref": "#/components/schemas/RequestVerificationBody", | |||
"exampleSetFlag": true | |||
}, | |||
"exampleSetFlag": false | |||
} | |||
} | } | ||
}, | }, | ||
" | "responses": { | ||
"200": { | |||
"description": "OK.", | |||
"content": { | |||
"application/json": { | |||
"schema": { | |||
"$ref": "#/components/schemas/ResponseOfVerificationToken", | |||
"exampleSetFlag": true | |||
}, | |||
"exampleSetFlag": false | |||
} | |||
} | |||
}, | }, | ||
" | "400": { | ||
"description": "A required parameter was not specified or a parameter had an invalid content.\n * 1002 - Missing required request parameter/header (e.g. X-CS-ClientId).\n * 1004 - Invalid request parameter/header value (expected, but wrong format/syntax) (e.g. unknown product key).\n * 1005 - Invalid path variable (e.g. productKey, mail).", | |||
"description": " | "content": { | ||
"application/json": { | |||
"schema": { | |||
"$ref": "#/components/schemas/Error", | |||
"exampleSetFlag": true | |||
}, | |||
"exampleSetFlag": false | |||
} | |||
} | |||
}, | }, | ||
" | "403": { | ||
"description": "The client is not allowed to perform the requested operation.\n * 3001 - Product not licensed.\n * 3002 - Invalid verification data.", | |||
"description": " | "content": { | ||
" | "application/json": { | ||
"schema": { | |||
"$ref": "#/components/schemas/Error", | |||
"exampleSetFlag": true | |||
}, | |||
"exampleSetFlag": false | |||
} | |||
} | |||
}, | }, | ||
" | "404": { | ||
"description": "The requested resource was not found.\n * 1006 - Specified endpoint does not exist.\n * 2004 - Specified version is not supported.", | |||
"description": " | "content": { | ||
" | "application/json": { | ||
"schema": { | |||
"$ref": "#/components/schemas/Error", | |||
"exampleSetFlag": true | |||
}, | |||
"exampleSetFlag": false | |||
} | |||
} | |||
}, | }, | ||
" | "429": { | ||
" | "description": "Too Many Requests.\n * 2007 - Request rejected because there are too many requests at the same time", | ||
"description": " | "content": { | ||
"exampleSetFlag": | "application/json": { | ||
} | "schema": { | ||
"$ref": "#/components/schemas/Error", | |||
"exampleSetFlag": true | |||
}, | }, | ||
" | "exampleSetFlag": false | ||
"title": " | } | ||
} | |||
}, | |||
"500": { | |||
"description": "Server error occurred. \n * 5000 - Service threw an exception that cannot be handled otherwise (e.g. Database error).", | |||
"content": { | |||
"application/json": { | |||
"schema": { | |||
"$ref": "#/components/schemas/Error", | |||
"exampleSetFlag": false | |||
}, | |||
"exampleSetFlag": false | |||
} | |||
} | |||
}, | |||
"501": { | |||
"description": "Server error occurred.", | |||
"content": { | |||
"application/json": { | |||
"schema": { | |||
"$ref": "#/components/schemas/Error", | |||
"exampleSetFlag": true | |||
}, | |||
"exampleSetFlag": false | |||
} | |||
} | |||
} | |||
} | |||
} | |||
} | |||
}, | |||
"components": { | |||
"schemas": { | |||
"ClientId": { | |||
"title": "ClientId", | |||
"type": "object", | "type": "object", | ||
"properties": { | "properties": { | ||
" | "clientId": { | ||
"type": "string", | |||
"description": "The ID that uniquely identifies the requesting client. Can also be specified by query parameter (client-id). Should be treated as confidential.", | |||
"type": " | |||
"description": " | |||
"exampleSetFlag": true | "exampleSetFlag": true | ||
} | } | ||
| Zeile 3.962: | Zeile 3.924: | ||
"exampleSetFlag": true | "exampleSetFlag": true | ||
}, | }, | ||
" | "CorsStatus": { | ||
"title": " | "title": "CorsStatus", | ||
"type": "object", | "type": "object", | ||
"properties": { | "properties": { | ||
" | "active": { | ||
"type": " | "type": "boolean", | ||
"description": " | "description": "Specifies whether CORS is active or not for requesting origin", | ||
" | "example": true, | ||
"exampleSetFlag": true | "exampleSetFlag": true | ||
} | } | ||
}, | }, | ||
"exampleSetFlag": true | "exampleSetFlag": true | ||
}, | }, | ||
" | "Details": { | ||
"title": " | "title": "Details", | ||
"type": "object", | "type": "object", | ||
"exampleSetFlag": true | "exampleSetFlag": true | ||
}, | }, | ||
" | "DownloadDto": { | ||
"title": " | "title": "DownloadDto", | ||
"type": "object", | "type": "object", | ||
"properties": { | "properties": { | ||
" | "downloadDate": { | ||
"type": "string", | "type": "string", | ||
"description": " | "description": "The date of the download. ISO 8601 with 'T' separator and numeric timezone.", | ||
"example": " | "example": "2020-10-09T11:51:46+02:00", | ||
"exampleSetFlag": true | "exampleSetFlag": true | ||
}, | }, | ||
" | "retrievalMethod": { | ||
"type": "string", | "type": "string", | ||
"description": " | "description": "The method how the file was retrieved: Downloaded or viewed in Content Viewer.", | ||
"exampleSetFlag": true, | "exampleSetFlag": true, | ||
"enum": [ | "enum": [ | ||
" | "DOWNLOADED", | ||
" | "VIEWED" | ||
] | ] | ||
} | } | ||
| Zeile 4.020: | Zeile 3.964: | ||
"exampleSetFlag": true | "exampleSetFlag": true | ||
}, | }, | ||
" | "EidSecurityMode": { | ||
"title": " | "title": "EidSecurityMode", | ||
"type": "object", | "type": "object", | ||
"properties": { | "properties": { | ||
" | "config": { | ||
"description": "Configuration of the security mode. Depending on the type (see 'name' property) this is one of OneTimePasswordSecurityModeConfig (for 'ONE_TIME_PASSWORD'), QuickSecurityModeConfig (for 'QUICK'), or EidSecurityModeConfig (for 'EID').", | |||
"description": " | "$ref": "#/components/schemas/EidSecurityModeConfig", | ||
" | |||
"exampleSetFlag": true | "exampleSetFlag": true | ||
}, | }, | ||
" | "name": { | ||
"type": "string", | "type": "string", | ||
"description": " | "description": "Name of the security mode.", | ||
"exampleSetFlag": true, | "exampleSetFlag": true, | ||
" | "enum": [ | ||
" | "EID", | ||
" | "ONE_TIME_PASSWORD", | ||
"QUICK" | |||
] | |||
} | } | ||
}, | }, | ||
"exampleSetFlag": true | "exampleSetFlag": true | ||
}, | }, | ||
" | "EidSecurityModeConfig": { | ||
"title": " | "title": "EidSecurityModeConfig", | ||
"type": "object", | |||
"exampleSetFlag": true | |||
}, | |||
"Error": { | |||
"title": "Error", | |||
"type": "object", | "type": "object", | ||
"properties": { | "properties": { | ||
" | "errorCode": { | ||
"type": " | "type": "integer", | ||
"description": " | "description": "Proprietary Cryptshare Server error code.", | ||
" | "format": "int32", | ||
"exampleSetFlag": true | "exampleSetFlag": true | ||
}, | }, | ||
" | "errorMessage": { | ||
"type": "string", | "type": "string", | ||
"description": " | "description": "Short description of the error code in English.", | ||
"exampleSetFlag": true | "exampleSetFlag": true | ||
}, | } | ||
" | }, | ||
"exampleSetFlag": true | |||
}, | |||
"FailedRecipient": { | |||
"title": "FailedRecipient", | |||
"type": "object", | |||
"properties": { | |||
"emailAddress": { | |||
"type": "string", | "type": "string", | ||
"description": "The | "description": "The email address of the failed recipient.", | ||
"example": "abc.def@example.com", | |||
"exampleSetFlag": true | "exampleSetFlag": true | ||
}, | }, | ||
" | "reason": { | ||
"type": "string", | "type": "string", | ||
"description": "The | "description": "The reason of the denial of the recipient. Currently, only 'POLICY_MISMATCH' is supported.", | ||
"exampleSetFlag": true, | |||
"exampleSetFlag": true | "enum": [ | ||
"POLICY_MISMATCH" | |||
] | |||
" | |||
} | } | ||
}, | }, | ||
"exampleSetFlag": true | "exampleSetFlag": true | ||
}, | }, | ||
" | "FileDownloadDto": { | ||
"title": " | "title": "FileDownloadDto", | ||
"type": "object", | "type": "object", | ||
"properties": { | "properties": { | ||
" | "downloads": { | ||
"type": " | "type": "array", | ||
"description": "The | "description": "The list of downloads of this file.", | ||
" | "exampleSetFlag": true, | ||
"items": { | |||
}, | "$ref": "#/components/schemas/DownloadDto", | ||
" | "exampleSetFlag": false | ||
} | |||
}, | |||
"id": { | |||
"type": "string", | "type": "string", | ||
"description": "The | "description": "The file ID.", | ||
"exampleSetFlag": true | "exampleSetFlag": true | ||
} | } | ||
| Zeile 4.113: | Zeile 4.051: | ||
"exampleSetFlag": true | "exampleSetFlag": true | ||
}, | }, | ||
" | "FileStatusDto": { | ||
"title": " | "title": "FileStatusDto", | ||
"type": "object", | "type": "object", | ||
"properties": { | "properties": { | ||
" | "id": { | ||
"type": "string", | "type": "string", | ||
"description": "The ID | "description": "The file ID.", | ||
"exampleSetFlag": true | "exampleSetFlag": true | ||
} | }, | ||
"removalCause": { | |||
" | |||
"type": "string", | "type": "string", | ||
"description": " | "description": "A formatted text with details why this file was removed. May be null.", | ||
"exampleSetFlag": true | "exampleSetFlag": true | ||
}, | }, | ||
" | "removed": { | ||
"type": " | "type": "boolean", | ||
"description": " | "description": "If this file was removed.", | ||
"example": false, | |||
"example": | |||
"exampleSetFlag": true | "exampleSetFlag": true | ||
} | } | ||
| Zeile 4.148: | Zeile 4.074: | ||
"exampleSetFlag": true | "exampleSetFlag": true | ||
}, | }, | ||
" | "Imprint": { | ||
"title": " | "title": "Imprint", | ||
"type": "object", | "type": "object", | ||
"properties": { | "properties": { | ||
" | "content": { | ||
"type": "string", | "type": "string", | ||
"description": " | "description": "Either an URL pointing to the imprint (type 'link') or the content itself (type 'html').", | ||
"example": "\u003Ch1\u003EImprint\u003C/h1\u003E\u003Cp\u003ELorem ipsum...\u003C/p\u003E", | |||
"exampleSetFlag": true | "exampleSetFlag": true | ||
}, | }, | ||
" | "type": { | ||
"type": "string", | "type": "string", | ||
"description": " | "description": "Specifies value type of the content property..", | ||
"example": "html", | |||
" | |||
"exampleSetFlag": true, | "exampleSetFlag": true, | ||
"enum": [ | "enum": [ | ||
" | "html", | ||
" | "link" | ||
] | ] | ||
} | } | ||
| Zeile 4.187: | Zeile 4.097: | ||
"exampleSetFlag": true | "exampleSetFlag": true | ||
}, | }, | ||
" | "LanguagePack": { | ||
"title": " | "title": "LanguagePack", | ||
"type": "object", | "type": "object", | ||
"properties": { | "properties": { | ||
" | "displayName": { | ||
"type": "string", | "type": "string", | ||
"description": "The | "description": "The display name of the language, in the respective language.", | ||
"example": "English (US)", | |||
"exampleSetFlag": true | "exampleSetFlag": true | ||
}, | }, | ||
" | "href": { | ||
"type": "string", | "type": "string", | ||
"description": "The | "description": "The absolute path to the language pack resources.", | ||
"exampleSetFlag": true, | "example": "/api/products/api.rest/language-packs/en-US_2", | ||
" | "exampleSetFlag": true | ||
}, | |||
"id": { | |||
"type": "string", | |||
"description": "Id of the language pack, contains locale and major version.", | |||
"example": "en-US_2", | |||
"exampleSetFlag": true | |||
}, | |||
"lastChangeTimestamp": { | |||
"type": "string", | |||
"description": "The date and time of the last update of the language pack, or null, if it was never updated. Format: ISO 8601 with 'T' separator and numeric timezone.", | |||
"example": "2020-10-09T11:51:46+02:00", | |||
"exampleSetFlag": true | |||
}, | |||
"locale": { | |||
"type": "string", | |||
"description": "IETF BCP 47 language tag, RFC 5646. Format: \u0026lt;language\u0026gt;[-\u0026lt;region\u0026gt;]. Case insensitive.", | |||
"example": "en-US", | |||
"exampleSetFlag": true | |||
}, | |||
"version": { | |||
"type": "string", | |||
"description": "The version of the language pack, consisting of major and minor version.", | |||
"example": "2.1", | |||
"exampleSetFlag": true | |||
} | } | ||
}, | }, | ||
"exampleSetFlag": true | "exampleSetFlag": true | ||
}, | }, | ||
" | "LogEntry": { | ||
"title": " | "title": "LogEntry", | ||
"type": "object", | "type": "object", | ||
"properties": { | "properties": { | ||
" | "level": { | ||
"type": "string", | "type": "string", | ||
"description": " | "description": "Assumes a severity ordering as specified by RFC 5424.", | ||
"exampleSetFlag": true, | "exampleSetFlag": true, | ||
"enum": [ | "enum": [ | ||
" | "debug", | ||
] | "error", | ||
"info", | |||
"trace", | |||
"warn" | |||
] | |||
}, | |||
"message": { | |||
"type": "string", | |||
"description": "The log message.", | |||
"exampleSetFlag": true | |||
}, | |||
"timestamp": { | |||
"type": "string", | |||
"description": "ISO 8601 with 'T' separator and numeric timezone.", | |||
"example": "2020-10-09T11:51:46+02:00", | |||
"exampleSetFlag": true | |||
} | } | ||
}, | }, | ||
"exampleSetFlag": true | "exampleSetFlag": true | ||
}, | }, | ||
" | "LoggingSettings": { | ||
"title": " | "title": "LoggingSettings", | ||
"type": "object", | "type": "object", | ||
"properties": { | "properties": { | ||
" | "level": { | ||
"type": "string", | "type": "string", | ||
"description": " | "description": "Assumes a severity ordering as specified by RFC 5424.", | ||
"exampleSetFlag": true, | "exampleSetFlag": true, | ||
"enum": [ | "enum": [ | ||
" | "debug", | ||
"error", | |||
"info", | |||
"trace", | |||
"warn" | |||
] | ] | ||
}, | |||
"remoteLoggingEnabled": { | |||
"type": "boolean", | |||
"description": "Specifies whether the requesting client should send its log entries to the Cryptshare Server.", | |||
"example": true, | |||
"exampleSetFlag": true | |||
} | } | ||
}, | }, | ||
"exampleSetFlag": true | "exampleSetFlag": true | ||
}, | }, | ||
" | "OneTimePasswordSecurityMode": { | ||
"title": " | "title": "OneTimePasswordSecurityMode", | ||
" | "type": "object", | ||
" | "properties": { | ||
"config": { | |||
"description": "Configuration of the security mode. Depending on the type (see 'name' property) this is one of OneTimePasswordSecurityModeConfig (for 'ONE_TIME_PASSWORD'), QuickSecurityModeConfig (for 'QUICK'), or EidSecurityModeConfig (for 'EID').", | |||
"$ref": "#/components/schemas/OneTimePasswordSecurityModeConfig", | |||
"exampleSetFlag": true | |||
}, | |||
"name": { | |||
"type": "string", | |||
"description": "Name of the security mode.", | |||
"exampleSetFlag": true, | |||
"enum": [ | |||
"EID", | |||
"ONE_TIME_PASSWORD", | |||
"QUICK" | |||
] | |||
} | |||
}, | |||
"exampleSetFlag": true | |||
}, | |||
"OneTimePasswordSecurityModeConfig": { | |||
"title": "OneTimePasswordSecurityModeConfig", | |||
"type": "object", | "type": "object", | ||
"properties": { | "properties": { | ||
" | "allowedPasswordModes": { | ||
"type": "array", | "type": "array", | ||
"description": "Password modes allowed for one time passwords.", | |||
"example": "[\"NONE\", \"MANUAL\", \"GENERATED\"]", | |||
"exampleSetFlag": true, | "exampleSetFlag": true, | ||
"items": { | "items": { | ||
"type": "string", | "type": "string", | ||
"exampleSetFlag": false | "exampleSetFlag": false, | ||
"enum": [ | |||
"GENERATED", | |||
"MANUAL", | |||
"NONE" | |||
] | |||
} | } | ||
} | } | ||
| Zeile 4.267: | Zeile 4.239: | ||
"exampleSetFlag": true | "exampleSetFlag": true | ||
}, | }, | ||
" | "PasswordValidationResult": { | ||
"title": " | "title": "PasswordValidationResult", | ||
"type": "object", | "type": "object", | ||
"properties": { | "properties": { | ||
" | "rulesNotFulfilled": { | ||
"type": "array", | |||
"description": "List of rules that are not fulfilled by the given password", | |||
"exampleSetFlag": true, | |||
"type": "array", | |||
"description": "List of | |||
"exampleSetFlag": true, | |||
"items": { | "items": { | ||
"$ref": "#/components/schemas/ | "$ref": "#/components/schemas/PasswordValidationRule", | ||
"exampleSetFlag": false | "exampleSetFlag": false | ||
} | } | ||
}, | }, | ||
" | "valid": { | ||
"description": " | "type": "boolean", | ||
" | "description": "Whether the given password is valid.", | ||
"example": false, | |||
"exampleSetFlag": true | "exampleSetFlag": true | ||
} | } | ||
}, | }, | ||
"description": "Results of the validation of a given password", | |||
"exampleSetFlag": true | "exampleSetFlag": true | ||
}, | }, | ||
" | "PasswordValidationRule": { | ||
"title": " | "title": "PasswordValidationRule", | ||
"type": "object", | "type": "object", | ||
"properties": { | "properties": { | ||
" | "details": { | ||
"description": "Details of the rule.", | |||
"description": " | "$ref": "#/components/schemas/Details", | ||
" | |||
"exampleSetFlag": true | "exampleSetFlag": true | ||
}, | }, | ||
" | "name": { | ||
"type": " | "type": "string", | ||
"description": " | "description": "Name of the rule.", | ||
"exampleSetFlag": true | "exampleSetFlag": true | ||
}, | } | ||
}, | |||
"description": "Represents a rule a password has to fulfill to be valid", | |||
"exampleSetFlag": true | |||
}, | |||
" | "PasswordWrapper": { | ||
"title": "PasswordWrapper", | |||
"type": "object", | |||
"properties": { | |||
"password": { | |||
"type": "string", | |||
"exampleSetFlag": true | "exampleSetFlag": true | ||
}, | } | ||
}, | |||
"exampleSetFlag": true | |||
"description": " | }, | ||
" | "QuickSecurityMode": { | ||
"title": "QuickSecurityMode", | |||
"type": "object", | |||
"properties": { | |||
"config": { | |||
"description": "Configuration of the security mode. Depending on the type (see 'name' property) this is one of OneTimePasswordSecurityModeConfig (for 'ONE_TIME_PASSWORD'), QuickSecurityModeConfig (for 'QUICK'), or EidSecurityModeConfig (for 'EID').", | |||
"$ref": "#/components/schemas/QuickSecurityModeConfig", | |||
"exampleSetFlag": true | "exampleSetFlag": true | ||
}, | }, | ||
" | "name": { | ||
"type": " | "type": "string", | ||
"description": " | "description": "Name of the security mode.", | ||
"exampleSetFlag": true, | "exampleSetFlag": true, | ||
" | "enum": [ | ||
" | "EID", | ||
"ONE_TIME_PASSWORD", | |||
"QUICK" | |||
] | |||
" | } | ||
"type": " | }, | ||
"description": " | "exampleSetFlag": true | ||
"example": | }, | ||
"exampleSetFlag": true | "QuickSecurityModeConfig": { | ||
"title": "QuickSecurityModeConfig", | |||
"type": "object", | |||
"properties": { | |||
"allowedPasswordModes": { | |||
"type": "array", | |||
"description": "Password modes allowed for invitational (initial) QUICK transfers.", | |||
"example": "[\"NONE\", \"MANUAL\", \"GENERATED\"]", | |||
"exampleSetFlag": true, | |||
"items": { | |||
"type": "string", | |||
"exampleSetFlag": false, | |||
"enum": [ | |||
"GENERATED", | |||
"MANUAL", | |||
"NONE" | |||
] | |||
} | |||
}, | }, | ||
" | "defaultIfEstablished": { | ||
"type": "boolean", | "type": "boolean", | ||
"description": "Specifies whether the client should set QUICK as default security mode if the sender has an already established QUICK connection with all recipients.", | |||
"description": "Specifies whether the | |||
"example": false, | "example": false, | ||
"exampleSetFlag": true | "exampleSetFlag": true | ||
| Zeile 4.373: | Zeile 4.341: | ||
"exampleSetFlag": true | "exampleSetFlag": true | ||
}, | }, | ||
" | "Recipient": { | ||
"title": " | "title": "Recipient", | ||
"required": [ | |||
"mail" | |||
], | |||
"type": "object", | "type": "object", | ||
"properties": { | "properties": { | ||
" | "mail": { | ||
"type": " | "type": "string", | ||
"description": "The | "description": "The recipient email address.", | ||
"exampleSetFlag": true | "exampleSetFlag": true | ||
} | } | ||
}, | }, | ||
"exampleSetFlag": true | "exampleSetFlag": true | ||
}, | }, | ||
" | "RecipientStatusDto": { | ||
"title": " | "title": "RecipientStatusDto", | ||
"type": "object", | "type": "object", | ||
"properties": { | "properties": { | ||
" | "downloadUrl": { | ||
"type": "string", | "type": "string", | ||
"description": " | "description": "The URL this recipient can use to access this transfer. This URL is meant to be used by a real user, not an API. This field is set to null only if the password mode is none and a different verification token is used than the one when this transfer was created with.", | ||
"exampleSetFlag": true | "exampleSetFlag": true | ||
}, | }, | ||
" | "fileDownloads": { | ||
"type": " | "uniqueItems": true, | ||
" | "type": "array", | ||
"exampleSetFlag": true, | |||
"items": { | |||
"$ref": "#/components/schemas/FileDownloadDto", | |||
"exampleSetFlag": false | |||
} | |||
}, | }, | ||
" | "id": { | ||
"type": "string", | "type": "string", | ||
"description": "The | "description": "The recipient transfer ID.", | ||
"exampleSetFlag": true | "exampleSetFlag": true | ||
}, | }, | ||
" | "mail": { | ||
"type": "string", | "type": "string", | ||
"description": "The | "description": "The recipient email address.", | ||
"exampleSetFlag": true | "exampleSetFlag": true | ||
}, | }, | ||
" | "notificationFailed": { | ||
"uniqueItems": true, | "type": "boolean", | ||
"description": "If notification of this recipient failed.", | |||
"example": false, | |||
"exampleSetFlag": true | |||
} | |||
}, | |||
"exampleSetFlag": true | |||
}, | |||
"Recipients": { | |||
"title": "Recipients", | |||
"type": "object", | |||
"properties": { | |||
"bcc": { | |||
"uniqueItems": true, | |||
"type": "array", | "type": "array", | ||
"description": "The | "description": "The 'BCC' recipients.", | ||
"exampleSetFlag": true, | "exampleSetFlag": true, | ||
"items": { | "items": { | ||
"$ref": "#/components/schemas/ | "$ref": "#/components/schemas/Recipient", | ||
"exampleSetFlag": false | "exampleSetFlag": false | ||
} | } | ||
}, | }, | ||
" | "cc": { | ||
"description": "The | "uniqueItems": true, | ||
"$ref": "#/components/schemas/ | "type": "array", | ||
"description": "The 'CC' recipients.", | |||
"exampleSetFlag": true, | |||
"items": { | |||
"$ref": "#/components/schemas/Recipient", | |||
"exampleSetFlag": false | |||
} | |||
}, | }, | ||
" | "to": { | ||
"type": " | "uniqueItems": true, | ||
"description": "The | "type": "array", | ||
" | "description": "The 'To' recipients.", | ||
"exampleSetFlag": true | "exampleSetFlag": true, | ||
}, | "items": { | ||
" | "$ref": "#/components/schemas/Recipient", | ||
"$ref": "#/components/schemas/ | "exampleSetFlag": false | ||
} | |||
} | |||
}, | |||
"description": "The recipients of the transfer grouped by to, cc and bcc.", | |||
"exampleSetFlag": true | |||
}, | |||
"RequestVerificationBody": { | |||
"title": "RequestVerificationBody", | |||
"type": "object", | |||
"properties": { | |||
"verificationCode": { | |||
"type": "string", | |||
"description": "Code that confirms this verification. Must be present unless requesting a verification using client-id.", | |||
"exampleSetFlag": true | |||
} | |||
}, | |||
"exampleSetFlag": true | |||
}, | |||
"ResponseOfClientId": { | |||
"title": "ResponseOfClientId", | |||
"type": "object", | |||
"properties": { | |||
"data": { | |||
"description": "Main data of the response.", | |||
"$ref": "#/components/schemas/ClientId", | |||
"exampleSetFlag": true | "exampleSetFlag": true | ||
}, | }, | ||
" | "meta": { | ||
" | "type": "object", | ||
" | "description": "Additional response metadata.", | ||
"exampleSetFlag": true | "exampleSetFlag": true | ||
}, | } | ||
}, | |||
"exampleSetFlag": true | |||
"description": " | }, | ||
" | "ResponseOfCorsStatus": { | ||
"title": "ResponseOfCorsStatus", | |||
"type": "object", | |||
"properties": { | |||
"data": { | |||
"description": "Main data of the response.", | |||
"$ref": "#/components/schemas/CorsStatus", | |||
"exampleSetFlag": true | "exampleSetFlag": true | ||
}, | }, | ||
" | "meta": { | ||
"type": " | "type": "object", | ||
"description": " | "description": "Additional response metadata.", | ||
"exampleSetFlag": true | "exampleSetFlag": true | ||
} | } | ||
| Zeile 4.499: | Zeile 4.477: | ||
"exampleSetFlag": true | "exampleSetFlag": true | ||
}, | }, | ||
" | "ResponseOfImprint": { | ||
"title": " | "title": "ResponseOfImprint", | ||
"type": "object", | "type": "object", | ||
"properties": { | "properties": { | ||
" | "data": { | ||
"$ref": "#/components/schemas/ | "description": "Main data of the response.", | ||
"$ref": "#/components/schemas/Imprint", | |||
"exampleSetFlag": true | "exampleSetFlag": true | ||
}, | }, | ||
" | "meta": { | ||
" | "type": "object", | ||
"description": "Additional response metadata.", | |||
"exampleSetFlag": true | "exampleSetFlag": true | ||
} | } | ||
| Zeile 4.514: | Zeile 4.494: | ||
"exampleSetFlag": true | "exampleSetFlag": true | ||
}, | }, | ||
" | "ResponseOfLanguagePack": { | ||
"title": " | "title": "ResponseOfLanguagePack", | ||
"type": "object", | "type": "object", | ||
"properties": { | "properties": { | ||
" | "data": { | ||
"description": "Main data of the response.", | |||
"description": " | "$ref": "#/components/schemas/LanguagePack", | ||
" | |||
"exampleSetFlag": true | "exampleSetFlag": true | ||
}, | }, | ||
" | "meta": { | ||
"type": " | "type": "object", | ||
"description": " | "description": "Additional response metadata.", | ||
"exampleSetFlag": true | "exampleSetFlag": true | ||
} | |||
}, | |||
"exampleSetFlag": true | |||
}, | |||
"ResponseOfListOfLanguagePack": { | |||
"title": "ResponseOfListOfLanguagePack", | |||
"type": "object", | |||
"properties": { | |||
"data": { | |||
"type": "array", | |||
"description": "Main data of the response.", | |||
"exampleSetFlag": true, | |||
"items": { | |||
"$ref": "#/components/schemas/LanguagePack", | |||
"exampleSetFlag": false | |||
} | |||
}, | }, | ||
" | "meta": { | ||
"type": " | "type": "object", | ||
"description": " | "description": "Additional response metadata.", | ||
"exampleSetFlag": true | "exampleSetFlag": true | ||
} | |||
}, | |||
"exampleSetFlag": true | |||
}, | |||
"ResponseOfListOfPasswordValidationRule": { | |||
"title": "ResponseOfListOfPasswordValidationRule", | |||
"type": "object", | |||
"properties": { | |||
"data": { | |||
"type": "array", | |||
"description": "Main data of the response.", | |||
"exampleSetFlag": true, | |||
"items": { | |||
"$ref": "#/components/schemas/PasswordValidationRule", | |||
"exampleSetFlag": false | |||
} | |||
}, | }, | ||
" | "meta": { | ||
"type": " | "type": "object", | ||
"description": " | "description": "Additional response metadata.", | ||
"exampleSetFlag": true | "exampleSetFlag": true | ||
} | |||
}, | |||
"exampleSetFlag": true | |||
}, | |||
"ResponseOfListOfTransferBasicInfoDto": { | |||
"title": "ResponseOfListOfTransferBasicInfoDto", | |||
"type": "object", | |||
"properties": { | |||
"data": { | |||
"type": "array", | |||
"description": "Main data of the response.", | |||
"exampleSetFlag": true, | |||
"items": { | |||
"$ref": "#/components/schemas/TransferBasicInfoDto", | |||
"exampleSetFlag": false | |||
} | |||
}, | }, | ||
"size": { | "meta": { | ||
"type": "integer", | "type": "object", | ||
"description": "The file size in bytes.", | "description": "Additional response metadata.", | ||
"exampleSetFlag": true | |||
} | |||
}, | |||
"exampleSetFlag": true | |||
}, | |||
"ResponseOfListOfTransferFile": { | |||
"title": "ResponseOfListOfTransferFile", | |||
"type": "object", | |||
"properties": { | |||
"data": { | |||
"type": "array", | |||
"description": "Main data of the response.", | |||
"exampleSetFlag": true, | |||
"items": { | |||
"$ref": "#/components/schemas/TransferFile", | |||
"exampleSetFlag": false | |||
} | |||
}, | |||
"meta": { | |||
"type": "object", | |||
"description": "Additional response metadata.", | |||
"exampleSetFlag": true | |||
} | |||
}, | |||
"exampleSetFlag": true | |||
}, | |||
"ResponseOfLoggingSettings": { | |||
"title": "ResponseOfLoggingSettings", | |||
"type": "object", | |||
"properties": { | |||
"data": { | |||
"description": "Main data of the response.", | |||
"$ref": "#/components/schemas/LoggingSettings", | |||
"exampleSetFlag": true | |||
}, | |||
"meta": { | |||
"type": "object", | |||
"description": "Additional response metadata.", | |||
"exampleSetFlag": true | |||
} | |||
}, | |||
"exampleSetFlag": true | |||
}, | |||
"ResponseOfPasswordValidationResult": { | |||
"title": "ResponseOfPasswordValidationResult", | |||
"type": "object", | |||
"properties": { | |||
"data": { | |||
"description": "Main data of the response.", | |||
"$ref": "#/components/schemas/PasswordValidationResult", | |||
"exampleSetFlag": true | |||
}, | |||
"meta": { | |||
"type": "object", | |||
"description": "Additional response metadata.", | |||
"exampleSetFlag": true | |||
} | |||
}, | |||
"exampleSetFlag": true | |||
}, | |||
"ResponseOfPasswordWrapper": { | |||
"title": "ResponseOfPasswordWrapper", | |||
"type": "object", | |||
"properties": { | |||
"data": { | |||
"description": "Main data of the response.", | |||
"$ref": "#/components/schemas/PasswordWrapper", | |||
"exampleSetFlag": true | |||
}, | |||
"meta": { | |||
"type": "object", | |||
"description": "Additional response metadata.", | |||
"exampleSetFlag": true | |||
} | |||
}, | |||
"exampleSetFlag": true | |||
}, | |||
"ResponseOfTermsOfUseInfo": { | |||
"title": "ResponseOfTermsOfUseInfo", | |||
"type": "object", | |||
"properties": { | |||
"data": { | |||
"description": "Main data of the response.", | |||
"$ref": "#/components/schemas/TermsOfUseInfo", | |||
"exampleSetFlag": true | |||
}, | |||
"meta": { | |||
"type": "object", | |||
"description": "Additional response metadata.", | |||
"exampleSetFlag": true | |||
} | |||
}, | |||
"exampleSetFlag": true | |||
}, | |||
"ResponseOfTransferFileCreationOptions": { | |||
"title": "ResponseOfTransferFileCreationOptions", | |||
"type": "object", | |||
"properties": { | |||
"data": { | |||
"description": "Main data of the response.", | |||
"$ref": "#/components/schemas/TransferFileCreationOptionsRes", | |||
"exampleSetFlag": true | |||
}, | |||
"meta": { | |||
"type": "object", | |||
"description": "Additional response metadata.", | |||
"exampleSetFlag": true | |||
} | |||
}, | |||
"exampleSetFlag": true | |||
}, | |||
"ResponseOfTransferInfo": { | |||
"title": "ResponseOfTransferInfo", | |||
"type": "object", | |||
"properties": { | |||
"data": { | |||
"description": "Main data of the response.", | |||
"$ref": "#/components/schemas/TransferInfo", | |||
"exampleSetFlag": true | |||
}, | |||
"meta": { | |||
"type": "object", | |||
"description": "Additional response metadata.", | |||
"exampleSetFlag": true | |||
} | |||
}, | |||
"exampleSetFlag": true | |||
}, | |||
"ResponseOfTransferPolicyResult": { | |||
"title": "ResponseOfTransferPolicyResult", | |||
"type": "object", | |||
"properties": { | |||
"data": { | |||
"description": "Main data of the response.", | |||
"$ref": "#/components/schemas/TransferPolicyResult", | |||
"exampleSetFlag": true | |||
}, | |||
"meta": { | |||
"type": "object", | |||
"description": "Additional response metadata.", | |||
"exampleSetFlag": true | |||
} | |||
}, | |||
"exampleSetFlag": true | |||
}, | |||
"ResponseOfTransferSession": { | |||
"title": "ResponseOfTransferSession", | |||
"type": "object", | |||
"properties": { | |||
"data": { | |||
"description": "Main data of the response.", | |||
"$ref": "#/components/schemas/TransferSession", | |||
"exampleSetFlag": true | |||
}, | |||
"meta": { | |||
"type": "object", | |||
"description": "Additional response metadata.", | |||
"exampleSetFlag": true | |||
} | |||
}, | |||
"exampleSetFlag": true | |||
}, | |||
"ResponseOfTransferStatus": { | |||
"title": "ResponseOfTransferStatus", | |||
"type": "object", | |||
"properties": { | |||
"data": { | |||
"description": "Main data of the response.", | |||
"$ref": "#/components/schemas/TransferStatus", | |||
"exampleSetFlag": true | |||
}, | |||
"meta": { | |||
"type": "object", | |||
"description": "Additional response metadata.", | |||
"exampleSetFlag": true | |||
} | |||
}, | |||
"exampleSetFlag": true | |||
}, | |||
"ResponseOfVerificationStatus": { | |||
"title": "ResponseOfVerificationStatus", | |||
"type": "object", | |||
"properties": { | |||
"data": { | |||
"description": "Main data of the response.", | |||
"$ref": "#/components/schemas/VerificationStatus", | |||
"exampleSetFlag": true | |||
}, | |||
"meta": { | |||
"type": "object", | |||
"description": "Additional response metadata.", | |||
"exampleSetFlag": true | |||
} | |||
}, | |||
"exampleSetFlag": true | |||
}, | |||
"ResponseOfVerificationToken": { | |||
"title": "ResponseOfVerificationToken", | |||
"type": "object", | |||
"properties": { | |||
"data": { | |||
"description": "Main data of the response.", | |||
"$ref": "#/components/schemas/VerificationToken", | |||
"exampleSetFlag": true | |||
}, | |||
"meta": { | |||
"type": "object", | |||
"description": "Additional response metadata.", | |||
"exampleSetFlag": true | |||
} | |||
}, | |||
"exampleSetFlag": true | |||
}, | |||
"ResponseOfVoid": { | |||
"title": "ResponseOfVoid", | |||
"type": "object", | |||
"properties": { | |||
"meta": { | |||
"type": "object", | |||
"description": "Additional response metadata.", | |||
"exampleSetFlag": true | |||
} | |||
}, | |||
"exampleSetFlag": true | |||
}, | |||
"Sender": { | |||
"title": "Sender", | |||
"type": "object", | |||
"properties": { | |||
"name": { | |||
"type": "string", | |||
"description": "The sender name.", | |||
"exampleSetFlag": true | |||
}, | |||
"phone": { | |||
"type": "string", | |||
"description": "The sender phone.", | |||
"exampleSetFlag": true | |||
} | |||
}, | |||
"description": "The sender of the transfer (without email).", | |||
"exampleSetFlag": true | |||
}, | |||
"SenderStatusDto": { | |||
"title": "SenderStatusDto", | |||
"type": "object", | |||
"properties": { | |||
"email": { | |||
"type": "string", | |||
"description": "The sender email address.", | |||
"exampleSetFlag": true | |||
}, | |||
"notificationFailed": { | |||
"type": "boolean", | |||
"description": "If notification of the sender failed.", | |||
"example": false, | |||
"exampleSetFlag": true | |||
} | |||
}, | |||
"exampleSetFlag": true | |||
}, | |||
"StatusDto": { | |||
"title": "StatusDto", | |||
"type": "object", | |||
"properties": { | |||
"emlCreationFailed": { | |||
"type": "boolean", | |||
"description": "If the creation of the EML file failed.", | |||
"example": false, | |||
"exampleSetFlag": true | |||
}, | |||
"files": { | |||
"uniqueItems": true, | |||
"type": "array", | |||
"exampleSetFlag": true, | |||
"items": { | |||
"$ref": "#/components/schemas/FileStatusDto", | |||
"exampleSetFlag": false | |||
} | |||
}, | |||
"recipients": { | |||
"uniqueItems": true, | |||
"type": "array", | |||
"exampleSetFlag": true, | |||
"items": { | |||
"$ref": "#/components/schemas/RecipientStatusDto", | |||
"exampleSetFlag": false | |||
} | |||
}, | |||
"sender": { | |||
"$ref": "#/components/schemas/SenderStatusDto", | |||
"exampleSetFlag": true | |||
}, | |||
"state": { | |||
"type": "string", | |||
"description": "The state of the transfer.", | |||
"exampleSetFlag": true, | |||
"enum": [ | |||
"ACTIVE", | |||
"DELETED_BY_ADMIN", | |||
"DELETED_BY_EXPIRATION", | |||
"DELETED_BY_REVOCATION", | |||
"DELETED_BY_SECURITY", | |||
"FAILED", | |||
"PROCESSING" | |||
] | |||
}, | |||
"warnings": { | |||
"type": "boolean", | |||
"description": "If any warnings were encountered. This could be for example files that were removed.", | |||
"example": false, | |||
"exampleSetFlag": true | |||
} | |||
}, | |||
"exampleSetFlag": true | |||
}, | |||
"StreamingResponseBody": { | |||
"title": "StreamingResponseBody", | |||
"type": "object", | |||
"exampleSetFlag": true | |||
}, | |||
"TermsOfUse": { | |||
"title": "TermsOfUse", | |||
"type": "object", | |||
"properties": { | |||
"content": { | |||
"type": "string", | |||
"description": "Either an URL pointing to the terms of use (type 'link') or the content of the terms of use itself (type 'html')", | |||
"example": "\u003Cp\u003EThe terms of use!\u003C/p\u003E", | |||
"exampleSetFlag": true | |||
}, | |||
"locale": { | |||
"type": "string", | |||
"description": "IETF BCP 47 language tag, RFC 5646. Format: \u0026lt;language\u0026gt;[-\u0026lt;region\u0026gt;]. Case insensitive.", | |||
"example": "en-US", | |||
"exampleSetFlag": true | |||
}, | |||
"title": { | |||
"type": "string", | |||
"description": "Title of the terms of use, in the respective language.", | |||
"example": "Cryptshare at ACME Inc., Terms of Use", | |||
"exampleSetFlag": true | |||
}, | |||
"type": { | |||
"type": "string", | |||
"description": "Specifies the value type of the content property.", | |||
"example": "html", | |||
"exampleSetFlag": true, | |||
"enum": [ | |||
"html", | |||
"link" | |||
] | |||
} | |||
}, | |||
"exampleSetFlag": true | |||
}, | |||
"TermsOfUseInfo": { | |||
"title": "TermsOfUseInfo", | |||
"type": "object", | |||
"properties": { | |||
"active": { | |||
"type": "boolean", | |||
"description": "Specifies whether terms of use are active or not. Active terms of use need to be accepted by users before first usage of the product or whenever terms are changed.", | |||
"example": true, | |||
"exampleSetFlag": true | |||
}, | |||
"lastChangeTimestamp": { | |||
"type": "string", | |||
"description": "The date and time of the last change of the terms of use, or null, if the terms of use have never been changed. Format: ISO 8601 with 'T' separator and numeric timezone.", | |||
"example": "2020-10-09T11:51:46+02:00", | |||
"exampleSetFlag": true | |||
}, | |||
"terms": { | |||
"type": "array", | |||
"description": "The terms of use in specific languages.", | |||
"exampleSetFlag": true, | |||
"items": { | |||
"$ref": "#/components/schemas/TermsOfUse", | |||
"exampleSetFlag": false | |||
} | |||
} | |||
}, | |||
"exampleSetFlag": true | |||
}, | |||
"TransferBasicInfoDto": { | |||
"title": "TransferBasicInfoDto", | |||
"type": "object", | |||
"properties": { | |||
"href": { | |||
"type": "string", | |||
"description": "The absolute path to the transfer.", | |||
"exampleSetFlag": true | |||
}, | |||
"recipients": { | |||
"uniqueItems": true, | |||
"type": "array", | |||
"exampleSetFlag": true, | |||
"items": { | |||
"$ref": "#/components/schemas/RecipientStatusDto", | |||
"exampleSetFlag": false | |||
} | |||
}, | |||
"state": { | |||
"type": "string", | |||
"description": "The state of the transfer.", | |||
"exampleSetFlag": true, | |||
"enum": [ | |||
"ACTIVE", | |||
"DELETED_BY_ADMIN", | |||
"DELETED_BY_EXPIRATION", | |||
"DELETED_BY_REVOCATION", | |||
"DELETED_BY_SECURITY", | |||
"FAILED", | |||
"PENDING", | |||
"PROCESSING", | |||
"UNKNOWN" | |||
] | |||
}, | |||
"trackingId": { | |||
"type": "string", | |||
"description": "The tracking ID.", | |||
"exampleSetFlag": true | |||
} | |||
}, | |||
"exampleSetFlag": true | |||
}, | |||
"TransferFile": { | |||
"title": "TransferFile", | |||
"type": "object", | |||
"properties": { | |||
"checksum": { | |||
"type": "string", | |||
"description": "The checksum of the file.", | |||
"example": "737b6a930368b34c9ef9022ab088ac9b0b7abf8ef9046929c5d2fea3f87e7d15", | |||
"exampleSetFlag": true | |||
}, | |||
"fileName": { | |||
"type": "string", | |||
"description": "The name of the file.", | |||
"example": "Invoice.pdf", | |||
"exampleSetFlag": true | |||
}, | |||
"href": { | |||
"type": "string", | |||
"description": "The absolute path to the transfer file.", | |||
"exampleSetFlag": true | |||
}, | |||
"id": { | |||
"type": "string", | |||
"description": "The ID of this file.", | |||
"example": "a58dFp1Tr7", | |||
"exampleSetFlag": true | |||
}, | |||
"size": { | |||
"type": "integer", | |||
"description": "The file size in bytes.", | |||
"format": "int64", | "format": "int64", | ||
"example": 13987, | "example": 13987, | ||
"exampleSetFlag": true | |||
} | |||
}, | |||
"exampleSetFlag": true | |||
}, | |||
"TransferFileCreationOptionsReq": { | |||
"title": "TransferFileCreationOptionsReq", | |||
"required": [ | |||
"fileName", | |||
"size" | |||
], | |||
"type": "object", | |||
"properties": { | |||
"checksum": { | |||
"type": "string", | |||
"description": "The checksum of the file. This may be provided to check the file integrity during processing. For the used algorithm, see the corresponding transfer session.", | |||
"example": "737b6a930368b34c9ef9022ab088ac9b0b7abf8ef9046929c5d2fea3f87e7d15", | |||
"exampleSetFlag": true | |||
}, | |||
"fileName": { | |||
"type": "string", | |||
"description": "The name of the file.", | |||
"exampleSetFlag": true | |||
}, | |||
"size": { | |||
"type": "integer", | |||
"description": "The file size in bytes. This may be provided to allow the server to give early feedback regarding exceeded size limits.", | |||
"format": "int64", | |||
"exampleSetFlag": true | |||
} | |||
}, | |||
"exampleSetFlag": true | |||
}, | |||
"TransferFileCreationOptionsRes": { | |||
"title": "TransferFileCreationOptionsRes", | |||
"required": [ | |||
"fileId" | |||
], | |||
"type": "object", | |||
"properties": { | |||
"fileId": { | |||
"type": "string", | |||
"description": "The ID of the file.", | |||
"exampleSetFlag": true | |||
} | |||
}, | |||
"exampleSetFlag": true | |||
}, | |||
"TransferInfo": { | |||
"title": "TransferInfo", | |||
"type": "object", | |||
"properties": { | |||
"checksumAlgorithm": { | |||
"type": "string", | |||
"description": "The checksum algorithm used for checksum generation.", | |||
"example": "SHA-256", | |||
"exampleSetFlag": true | |||
}, | |||
"totalSize": { | |||
"type": "integer", | |||
"description": "The total file size in bytes.", | |||
"format": "int64", | |||
"example": 13987, | |||
"exampleSetFlag": true | |||
} | |||
}, | |||
"exampleSetFlag": true | |||
}, | |||
"TransferNotificationMessage": { | |||
"title": "TransferNotificationMessage", | |||
"type": "object", | |||
"properties": { | |||
"body": { | |||
"type": "string", | |||
"description": "The body of the transfer notification. May contain HTML.", | |||
"exampleSetFlag": true | |||
}, | |||
"subject": { | |||
"type": "string", | |||
"description": "The subject of the transfer notification.", | |||
"exampleSetFlag": true | |||
} | |||
}, | |||
"exampleSetFlag": true | |||
}, | |||
"TransferOneTimePasswordSecurityModeConfigReq": { | |||
"title": "TransferOneTimePasswordSecurityModeConfigReq", | |||
"type": "object", | |||
"properties": { | |||
"password": { | |||
"type": "string", | |||
"description": "The password for the transfer.", | |||
"exampleSetFlag": true | |||
}, | |||
"passwordMode": { | |||
"type": "string", | |||
"description": "The password mode to use. Note that if 'GENERATED' is used, the password is calculated by the server.", | |||
"exampleSetFlag": true, | |||
"enum": [ | |||
"GENERATED", | |||
"MANUAL", | |||
"NONE" | |||
] | |||
} | |||
}, | |||
"exampleSetFlag": true | |||
}, | |||
"TransferOneTimePasswordSecurityModeConfigRes": { | |||
"title": "TransferOneTimePasswordSecurityModeConfigRes", | |||
"type": "object", | |||
"properties": { | |||
"password": { | |||
"type": "string", | |||
"description": "The password for the transfer.", | |||
"exampleSetFlag": true | |||
}, | |||
"passwordMode": { | |||
"type": "string", | |||
"description": "The password mode to use. Note that if 'GENERATED' is used, the password is calculated by the server.", | |||
"exampleSetFlag": true, | |||
"enum": [ | |||
"GENERATED", | |||
"MANUAL", | |||
"NONE" | |||
] | |||
} | |||
}, | |||
"exampleSetFlag": true | |||
}, | |||
"TransferOneTimePasswordSecurityModeReq": { | |||
"title": "TransferOneTimePasswordSecurityModeReq", | |||
"type": "object", | |||
"properties": { | |||
"config": { | |||
"description": "The configuration of the security mode.", | |||
"$ref": "#/components/schemas/TransferOneTimePasswordSecurityModeConfigReq", | |||
"exampleSetFlag": true | |||
}, | |||
"name": { | |||
"type": "string", | |||
"description": "The identifier for this security mode.", | |||
"exampleSetFlag": true, | |||
"enum": [ | |||
"ONE_TIME_PASSWORD" | |||
] | |||
} | |||
}, | |||
"exampleSetFlag": true | |||
}, | |||
"TransferOneTimePasswordSecurityModeRes": { | |||
"title": "TransferOneTimePasswordSecurityModeRes", | |||
"type": "object", | |||
"properties": { | |||
"config": { | |||
"description": "The configuration of the security mode.", | |||
"$ref": "#/components/schemas/TransferOneTimePasswordSecurityModeConfigRes", | |||
"exampleSetFlag": true | |||
}, | |||
"name": { | |||
"type": "string", | |||
"description": "The identifier for this security mode.", | |||
"exampleSetFlag": true, | |||
"enum": [ | |||
"ONE_TIME_PASSWORD" | |||
] | |||
} | |||
}, | |||
"exampleSetFlag": true | |||
}, | |||
"TransferPolicyRequest": { | |||
"title": "TransferPolicyRequest", | |||
"required": [ | |||
"recipients" | |||
], | |||
"type": "object", | |||
"properties": { | |||
"recipients": { | |||
"type": "array", | |||
"exampleSetFlag": true, | |||
"items": { | |||
"type": "string", | |||
"exampleSetFlag": false | |||
} | |||
} | |||
}, | |||
"exampleSetFlag": true | |||
}, | |||
"TransferPolicyResult": { | |||
"title": "TransferPolicyResult", | |||
"type": "object", | |||
"properties": { | |||
"allowed": { | |||
"type": "boolean", | |||
"description": "Whether a transfer with the requested sender-recipient combination would be allowed or not. Please note that if the user isn't allowed as sender at all, the request would result in a error response instead.", | |||
"example": true, | |||
"exampleSetFlag": true | |||
}, | |||
"failedRecipients": { | |||
"uniqueItems": true, | |||
"type": "array", | |||
"description": "List of all recipients to which the given sender is not allowed to perform a transfer. This is only set if the transfer would not be allowed.", | |||
"exampleSetFlag": true, | |||
"items": { | |||
"$ref": "#/components/schemas/FailedRecipient", | |||
"exampleSetFlag": false | |||
} | |||
}, | |||
"settings": { | |||
"description": "The evaluated policy settings of the matching policy rules. This is only set the transfer would be allowed at all.", | |||
"$ref": "#/components/schemas/TransferPolicySettings", | |||
"exampleSetFlag": true | |||
} | |||
}, | |||
"exampleSetFlag": true | |||
}, | |||
"TransferPolicySettings": { | |||
"title": "TransferPolicySettings", | |||
"type": "object", | |||
"properties": { | |||
"confidentialMessageAllowed": { | |||
"type": "boolean", | |||
"description": "Specifies whether a confidential message can be part of the transfer or not.", | |||
"example": false, | |||
"exampleSetFlag": true | |||
}, | |||
"confidentialMessageRequired": { | |||
"type": "boolean", | |||
"description": "Specifies whether a confidential message has to be part of the transfer or not.", | |||
"example": false, | |||
"exampleSetFlag": true | |||
}, | |||
"maxRetentionPeriod": { | |||
"type": "integer", | |||
"description": "Max. number of days the transfer is retrievable, starting at the transfer's provision time.", | |||
"format": "int64", | |||
"example": 30, | |||
"exampleSetFlag": true | |||
}, | |||
"maxTotalSize": { | |||
"type": "integer", | |||
"description": "Max. total size of all files in bytes.", | |||
"format": "int64", | |||
"example": 2147483648, | |||
"exampleSetFlag": true | |||
}, | |||
"recipientNotificationEditable": { | |||
"type": "boolean", | |||
"description": "Specifies whether the recipient notification can be edited or not.", | |||
"example": false, | |||
"exampleSetFlag": true | |||
}, | |||
"securityModes": { | |||
"type": "array", | |||
"description": "List of available security modes (OneTimePasswordSecurityMode, QuickSecurityMode, EidSecurityMode), ordered by priority. The first element is meant to be set as default by the client.", | |||
"exampleSetFlag": true, | |||
"items": { | |||
"$ref": "Error-ModelName{namespace='com.cryptshare.server.api.rest.ui.v1.users.transfers', name='SecurityModeDtoOfSecurityModeConfigDto'}", | |||
"exampleSetFlag": false | |||
} | |||
}, | |||
"sendDownloadNotificationsChangeable": { | |||
"type": "boolean", | |||
"description": "Specifies whether the sendDownloadNotificationsDefault setting is changeable or not.", | |||
"example": false, | |||
"exampleSetFlag": true | |||
}, | |||
"sendDownloadNotificationsDefault": { | |||
"type": "boolean", | |||
"description": "Default setting for sending download notifications on file retrieval.", | |||
"example": false, | |||
"exampleSetFlag": true | |||
}, | |||
"showFileNamesChangeable": { | |||
"type": "boolean", | |||
"description": "Specifies whether the showFileNamesDefault setting is changeable or not.", | |||
"example": false, | |||
"exampleSetFlag": true | |||
}, | |||
"showFileNamesDefault": { | |||
"type": "boolean", | |||
"description": "Default setting for showing file names in notifications and logs.", | |||
"example": false, | |||
"exampleSetFlag": true | |||
}, | |||
"showZipFileContentDefault": { | |||
"type": "boolean", | |||
"description": "Default setting for showing file names within ZIP files in notifications and logs. This only has an effect if file names are shown in general.", | |||
"example": false, | |||
"exampleSetFlag": true | |||
} | |||
}, | |||
"exampleSetFlag": true | |||
}, | |||
"TransferSecurityModeOfobject": { | |||
"title": "TransferSecurityModeOfobject", | |||
"type": "object", | |||
"properties": { | |||
"config": { | |||
"type": "object", | |||
"description": "The configuration of the security mode.", | |||
"exampleSetFlag": true | |||
}, | |||
"name": { | |||
"type": "string", | |||
"description": "The identifier for this security mode.", | |||
"exampleSetFlag": true, | |||
"enum": [ | |||
"ONE_TIME_PASSWORD" | |||
] | |||
} | |||
}, | |||
"description": "Security mode. Possible implementations are: 'TransferOneTimePasswordSecurityMode'", | |||
"exampleSetFlag": true | |||
}, | |||
"TransferSession": { | |||
"title": "TransferSession", | |||
"type": "object", | |||
"properties": { | |||
"classificationId": { | |||
"type": "string", | |||
"description": "An optional ID for the type of classification used for this transfer.", | |||
"exampleSetFlag": true | |||
}, | |||
"confidentialMessageFileId": { | |||
"type": "string", | |||
"description": "The file ID of the confidential message. May be null.", | |||
"exampleSetFlag": true | |||
}, | |||
"expirationDate": { | |||
"type": "string", | |||
"description": "The expiration date of the transfer. ISO 8601 with 'T' separator and numeric timezone.", | |||
"example": "2020-10-09T11:51:46+02:00", | |||
"exampleSetFlag": true | |||
}, | |||
"fileChecksumAlgorithm": { | |||
"type": "string", | |||
"description": "The name of the hashing algorithm that will be used for files in this transfer.", | |||
"example": "SHA-256", | |||
"exampleSetFlag": true | |||
}, | |||
"files": { | |||
"uniqueItems": true, | |||
"type": "array", | |||
"description": "The files of this transfer.", | |||
"exampleSetFlag": true, | |||
"items": { | |||
"$ref": "#/components/schemas/TransferSessionFile", | |||
"exampleSetFlag": false | |||
} | |||
}, | |||
"notificationMessage": { | |||
"description": "The notification mail that will be sent to the recipients.", | |||
"$ref": "#/components/schemas/TransferNotificationMessage", | |||
"exampleSetFlag": true | |||
}, | |||
"recipientLanguage": { | |||
"type": "string", | |||
"description": "The recipient language. IETF BCP 47 language tag, RFC 5646. Format: \u0026lt;language\u0026gt;[-\u0026lt;region\u0026gt;]. Case insensitive.", | |||
"example": "en", | |||
"exampleSetFlag": true | |||
}, | |||
"recipients": { | |||
"$ref": "#/components/schemas/Recipients", | |||
"exampleSetFlag": true | |||
}, | |||
"securityMode": { | |||
"description": "The security mode for this transfer.", | |||
"$ref": "#/components/schemas/TransferSecurityModeOfobject", | |||
"exampleSetFlag": true | |||
}, | |||
"sendDownloadNotifications": { | |||
"type": "boolean", | |||
"description": "If notification mails should be sent to the sender when a file is downloaded.", | |||
"example": false, | |||
"exampleSetFlag": true | |||
}, | |||
"sendDownloadSummary": { | |||
"type": "boolean", | |||
"description": "If a summary notification mail should be sent to the sender the transfer expires.", | |||
"example": false, | |||
"exampleSetFlag": true | |||
}, | |||
"sendRecipientNotification": { | |||
"type": "boolean", | |||
"description": "If notification mails should be sent to the recipients after the transfer is provided.", | |||
"example": false, | |||
"exampleSetFlag": true | |||
}, | |||
"sendUploadSummary": { | |||
"type": "boolean", | |||
"description": "If a confirmation notification mail should be sent to the sender after the transfer is provided.", | |||
"example": false, | |||
"exampleSetFlag": true | |||
}, | |||
"sender": { | |||
"$ref": "#/components/schemas/Sender", | |||
"exampleSetFlag": true | |||
}, | |||
"senderLanguage": { | |||
"type": "string", | |||
"description": "The sender language. Initially, this is set to the value of the 'Accept-Language' header. IETF BCP 47 language tag, RFC 5646. Format: \u0026lt;language\u0026gt;[-\u0026lt;region\u0026gt;]. Case insensitive.", | |||
"example": "en", | |||
"exampleSetFlag": true | |||
}, | |||
"showFileNames": { | |||
"type": "boolean", | |||
"description": "If file names should be shown in notification mails.", | |||
"example": false, | |||
"exampleSetFlag": true | |||
}, | |||
"showZipFileContent": { | |||
"type": "boolean", | |||
"description": "If the contents of ZIP files should be shown in notification mails. Has no effect if `showFileNames` is false.", | |||
"example": false, | |||
"exampleSetFlag": true | |||
} | |||
}, | |||
"exampleSetFlag": true | |||
}, | |||
"TransferSessionCreationOptions": { | |||
"title": "TransferSessionCreationOptions", | |||
"type": "object", | |||
"properties": { | |||
"recipients": { | |||
"$ref": "#/components/schemas/Recipients", | |||
"exampleSetFlag": true | |||
}, | |||
"sender": { | |||
"$ref": "#/components/schemas/Sender", | |||
"exampleSetFlag": true | |||
} | |||
}, | |||
"exampleSetFlag": true | |||
}, | |||
"TransferSessionFile": { | |||
"title": "TransferSessionFile", | |||
"type": "object", | |||
"properties": { | |||
"checksum": { | |||
"type": "string", | |||
"description": "The checksum of the file.", | |||
"example": "737b6a930368b34c9ef9022ab088ac9b0b7abf8ef9046929c5d2fea3f87e7d15", | |||
"exampleSetFlag": true | |||
}, | |||
"fileName": { | |||
"type": "string", | |||
"description": "The name of the file.", | |||
"example": "Invoice.pdf", | |||
"exampleSetFlag": true | |||
}, | |||
"href": { | |||
"type": "string", | |||
"description": "The absolute path to the transfer file.", | |||
"exampleSetFlag": true | |||
}, | |||
"id": { | |||
"type": "string", | |||
"description": "The ID of this file.", | |||
"example": "a58dFp1Tr7", | |||
"exampleSetFlag": true | |||
}, | |||
"size": { | |||
"type": "integer", | |||
"description": "The file size in bytes.", | |||
"format": "int64", | |||
"example": 13987, | |||
"exampleSetFlag": true | |||
}, | |||
"state": { | |||
"type": "string", | |||
"description": "The state of this file.", | |||
"exampleSetFlag": true, | |||
"enum": [ | |||
"ACTIVE", | |||
"INITIALIZED", | |||
"REMOVED", | |||
"UPLOADED" | |||
] | |||
} | |||
}, | |||
"exampleSetFlag": true | |||
}, | |||
"TransferSessionOfobject": { | |||
"title": "TransferSessionOfobject", | |||
"type": "object", | |||
"properties": { | |||
"classificationId": { | |||
"type": "string", | |||
"description": "An optional ID for the type of classification used for this transfer.", | |||
"exampleSetFlag": true | |||
}, | |||
"confidentialMessageFileId": { | |||
"type": "string", | |||
"description": "The file ID of the confidential message. May be null.", | |||
"exampleSetFlag": true | |||
}, | |||
"expirationDate": { | |||
"type": "string", | |||
"description": "The expiration date of the transfer. ISO 8601 with 'T' separator and numeric timezone.", | |||
"example": "2020-10-09T11:51:46+02:00", | |||
"exampleSetFlag": true | |||
}, | |||
"fileChecksumAlgorithm": { | |||
"type": "string", | |||
"description": "The name of the hashing algorithm that will be used for files in this transfer.", | |||
"example": "SHA-256", | |||
"exampleSetFlag": true | |||
}, | |||
"files": { | |||
"uniqueItems": true, | |||
"type": "array", | |||
"description": "The files of this transfer.", | |||
"exampleSetFlag": true, | |||
"items": { | |||
"$ref": "#/components/schemas/TransferSessionFile", | |||
"exampleSetFlag": false | |||
} | |||
}, | |||
"notificationMessage": { | |||
"description": "The notification mail that will be sent to the recipients.", | |||
"$ref": "#/components/schemas/TransferNotificationMessage", | |||
"exampleSetFlag": true | |||
}, | |||
"recipientLanguage": { | |||
"type": "string", | |||
"description": "The recipient language. IETF BCP 47 language tag, RFC 5646. Format: \u0026lt;language\u0026gt;[-\u0026lt;region\u0026gt;]. Case insensitive.", | |||
"example": "en", | |||
"exampleSetFlag": true | |||
}, | |||
"recipients": { | |||
"$ref": "#/components/schemas/Recipients", | |||
"exampleSetFlag": true | |||
}, | |||
"securityMode": { | |||
"type": "object", | |||
"description": "The security mode for this transfer.", | |||
"exampleSetFlag": true | |||
}, | |||
"sendDownloadNotifications": { | |||
"type": "boolean", | |||
"description": "If notification mails should be sent to the sender when a file is downloaded.", | |||
"example": false, | |||
"exampleSetFlag": true | |||
}, | |||
"sendDownloadSummary": { | |||
"type": "boolean", | |||
"description": "If a summary notification mail should be sent to the sender the transfer expires.", | |||
"example": false, | |||
"exampleSetFlag": true | |||
}, | |||
"sendRecipientNotification": { | |||
"type": "boolean", | |||
"description": "If notification mails should be sent to the recipients after the transfer is provided.", | |||
"example": false, | |||
"exampleSetFlag": true | |||
}, | |||
"sendUploadSummary": { | |||
"type": "boolean", | |||
"description": "If a confirmation notification mail should be sent to the sender after the transfer is provided.", | |||
"example": false, | |||
"exampleSetFlag": true | |||
}, | |||
"sender": { | |||
"$ref": "#/components/schemas/Sender", | |||
"exampleSetFlag": true | |||
}, | |||
"senderLanguage": { | |||
"type": "string", | |||
"description": "The sender language. Initially, this is set to the value of the 'Accept-Language' header. IETF BCP 47 language tag, RFC 5646. Format: \u0026lt;language\u0026gt;[-\u0026lt;region\u0026gt;]. Case insensitive.", | |||
"example": "en", | |||
"exampleSetFlag": true | |||
}, | |||
"showFileNames": { | |||
"type": "boolean", | |||
"description": "If file names should be shown in notification mails.", | |||
"example": false, | |||
"exampleSetFlag": true | |||
}, | |||
"showZipFileContent": { | |||
"type": "boolean", | |||
"description": "If the contents of ZIP files should be shown in notification mails. Has no effect if `showFileNames` is false.", | |||
"example": false, | |||
"exampleSetFlag": true | |||
} | |||
}, | |||
"exampleSetFlag": true | |||
}, | |||
"TransferSessionPatchable": { | |||
"title": "TransferSessionPatchable", | |||
"type": "object", | |||
"properties": { | |||
"classificationId": { | |||
"type": "string", | |||
"description": "An optional ID for the type of classification used for this transfer.", | |||
"exampleSetFlag": true | |||
}, | |||
"confidentialMessageFileId": { | |||
"type": "string", | |||
"description": "The file ID of the confidential message. May be null.", | |||
"exampleSetFlag": true | |||
}, | |||
"expirationDate": { | |||
"type": "string", | |||
"description": "The expiration date of the transfer. ISO 8601 with 'T' separator and numeric timezone.", | |||
"example": "2020-10-09T11:51:46+02:00", | |||
"exampleSetFlag": true | |||
}, | |||
"fileChecksumAlgorithm": { | |||
"type": "string", | |||
"description": "The name of the hashing algorithm that will be used for files in this transfer.", | |||
"example": "SHA-256", | |||
"exampleSetFlag": true | |||
}, | |||
"notificationMessage": { | |||
"description": "The notification mail that will be sent to the recipients.", | |||
"$ref": "#/components/schemas/TransferNotificationMessage", | |||
"exampleSetFlag": true | |||
}, | |||
"recipientLanguage": { | |||
"type": "string", | |||
"description": "The recipient language. IETF BCP 47 language tag, RFC 5646. Format: \u0026lt;language\u0026gt;[-\u0026lt;region\u0026gt;]. Case insensitive.", | |||
"example": "en", | |||
"exampleSetFlag": true | |||
}, | |||
"securityMode": { | |||
"description": "The security mode for this transfer.", | |||
"$ref": "#/components/schemas/TransferSecurityModeOfobject", | |||
"exampleSetFlag": true | |||
}, | |||
"sendDownloadNotifications": { | |||
"type": "boolean", | |||
"description": "If notification mails should be sent to the sender when a file is downloaded.", | |||
"example": false, | |||
"exampleSetFlag": true | |||
}, | |||
"sendDownloadSummary": { | |||
"type": "boolean", | |||
"description": "If a summary notification mail should be sent to the sender the transfer expires.", | |||
"example": false, | |||
"exampleSetFlag": true | |||
}, | |||
"sendRecipientNotification": { | |||
"type": "boolean", | |||
"description": "If notification mails should be sent to the recipients after the transfer is provided.", | |||
"example": false, | |||
"exampleSetFlag": true | |||
}, | |||
"sendUploadSummary": { | |||
"type": "boolean", | |||
"description": "If a confirmation notification mail should be sent to the sender after the transfer is provided.", | |||
"example": false, | |||
"exampleSetFlag": true | |||
}, | |||
"sender": { | |||
"$ref": "#/components/schemas/Sender", | |||
"exampleSetFlag": true | |||
}, | |||
"senderLanguage": { | |||
"type": "string", | |||
"description": "The sender language. Initially, this is set to the value of the 'Accept-Language' header. IETF BCP 47 language tag, RFC 5646. Format: \u0026lt;language\u0026gt;[-\u0026lt;region\u0026gt;]. Case insensitive.", | |||
"example": "en", | |||
"exampleSetFlag": true | |||
}, | |||
"showFileNames": { | |||
"type": "boolean", | |||
"description": "If file names should be shown in notification mails.", | |||
"example": false, | |||
"exampleSetFlag": true | |||
}, | |||
"showZipFileContent": { | |||
"type": "boolean", | |||
"description": "If the contents of ZIP files should be shown in notification mails. Has no effect if `showFileNames` is false.", | |||
"example": false, | |||
"exampleSetFlag": true | "exampleSetFlag": true | ||
} | } | ||
}, | }, | ||
"exampleSetFlag": true | "exampleSetFlag": true | ||
}, | }, | ||
" | "TransferStatus": { | ||
"title": " | "title": "TransferStatus", | ||
"type": "object", | "type": "object", | ||
"properties": { | "properties": { | ||
" | "status": { | ||
"$ref": "#/components/schemas/StatusDto", | |||
"$ref": "#/components/schemas/ | |||
"exampleSetFlag": true | "exampleSetFlag": true | ||
}, | }, | ||
" | "transfer": { | ||
" | "$ref": "#/components/schemas/TransferSessionOfobject", | ||
"exampleSetFlag": true | "exampleSetFlag": true | ||
} | } | ||
| Zeile 4.765: | Zeile 5.833: | ||
"schema": { | "schema": { | ||
"type": "string", | "type": "string", | ||
"example": " | "example": "api.rest", | ||
"exampleSetFlag": true | "exampleSetFlag": true | ||
} | } | ||
Version vom 4. August 2023, 11:13 Uhr
| openapi | "3.0.3" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| info |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| servers |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| tags |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| paths |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| components |
|