RESTAPI:OpenAPICode: Unterschied zwischen den Versionen
Aus Cryptshare Documentation
Keine Bearbeitungszusammenfassung |
Keine Bearbeitungszusammenfassung |
||
| Zeile 1: | Zeile 1: | ||
{ | { | ||
"openapi": "3.0. | "openapi": "3.0.1", | ||
"info": { | "info": { | ||
"title": "Cryptshare REST API", | "title": "Cryptshare REST API", | ||
"description": "REST API of Cryptshare Server.", | "description": "REST API of Cryptshare Server, currently focussed on Cryptshare for OWA.", | ||
"version": "1. | "version": "1.9" | ||
}, | }, | ||
"servers": [ | "servers": [ | ||
| Zeile 23: | Zeile 23: | ||
], | ], | ||
"tags": [ | "tags": [ | ||
{ | |||
"name": "terms-of-use", | |||
"description": "Operations to retrieve resources and information regarding the terms of use." | |||
}, | |||
{ | { | ||
"name": "client", | "name": "client", | ||
| Zeile 28: | Zeile 32: | ||
}, | }, | ||
{ | { | ||
"name": " | "name": "password", | ||
"description": " | "description": "Operations for generating, validating passwords and viewing the password requirements" | ||
}, | }, | ||
{ | { | ||
"name": " | "name": "transfer-policy", | ||
"description": "Operations to | "description": "Operations to retrieve information about the transfer policy." | ||
}, | }, | ||
{ | { | ||
| Zeile 40: | Zeile 44: | ||
}, | }, | ||
{ | { | ||
"name": " | "name": "transfer", | ||
"description": "Operations to | "description": "Operations to check existing transfers." | ||
}, | }, | ||
{ | { | ||
"name": " | "name": "transfer-session", | ||
"description": "Operations to | "description": "Operations to create and access new transfers. Transfer sessions may only be modified using the same verification token they were created with." | ||
}, | }, | ||
{ | { | ||
"name": " | "name": "cors", | ||
"description": " | "description": "Operation to retrieve CORS status for the requesting origin." | ||
}, | }, | ||
{ | { | ||
"name": " | "name": "logging", | ||
"description": "Operations to retrieve | "description": "Operations to retrieve logging settings." | ||
}, | }, | ||
{ | { | ||
"name": " | "name": "logging", | ||
"description": "Operations to | "description": "Operations to retrieve logging settings and perform remote logging." | ||
}, | }, | ||
{ | { | ||
"name": " | "name": "language-packs", | ||
"description": "Operations to retrieve information | "description": "Operations to retrieve language pack resources and information." | ||
}, | }, | ||
{ | { | ||
"name": " | "name": "verification", | ||
"description": "Operations to | "description": "Operations to access user verification." | ||
}, | }, | ||
{ | { | ||
"name": " | "name": "download", | ||
"description": "Operations to | "description": "Operations to download transfer information and files." | ||
} | } | ||
], | ], | ||
"paths": { | "paths": { | ||
"/ | "/users/{email-address}/transfer-sessions/{tracking-id}/files/{file-id}/content": { | ||
" | "put": { | ||
"tags": [ | "tags": [ | ||
" | "transfer-session" | ||
], | ], | ||
"summary": " | "summary": "Puts raw binary data to a transfer file. If data was already written to this file, it can not be replaced. Clients may want to stream the data if fitting.", | ||
"operationId": " | "operationId": "putFile", | ||
"parameters": [ | "parameters": [ | ||
{ | { | ||
" | "name": "email-address", | ||
"in": "path", | |||
"description": "User to send as.", | |||
"required": true, | |||
"schema": { | |||
"type": "string" | |||
} | |||
}, | }, | ||
{ | { | ||
" | "name": "tracking-id", | ||
"in": "path", | |||
"description": "The tracking ID.", | |||
"required": true, | |||
"schema": { | |||
"type": "string" | |||
} | |||
}, | }, | ||
{ | { | ||
" | "name": "file-id", | ||
"in": "path", | |||
"description": "The file ID to write data for.", | |||
"required": true, | |||
"schema": { | |||
"type": "string" | |||
} | |||
}, | }, | ||
{ | { | ||
" | "name": "X-CS-ProductKey", | ||
"in": "header", | |||
"description": "The key of the product that the requesting client belongs to. Default is set to 'api.rest'. Can also be specified by query parameter (product-key).", | |||
"schema": { | |||
"type": "string", | |||
"description": " | "example": "client.Owa" | ||
" | |||
" | |||
} | } | ||
}, | }, | ||
" | { | ||
"description": " | "name": "X-CS-ClientId", | ||
"content": { | "in": "header", | ||
"description": "The ID that uniquely identifies the requesting client. Can also be specified by query parameter (client-id). Should be treated as confidential.", | |||
"required": true, | |||
"schema": { | |||
"maxLength": 4000, | |||
"minLength": 50, | |||
"pattern": "^[a-zA-Z0-9]+$", | |||
"type": "string" | |||
} | |||
}, | |||
{ | |||
"name": "X-CS-MajorApiVersion", | |||
"in": "header", | |||
"description": "The major version of the API to use. Can also be specified by query parameter (major-api-version).", | |||
"required": true, | |||
"schema": { | |||
"minimum": 0, | |||
"type": "integer", | |||
"example": 1 | |||
} | |||
}, | |||
{ | |||
"name": "X-CS-MinimumMinorApiVersion", | |||
"in": "header", | |||
"description": "The minimum minor version of the API that the client requires. Can also be specified by query parameter (minimum-minor-api-version).", | |||
"required": true, | |||
"schema": { | |||
"minimum": 0, | |||
"type": "integer", | |||
"example": 9 | |||
} | |||
} | |||
], | |||
"responses": { | |||
"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": { | "application/json": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/Error" | "$ref": "#/components/schemas/Error" | ||
} | |||
} | |||
} | } | ||
} | } | ||
}, | }, | ||
" | "409": { | ||
"description": " | "description": "State failed.\n * 2002 - The file has already been uploaded.", | ||
"content": { | "content": { | ||
"application/json": { | "application/json": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/Error" | "$ref": "#/components/schemas/Error" | ||
} | |||
} | |||
} | } | ||
} | } | ||
}, | }, | ||
" | "200": { | ||
"description": "The requested | "description": "Ok." | ||
}, | |||
"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": { | "content": { | ||
"application/json": { | "application/json": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/Error" | "$ref": "#/components/schemas/Error" | ||
} | |||
} | |||
} | } | ||
} | } | ||
}, | }, | ||
" | "400": { | ||
"description": " | "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": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/Error" | "$ref": "#/components/schemas/Error" | ||
} | |||
} | |||
} | } | ||
} | } | ||
} | } | ||
} | }, | ||
"security": [ | |||
{ | |||
"verification": [] | |||
} | |||
] | |||
} | } | ||
}, | }, | ||
"/ | "/users/{email-address}/verification/token": { | ||
" | "post": { | ||
"tags": [ | "tags": [ | ||
" | "verification" | ||
], | ], | ||
"summary": " | "summary": "Creates a verification token. Note that repeated access in quick succession may cause rate limiting.", | ||
"operationId": " | "operationId": "createVerificationToken", | ||
"parameters": [ | "parameters": [ | ||
{ | { | ||
"name": " | "name": "email-address", | ||
"in": "path", | "in": "path", | ||
"required": true, | "required": true, | ||
"schema": { | "schema": { | ||
"type": "string" | "type": "string" | ||
} | } | ||
}, | }, | ||
{ | { | ||
"name": " | "name": "X-CS-ProductKey", | ||
"in": "header", | "in": "header", | ||
"description": "The | "description": "The key of the product that the requesting client belongs to. Default is set to 'api.rest'. Can also be specified by query parameter (product-key).", | ||
"schema": { | "schema": { | ||
"type": "string", | "type": "string", | ||
" | "example": "client.Owa" | ||
} | } | ||
}, | }, | ||
{ | { | ||
"$ | "name": "X-CS-ClientId", | ||
"in": "header", | |||
"description": "The ID that uniquely identifies the requesting client. Can also be specified by query parameter (client-id). Should be treated as confidential.", | |||
"required": true, | |||
"schema": { | |||
"maxLength": 4000, | |||
"minLength": 50, | |||
"pattern": "^[a-zA-Z0-9]+$", | |||
"type": "string" | |||
} | |||
}, | }, | ||
{ | { | ||
" | "name": "X-CS-MajorApiVersion", | ||
"in": "header", | |||
"description": "The major version of the API to use. Can also be specified by query parameter (major-api-version).", | |||
"required": true, | |||
"schema": { | |||
"minimum": 0, | |||
"type": "integer", | |||
"example": 1 | |||
} | |||
}, | }, | ||
{ | { | ||
" | "name": "X-CS-MinimumMinorApiVersion", | ||
"in": "header", | |||
"description": "The minimum minor version of the API that the client requires. Can also be specified by query parameter (minimum-minor-api-version).", | |||
"required": true, | |||
"schema": { | |||
"minimum": 0, | |||
"type": "integer", | |||
"example": 9 | |||
} | |||
} | } | ||
], | ], | ||
"responses": { | "requestBody": { | ||
" | "content": { | ||
"description": " | "application/json": { | ||
"schema": { | |||
"$ref": "#/components/schemas/RequestVerificationBody" | |||
} | |||
} | |||
}, | |||
"required": true | |||
}, | |||
"responses": { | |||
"404": { | |||
"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": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/ | "$ref": "#/components/schemas/Error" | ||
} | |||
} | |||
} | } | ||
} | } | ||
}, | }, | ||
" | "403": { | ||
"description": " | "description": "The client is not allowed to perform the requested operation.\n * 3001 - Product not licensed.\n * 3002 - Invalid verification data.", | ||
"content": { | "content": { | ||
"application/json": { | "application/json": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/Error" | "$ref": "#/components/schemas/Error" | ||
} | |||
} | |||
} | } | ||
} | } | ||
}, | }, | ||
" | "429": { | ||
"description": " | "description": "Too Many Requests.\n * 2007 - Request rejected because there are too many requests at the same time", | ||
"content": { | |||
"application/json": { | |||
"schema": { | |||
"$ref": "#/components/schemas/Error" | |||
} | |||
} | |||
} | |||
}, | |||
"200": { | |||
"description": "OK.", | |||
"content": { | "content": { | ||
"application/json": { | "application/json": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/ | "$ref": "#/components/schemas/ResponseVerificationToken" | ||
} | |||
} | |||
} | } | ||
} | } | ||
}, | }, | ||
" | "400": { | ||
"description": " | "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": { | "content": { | ||
"application/json": { | "application/json": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/Error" | "$ref": "#/components/schemas/Error" | ||
} | |||
} | |||
} | } | ||
} | } | ||
}, | }, | ||
" | "501": { | ||
"description": "Server error occurred | "description": "Server error occurred.", | ||
"content": { | "content": { | ||
"application/json": { | "application/json": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/Error" | "$ref": "#/components/schemas/Error" | ||
} | |||
} | |||
} | } | ||
} | } | ||
| Zeile 264: | Zeile 342: | ||
} | } | ||
}, | }, | ||
"/ | "/users/{email-address}/verification/code/email": { | ||
" | "post": { | ||
"tags": [ | "tags": [ | ||
" | "verification" | ||
], | ], | ||
"summary": " | "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": " | "operationId": "generateVerificationCode", | ||
"parameters": [ | "parameters": [ | ||
{ | { | ||
"name": " | "name": "email-address", | ||
"in": "path", | "in": "path", | ||
"required": true, | "required": true, | ||
"schema": { | "schema": { | ||
"type": "string" | "type": "string" | ||
} | } | ||
}, | }, | ||
{ | { | ||
"name": " | "name": "X-CS-ProductKey", | ||
"in": " | "in": "header", | ||
"description": "The | "description": "The key of the product that the requesting client belongs to. Default is set to 'api.rest'. Can also be specified by query parameter (product-key).", | ||
"schema": { | "schema": { | ||
"type": "string", | "type": "string", | ||
" | "example": "client.Owa" | ||
} | } | ||
}, | }, | ||
{ | { | ||
"name": "X-CS- | "name": "X-CS-ClientId", | ||
"in": "header", | "in": "header", | ||
"description": "The | "description": "The ID that uniquely identifies the requesting client. Can also be specified by query parameter (client-id). Should be treated as confidential.", | ||
"required": | "required": true, | ||
"schema": { | "schema": { | ||
" | "maxLength": 4000, | ||
" | "minLength": 50, | ||
"pattern": "^[a-zA-Z0-9]+$", | |||
"type": "string" | |||
} | } | ||
}, | }, | ||
{ | { | ||
" | "name": "X-CS-MajorApiVersion", | ||
"in": "header", | |||
"description": "The major version of the API to use. Can also be specified by query parameter (major-api-version).", | |||
"required": true, | |||
"schema": { | |||
"minimum": 0, | |||
"type": "integer", | |||
"example": 1 | |||
} | |||
}, | }, | ||
{ | { | ||
" | "name": "X-CS-MinimumMinorApiVersion", | ||
"in": "header", | |||
"description": "The minimum minor version of the API that the client requires. Can also be specified by query parameter (minimum-minor-api-version).", | |||
" | "required": true, | ||
"schema": { | |||
"minimum": 0, | |||
"type": "integer", | |||
"example": 9 | |||
} | |||
} | } | ||
], | ], | ||
"responses": { | "responses": { | ||
" | "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": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/ | "$ref": "#/components/schemas/Error" | ||
} | |||
} | |||
} | } | ||
} | } | ||
}, | }, | ||
" | "429": { | ||
"description": " | "description": "Too Many Requests.\n * 2007 - Request rejected because there are too many requests at the same time", | ||
"content": { | "content": { | ||
"application/json": { | "application/json": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/Error" | "$ref": "#/components/schemas/Error" | ||
} | |||
} | |||
} | } | ||
} | } | ||
}, | }, | ||
" | "200": { | ||
"description": " | "description": "OK." | ||
}, | }, | ||
" | "400": { | ||
"description": " | "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": { | "content": { | ||
"application/json": { | "application/json": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/Error" | "$ref": "#/components/schemas/Error" | ||
} | |||
} | |||
} | } | ||
} | } | ||
}, | }, | ||
" | "500": { | ||
"description": " | "description": "Email service is not reachable.", | ||
"content": { | "content": { | ||
"application/json": { | "application/json": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/Error" | "$ref": "#/components/schemas/Error" | ||
} | |||
} | |||
} | } | ||
} | } | ||
}, | }, | ||
" | "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": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/Error" | "$ref": "#/components/schemas/Error" | ||
} | |||
} | |||
} | } | ||
} | } | ||
}, | }, | ||
"501": { | "501": { | ||
"description": "Server error occurred. | "description": "Server error occurred.", | ||
"content": { | "content": { | ||
"application/json": { | "application/json": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/Error" | "$ref": "#/components/schemas/Error" | ||
} | |||
} | |||
} | } | ||
} | } | ||
| Zeile 417: | Zeile 469: | ||
} | } | ||
}, | }, | ||
"/ | "/users/{email-address}/transfer-sessions": { | ||
" | "post": { | ||
"tags": [ | "tags": [ | ||
" | "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": "createSession", | ||
"parameters": [ | "parameters": [ | ||
{ | { | ||
"name": " | "name": "email-address", | ||
"in": "path", | "in": "path", | ||
"description": " | "description": "User to send as.", | ||
"required": true, | "required": true, | ||
"schema": { | "schema": { | ||
"type": "string" | "type": "string" | ||
} | } | ||
}, | }, | ||
{ | { | ||
"name": " | "name": "X-CS-ProductKey", | ||
"in": " | "in": "header", | ||
"description": "The | "description": "The key of the product that the requesting client belongs to. Default is set to 'api.rest'. Can also be specified by query parameter (product-key).", | ||
"schema": { | "schema": { | ||
"type": "string", | "type": "string", | ||
" | "example": "client.Owa" | ||
} | } | ||
}, | }, | ||
{ | { | ||
"name": "X-CS- | "name": "X-CS-ClientId", | ||
"in": "header", | "in": "header", | ||
"description": "The | "description": "The ID that uniquely identifies the requesting client. Can also be specified by query parameter (client-id). Should be treated as confidential.", | ||
"required": | "required": true, | ||
"schema": { | "schema": { | ||
" | "maxLength": 4000, | ||
" | "minLength": 50, | ||
"pattern": "^[a-zA-Z0-9]+$", | |||
"type": "string" | |||
} | } | ||
}, | }, | ||
{ | { | ||
" | "name": "X-CS-MajorApiVersion", | ||
"in": "header", | |||
"description": "The major version of the API to use. Can also be specified by query parameter (major-api-version).", | |||
"required": true, | |||
"schema": { | |||
"minimum": 0, | |||
"type": "integer", | |||
"example": 1 | |||
} | |||
}, | }, | ||
{ | { | ||
" | "name": "X-CS-MinimumMinorApiVersion", | ||
"in": "header", | |||
"description": "The minimum minor version of the API that the client requires. Can also be specified by query parameter (minimum-minor-api-version).", | |||
" | "required": true, | ||
"schema": { | |||
"minimum": 0, | |||
"type": "integer", | |||
"example": 9 | |||
} | |||
} | } | ||
], | ], | ||
" | "requestBody": { | ||
" | "content": { | ||
" | "application/json": { | ||
"schema": { | |||
" | "$ref": "#/components/schemas/TransferSessionCreationOptions" | ||
} | } | ||
} | } | ||
}, | }, | ||
" | "required": true | ||
"description": " | }, | ||
"responses": { | |||
"404": { | |||
"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": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/Error" | "$ref": "#/components/schemas/Error" | ||
} | |||
} | |||
} | } | ||
} | } | ||
}, | }, | ||
" | "201": { | ||
"description": " | "description": "Created the transfer session. The 'Location' header will contain the URL of the created session." | ||
}, | |||
"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": { | "content": { | ||
"application/json": { | "application/json": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/Error" | "$ref": "#/components/schemas/Error" | ||
} | |||
} | |||
} | } | ||
} | } | ||
}, | }, | ||
"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 * 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": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/Error" | "$ref": "#/components/schemas/Error" | ||
} | |||
} | |||
} | } | ||
} | } | ||
}, | } | ||
}, | |||
" | "security": [ | ||
{ | |||
"verification": [] | |||
} | |||
] | |||
} | |||
}, | |||
"/users/{email-address}/transfer-sessions/{tracking-id}": { | |||
"get": { | |||
"tags": [ | |||
"transfer-session" | |||
], | |||
"summary": "Returns an existing transfer session. Note that all properties will be present.", | |||
"operationId": "getSession", | |||
"parameters": [ | |||
{ | |||
"name": "email-address", | |||
"in": "path", | |||
"description": "User to send as.", | |||
"required": true, | |||
"schema": { | |||
"type": "string" | |||
} | } | ||
}, | }, | ||
{ | |||
"name": "tracking-id", | |||
{ | |||
"name": " | |||
"in": "path", | "in": "path", | ||
"description": "The | "description": "The tracking ID.", | ||
"required": true, | "required": true, | ||
"schema": { | "schema": { | ||
"type": "string" | "type": "string" | ||
} | } | ||
}, | }, | ||
{ | { | ||
"name": " | "name": "X-CS-ProductKey", | ||
"in": " | "in": "header", | ||
"description": "The | "description": "The key of the product that the requesting client belongs to. Default is set to 'api.rest'. Can also be specified by query parameter (product-key).", | ||
"schema": { | "schema": { | ||
"type": "string", | "type": "string", | ||
" | "example": "client.Owa" | ||
} | } | ||
}, | }, | ||
{ | { | ||
"name": "X-CS- | "name": "X-CS-ClientId", | ||
"in": "header", | "in": "header", | ||
"description": "The | "description": "The ID that uniquely identifies the requesting client. Can also be specified by query parameter (client-id). Should be treated as confidential.", | ||
"required": | "required": true, | ||
"schema": { | "schema": { | ||
" | "maxLength": 4000, | ||
" | "minLength": 50, | ||
"pattern": "^[a-zA-Z0-9]+$", | |||
"type": "string" | |||
} | } | ||
}, | }, | ||
{ | { | ||
"name": " | "name": "X-CS-MajorApiVersion", | ||
"in": " | "in": "header", | ||
"description": "The | "description": "The major version of the API to use. Can also be specified by query parameter (major-api-version).", | ||
"required": | "required": true, | ||
"schema": { | "schema": { | ||
"minimum": 0, | |||
"type": "integer", | "type": "integer", | ||
" | "example": 1 | ||
} | } | ||
}, | }, | ||
{ | { | ||
" | "name": "X-CS-MinimumMinorApiVersion", | ||
"in": "header", | |||
"description": "The minimum minor version of the API that the client requires. Can also be specified by query parameter (minimum-minor-api-version).", | |||
" | "required": true, | ||
"schema": { | |||
"minimum": 0, | |||
" | "type": "integer", | ||
"example": 9 | |||
} | |||
} | } | ||
], | ], | ||
"responses": { | "responses": { | ||
"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" | |||
} | |||
} | |||
} | |||
}, | |||
"200": { | "200": { | ||
"description": "OK.", | "description": "OK.", | ||
"content": { | "content": { | ||
"application/ | "application/json": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/ | "$ref": "#/components/schemas/ResponseTransferSessionTransferSecurityModeObject" | ||
} | |||
} | |||
} | } | ||
} | } | ||
}, | }, | ||
" | "403": { | ||
"description": " | "description": "The client is not allowed to perform the requested operation.\n * 3001 - Product not licensed.", | ||
"content": { | "content": { | ||
"application/json": { | "application/json": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/Error" | "$ref": "#/components/schemas/Error" | ||
} | |||
} | |||
} | } | ||
} | } | ||
}, | }, | ||
"401": { | "401": { | ||
"description": " | "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": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/Error" | "$ref": "#/components/schemas/Error" | ||
} | |||
} | |||
} | } | ||
} | } | ||
}, | }, | ||
" | "400": { | ||
"description": " | "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": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/Error" | "$ref": "#/components/schemas/Error" | ||
} | |||
} | |||
} | } | ||
} | |||
} | |||
}, | |||
"security": [ | |||
{ | |||
"verification": [] | |||
} | |||
] | |||
}, | |||
"post": { | |||
"tags": [ | |||
"transfer-session" | |||
], | |||
"summary": "Submits an existing transfer session. Returns the location where the finalized transfer can be inspected", | |||
"operationId": "finalizeSession", | |||
"parameters": [ | |||
{ | |||
"name": "email-address", | |||
"in": "path", | |||
"description": "User to send as.", | |||
"required": true, | |||
"schema": { | |||
"type": "string" | |||
} | } | ||
}, | }, | ||
{ | |||
" | "name": "tracking-id", | ||
" | "in": "path", | ||
"description": "The tracking ID.", | |||
"required": true, | |||
"schema": { | |||
"type": "string" | |||
} | } | ||
}, | }, | ||
" | { | ||
"description": "The requested | "name": "X-CS-ProductKey", | ||
"in": "header", | |||
"description": "The key of the product that the requesting client belongs to. Default is set to 'api.rest'. Can also be specified by query parameter (product-key).", | |||
"schema": { | |||
"type": "string", | |||
"example": "client.Owa" | |||
} | |||
}, | |||
{ | |||
"name": "X-CS-ClientId", | |||
"in": "header", | |||
"description": "The ID that uniquely identifies the requesting client. Can also be specified by query parameter (client-id). Should be treated as confidential.", | |||
"required": true, | |||
"schema": { | |||
"maxLength": 4000, | |||
"minLength": 50, | |||
"pattern": "^[a-zA-Z0-9]+$", | |||
"type": "string" | |||
} | |||
}, | |||
{ | |||
"name": "X-CS-MajorApiVersion", | |||
"in": "header", | |||
"description": "The major version of the API to use. Can also be specified by query parameter (major-api-version).", | |||
"required": true, | |||
"schema": { | |||
"minimum": 0, | |||
"type": "integer", | |||
"example": 1 | |||
} | |||
}, | |||
{ | |||
"name": "X-CS-MinimumMinorApiVersion", | |||
"in": "header", | |||
"description": "The minimum minor version of the API that the client requires. Can also be specified by query parameter (minimum-minor-api-version).", | |||
"required": true, | |||
"schema": { | |||
"minimum": 0, | |||
"type": "integer", | |||
"example": 9 | |||
} | |||
} | |||
], | |||
"responses": { | |||
"404": { | |||
"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": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/Error" | "$ref": "#/components/schemas/Error" | ||
} | |||
} | |||
} | } | ||
} | } | ||
}, | }, | ||
" | "403": { | ||
"description": " | "description": "The client is not allowed to perform the requested operation.\n * 3001 - Product not licensed.\n ", | ||
"content": { | "content": { | ||
"application/json": { | "application/json": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/Error" | "$ref": "#/components/schemas/Error" | ||
} | |||
} | |||
} | } | ||
} | } | ||
}, | }, | ||
" | "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": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/Error" | "$ref": "#/components/schemas/Error" | ||
} | |||
} | |||
} | } | ||
} | } | ||
} | }, | ||
"201": { | |||
"description": "Created." | |||
}, | |||
"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" | |||
} | |||
} | |||
} | |||
} | |||
}, | |||
"security": [ | |||
{ | |||
"verification": [] | |||
} | |||
] | |||
}, | |||
"delete": { | |||
"tags": [ | "tags": [ | ||
" | "transfer-session" | ||
], | ], | ||
"summary": " | "summary": "Deletes an existing transfer session.", | ||
"operationId": " | "operationId": "deleteSession", | ||
"parameters": [ | "parameters": [ | ||
{ | { | ||
"name": " | "name": "email-address", | ||
"in": "path", | "in": "path", | ||
"description": " | "description": "User to send as.", | ||
"required": true, | "required": true, | ||
"schema": { | "schema": { | ||
"type": "string" | "type": "string" | ||
} | } | ||
}, | }, | ||
{ | { | ||
"name": " | "name": "tracking-id", | ||
"in": " | "in": "path", | ||
"description": "The | "description": "The tracking ID.", | ||
"required": | "required": true, | ||
"schema": { | "schema": { | ||
"type": "string" | "type": "string" | ||
} | } | ||
}, | }, | ||
{ | { | ||
"name": "X-CS- | "name": "X-CS-ProductKey", | ||
"in": "header", | "in": "header", | ||
"description": "The | "description": "The key of the product that the requesting client belongs to. Default is set to 'api.rest'. Can also be specified by query parameter (product-key).", | ||
"schema": { | "schema": { | ||
"type": "string", | "type": "string", | ||
" | "example": "client.Owa" | ||
} | } | ||
}, | }, | ||
{ | { | ||
"$ | "name": "X-CS-ClientId", | ||
"in": "header", | |||
"description": "The ID that uniquely identifies the requesting client. Can also be specified by query parameter (client-id). Should be treated as confidential.", | |||
"required": true, | |||
"schema": { | |||
"maxLength": 4000, | |||
"minLength": 50, | |||
"pattern": "^[a-zA-Z0-9]+$", | |||
"type": "string" | |||
} | |||
}, | }, | ||
{ | { | ||
" | "name": "X-CS-MajorApiVersion", | ||
"in": "header", | |||
"description": "The major version of the API to use. Can also be specified by query parameter (major-api-version).", | |||
"required": true, | |||
"schema": { | |||
"minimum": 0, | |||
"type": "integer", | |||
"example": 1 | |||
} | |||
}, | }, | ||
{ | { | ||
" | "name": "X-CS-MinimumMinorApiVersion", | ||
"in": "header", | |||
"description": "The minimum minor version of the API that the client requires. Can also be specified by query parameter (minimum-minor-api-version).", | |||
"required": true, | |||
"schema": { | |||
"minimum": 0, | |||
"type": "integer", | |||
"example": 9 | |||
} | |||
} | } | ||
], | ], | ||
"responses": { | "responses": { | ||
" | "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": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/ | "$ref": "#/components/schemas/Error" | ||
} | |||
} | |||
} | } | ||
} | } | ||
}, | }, | ||
" | "403": { | ||
"description": " | "description": "The client is not allowed to perform the requested operation.\n * 3001 - Product not licensed.", | ||
"content": { | "content": { | ||
"application/json": { | "application/json": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/Error" | "$ref": "#/components/schemas/Error" | ||
} | |||
} | |||
} | } | ||
} | } | ||
}, | }, | ||
" | "204": { | ||
"description": " | "description": "No Content.", | ||
"content": { | "content": { | ||
" | "*/*": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/ | "$ref": "#/components/schemas/ResponseVoid" | ||
} | |||
} | |||
} | } | ||
} | } | ||
}, | }, | ||
" | "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": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/Error" | "$ref": "#/components/schemas/Error" | ||
} | |||
} | |||
} | } | ||
} | } | ||
}, | }, | ||
" | "400": { | ||
"description": " | "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": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/Error" | "$ref": "#/components/schemas/Error" | ||
} | |||
} | |||
} | } | ||
} | } | ||
} | } | ||
} | }, | ||
"security": [ | |||
{ | |||
"verification": [] | |||
" | } | ||
] | |||
}, | |||
"patch": { | |||
"tags": [ | "tags": [ | ||
" | "transfer-session" | ||
], | ], | ||
"summary": " | "summary": "Edits an existing transfer session.", | ||
"operationId": " | "operationId": "editSession", | ||
"parameters": [ | "parameters": [ | ||
{ | { | ||
"name": " | "name": "email-address", | ||
"in": "path", | "in": "path", | ||
"description": " | "description": "User to send as.", | ||
"required": true, | "required": true, | ||
"schema": { | "schema": { | ||
"type": "string" | "type": "string" | ||
} | } | ||
}, | }, | ||
{ | { | ||
"name": " | "name": "tracking-id", | ||
"in": " | "in": "path", | ||
"description": "The | "description": "The tracking ID.", | ||
"required": | "required": true, | ||
"schema": { | "schema": { | ||
"type": "string" | "type": "string" | ||
} | } | ||
}, | }, | ||
{ | { | ||
"name": "X-CS- | "name": "X-CS-ProductKey", | ||
"in": "header", | "in": "header", | ||
"description": "The | "description": "The key of the product that the requesting client belongs to. Default is set to 'api.rest'. Can also be specified by query parameter (product-key).", | ||
"schema": { | "schema": { | ||
"type": "string", | "type": "string", | ||
" | "example": "client.Owa" | ||
} | } | ||
}, | }, | ||
{ | { | ||
"name": " | "name": "X-CS-ClientId", | ||
"in": " | "in": "header", | ||
"description": "The | "description": "The ID that uniquely identifies the requesting client. Can also be specified by query parameter (client-id). Should be treated as confidential.", | ||
"required": true, | "required": true, | ||
"schema": { | "schema": { | ||
" | "maxLength": 4000, | ||
" | "minLength": 50, | ||
"pattern": "^[a-zA-Z0-9]+$", | |||
"type": "string" | |||
} | } | ||
}, | }, | ||
{ | { | ||
" | "name": "X-CS-MajorApiVersion", | ||
"in": "header", | |||
"description": "The major version of the API to use. Can also be specified by query parameter (major-api-version).", | |||
"required": true, | |||
"schema": { | |||
"minimum": 0, | |||
"type": "integer", | |||
"example": 1 | |||
} | |||
}, | }, | ||
{ | { | ||
" | "name": "X-CS-MinimumMinorApiVersion", | ||
"in": "header", | |||
"description": "The minimum minor version of the API that the client requires. Can also be specified by query parameter (minimum-minor-api-version).", | |||
" | "required": true, | ||
"schema": { | |||
"minimum": 0, | |||
"type": "integer", | |||
"example": 9 | |||
} | |||
} | } | ||
], | ], | ||
"requestBody": { | |||
"content": { | |||
"application/json": { | |||
"schema": { | |||
"$ref": "#/components/schemas/TransferSessionPatchable" | |||
} | |||
} | |||
}, | |||
"required": true | |||
}, | |||
"responses": { | "responses": { | ||
" | "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": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/Error" | "$ref": "#/components/schemas/Error" | ||
} | |||
} | |||
} | } | ||
} | } | ||
}, | }, | ||
" | "200": { | ||
"description": " | "description": "OK.", | ||
"content": { | "content": { | ||
"application/json": { | "application/json": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/ | "$ref": "#/components/schemas/ResponseTransferSessionTransferSecurityModeObject" | ||
} | |||
} | |||
} | } | ||
} | } | ||
}, | }, | ||
"403": { | "403": { | ||
"description": "The client is not allowed to perform the requested operation. | "description": "The client is not allowed to perform the requested operation.\n * 3001 - Product not licensed.\n ", | ||
"content": { | "content": { | ||
"application/json": { | "application/json": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/Error" | "$ref": "#/components/schemas/Error" | ||
} | |||
} | |||
} | } | ||
} | } | ||
}, | }, | ||
" | "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": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/Error" | "$ref": "#/components/schemas/Error" | ||
} | |||
} | |||
} | } | ||
} | } | ||
}, | }, | ||
" | "400": { | ||
"description": " | "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": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/Error" | "$ref": "#/components/schemas/Error" | ||
} | |||
} | |||
} | } | ||
} | } | ||
} | } | ||
}, | |||
"security": [ | |||
{ | |||
"verification": [] | |||
} | |||
] | |||
" | |||
} | |||
} | } | ||
}, | }, | ||
"/ | "/users/{email-address}/transfer-sessions/{tracking-id}/files": { | ||
" | "post": { | ||
"tags": [ | "tags": [ | ||
" | "transfer-session" | ||
], | ], | ||
"summary": " | "summary": "Creates a new transfer file.", | ||
"operationId": " | "operationId": "createFile", | ||
"parameters": [ | "parameters": [ | ||
{ | { | ||
"name": " | "name": "email-address", | ||
"in": "path", | "in": "path", | ||
"description": " | "description": "User to send as.", | ||
"required": true, | "required": true, | ||
"schema": { | "schema": { | ||
"type": "string" | "type": "string" | ||
} | } | ||
}, | }, | ||
{ | { | ||
"name": " | "name": "tracking-id", | ||
"in": " | "in": "path", | ||
"description": "The | "description": "The tracking ID.", | ||
"required": | "required": true, | ||
"schema": { | "schema": { | ||
"type": "string" | "type": "string" | ||
} | } | ||
}, | }, | ||
{ | { | ||
"name": "X-CS- | "name": "X-CS-ProductKey", | ||
"in": "header", | "in": "header", | ||
"description": "The | "description": "The key of the product that the requesting client belongs to. Default is set to 'api.rest'. Can also be specified by query parameter (product-key).", | ||
"schema": { | "schema": { | ||
"type": "string", | "type": "string", | ||
" | "example": "client.Owa" | ||
} | } | ||
}, | }, | ||
{ | { | ||
"name": " | "name": "X-CS-ClientId", | ||
"in": " | "in": "header", | ||
"description": " | "description": "The ID that uniquely identifies the requesting client. Can also be specified by query parameter (client-id). Should be treated as confidential.", | ||
"required": | "required": true, | ||
"schema": { | "schema": { | ||
" | "maxLength": 4000, | ||
" | "minLength": 50, | ||
"pattern": "^[a-zA-Z0-9]+$", | |||
"type": "string" | |||
} | } | ||
}, | }, | ||
{ | { | ||
" | "name": "X-CS-MajorApiVersion", | ||
"in": "header", | |||
"description": "The major version of the API to use. Can also be specified by query parameter (major-api-version).", | |||
"required": true, | |||
"schema": { | |||
"minimum": 0, | |||
"type": "integer", | |||
"example": 1 | |||
} | |||
}, | }, | ||
{ | { | ||
" | "name": "X-CS-MinimumMinorApiVersion", | ||
"in": "header", | |||
"description": "The minimum minor version of the API that the client requires. Can also be specified by query parameter (minimum-minor-api-version).", | |||
" | "required": true, | ||
"schema": { | |||
"minimum": 0, | |||
"type": "integer", | |||
"example": 9 | |||
} | |||
} | } | ||
], | ], | ||
" | "requestBody": { | ||
" | "content": { | ||
"application/json": { | |||
"schema": { | |||
"$ref": "#/components/schemas/TransferFileCreationOptions" | |||
} | } | ||
} | } | ||
}, | }, | ||
" | "required": true | ||
"description": " | }, | ||
"responses": { | |||
"404": { | |||
"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": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/Error" | "$ref": "#/components/schemas/Error" | ||
} | |||
} | |||
} | } | ||
} | } | ||
}, | }, | ||
" | "403": { | ||
"description": " | "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": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/Error" | "$ref": "#/components/schemas/Error" | ||
} | |||
} | |||
} | } | ||
} | } | ||
}, | }, | ||
" | "201": { | ||
"description": "The | "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/ResponseTransferFileCreationOptions" | ||
} | |||
} | |||
} | } | ||
} | } | ||
}, | }, | ||
" | "400": { | ||
"description": " | "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": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/Error" | "$ref": "#/components/schemas/Error" | ||
} | |||
} | |||
} | } | ||
} | } | ||
} | } | ||
} | }, | ||
"security": [ | |||
{ | |||
"verification": [] | |||
} | |||
] | |||
} | } | ||
}, | }, | ||
"/ | "/users/{email-address}/transfer-policy": { | ||
" | "post": { | ||
"tags": [ | "tags": [ | ||
" | "transfer-policy" | ||
], | ], | ||
"summary": " | "summary": "Requests the policy for the user as sender and the given recipients.", | ||
"operationId": " | "operationId": "requestPolicy", | ||
"parameters": [ | "parameters": [ | ||
{ | { | ||
"name": " | "name": "email-address", | ||
"in": "path", | "in": "path", | ||
"description": " | "description": "User to send as.", | ||
"required": true, | "required": true, | ||
"schema": { | "schema": { | ||
"type": "string" | "type": "string" | ||
} | } | ||
}, | }, | ||
{ | { | ||
" | "name": "X-CS-ProductKey", | ||
"in": "header", | |||
"description": "The key of the product that the requesting client belongs to. Default is set to 'api.rest'. Can also be specified by query parameter (product-key).", | |||
"schema": { | |||
"type": "string", | |||
"example": "client.Owa" | |||
} | |||
}, | }, | ||
{ | { | ||
"$ | "name": "X-CS-ClientId", | ||
"in": "header", | |||
"description": "The ID that uniquely identifies the requesting client. Can also be specified by query parameter (client-id). Should be treated as confidential.", | |||
"required": true, | |||
"schema": { | |||
"maxLength": 4000, | |||
"minLength": 50, | |||
"pattern": "^[a-zA-Z0-9]+$", | |||
"type": "string" | |||
} | |||
}, | }, | ||
{ | { | ||
" | "name": "X-CS-MajorApiVersion", | ||
"in": "header", | |||
"description": "The major version of the API to use. Can also be specified by query parameter (major-api-version).", | |||
"required": true, | |||
"schema": { | |||
"minimum": 0, | |||
"type": "integer", | |||
"example": 1 | |||
} | |||
}, | }, | ||
{ | { | ||
" | "name": "X-CS-MinimumMinorApiVersion", | ||
"in": "header", | |||
"description": "The minimum minor version of the API that the client requires. Can also be specified by query parameter (minimum-minor-api-version).", | |||
"required": true, | |||
"schema": { | |||
"minimum": 0, | |||
"type": "integer", | |||
"example": 9 | |||
} | |||
} | } | ||
], | ], | ||
"requestBody": { | |||
"content": { | |||
"application/json": { | |||
"schema": { | |||
"$ref": "#/components/schemas/TransferPolicyRequest" | |||
} | |||
} | |||
}, | |||
"required": true | |||
}, | |||
"responses": { | "responses": { | ||
"200": { | "200": { | ||
"description": " | "description": "Success.", | ||
"content": { | "content": { | ||
"application/json": { | "application/json": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/ | "$ref": "#/components/schemas/ResponseTransferPolicyResult" | ||
} | |||
} | |||
} | } | ||
} | } | ||
}, | }, | ||
" | "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": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/Error" | "$ref": "#/components/schemas/Error" | ||
} | |||
} | |||
} | } | ||
} | } | ||
}, | }, | ||
" | "400": { | ||
"description": " | "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": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/Error" | "$ref": "#/components/schemas/Error" | ||
} | |||
} | |||
} | } | ||
} | } | ||
}, | }, | ||
" | "403": { | ||
"description": "The requested | "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": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/Error" | "$ref": "#/components/schemas/Error" | ||
} | |||
} | |||
} | } | ||
} | } | ||
} | } | ||
} | }, | ||
"security": [ | |||
{ | |||
"verification": [] | |||
} | |||
] | |||
} | } | ||
}, | }, | ||
"/ | "/password": { | ||
"get": { | "get": { | ||
"tags": [ | "tags": [ | ||
" | "password" | ||
], | ], | ||
"summary": "Returns a | "summary": "Returns a generated, valid password.", | ||
"operationId": " | "operationId": "generatePassword", | ||
"parameters": [ | "parameters": [ | ||
{ | { | ||
"name": " | "name": "X-CS-ProductKey", | ||
"in": " | "in": "header", | ||
"description": "The | "description": "The key of the product that the requesting client belongs to. Default is set to 'api.rest'. Can also be specified by query parameter (product-key).", | ||
"schema": { | "schema": { | ||
"type": "string", | "type": "string", | ||
" | "example": "client.Owa" | ||
} | } | ||
}, | }, | ||
{ | { | ||
"name": " | "name": "X-CS-ClientId", | ||
"in": " | "in": "header", | ||
"description": "The | "description": "The ID that uniquely identifies the requesting client. Can also be specified by query parameter (client-id). Should be treated as confidential.", | ||
"required": | "required": true, | ||
"schema": { | "schema": { | ||
" | "maxLength": 4000, | ||
" | "minLength": 50, | ||
" | "pattern": "^[a-zA-Z0-9]+$", | ||
"type": "string" | |||
} | } | ||
}, | }, | ||
{ | { | ||
" | "name": "X-CS-MajorApiVersion", | ||
"in": "header", | |||
"description": "The major version of the API to use. Can also be specified by query parameter (major-api-version).", | |||
"required": true, | |||
"schema": { | |||
"minimum": 0, | |||
"type": "integer", | |||
"example": 1 | |||
} | |||
}, | }, | ||
{ | { | ||
" | "name": "X-CS-MinimumMinorApiVersion", | ||
"in": "header", | |||
"description": "The minimum minor version of the API that the client requires. Can also be specified by query parameter (minimum-minor-api-version).", | |||
"required": true, | |||
"schema": { | |||
"minimum": 0, | |||
"type": "integer", | |||
"example": 9 | |||
} | |||
} | } | ||
], | ], | ||
"responses": { | "responses": { | ||
" | "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": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/ | "$ref": "#/components/schemas/Error" | ||
} | |||
} | |||
} | } | ||
} | } | ||
}, | }, | ||
" | "200": { | ||
"description": " | "description": "OK.", | ||
"content": { | "content": { | ||
"application/json": { | "application/json": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/ | "$ref": "#/components/schemas/ResponsePassword-Wrapper" | ||
} | |||
} | |||
} | } | ||
} | } | ||
| Zeile 1.386: | Zeile 1.422: | ||
"application/json": { | "application/json": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/Error" | "$ref": "#/components/schemas/Error" | ||
} | |||
} | |||
} | } | ||
} | } | ||
}, | }, | ||
" | "401": { | ||
"description": "The requested | "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": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/Error" | "$ref": "#/components/schemas/Error" | ||
} | |||
} | |||
} | } | ||
} | } | ||
}, | }, | ||
" | "400": { | ||
"description": " | "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": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/Error" | "$ref": "#/components/schemas/Error" | ||
} | |||
} | |||
} | } | ||
} | } | ||
} | } | ||
} | } | ||
}, | |||
"post": { | |||
" | |||
"tags": [ | "tags": [ | ||
" | "password" | ||
], | ], | ||
"summary": " | "summary": "Requests the validation of a given password against the current password requirements.", | ||
"operationId": " | "operationId": "validatePassword", | ||
"parameters": [ | "parameters": [ | ||
{ | { | ||
"name": " | "name": "X-CS-ProductKey", | ||
"in": " | "in": "header", | ||
"description": "The | "description": "The key of the product that the requesting client belongs to. Default is set to 'api.rest'. Can also be specified by query parameter (product-key).", | ||
"schema": { | "schema": { | ||
"type": "string", | "type": "string", | ||
" | "example": "client.Owa" | ||
} | } | ||
}, | }, | ||
{ | { | ||
"name": " | "name": "X-CS-ClientId", | ||
"in": " | "in": "header", | ||
"description": "The ID | "description": "The ID that uniquely identifies the requesting client. Can also be specified by query parameter (client-id). Should be treated as confidential.", | ||
"required": true, | "required": true, | ||
"schema": { | "schema": { | ||
" | "maxLength": 4000, | ||
" | "minLength": 50, | ||
"pattern": "^[a-zA-Z0-9]+$", | |||
"type": "string" | |||
} | } | ||
}, | }, | ||
{ | { | ||
" | "name": "X-CS-MajorApiVersion", | ||
"in": "header", | |||
"description": "The major version of the API to use. Can also be specified by query parameter (major-api-version).", | |||
"required": true, | |||
"schema": { | |||
"minimum": 0, | |||
"type": "integer", | |||
"example": 1 | |||
} | |||
}, | }, | ||
{ | { | ||
" | "name": "X-CS-MinimumMinorApiVersion", | ||
"in": "header", | |||
"description": "The minimum minor version of the API that the client requires. Can also be specified by query parameter (minimum-minor-api-version).", | |||
" | "required": true, | ||
"schema": { | |||
"minimum": 0, | |||
"type": "integer", | |||
"example": 9 | |||
} | |||
} | } | ||
], | ], | ||
"requestBody": { | |||
"content": { | |||
"application/json": { | |||
"schema": { | |||
"$ref": "#/components/schemas/Password-Wrapper" | |||
} | |||
} | |||
}, | |||
"required": true | |||
}, | |||
"responses": { | "responses": { | ||
" | "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": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/ | "$ref": "#/components/schemas/Error" | ||
} | |||
} | |||
} | } | ||
} | } | ||
}, | }, | ||
" | "200": { | ||
"description": " | "description": "OK.", | ||
"content": { | "content": { | ||
"application/json": { | "application/json": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/ | "$ref": "#/components/schemas/ResponsePasswordValidationResult" | ||
} | |||
} | |||
} | } | ||
} | } | ||
| Zeile 1.493: | Zeile 1.536: | ||
"application/json": { | "application/json": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/Error" | "$ref": "#/components/schemas/Error" | ||
} | |||
} | |||
} | } | ||
} | } | ||
}, | }, | ||
" | "401": { | ||
"description": "The requested | "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": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/Error" | "$ref": "#/components/schemas/Error" | ||
} | |||
} | |||
} | } | ||
} | } | ||
}, | }, | ||
" | "400": { | ||
"description": " | "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": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/Error" | "$ref": "#/components/schemas/Error" | ||
} | |||
} | |||
} | } | ||
} | } | ||
| Zeile 1.527: | Zeile 1.564: | ||
} | } | ||
}, | }, | ||
"/ | "/logs": { | ||
" | "post": { | ||
"tags": [ | "tags": [ | ||
" | "logging" | ||
], | ], | ||
"summary": " | "summary": "Creates a single log message on the Cryptshare Server for the purpose of remote logging.", | ||
"operationId": " | "operationId": "addLogEvent", | ||
"parameters": [ | "parameters": [ | ||
{ | { | ||
"name": " | "name": "X-CS-ProductKey", | ||
"in": " | "in": "header", | ||
"description": "The | "description": "The key of the product that the requesting client belongs to. Default is set to 'api.rest'. Can also be specified by query parameter (product-key).", | ||
"schema": { | "schema": { | ||
"type": "string", | "type": "string", | ||
" | "example": "client.Owa" | ||
} | } | ||
}, | }, | ||
{ | { | ||
"name": " | "name": "X-CS-ClientId", | ||
"in": " | "in": "header", | ||
"description": "The ID | "description": "The ID that uniquely identifies the requesting client. Can also be specified by query parameter (client-id). Should be treated as confidential.", | ||
"required": true, | "required": true, | ||
"schema": { | "schema": { | ||
" | "maxLength": 4000, | ||
" | "minLength": 50, | ||
"pattern": "^[a-zA-Z0-9]+$", | |||
"type": "string" | |||
} | } | ||
}, | }, | ||
{ | { | ||
" | "name": "X-CS-MajorApiVersion", | ||
"in": "header", | |||
"description": "The major version of the API to use. Can also be specified by query parameter (major-api-version).", | |||
"required": true, | |||
"schema": { | |||
"minimum": 0, | |||
"type": "integer", | |||
"example": 1 | |||
} | |||
}, | }, | ||
{ | { | ||
" | "name": "X-CS-MinimumMinorApiVersion", | ||
"in": "header", | |||
"description": "The minimum minor version of the API that the client requires. Can also be specified by query parameter (minimum-minor-api-version).", | |||
" | "required": true, | ||
"schema": { | |||
"minimum": 0, | |||
"type": "integer", | |||
"example": 9 | |||
} | |||
} | } | ||
], | ], | ||
" | "requestBody": { | ||
"description": "The log entry to be logged remotely.", | |||
"content": { | |||
"application/json": { | |||
"schema": { | |||
"type": "array", | |||
"items": { | |||
"$ref": "#/components/schemas/LogEntry" | |||
" | } | ||
} | |||
} | } | ||
} | } | ||
}, | }, | ||
" | "required": true | ||
"description": " | }, | ||
"responses": { | |||
"404": { | |||
"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": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/Error" | "$ref": "#/components/schemas/Error" | ||
} | |||
} | |||
} | } | ||
} | } | ||
}, | }, | ||
"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 * 3004 - Remote logging not permitted.", | ||
"content": { | "content": { | ||
"application/json": { | "application/json": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/Error" | "$ref": "#/components/schemas/Error" | ||
} | |||
} | |||
} | } | ||
} | } | ||
}, | }, | ||
" | "400": { | ||
"description": " | "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).", | ||
"content": { | "content": { | ||
"application/json": { | "application/json": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/Error" | "$ref": "#/components/schemas/Error" | ||
} | |||
} | |||
} | } | ||
} | } | ||
}, | }, | ||
" | "201": { | ||
"description": " | "description": "The resource was created successfully" | ||
} | } | ||
} | } | ||
} | } | ||
}, | }, | ||
"/ | "/users/{email-address}/verification": { | ||
"get": { | "get": { | ||
"tags": [ | "tags": [ | ||
" | "verification" | ||
], | ], | ||
"summary": "Returns | "summary": "Returns if an active verification for the provided mail exists, and what verification methods are available.", | ||
"operationId": " | "operationId": "getVerificationStatus", | ||
"parameters": [ | "parameters": [ | ||
{ | { | ||
"name": " | "name": "email-address", | ||
"in": "path", | "in": "path", | ||
"required": true, | "required": true, | ||
"schema": { | "schema": { | ||
"type": "string" | "type": "string" | ||
} | } | ||
}, | }, | ||
{ | { | ||
" | "name": "X-CS-VerificationToken", | ||
"in": "header", | |||
"description": "The verification token to check.", | |||
"required": false, | |||
"schema": { | |||
"type": "string" | |||
} | |||
}, | }, | ||
{ | { | ||
" | "name": "X-CS-ProductKey", | ||
"in": "header", | |||
"description": "The key of the product that the requesting client belongs to. Default is set to 'api.rest'. Can also be specified by query parameter (product-key).", | |||
"schema": { | |||
"type": "string", | |||
"example": "client.Owa" | |||
} | |||
}, | }, | ||
{ | { | ||
"$ | "name": "X-CS-ClientId", | ||
"in": "header", | |||
"description": "The ID that uniquely identifies the requesting client. Can also be specified by query parameter (client-id). Should be treated as confidential.", | |||
"required": true, | |||
"schema": { | |||
"maxLength": 4000, | |||
"minLength": 50, | |||
"pattern": "^[a-zA-Z0-9]+$", | |||
"type": "string" | |||
} | |||
}, | }, | ||
{ | { | ||
" | "name": "X-CS-MajorApiVersion", | ||
"in": "header", | |||
"description": "The major version of the API to use. Can also be specified by query parameter (major-api-version).", | |||
"required": true, | |||
"schema": { | |||
"minimum": 0, | |||
"type": "integer", | |||
"example": 1 | |||
} | |||
}, | |||
{ | |||
"name": "X-CS-MinimumMinorApiVersion", | |||
"in": "header", | |||
"description": "The minimum minor version of the API that the client requires. Can also be specified by query parameter (minimum-minor-api-version).", | |||
"required": true, | |||
"schema": { | |||
"minimum": 0, | |||
"type": "integer", | |||
"example": 9 | |||
} | |||
} | } | ||
], | ], | ||
"responses": { | "responses": { | ||
" | "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": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/ | "$ref": "#/components/schemas/Error" | ||
} | |||
} | |||
} | } | ||
} | } | ||
}, | }, | ||
" | "403": { | ||
"description": " | "description": "The client is not allowed to perform the requested operation.\n * 3001 - Product not licensed.\n * 3002 - Invalid verification data.", | ||
"content": { | "content": { | ||
"application/json": { | "application/json": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/Error" | "$ref": "#/components/schemas/Error" | ||
} | |||
} | |||
} | } | ||
} | } | ||
}, | }, | ||
" | "200": { | ||
"description": " | "description": "OK.", | ||
"content": { | "content": { | ||
"application/json": { | "application/json": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/ | "$ref": "#/components/schemas/ResponseVerificationStatus" | ||
} | |||
} | |||
} | } | ||
} | } | ||
}, | }, | ||
" | "400": { | ||
"description": " | "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": { | "content": { | ||
"application/json": { | "application/json": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/Error" | "$ref": "#/components/schemas/Error" | ||
} | |||
} | |||
} | } | ||
} | } | ||
}, | }, | ||
" | "501": { | ||
"description": "Server error occurred | "description": "Server error occurred.", | ||
"content": { | "content": { | ||
"application/json": { | "application/json": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/Error" | "$ref": "#/components/schemas/Error" | ||
} | |||
} | |||
} | } | ||
} | } | ||
| Zeile 1.731: | Zeile 1.790: | ||
} | } | ||
}, | }, | ||
"/ | "/users/{email-address}/transfers": { | ||
"get": { | "get": { | ||
"tags": [ | "tags": [ | ||
" | "transfer" | ||
], | ], | ||
"summary": "Returns a | "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": "getAllTransfers", | ||
"parameters": [ | "parameters": [ | ||
{ | { | ||
" | "name": "email-address", | ||
"in": "path", | |||
"required": true, | |||
"schema": { | |||
"type": "string" | |||
} | |||
}, | }, | ||
{ | { | ||
" | "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.", | |||
"required": false, | |||
"schema": { | |||
"type": "integer", | |||
"format": "int32", | |||
"default": 10 | |||
} | |||
}, | }, | ||
{ | { | ||
" | "name": "page", | ||
"in": "query", | |||
"description": "Pagination index, 1-indexed. Default page: 1.", | |||
"required": false, | |||
"schema": { | |||
"type": "integer", | |||
"format": "int32", | |||
"default": 1 | |||
} | |||
}, | }, | ||
{ | { | ||
"$ | "name": "X-CS-ProductKey", | ||
} | "in": "header", | ||
], | "description": "The key of the product that the requesting client belongs to. Default is set to 'api.rest'. Can also be specified by query parameter (product-key).", | ||
"schema": { | |||
"type": "string", | |||
"example": "client.Owa" | |||
} | |||
}, | |||
{ | |||
"name": "X-CS-ClientId", | |||
"in": "header", | |||
"description": "The ID that uniquely identifies the requesting client. Can also be specified by query parameter (client-id). Should be treated as confidential.", | |||
"required": true, | |||
"schema": { | |||
"maxLength": 4000, | |||
"minLength": 50, | |||
"pattern": "^[a-zA-Z0-9]+$", | |||
"type": "string" | |||
} | |||
}, | |||
{ | |||
"name": "X-CS-MajorApiVersion", | |||
"in": "header", | |||
"description": "The major version of the API to use. Can also be specified by query parameter (major-api-version).", | |||
"required": true, | |||
"schema": { | |||
"minimum": 0, | |||
"type": "integer", | |||
"example": 1 | |||
} | |||
}, | |||
{ | |||
"name": "X-CS-MinimumMinorApiVersion", | |||
"in": "header", | |||
"description": "The minimum minor version of the API that the client requires. Can also be specified by query parameter (minimum-minor-api-version).", | |||
"required": true, | |||
"schema": { | |||
"minimum": 0, | |||
"type": "integer", | |||
"example": 9 | |||
} | |||
} | |||
], | |||
"responses": { | "responses": { | ||
"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" | |||
} | |||
} | |||
} | |||
}, | |||
"200": { | "200": { | ||
"description": "OK.", | "description": "OK.", | ||
| Zeile 1.758: | Zeile 1.888: | ||
"application/json": { | "application/json": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/ | "$ref": "#/components/schemas/ResponseListTransferBasicInfoDto" | ||
} | |||
} | |||
} | } | ||
} | } | ||
}, | }, | ||
" | "403": { | ||
"description": " | "description": "The client is not allowed to perform the requested operation.\n * 3001 - Product not licensed.", | ||
"content": { | "content": { | ||
"application/json": { | "application/json": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/Error" | "$ref": "#/components/schemas/Error" | ||
} | |||
} | |||
} | } | ||
} | } | ||
| Zeile 1.782: | Zeile 1.908: | ||
"application/json": { | "application/json": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/Error" | "$ref": "#/components/schemas/Error" | ||
} | |||
} | |||
} | } | ||
} | } | ||
}, | }, | ||
" | "400": { | ||
"description": " | "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": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/Error" | "$ref": "#/components/schemas/Error" | ||
} | |||
} | } | ||
} | } | ||
} | } | ||
} | }, | ||
}, | "security": [ | ||
" | { | ||
"verification": [] | |||
} | |||
] | |||
} | |||
}, | |||
"/users/{email-address}/transfers/{tracking-id}": { | |||
"get": { | |||
"tags": [ | "tags": [ | ||
" | "transfer" | ||
], | ], | ||
"summary": " | "summary": "Returns the details of a given transfer for its sender, including processing errors.", | ||
"operationId": " | "operationId": "getTransferDetails", | ||
"parameters": [ | "parameters": [ | ||
{ | { | ||
" | "name": "email-address", | ||
"in": "path", | |||
"description": "User that sent this transfer.", | |||
"required": true, | |||
"schema": { | |||
"type": "string" | |||
} | |||
}, | }, | ||
{ | { | ||
" | "name": "tracking-id", | ||
}, | "in": "path", | ||
"description": "The tracking ID.", | |||
"required": true, | |||
"schema": { | |||
"type": "string" | |||
} | |||
}, | |||
{ | |||
"name": "X-CS-ProductKey", | |||
"in": "header", | |||
"description": "The key of the product that the requesting client belongs to. Default is set to 'api.rest'. Can also be specified by query parameter (product-key).", | |||
"schema": { | |||
"type": "string", | |||
"example": "client.Owa" | |||
} | |||
}, | |||
{ | { | ||
"$ | "name": "X-CS-ClientId", | ||
"in": "header", | |||
"description": "The ID that uniquely identifies the requesting client. Can also be specified by query parameter (client-id). Should be treated as confidential.", | |||
"required": true, | |||
"schema": { | |||
"maxLength": 4000, | |||
"minLength": 50, | |||
"pattern": "^[a-zA-Z0-9]+$", | |||
"type": "string" | |||
} | |||
}, | }, | ||
{ | { | ||
" | "name": "X-CS-MajorApiVersion", | ||
"in": "header", | |||
"description": "The major version of the API to use. Can also be specified by query parameter (major-api-version).", | |||
"required": true, | |||
"schema": { | |||
"minimum": 0, | |||
"type": "integer", | |||
"example": 1 | |||
} | |||
}, | |||
{ | |||
"name": "X-CS-MinimumMinorApiVersion", | |||
"in": "header", | |||
"description": "The minimum minor version of the API that the client requires. Can also be specified by query parameter (minimum-minor-api-version).", | |||
"required": true, | |||
"schema": { | |||
"minimum": 0, | |||
"type": "integer", | |||
"example": 9 | |||
} | |||
} | } | ||
], | ], | ||
"responses": { | "responses": { | ||
" | "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": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/ | "$ref": "#/components/schemas/Error" | ||
} | |||
} | |||
} | } | ||
} | } | ||
}, | }, | ||
" | "200": { | ||
"description": " | "description": "OK.", | ||
"content": { | "content": { | ||
"application/json": { | "application/json": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/ | "$ref": "#/components/schemas/ResponseTransferStatus" | ||
} | |||
} | |||
} | } | ||
} | } | ||
| Zeile 1.900: | Zeile 2.027: | ||
"application/json": { | "application/json": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/Error" | "$ref": "#/components/schemas/Error" | ||
} | |||
} | |||
} | } | ||
} | } | ||
}, | }, | ||
" | "401": { | ||
"description": "The requested | "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": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/Error" | "$ref": "#/components/schemas/Error" | ||
} | |||
} | |||
} | } | ||
} | } | ||
}, | }, | ||
" | "400": { | ||
"description": " | "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": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/Error" | "$ref": "#/components/schemas/Error" | ||
} | |||
} | |||
} | } | ||
} | } | ||
} | } | ||
} | }, | ||
"security": [ | |||
{ | |||
"verification": [] | |||
} | |||
] | |||
} | } | ||
}, | }, | ||
"/ | "/transfers/{transfer-id}": { | ||
"get": { | "get": { | ||
"tags": [ | "tags": [ | ||
" | "download" | ||
], | ], | ||
"summary": "Returns the | "summary": "Returns the transfer information.", | ||
"operationId": " | "operationId": "getTransferInformation", | ||
"parameters": [ | "parameters": [ | ||
{ | { | ||
" | "name": "transfer-id", | ||
"in": "path", | |||
"description": "The transfer ID of the transfer whose information is requested.", | |||
"required": true, | |||
"schema": { | |||
"type": "string", | |||
"example": "AATga41O4m" | |||
} | |||
}, | }, | ||
{ | { | ||
" | "name": "password", | ||
}, | "in": "query", | ||
"description": "The URL encoded password for the transfer (can be specified by query parameter or header).", | |||
"required": false, | |||
"schema": { | |||
"type": "string", | |||
"example": "passw0rd" | |||
} | |||
}, | |||
{ | |||
"name": "X-CS-Password", | |||
"in": "header", | |||
"description": "The URL encoded password for the transfer (can be specified by query parameter or header).", | |||
"required": false, | |||
"schema": { | |||
"type": "string", | |||
"example": "passw0rd" | |||
} | |||
}, | |||
{ | { | ||
" | "name": "X-CS-ProductKey", | ||
"in": "header", | |||
"description": "The key of the product that the requesting client belongs to. Default is set to 'api.rest'. Can also be specified by query parameter (product-key).", | |||
"schema": { | |||
"type": "string", | |||
"example": "client.Owa" | |||
} | |||
}, | }, | ||
{ | { | ||
"$ | "name": "X-CS-ClientId", | ||
"in": "header", | |||
"description": "The ID that uniquely identifies the requesting client. Can also be specified by query parameter (client-id). Should be treated as confidential.", | |||
"required": true, | |||
"schema": { | |||
"maxLength": 4000, | |||
"minLength": 50, | |||
"pattern": "^[a-zA-Z0-9]+$", | |||
"type": "string" | |||
} | |||
}, | |||
{ | |||
"name": "X-CS-MajorApiVersion", | |||
"in": "header", | |||
"description": "The major version of the API to use. Can also be specified by query parameter (major-api-version).", | |||
"required": true, | |||
"schema": { | |||
"minimum": 0, | |||
"type": "integer", | |||
"example": 1 | |||
} | |||
}, | |||
{ | |||
"name": "X-CS-MinimumMinorApiVersion", | |||
"in": "header", | |||
"description": "The minimum minor version of the API that the client requires. Can also be specified by query parameter (minimum-minor-api-version).", | |||
"required": true, | |||
"schema": { | |||
"minimum": 0, | |||
"type": "integer", | |||
"example": 9 | |||
} | |||
} | } | ||
], | ], | ||
"responses": { | "responses": { | ||
" | "501": { | ||
"description": " | "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/ | "$ref": "#/components/schemas/Error" | ||
} | |||
} | |||
} | } | ||
} | } | ||
}, | }, | ||
" | "410": { | ||
"description": " | "description": "The requested entity is deleted with this request.\n * 2006 - Transfer is deleted with this request", | ||
"content": { | |||
"application/json": { | |||
"schema": { | |||
"$ref": "#/components/schemas/Error" | |||
} | |||
} | |||
} | |||
}, | |||
"403": { | |||
"description": "The client is not allowed to perform the requested operation.\n * 2005 - Specified entity is locked/blocked (e.g. Transfer locked)\n * 3001 - Product not licensed.", | |||
"content": { | "content": { | ||
"application/json": { | "application/json": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/Error" | "$ref": "#/components/schemas/Error" | ||
} | |||
} | |||
} | } | ||
} | } | ||
}, | }, | ||
" | "404": { | ||
"description": "The | "description": "The requested resource was not found.\n * 1006 - Specified endpoint does not exist.\n * 2003 - Specified entity does not exists (e.g. transferId does not exist)\n * 2004 - Specified version is not supported.", | ||
"content": { | "content": { | ||
"application/json": { | "application/json": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/Error" | "$ref": "#/components/schemas/Error" | ||
} | |||
} | |||
} | } | ||
} | } | ||
}, | }, | ||
" | "200": { | ||
"description": " | "description": "OK.", | ||
"content": { | "content": { | ||
"application/json": { | "application/json": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/ | "$ref": "#/components/schemas/ResponseTransferInfo" | ||
} | |||
} | |||
} | } | ||
} | } | ||
}, | }, | ||
" | "401": { | ||
"description": " | "description": "Unauthorized.\n * 3003 - Wrong transfer password", | ||
"content": { | "content": { | ||
"application/json": { | "application/json": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/Error" | "$ref": "#/components/schemas/Error" | ||
} | |||
} | |||
} | } | ||
} | } | ||
}, | }, | ||
" | "400": { | ||
"description": " | "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. transferId).", | ||
"content": { | "content": { | ||
"application/json": { | "application/json": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/Error" | "$ref": "#/components/schemas/Error" | ||
} | |||
} | |||
} | } | ||
} | } | ||
| Zeile 2.031: | Zeile 2.216: | ||
} | } | ||
}, | }, | ||
"/ | "/transfers/{transfer-id}/zip": { | ||
" | "get": { | ||
"tags": [ | "tags": [ | ||
" | "download" | ||
], | ], | ||
"summary": " | "summary": "Returns a ZIP file download stream including all transfer files of this transfer. \nTo customize the locale of the checksums, the 'Accept-Language' header can be used.", | ||
"operationId": " | "operationId": "downloadZip", | ||
"parameters": [ | "parameters": [ | ||
{ | { | ||
" | "name": "transfer-id", | ||
}, | "in": "path", | ||
"description": "The transfer ID of the transfer whose files are requested.", | |||
"required": true, | |||
"schema": { | |||
"type": "string", | |||
"example": "AATga41O4m" | |||
} | |||
}, | |||
{ | { | ||
" | "name": "password", | ||
"in": "query", | |||
"description": "The URL encoded password for the transfer (can be specified by query parameter or header).", | |||
"required": false, | |||
"schema": { | |||
"type": "string", | |||
"example": "passw0rd" | |||
} | |||
}, | }, | ||
{ | { | ||
" | "name": "X-CS-Password", | ||
"in": "header", | |||
"description": "The URL encoded password for the transfer (can be specified by query parameter or header).", | |||
"required": false, | |||
"schema": { | |||
"type": "string", | |||
"example": "passw0rd" | |||
} | |||
}, | }, | ||
{ | { | ||
" | "name": "include-checksum-file", | ||
"in": "query", | |||
"description": "If the checksum file from the checksum endpoint should be included in the ZIP file.", | |||
"required": false, | |||
"schema": { | |||
" | "type": "boolean", | ||
"default": false | |||
" | |||
} | } | ||
}, | }, | ||
" | { | ||
"description": "The | "name": "X-CS-ProductKey", | ||
"in": "header", | |||
"description": "The key of the product that the requesting client belongs to. Default is set to 'api.rest'. Can also be specified by query parameter (product-key).", | |||
"schema": { | |||
"type": "string", | |||
"example": "client.Owa" | |||
} | |||
}, | |||
{ | |||
"name": "X-CS-ClientId", | |||
"in": "header", | |||
"description": "The ID that uniquely identifies the requesting client. Can also be specified by query parameter (client-id). Should be treated as confidential.", | |||
"required": true, | |||
"schema": { | |||
"maxLength": 4000, | |||
"minLength": 50, | |||
"pattern": "^[a-zA-Z0-9]+$", | |||
"type": "string" | |||
} | |||
}, | |||
{ | |||
"name": "X-CS-MajorApiVersion", | |||
"in": "header", | |||
"description": "The major version of the API to use. Can also be specified by query parameter (major-api-version).", | |||
"required": true, | |||
"schema": { | |||
"minimum": 0, | |||
"type": "integer", | |||
"example": 1 | |||
} | |||
}, | }, | ||
" | { | ||
"description": " | "name": "X-CS-MinimumMinorApiVersion", | ||
"in": "header", | |||
"description": "The minimum minor version of the API that the client requires. Can also be specified by query parameter (minimum-minor-api-version).", | |||
"required": true, | |||
"schema": { | |||
"minimum": 0, | |||
"type": "integer", | |||
"example": 9 | |||
} | |||
} | |||
], | |||
"responses": { | |||
"501": { | |||
"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" | ||
} | |||
} | |||
} | } | ||
} | } | ||
}, | }, | ||
" | "410": { | ||
"description": "The | "description": "The requested entity is deleted with this request.\n * 2006 - Transfer is deleted with this request", | ||
"content": { | "content": { | ||
"application/json": { | "application/json": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/Error" | "$ref": "#/components/schemas/Error" | ||
} | |||
} | |||
} | } | ||
} | } | ||
}, | }, | ||
" | "403": { | ||
"description": "The requested | "description": "The client is not allowed to perform the requested operation.\n * 2005 - Specified entity is locked/blocked (e.g. Transfer locked)\n * 3001 - Product not licensed.", | ||
"content": { | "content": { | ||
"application/json": { | "application/json": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/Error" | "$ref": "#/components/schemas/Error" | ||
} | |||
} | |||
} | } | ||
} | } | ||
}, | }, | ||
" | "404": { | ||
"description": " | "description": "The requested resource was not found.\n * 1006 - Specified endpoint does not exist.\n * 2003 - Specified entity does not exists (e.g. transferId does not exist)\n * 2004 - Specified version is not supported.", | ||
"content": { | |||
"application/json": { | |||
"schema": { | |||
"$ref": "#/components/schemas/Error" | |||
} | |||
} | |||
} | |||
}, | |||
"401": { | |||
"description": "Unauthorized.\n * 3003 - Wrong transfer password", | |||
"content": { | |||
"application/json": { | |||
"schema": { | |||
"$ref": "#/components/schemas/Error" | |||
} | |||
} | |||
} | |||
}, | |||
"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. transferId).", | |||
"content": { | "content": { | ||
"application/json": { | "application/json": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/Error", | "$ref": "#/components/schemas/Error" | ||
} | |||
} | |||
} | |||
}, | |||
"200": { | |||
"description": "OK.", | |||
"content": { | |||
"application/zip": { | |||
"schema": { | |||
"type": "string", | |||
"format": "binary" | |||
} | |||
} | } | ||
} | } | ||
| Zeile 2.125: | Zeile 2.383: | ||
} | } | ||
}, | }, | ||
"/ | "/transfers/{transfer-id}/files": { | ||
"get": { | "get": { | ||
"tags": [ | "tags": [ | ||
" | "download" | ||
], | ], | ||
"summary": "Returns information | "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": "getTransferFilesInformation", | ||
"parameters": [ | "parameters": [ | ||
{ | { | ||
"name": " | "name": "transfer-id", | ||
"in": "path", | "in": "path", | ||
"description": "The | "description": "The transfer ID of the transfer whose information is requested.", | ||
"required": true, | "required": true, | ||
"schema": { | "schema": { | ||
"type": "string", | "type": "string", | ||
" | "example": "AATga41O4m" | ||
} | } | ||
}, | }, | ||
{ | { | ||
" | "name": "password", | ||
}, | "in": "query", | ||
"description": "The URL encoded password for the transfer (can be specified by query parameter or header).", | |||
"required": false, | |||
"schema": { | |||
"type": "string", | |||
"example": "passw0rd" | |||
} | |||
}, | |||
{ | { | ||
" | "name": "X-CS-Password", | ||
"in": "header", | |||
"description": "The URL encoded password for the transfer (can be specified by query parameter or header).", | |||
"required": false, | |||
"schema": { | |||
"type": "string", | |||
"example": "passw0rd" | |||
} | |||
}, | }, | ||
{ | { | ||
" | "name": "X-CS-ProductKey", | ||
"in": "header", | |||
"description": "The key of the product that the requesting client belongs to. Default is set to 'api.rest'. Can also be specified by query parameter (product-key).", | |||
"schema": { | |||
"type": "string", | |||
"example": "client.Owa" | |||
} | |||
}, | }, | ||
{ | { | ||
"$ | "name": "X-CS-ClientId", | ||
"in": "header", | |||
"description": "The ID that uniquely identifies the requesting client. Can also be specified by query parameter (client-id). Should be treated as confidential.", | |||
"required": true, | |||
"schema": { | |||
"maxLength": 4000, | |||
"minLength": 50, | |||
"pattern": "^[a-zA-Z0-9]+$", | |||
"type": "string" | |||
} | |||
}, | |||
{ | |||
"name": "X-CS-MajorApiVersion", | |||
"in": "header", | |||
"description": "The major version of the API to use. Can also be specified by query parameter (major-api-version).", | |||
"required": true, | |||
"schema": { | |||
"minimum": 0, | |||
"type": "integer", | |||
"example": 1 | |||
} | |||
}, | |||
{ | |||
"name": "X-CS-MinimumMinorApiVersion", | |||
"in": "header", | |||
"description": "The minimum minor version of the API that the client requires. Can also be specified by query parameter (minimum-minor-api-version).", | |||
"required": true, | |||
"schema": { | |||
"minimum": 0, | |||
"type": "integer", | |||
"example": 9 | |||
} | |||
} | } | ||
], | ], | ||
"responses": { | "responses": { | ||
" | "501": { | ||
"description": " | "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/ | "$ref": "#/components/schemas/Error" | ||
} | |||
} | |||
} | } | ||
} | } | ||
}, | }, | ||
" | "410": { | ||
"description": " | "description": "The requested entity is deleted with this request.\n * 2006 - Transfer is deleted with this request", | ||
"content": { | "content": { | ||
"application/json": { | "application/json": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/Error" | "$ref": "#/components/schemas/Error" | ||
} | |||
} | |||
} | } | ||
} | } | ||
}, | }, | ||
"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 * 2005 - Specified entity is locked/blocked (e.g. Transfer locked)\n * 3001 - Product not licensed.", | ||
"content": { | "content": { | ||
"application/json": { | "application/json": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/Error" | "$ref": "#/components/schemas/Error" | ||
} | |||
} | |||
} | } | ||
} | } | ||
}, | }, | ||
"404": { | "404": { | ||
"description": "The requested resource was not found.\n * 1006 - Specified endpoint does not exist.\n * 2003 - Specified entity does not exists\n * 2004 - Specified version is not supported.", | "description": "The requested resource was not found.\n * 1006 - Specified endpoint does not exist.\n * 2003 - Specified entity does not exists (e.g. transferId does not exist)\n * 2004 - Specified version is not supported.", | ||
"content": { | |||
"application/json": { | |||
"schema": { | |||
"$ref": "#/components/schemas/Error" | |||
} | |||
} | |||
} | |||
}, | |||
"200": { | |||
"description": "OK.", | |||
"content": { | |||
"application/json": { | |||
"schema": { | |||
"$ref": "#/components/schemas/ResponseListTransferFile" | |||
} | |||
} | |||
} | |||
}, | |||
"401": { | |||
"description": "Unauthorized.\n * 3003 - Wrong transfer password", | |||
"content": { | "content": { | ||
"application/json": { | "application/json": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/Error" | "$ref": "#/components/schemas/Error" | ||
} | |||
} | |||
} | } | ||
} | } | ||
}, | }, | ||
" | "400": { | ||
"description": " | "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. transferId).", | ||
"content": { | "content": { | ||
"application/json": { | "application/json": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/Error" | "$ref": "#/components/schemas/Error" | ||
} | |||
} | |||
} | } | ||
} | } | ||
| Zeile 2.221: | Zeile 2.539: | ||
} | } | ||
}, | }, | ||
"/ | "/transfers/{transfer-id}/files/{file-id}": { | ||
"get": { | "get": { | ||
"tags": [ | "tags": [ | ||
" | "download" | ||
], | ], | ||
"summary": "Returns a | "summary": "Returns a file download stream for a transfer file.", | ||
"operationId": " | "operationId": "downloadSingleFile", | ||
"parameters": [ | "parameters": [ | ||
{ | { | ||
"name": " | "name": "transfer-id", | ||
"in": "path", | "in": "path", | ||
"description": " | "description": "The transfer ID of the transfer whose file is requested.", | ||
"required": true, | "required": true, | ||
"schema": { | "schema": { | ||
"type": "string", | "type": "string", | ||
" | "example": "AATga41O4m" | ||
} | } | ||
}, | }, | ||
{ | { | ||
"name": " | "name": "password", | ||
"in": "query", | "in": "query", | ||
"description": " | "description": "The URL encoded password for the transfer (can be specified by query parameter or header).", | ||
"required": false, | "required": false, | ||
"schema": { | "schema": { | ||
"type": " | "type": "string", | ||
" | "example": "passw0rd" | ||
} | } | ||
}, | }, | ||
{ | { | ||
"name": " | "name": "X-CS-Password", | ||
"in": " | "in": "header", | ||
"description": " | "description": "The URL encoded password for the transfer (can be specified by query parameter or header).", | ||
"required": false, | "required": false, | ||
"schema": { | "schema": { | ||
"type": " | "type": "string", | ||
" | "example": "passw0rd" | ||
} | } | ||
}, | }, | ||
{ | { | ||
" | "name": "file-id", | ||
"in": "path", | |||
"description": "The file id of the file to download, retrieved from the files endpoint.", | |||
"required": true, | |||
"schema": { | |||
"type": "string", | |||
"example": "rP1t0njzTR" | |||
} | |||
}, | }, | ||
{ | { | ||
" | "name": "X-CS-ProductKey", | ||
"in": "header", | |||
"description": "The key of the product that the requesting client belongs to. Default is set to 'api.rest'. Can also be specified by query parameter (product-key).", | |||
"schema": { | |||
"type": "string", | |||
"example": "client.Owa" | |||
} | |||
}, | }, | ||
{ | { | ||
"$ | "name": "X-CS-ClientId", | ||
"in": "header", | |||
"description": "The ID that uniquely identifies the requesting client. Can also be specified by query parameter (client-id). Should be treated as confidential.", | |||
"required": true, | |||
"schema": { | |||
"maxLength": 4000, | |||
"minLength": 50, | |||
"pattern": "^[a-zA-Z0-9]+$", | |||
"type": "string" | |||
} | |||
}, | }, | ||
{ | { | ||
" | "name": "X-CS-MajorApiVersion", | ||
"in": "header", | |||
"description": "The major version of the API to use. Can also be specified by query parameter (major-api-version).", | |||
"required": true, | |||
"schema": { | |||
"minimum": 0, | |||
"type": "integer", | |||
"example": 1 | |||
} | |||
}, | |||
{ | |||
"name": "X-CS-MinimumMinorApiVersion", | |||
"in": "header", | |||
"description": "The minimum minor version of the API that the client requires. Can also be specified by query parameter (minimum-minor-api-version).", | |||
"required": true, | |||
"schema": { | |||
"minimum": 0, | |||
"type": "integer", | |||
"example": 9 | |||
} | |||
} | } | ||
], | ], | ||
"responses": { | "responses": { | ||
" | "501": { | ||
"description": " | "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/ | "$ref": "#/components/schemas/Error" | ||
} | |||
} | |||
} | } | ||
} | } | ||
}, | }, | ||
"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. | "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. transferId, fileId).", | ||
"content": { | |||
"application/json": { | |||
"schema": { | |||
"$ref": "#/components/schemas/Error" | |||
} | |||
} | |||
} | |||
}, | |||
"404": { | |||
"description": "The requested resource was not found.\n * 1006 - Specified endpoint does not exist.\n * 2003 - Specified entity does not exists (e.g. transferId or fileId does not exist)\n * 2004 - Specified version is not supported.", | |||
"content": { | "content": { | ||
"application/json": { | "application/json": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/Error" | "$ref": "#/components/schemas/Error" | ||
} | |||
} | |||
} | } | ||
} | } | ||
}, | }, | ||
" | "410": { | ||
"description": "The | "description": "The requested entity is deleted with this request.\n * 2006 - Transfer is deleted with this request", | ||
"content": { | "content": { | ||
"application/json": { | "application/json": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/Error" | "$ref": "#/components/schemas/Error" | ||
} | |||
} | |||
} | } | ||
} | } | ||
}, | }, | ||
"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 * 2005 - Specified entity is locked/blocked (e.g. Transfer locked)\n * 3001 - Product not licensed.", | ||
"content": { | "content": { | ||
"application/json": { | "application/json": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/Error" | "$ref": "#/components/schemas/Error" | ||
} | |||
} | |||
} | } | ||
} | } | ||
}, | }, | ||
" | "401": { | ||
"description": " | "description": "Unauthorized.\n * 3003 - Wrong transfer password", | ||
"content": { | "content": { | ||
"application/json": { | "application/json": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/Error" | "$ref": "#/components/schemas/Error" | ||
} | |||
} | |||
} | } | ||
} | } | ||
}, | }, | ||
" | "200": { | ||
"description": " | "description": "OK.", | ||
"content": { | "content": { | ||
"application/ | "application/octet-stream": { | ||
"schema": { | "schema": { | ||
" | "type": "string", | ||
" | "format": "binary" | ||
} | } | ||
} | } | ||
} | } | ||
} | } | ||
} | } | ||
} | } | ||
}, | }, | ||
" | "/transfers/{transfer-id}/eml": { | ||
"get": { | "get": { | ||
"tags": [ | "tags": [ | ||
" | "download" | ||
], | ], | ||
"summary": "Returns the | "summary": "Returns an EML file download stream including the confidential message with attachments embedded.", | ||
"operationId": " | "operationId": "downloadEml", | ||
"parameters": [ | "parameters": [ | ||
{ | { | ||
"name": " | "name": "transfer-id", | ||
"in": "path", | "in": "path", | ||
"description": " | "description": "The transfer ID of the transfer whose files are requested.", | ||
"required": true, | "required": true, | ||
"schema": { | "schema": { | ||
"type": "string", | "type": "string", | ||
" | "example": "AATga41O4m" | ||
} | } | ||
}, | }, | ||
{ | { | ||
"name": " | "name": "password", | ||
"in": " | "in": "query", | ||
"description": "The | "description": "The URL encoded password for the transfer (can be specified by query parameter or header).", | ||
"required": | "required": false, | ||
"schema": { | "schema": { | ||
"type": "string", | "type": "string", | ||
" | "example": "passw0rd" | ||
} | } | ||
}, | }, | ||
{ | { | ||
" | "name": "X-CS-Password", | ||
"in": "header", | |||
"description": "The URL encoded password for the transfer (can be specified by query parameter or header).", | |||
"required": false, | |||
"schema": { | |||
"type": "string", | |||
"example": "passw0rd" | |||
} | |||
}, | }, | ||
{ | { | ||
" | "name": "threshold", | ||
"in": "query", | |||
"description": "The threshold in megabytes for embedding attachments to the EML body.", | |||
"required": false, | |||
"schema": { | |||
"type": "integer", | |||
"format": "int32" | |||
} | |||
}, | }, | ||
{ | { | ||
" | "name": "X-CS-ProductKey", | ||
"in": "header", | |||
"description": "The key of the product that the requesting client belongs to. Default is set to 'api.rest'. Can also be specified by query parameter (product-key).", | |||
"schema": { | |||
"type": "string", | |||
"example": "client.Owa" | |||
} | |||
}, | }, | ||
{ | { | ||
" | "name": "X-CS-ClientId", | ||
"in": "header", | |||
"description": "The ID that uniquely identifies the requesting client. Can also be specified by query parameter (client-id). Should be treated as confidential.", | |||
"required": true, | |||
"schema": { | |||
"maxLength": 4000, | |||
"minLength": 50, | |||
" | "pattern": "^[a-zA-Z0-9]+$", | ||
"type": "string" | |||
} | |||
}, | |||
{ | |||
"name": "X-CS-MajorApiVersion", | |||
"in": "header", | |||
"description": "The major version of the API to use. Can also be specified by query parameter (major-api-version).", | |||
"required": true, | |||
"schema": { | |||
"minimum": 0, | |||
"type": "integer", | |||
"example": 1 | |||
} | } | ||
}, | }, | ||
" | { | ||
"description": " | "name": "X-CS-MinimumMinorApiVersion", | ||
"in": "header", | |||
"description": "The minimum minor version of the API that the client requires. Can also be specified by query parameter (minimum-minor-api-version).", | |||
"required": true, | |||
"schema": { | |||
"minimum": 0, | |||
"type": "integer", | |||
"example": 9 | |||
} | |||
} | |||
], | |||
"responses": { | |||
"501": { | |||
"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" | ||
} | |||
} | |||
} | } | ||
} | } | ||
}, | }, | ||
" | "410": { | ||
"description": "The | "description": "The requested entity is deleted with this request.\n * 2006 - Transfer is deleted with this request", | ||
"content": { | "content": { | ||
"application/json": { | "application/json": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/Error" | "$ref": "#/components/schemas/Error" | ||
} | |||
} | |||
} | } | ||
} | } | ||
}, | }, | ||
"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 * 2005 - Specified entity is locked/blocked (e.g. Transfer locked)\n * 3001 - Product not licensed.", | ||
"content": { | "content": { | ||
"application/json": { | "application/json": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/Error" | "$ref": "#/components/schemas/Error" | ||
} | |||
} | |||
} | } | ||
} | } | ||
}, | }, | ||
"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 * 2003 - Specified entity does not exists (e.g. transferId does not exist)\n * 2004 - Specified version is not supported.", | ||
"content": { | "content": { | ||
"application/json": { | "application/json": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/Error" | "$ref": "#/components/schemas/Error" | ||
} | |||
} | |||
} | } | ||
} | } | ||
}, | }, | ||
" | "401": { | ||
"description": " | "description": "Unauthorized.\n * 3003 - Wrong transfer password", | ||
"content": { | "content": { | ||
"application/json": { | "application/json": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/Error", | "$ref": "#/components/schemas/Error" | ||
" | } | ||
}, | } | ||
" | } | ||
}, | |||
"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. transferId).", | |||
"content": { | |||
"application/json": { | |||
"schema": { | |||
"$ref": "#/components/schemas/Error" | |||
} | |||
} | |||
} | |||
}, | |||
"200": { | |||
"description": "OK.", | |||
"content": { | |||
"application/octet-stream": { | |||
"schema": { | |||
"type": "string", | |||
"format": "binary" | |||
} | |||
} | } | ||
} | } | ||
} | } | ||
} | } | ||
} | } | ||
}, | }, | ||
"/ | "/transfers/{transfer-id}/checksums": { | ||
" | "get": { | ||
"tags": [ | "tags": [ | ||
" | "download" | ||
], | ], | ||
"summary": " | "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": "downloadChecksums", | ||
"parameters": [ | "parameters": [ | ||
{ | { | ||
"name": " | "name": "transfer-id", | ||
"in": "path", | "in": "path", | ||
"description": " | "description": "The transfer ID of the transfer whose information is requested.", | ||
"required": true, | "required": true, | ||
"schema": { | "schema": { | ||
"type": "string", | "type": "string", | ||
" | "example": "AATga41O4m" | ||
} | } | ||
}, | }, | ||
{ | { | ||
" | "name": "password", | ||
"in": "query", | |||
"description": "The URL encoded password for the transfer (can be specified by query parameter or header).", | |||
"required": false, | |||
"schema": { | |||
"type": "string", | |||
"example": "passw0rd" | |||
} | |||
}, | }, | ||
{ | { | ||
" | "name": "X-CS-Password", | ||
"in": "header", | |||
"description": "The URL encoded password for the transfer (can be specified by query parameter or header).", | |||
"required": false, | |||
"schema": { | |||
"type": "string", | |||
"example": "passw0rd" | |||
} | |||
}, | |||
{ | |||
"name": "X-CS-ProductKey", | |||
"in": "header", | |||
"description": "The key of the product that the requesting client belongs to. Default is set to 'api.rest'. Can also be specified by query parameter (product-key).", | |||
"schema": { | |||
"type": "string", | |||
"example": "client.Owa" | |||
} | |||
}, | }, | ||
{ | { | ||
"$ | "name": "X-CS-ClientId", | ||
"in": "header", | |||
"description": "The ID that uniquely identifies the requesting client. Can also be specified by query parameter (client-id). Should be treated as confidential.", | |||
"required": true, | |||
"schema": { | |||
"maxLength": 4000, | |||
"minLength": 50, | |||
"pattern": "^[a-zA-Z0-9]+$", | |||
"type": "string" | |||
} | |||
}, | }, | ||
{ | { | ||
" | "name": "X-CS-MajorApiVersion", | ||
"in": "header", | |||
"description": "The major version of the API to use. Can also be specified by query parameter (major-api-version).", | |||
"required": true, | |||
"schema": { | |||
"minimum": 0, | |||
"type": "integer", | |||
"example": 1 | |||
} | |||
}, | |||
{ | |||
"name": "X-CS-MinimumMinorApiVersion", | |||
"in": "header", | |||
"description": "The minimum minor version of the API that the client requires. Can also be specified by query parameter (minimum-minor-api-version).", | |||
"required": true, | |||
"schema": { | |||
"minimum": 0, | |||
"type": "integer", | |||
"example": 9 | |||
} | |||
} | } | ||
], | ], | ||
"responses": { | "responses": { | ||
" | "501": { | ||
"description": " | "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/ | "$ref": "#/components/schemas/Error" | ||
} | |||
} | |||
} | } | ||
} | } | ||
}, | }, | ||
" | "410": { | ||
"description": " | "description": "The requested entity is deleted with this request.\n * 2006 - Transfer is deleted with this request", | ||
"content": { | "content": { | ||
"application/json": { | "application/json": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/Error" | "$ref": "#/components/schemas/Error" | ||
} | |||
} | |||
} | } | ||
} | } | ||
}, | }, | ||
"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 * 2005 - Specified entity is locked/blocked (e.g. Transfer locked)\n * 3001 - Product not licensed.", | ||
"content": { | "content": { | ||
"application/json": { | "application/json": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/Error" | "$ref": "#/components/schemas/Error" | ||
} | |||
} | |||
} | } | ||
} | } | ||
}, | }, | ||
"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 * 2003 - Specified entity does not exists (e.g. transferId does not exist)\n * 2004 - Specified version is not supported.", | ||
"content": { | "content": { | ||
"application/json": { | "application/json": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/Error" | "$ref": "#/components/schemas/Error" | ||
} | |||
} | |||
} | } | ||
} | } | ||
}, | }, | ||
" | "401": { | ||
"description": " | "description": "Unauthorized.\n * 3003 - Wrong transfer password", | ||
"content": { | "content": { | ||
"application/json": { | "application/json": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/Error", | "$ref": "#/components/schemas/Error" | ||
" | } | ||
}, | } | ||
" | } | ||
}, | |||
"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. transferId).", | |||
"content": { | |||
"application/json": { | |||
"schema": { | |||
"$ref": "#/components/schemas/Error" | |||
} | |||
} | |||
} | |||
}, | |||
"200": { | |||
"description": "OK.", | |||
"content": { | |||
"text/csv": { | |||
"schema": { | |||
"type": "string" | |||
} | |||
} | } | ||
} | } | ||
} | } | ||
} | } | ||
} | } | ||
}, | }, | ||
"/ | "/products/{product-key}/logging": { | ||
" | "get": { | ||
"tags": [ | "tags": [ | ||
" | "logging" | ||
], | ], | ||
"summary": " | "summary": "Returns the logging settings for the given product and client.", | ||
"operationId": " | "operationId": "getLoggingSettings", | ||
"parameters": [ | "parameters": [ | ||
{ | { | ||
"name": " | "name": "product-key", | ||
"in": "path", | "in": "path", | ||
"description": " | "description": "The product key of the product the logging settings are requested for.", | ||
"required": true, | "required": true, | ||
"schema": { | "schema": { | ||
"type": "string", | "type": "string", | ||
" | "example": "client.owa" | ||
} | } | ||
}, | }, | ||
{ | { | ||
" | "name": "X-CS-ProductKey", | ||
"in": "header", | |||
"description": "The key of the product that the requesting client belongs to. Default is set to 'api.rest'. Can also be specified by query parameter (product-key).", | |||
"schema": { | |||
"type": "string", | |||
"example": "client.Owa" | |||
} | |||
}, | }, | ||
{ | { | ||
"$ | "name": "X-CS-ClientId", | ||
"in": "header", | |||
"description": "The ID that uniquely identifies the requesting client. Can also be specified by query parameter (client-id). Should be treated as confidential.", | |||
"required": true, | |||
"schema": { | |||
"maxLength": 4000, | |||
"minLength": 50, | |||
"pattern": "^[a-zA-Z0-9]+$", | |||
"type": "string" | |||
} | |||
}, | }, | ||
{ | { | ||
" | "name": "X-CS-MajorApiVersion", | ||
"in": "header", | |||
"description": "The major version of the API to use. Can also be specified by query parameter (major-api-version).", | |||
"required": true, | |||
"schema": { | |||
"minimum": 0, | |||
"type": "integer", | |||
"example": 1 | |||
} | |||
}, | }, | ||
{ | { | ||
" | "name": "X-CS-MinimumMinorApiVersion", | ||
"in": "header", | |||
"description": "The minimum minor version of the API that the client requires. Can also be specified by query parameter (minimum-minor-api-version).", | |||
"required": true, | |||
"schema": { | |||
"minimum": 0, | |||
"type": "integer", | |||
"example": 9 | |||
} | |||
} | } | ||
], | ], | ||
"responses": { | "responses": { | ||
" | "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": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/Error" | "$ref": "#/components/schemas/Error" | ||
} | |||
} | |||
} | } | ||
} | } | ||
}, | }, | ||
" | "200": { | ||
"description": " | "description": "OK.", | ||
"content": { | "content": { | ||
"application/json": { | "application/json": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/ | "$ref": "#/components/schemas/ResponseLoggingSettings" | ||
} | |||
} | |||
} | } | ||
} | } | ||
}, | }, | ||
" | "400": { | ||
"description": " | "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).", | ||
"content": { | "content": { | ||
"application/json": { | "application/json": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/Error" | "$ref": "#/components/schemas/Error" | ||
} | |||
} | |||
} | } | ||
} | } | ||
}, | }, | ||
" | "403": { | ||
"description": " | "description": "The client is not allowed to perform the requested operation.\n * 3001 - Product not licensed.", | ||
"content": { | "content": { | ||
"application/json": { | "application/json": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/Error" | "$ref": "#/components/schemas/Error" | ||
} | |||
} | |||
} | } | ||
} | } | ||
} | } | ||
} | } | ||
} | } | ||
}, | }, | ||
"/ | "/products/{product-key}/legal/terms-of-use": { | ||
"get": { | "get": { | ||
"tags": [ | "tags": [ | ||
" | "terms-of-use" | ||
], | ], | ||
"summary": "Returns | "summary": "Returns information about the provided terms of use.", | ||
"operationId": " | "operationId": "getTermsOfUse", | ||
"parameters": [ | "parameters": [ | ||
{ | { | ||
"name": " | "name": "product-key", | ||
"in": "path", | "in": "path", | ||
"description": " | "description": "The product key of the product whose terms of use are requested.", | ||
"required": true, | "required": true, | ||
"schema": { | "schema": { | ||
"type": "string", | "type": "string", | ||
" | "example": "api.rest" | ||
} | } | ||
}, | }, | ||
{ | { | ||
"name": " | "name": "X-CS-ProductKey", | ||
"in": " | "in": "header", | ||
"description": "The | "description": "The key of the product that the requesting client belongs to. Default is set to 'api.rest'. Can also be specified by query parameter (product-key).", | ||
"schema": { | "schema": { | ||
"type": "string", | "type": "string", | ||
" | "example": "client.Owa" | ||
} | } | ||
}, | }, | ||
{ | { | ||
"$ | "name": "X-CS-ClientId", | ||
"in": "header", | |||
"description": "The ID that uniquely identifies the requesting client. Can also be specified by query parameter (client-id). Should be treated as confidential.", | |||
"required": true, | |||
"schema": { | |||
"maxLength": 4000, | |||
"minLength": 50, | |||
"pattern": "^[a-zA-Z0-9]+$", | |||
"type": "string" | |||
} | |||
}, | }, | ||
{ | { | ||
" | "name": "X-CS-MajorApiVersion", | ||
"in": "header", | |||
"description": "The major version of the API to use. Can also be specified by query parameter (major-api-version).", | |||
"required": true, | |||
"schema": { | |||
"minimum": 0, | |||
"type": "integer", | |||
"example": 1 | |||
} | |||
}, | }, | ||
{ | { | ||
" | "name": "X-CS-MinimumMinorApiVersion", | ||
"in": "header", | |||
"description": "The minimum minor version of the API that the client requires. Can also be specified by query parameter (minimum-minor-api-version).", | |||
"required": true, | |||
"schema": { | |||
"minimum": 0, | |||
"type": "integer", | |||
"example": 9 | |||
} | |||
} | } | ||
], | ], | ||
| Zeile 2.746: | Zeile 3.203: | ||
"application/json": { | "application/json": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/ | "$ref": "#/components/schemas/ResponseTermsOfUseInfo" | ||
} | |||
} | |||
} | } | ||
} | } | ||
}, | }, | ||
"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).", | ||
"content": { | "content": { | ||
"application/json": { | "application/json": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/Error" | "$ref": "#/components/schemas/Error" | ||
} | |||
} | |||
} | } | ||
} | } | ||
| Zeile 2.782: | Zeile 3.223: | ||
"application/json": { | "application/json": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/Error" | "$ref": "#/components/schemas/Error" | ||
} | |||
} | |||
} | } | ||
} | } | ||
}, | }, | ||
"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 * 2003 - Specified entity does not exists\n * 2004 - Specified version is not supported.", | ||
"content": { | "content": { | ||
"application/json": { | "application/json": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/Error" | "$ref": "#/components/schemas/Error" | ||
} | |||
} | |||
} | } | ||
} | } | ||
} | } | ||
}, | } | ||
} | |||
}, | |||
"/products/{product-key}/legal/imprint": { | |||
"get": { | |||
"tags": [ | |||
"imprint" | |||
" | |||
"tags": [ | |||
" | |||
], | ], | ||
"summary": " | "summary": "Returns the imprint content.", | ||
"operationId": " | "operationId": "getImprint", | ||
"parameters": [ | "parameters": [ | ||
{ | { | ||
"name": " | "name": "product-key", | ||
"in": "path", | "in": "path", | ||
"description": " | "description": "The product key of the product whose imprint is requested.", | ||
"required": true, | "required": true, | ||
"schema": { | "schema": { | ||
"type": "string", | "type": "string", | ||
" | "example": "api.rest" | ||
} | } | ||
}, | }, | ||
{ | { | ||
"name": " | "name": "X-CS-ProductKey", | ||
"in": " | "in": "header", | ||
"description": "The | "description": "The key of the product that the requesting client belongs to. Default is set to 'api.rest'. Can also be specified by query parameter (product-key).", | ||
"schema": { | "schema": { | ||
"type": "string", | "type": "string", | ||
" | "example": "client.Owa" | ||
} | } | ||
}, | }, | ||
{ | { | ||
"$ | "name": "X-CS-ClientId", | ||
"in": "header", | |||
"description": "The ID that uniquely identifies the requesting client. Can also be specified by query parameter (client-id). Should be treated as confidential.", | |||
"required": true, | |||
"schema": { | |||
"maxLength": 4000, | |||
"minLength": 50, | |||
"pattern": "^[a-zA-Z0-9]+$", | |||
"type": "string" | |||
} | |||
}, | }, | ||
{ | { | ||
" | "name": "X-CS-MajorApiVersion", | ||
"in": "header", | |||
"description": "The major version of the API to use. Can also be specified by query parameter (major-api-version).", | |||
"required": true, | |||
"schema": { | |||
"minimum": 0, | |||
"type": "integer", | |||
"example": 1 | |||
} | |||
}, | }, | ||
{ | { | ||
" | "name": "X-CS-MinimumMinorApiVersion", | ||
"in": "header", | |||
"description": "The minimum minor version of the API that the client requires. Can also be specified by query parameter (minimum-minor-api-version).", | |||
"required": true, | |||
"schema": { | |||
"minimum": 0, | |||
"type": "integer", | |||
"example": 9 | |||
} | |||
} | } | ||
], | ], | ||
"responses": { | "responses": { | ||
" | "200": { | ||
"description": " | "description": "OK.", | ||
"content": { | "content": { | ||
"application/json": { | "application/json": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/ | "$ref": "#/components/schemas/ResponseImprint" | ||
} | |||
} | |||
} | } | ||
} | } | ||
}, | }, | ||
" | "400": { | ||
"description": " | "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).", | ||
"content": { | "content": { | ||
"application/json": { | "application/json": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/Error" | "$ref": "#/components/schemas/Error" | ||
} | |||
} | |||
} | } | ||
} | } | ||
}, | }, | ||
" | "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": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/Error" | "$ref": "#/components/schemas/Error" | ||
} | |||
} | |||
} | } | ||
} | } | ||
}, | }, | ||
" | "404": { | ||
"description": " | "description": "The requested resource was not found.\n * 1006 - Specified endpoint does not exist.\n * 2003 - Specified entity does not exists\n * 2004 - Specified version is not supported.", | ||
"content": { | "content": { | ||
"application/json": { | "application/json": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/Error" | "$ref": "#/components/schemas/Error" | ||
} | |||
} | |||
} | } | ||
} | } | ||
} | } | ||
}, | } | ||
} | |||
}, | |||
"/products/{product-key}/language-packs": { | |||
"get": { | |||
" | |||
"tags": [ | "tags": [ | ||
" | "language-packs" | ||
], | ], | ||
"summary": " | "summary": "Returns a list of installed language packs for the specified product.", | ||
"operationId": " | "operationId": "getAllLanguagePacks", | ||
"parameters": [ | "parameters": [ | ||
{ | { | ||
"name": " | "name": "product-key", | ||
"in": "path", | "in": "path", | ||
"description": " | "description": "The product key of the product the language pack is requested for.", | ||
"required": true, | "required": true, | ||
"schema": { | "schema": { | ||
"type": "string", | "type": "string", | ||
" | "example": "api.rest" | ||
} | } | ||
}, | }, | ||
{ | { | ||
"name": " | "name": "major-version", | ||
"in": " | "in": "query", | ||
"description": "The | "description": "The major-version of language packs. If specified, the returned list only contains language packs matching that version.", | ||
"required": | "required": false, | ||
"schema": { | "schema": { | ||
"type": "string", | "type": "string", | ||
" | "example": 5 | ||
} | } | ||
}, | }, | ||
{ | { | ||
" | "name": "X-CS-ProductKey", | ||
"in": "header", | |||
"description": "The key of the product that the requesting client belongs to. Default is set to 'api.rest'. Can also be specified by query parameter (product-key).", | |||
"schema": { | |||
"type": "string", | |||
"example": "client.Owa" | |||
} | |||
}, | }, | ||
{ | { | ||
"$ | "name": "X-CS-ClientId", | ||
"in": "header", | |||
"description": "The ID that uniquely identifies the requesting client. Can also be specified by query parameter (client-id). Should be treated as confidential.", | |||
"required": true, | |||
"schema": { | |||
"maxLength": 4000, | |||
"minLength": 50, | |||
"pattern": "^[a-zA-Z0-9]+$", | |||
"type": "string" | |||
} | |||
}, | }, | ||
{ | { | ||
" | "name": "X-CS-MajorApiVersion", | ||
"in": "header", | |||
"description": "The major version of the API to use. Can also be specified by query parameter (major-api-version).", | |||
"required": true, | |||
"schema": { | |||
"minimum": 0, | |||
"type": "integer", | |||
"example": 1 | |||
} | |||
}, | }, | ||
{ | { | ||
" | "name": "X-CS-MinimumMinorApiVersion", | ||
"in": "header", | |||
"description": "The minimum minor version of the API that the client requires. Can also be specified by query parameter (minimum-minor-api-version).", | |||
"required": true, | |||
"schema": { | |||
"minimum": 0, | |||
"type": "integer", | |||
"example": 9 | |||
} | |||
} | } | ||
], | ], | ||
"responses": { | "responses": { | ||
" | "200": { | ||
"description": " | "description": "OK", | ||
"content": { | "content": { | ||
" | "application/json": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/ | "$ref": "#/components/schemas/ResponseListLanguagePack" | ||
} | |||
} | |||
} | } | ||
} | } | ||
}, | }, | ||
" | "404": { | ||
"description": " | "description": "The requested resource was not found.\n * 1005 - Invalid path variable (e.g. lp-Id).\n * 1006 - Specified endpoint does not exist.\n * 2003 - Specified entity does not exists\n * 2004 - Specified version is not supported.", | ||
"content": { | "content": { | ||
"application/json": { | "application/json": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/Error" | "$ref": "#/components/schemas/Error" | ||
} | |||
} | |||
} | } | ||
} | } | ||
}, | }, | ||
" | "400": { | ||
"description": " | "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 ", | ||
"content": { | "content": { | ||
"application/json": { | "application/json": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/Error" | "$ref": "#/components/schemas/Error" | ||
} | |||
} | |||
} | } | ||
} | } | ||
| Zeile 3.017: | Zeile 3.455: | ||
"application/json": { | "application/json": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/Error" | "$ref": "#/components/schemas/Error" | ||
} | |||
} | } | ||
} | } | ||
} | } | ||
}, | } | ||
} | |||
}, | |||
"/products/{product-key}/language-packs/{lp-id}": { | |||
"get": { | |||
" | |||
"tags": [ | "tags": [ | ||
" | "language-packs" | ||
], | ], | ||
"summary": " | "summary": "Returns information (including download link) about a specific language pack", | ||
"operationId": " | "operationId": "getLanguagePack", | ||
"parameters": [ | "parameters": [ | ||
{ | { | ||
"name": " | "name": "product-key", | ||
"in": "path", | "in": "path", | ||
"description": " | "description": "The product key of the product the language pack is requested for.", | ||
"required": true, | "required": true, | ||
"schema": { | "schema": { | ||
"type": "string", | "type": "string", | ||
" | "example": "api.rest" | ||
} | } | ||
}, | }, | ||
{ | { | ||
"name": " | "name": "lp-id", | ||
"in": "path", | "in": "path", | ||
"description": "The | "description": "The ID of the specific language pack.", | ||
"required": true, | "required": true, | ||
"schema": { | "schema": { | ||
"type": "string", | "type": "string", | ||
" | "example": "en-US_2" | ||
} | } | ||
}, | }, | ||
{ | { | ||
" | "name": "X-CS-ProductKey", | ||
}, | "in": "header", | ||
"description": "The key of the product that the requesting client belongs to. Default is set to 'api.rest'. Can also be specified by query parameter (product-key).", | |||
"schema": { | |||
"type": "string", | |||
"example": "client.Owa" | |||
} | |||
}, | |||
{ | { | ||
"$ | "name": "X-CS-ClientId", | ||
"in": "header", | |||
"description": "The ID that uniquely identifies the requesting client. Can also be specified by query parameter (client-id). Should be treated as confidential.", | |||
"required": true, | |||
"schema": { | |||
"maxLength": 4000, | |||
"minLength": 50, | |||
"pattern": "^[a-zA-Z0-9]+$", | |||
"type": "string" | |||
} | |||
}, | }, | ||
{ | { | ||
" | "name": "X-CS-MajorApiVersion", | ||
"in": "header", | |||
"description": "The major version of the API to use. Can also be specified by query parameter (major-api-version).", | |||
"required": true, | |||
"schema": { | |||
"minimum": 0, | |||
"type": "integer", | |||
"example": 1 | |||
} | |||
}, | }, | ||
{ | { | ||
" | "name": "X-CS-MinimumMinorApiVersion", | ||
"in": "header", | |||
"description": "The minimum minor version of the API that the client requires. Can also be specified by query parameter (minimum-minor-api-version).", | |||
"required": true, | |||
"schema": { | |||
"minimum": 0, | |||
"type": "integer", | |||
"example": 9 | |||
} | |||
} | } | ||
], | ], | ||
"responses": { | "responses": { | ||
"200": { | "200": { | ||
"description": "OK | "description": "OK", | ||
"content": { | "content": { | ||
"application/json": { | "application/json": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/ | "$ref": "#/components/schemas/ResponseLanguagePack" | ||
} | |||
} | |||
} | } | ||
} | } | ||
}, | }, | ||
" | "404": { | ||
"description": " | "description": "The requested resource was not found.\n * 1005 - Invalid path variable (e.g. lp-Id).\n * 1006 - Specified endpoint does not exist.\n * 2003 - Specified entity does not exists\n * 2004 - Specified version is not supported.", | ||
"content": { | "content": { | ||
"application/json": { | "application/json": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/Error" | "$ref": "#/components/schemas/Error" | ||
} | |||
} | |||
} | } | ||
} | } | ||
}, | }, | ||
" | "400": { | ||
"description": " | "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 request parameter (e.g. productKey).", | ||
"content": { | "content": { | ||
"application/json": { | "application/json": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/Error" | "$ref": "#/components/schemas/Error" | ||
} | |||
} | |||
} | } | ||
} | } | ||
}, | }, | ||
" | "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": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/Error" | "$ref": "#/components/schemas/Error" | ||
} | |||
} | } | ||
} | } | ||
} | } | ||
} | } | ||
} | } | ||
}, | }, | ||
"/ | "/products/{product-key}/language-packs/{lp-id}/*/**": { | ||
" | "get": { | ||
"tags": [ | "tags": [ | ||
" | "language-packs" | ||
], | ], | ||
"summary": " | "summary": "Returns a resource (stream) of certain resource of a language pack.", | ||
"operationId": " | "operationId": "getLanguagePackFile", | ||
"parameters": [ | "parameters": [ | ||
{ | { | ||
"name": " | "name": "product-key", | ||
"in": "path", | "in": "path", | ||
"description": " | "description": "The product key of the product the language pack is requested for.", | ||
"required": true, | "required": true, | ||
"schema": { | "schema": { | ||
"type": "string", | "type": "string", | ||
" | "example": "api.rest" | ||
} | } | ||
}, | }, | ||
{ | { | ||
"name": " | "name": "lp-id", | ||
"in": "path", | "in": "path", | ||
"description": "The | "description": "The ID of the specific language pack.", | ||
"required": true, | "required": true, | ||
"schema": { | "schema": { | ||
"type": "string", | "type": "string", | ||
" | "example": "en-US_2" | ||
} | } | ||
}, | }, | ||
{ | { | ||
" | "name": "X-CS-ProductKey", | ||
"in": "header", | |||
"description": "The key of the product that the requesting client belongs to. Default is set to 'api.rest'. Can also be specified by query parameter (product-key).", | |||
"schema": { | |||
"type": "string", | |||
"example": "client.Owa" | |||
} | |||
}, | }, | ||
{ | { | ||
"$ | "name": "X-CS-ClientId", | ||
"in": "header", | |||
"description": "The ID that uniquely identifies the requesting client. Can also be specified by query parameter (client-id). Should be treated as confidential.", | |||
"required": true, | |||
"schema": { | |||
"maxLength": 4000, | |||
"minLength": 50, | |||
"pattern": "^[a-zA-Z0-9]+$", | |||
"type": "string" | |||
} | |||
}, | }, | ||
{ | { | ||
" | "name": "X-CS-MajorApiVersion", | ||
"in": "header", | |||
"description": "The major version of the API to use. Can also be specified by query parameter (major-api-version).", | |||
"required": true, | |||
"schema": { | |||
"minimum": 0, | |||
"type": "integer", | |||
"example": 1 | |||
} | |||
}, | }, | ||
{ | { | ||
" | "name": "X-CS-MinimumMinorApiVersion", | ||
"in": "header", | |||
"description": "The minimum minor version of the API that the client requires. Can also be specified by query parameter (minimum-minor-api-version).", | |||
"required": true, | |||
"schema": { | |||
"minimum": 0, | |||
"type": "integer", | |||
"example": 9 | |||
} | |||
} | } | ||
], | ], | ||
"responses": { | "responses": { | ||
" | "404": { | ||
"description": " | "description": "The requested resource was not found.\n * 1005 - Invalid path variable (e.g. lp-Id).\n * 1006 - Specified endpoint does not exist.\n * 2003 - Specified entity does not exists\n * 2004 - Specified version is not supported.", | ||
"content": { | "content": { | ||
"application/json": { | "application/json": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/ | "$ref": "#/components/schemas/Error" | ||
} | |||
} | |||
} | } | ||
} | } | ||
}, | }, | ||
" | "200": { | ||
"description": " | "description": "OK. Content type may be different, depending on the requested resource.", | ||
"content": { | "content": { | ||
" | "*/*": { | ||
"schema": { | "schema": { | ||
" | "type": "array", | ||
" | "items": { | ||
"type": "string", | |||
"format": "byte" | |||
} | |||
} | |||
} | } | ||
} | } | ||
}, | }, | ||
" | "400": { | ||
"description": " | "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).", | ||
"content": { | "content": { | ||
"application/json": { | "application/json": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/Error" | "$ref": "#/components/schemas/Error" | ||
} | |||
} | |||
} | } | ||
} | } | ||
}, | }, | ||
" | "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": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/Error" | "$ref": "#/components/schemas/Error" | ||
} | |||
} | |||
} | } | ||
} | } | ||
} | } | ||
} | } | ||
} | } | ||
}, | }, | ||
"/ | "/products/{product-key}/cors": { | ||
" | "get": { | ||
"tags": [ | "tags": [ | ||
" | "cors" | ||
], | ], | ||
"summary": " | "summary": "Returns the CORS status for the given product and requesting origin.", | ||
"operationId": " | "operationId": "getCorsStatus", | ||
"parameters": [ | "parameters": [ | ||
{ | { | ||
"name": " | "name": "product-key", | ||
"in": "path", | "in": "path", | ||
"description": " | "description": "The product key of the product whose CORS status is requested.", | ||
"required": true, | "required": true, | ||
"schema": { | "schema": { | ||
"type": "string", | "type": "string", | ||
" | "example": "api.rest" | ||
} | } | ||
}, | }, | ||
{ | { | ||
"name": " | "name": "Origin", | ||
"in": " | "in": "header", | ||
"description": "The | "description": "The origin header consists of scheme, host and port", | ||
"required": true, | "required": true, | ||
"schema": { | "schema": { | ||
"type": "string", | "type": "string", | ||
" | "example": "https://cryptshare.com" | ||
} | } | ||
}, | }, | ||
{ | { | ||
"name": " | "name": "X-CS-ProductKey", | ||
"in": " | "in": "header", | ||
"description": "The | "description": "The key of the product that the requesting client belongs to. Default is set to 'api.rest'. Can also be specified by query parameter (product-key).", | ||
"schema": { | "schema": { | ||
"type": "string", | "type": "string", | ||
" | "example": "client.Owa" | ||
} | } | ||
}, | }, | ||
{ | { | ||
"$ | "name": "X-CS-ClientId", | ||
"in": "header", | |||
"description": "The ID that uniquely identifies the requesting client. Can also be specified by query parameter (client-id). Should be treated as confidential.", | |||
"required": true, | |||
"schema": { | |||
"maxLength": 4000, | |||
"minLength": 50, | |||
"pattern": "^[a-zA-Z0-9]+$", | |||
"type": "string" | |||
} | |||
}, | }, | ||
{ | { | ||
" | "name": "X-CS-MajorApiVersion", | ||
"in": "header", | |||
"description": "The major version of the API to use. Can also be specified by query parameter (major-api-version).", | |||
"required": true, | |||
"schema": { | |||
"minimum": 0, | |||
"type": "integer", | |||
"example": 1 | |||
} | |||
}, | }, | ||
{ | { | ||
" | "name": "X-CS-MinimumMinorApiVersion", | ||
"in": "header", | |||
"description": "The minimum minor version of the API that the client requires. Can also be specified by query parameter (minimum-minor-api-version).", | |||
"required": true, | |||
"schema": { | |||
"minimum": 0, | |||
"type": "integer", | |||
"example": 9 | |||
} | |||
} | } | ||
], | ], | ||
"responses": { | "responses": { | ||
" | "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": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/ | "$ref": "#/components/schemas/Error" | ||
} | |||
} | |||
} | } | ||
} | } | ||
}, | }, | ||
" | "200": { | ||
"description": " | "description": "OK.", | ||
"content": { | "content": { | ||
"application/json": { | "application/json": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/ | "$ref": "#/components/schemas/ResponseCorsStatus" | ||
} | |||
} | |||
} | } | ||
} | } | ||
}, | }, | ||
"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": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/Error" | "$ref": "#/components/schemas/Error" | ||
} | |||
} | |||
} | } | ||
} | } | ||
}, | }, | ||
" | "400": { | ||
"description": " | "description": "A required query 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).", | ||
"content": { | "content": { | ||
"application/json": { | "application/json": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/Error" | "$ref": "#/components/schemas/Error" | ||
} | |||
} | |||
} | } | ||
} | } | ||
} | } | ||
} | |||
} | |||
}, | |||
"/products/client.owa/settings": { | |||
"get": { | |||
} | |||
}, | |||
"/ | |||
" | |||
"tags": [ | "tags": [ | ||
" | "products" | ||
], | ], | ||
"summary": " | "summary": "Returns the settings for the OWA add-in.", | ||
"operationId": " | "operationId": "getSettings", | ||
"parameters": [ | "parameters": [ | ||
{ | { | ||
"name": " | "name": "X-CS-ProductKey", | ||
"in": " | "in": "header", | ||
"description": " | "description": "The key of the product that the requesting client belongs to. Default is set to 'api.rest'. Can also be specified by query parameter (product-key).", | ||
"schema": { | "schema": { | ||
"type": "string", | "type": "string", | ||
" | "example": "client.Owa" | ||
} | } | ||
}, | }, | ||
{ | { | ||
"name": " | "name": "X-CS-ClientId", | ||
"in": " | "in": "header", | ||
"description": "The | "description": "The ID that uniquely identifies the requesting client. Can also be specified by query parameter (client-id). Should be treated as confidential.", | ||
"required": true, | "required": true, | ||
"schema": { | "schema": { | ||
" | "maxLength": 4000, | ||
" | "minLength": 50, | ||
"pattern": "^[a-zA-Z0-9]+$", | |||
"type": "string" | |||
} | } | ||
}, | }, | ||
{ | { | ||
"name": " | "name": "X-CS-MajorApiVersion", | ||
"in": " | "in": "header", | ||
"description": "The | "description": "The major version of the API to use. Can also be specified by query parameter (major-api-version).", | ||
"required": true, | "required": true, | ||
"schema": { | "schema": { | ||
"type": " | "minimum": 0, | ||
" | "type": "integer", | ||
"example": 1 | |||
} | } | ||
}, | }, | ||
{ | { | ||
" | "name": "X-CS-MinimumMinorApiVersion", | ||
"in": "header", | |||
"description": "The minimum minor version of the API that the client requires. Can also be specified by query parameter (minimum-minor-api-version).", | |||
" | "required": true, | ||
"schema": { | |||
"minimum": 0, | |||
" | "type": "integer", | ||
"example": 9 | |||
} | |||
} | } | ||
], | ], | ||
"responses": { | "responses": { | ||
" | "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": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/Error" | "$ref": "#/components/schemas/Error" | ||
} | |||
} | |||
} | } | ||
} | } | ||
}, | }, | ||
" | "200": { | ||
"description": " | "description": "OK.", | ||
"content": { | "content": { | ||
"application/json": { | "application/json": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/ | "$ref": "#/components/schemas/ResponseOwaSettings" | ||
} | |||
} | |||
} | } | ||
} | } | ||
}, | }, | ||
" | "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": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/Error" | "$ref": "#/components/schemas/Error" | ||
} | |||
} | |||
} | } | ||
} | } | ||
}, | }, | ||
" | "400": { | ||
"description": " | "description": "A required query 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).", | ||
"content": { | "content": { | ||
"application/json": { | "application/json": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/Error" | "$ref": "#/components/schemas/Error" | ||
} | |||
} | |||
} | } | ||
} | } | ||
} | } | ||
} | } | ||
} | } | ||
}, | }, | ||
"/ | "/password/requirements": { | ||
"get": { | "get": { | ||
"tags": [ | "tags": [ | ||
" | "password" | ||
], | ], | ||
"summary": "Returns | "summary": "Returns the currently active password requirements.", | ||
"operationId": " | "operationId": "getPasswordRequirements", | ||
"parameters": [ | "parameters": [ | ||
{ | { | ||
"name": " | "name": "X-CS-ProductKey", | ||
"in": " | "in": "header", | ||
"description": " | "description": "The key of the product that the requesting client belongs to. Default is set to 'api.rest'. Can also be specified by query parameter (product-key).", | ||
"schema": { | "schema": { | ||
"type": "string", | "type": "string", | ||
" | "example": "client.Owa" | ||
} | } | ||
}, | }, | ||
{ | { | ||
"name": "X-CS- | "name": "X-CS-ClientId", | ||
"in": "header", | "in": "header", | ||
"description": "The | "description": "The ID that uniquely identifies the requesting client. Can also be specified by query parameter (client-id). Should be treated as confidential.", | ||
"required": | "required": true, | ||
"schema": { | "schema": { | ||
" | "maxLength": 4000, | ||
" | "minLength": 50, | ||
"pattern": "^[a-zA-Z0-9]+$", | |||
"type": "string" | |||
} | } | ||
}, | }, | ||
{ | { | ||
" | "name": "X-CS-MajorApiVersion", | ||
"in": "header", | |||
"description": "The major version of the API to use. Can also be specified by query parameter (major-api-version).", | |||
"required": true, | |||
"schema": { | |||
"minimum": 0, | |||
"type": "integer", | |||
"example": 1 | |||
} | |||
}, | }, | ||
{ | { | ||
" | "name": "X-CS-MinimumMinorApiVersion", | ||
"in": "header", | |||
"description": "The minimum minor version of the API that the client requires. Can also be specified by query parameter (minimum-minor-api-version).", | |||
" | "required": true, | ||
"schema": { | |||
"minimum": 0, | |||
"type": "integer", | |||
"example": 9 | |||
} | |||
} | } | ||
], | ], | ||
"responses": { | "responses": { | ||
" | "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": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/ | "$ref": "#/components/schemas/Error" | ||
} | |||
} | |||
} | } | ||
} | } | ||
}, | }, | ||
" | "200": { | ||
"description": " | "description": "OK.", | ||
"content": { | "content": { | ||
"application/json": { | "application/json": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/ | "$ref": "#/components/schemas/ResponseArrayListPasswordValidationRule" | ||
} | |||
} | |||
} | } | ||
} | } | ||
}, | }, | ||
"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": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/Error" | "$ref": "#/components/schemas/Error" | ||
} | |||
} | |||
} | } | ||
} | } | ||
}, | }, | ||
" | "401": { | ||
"description": "The requested | "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": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/Error" | "$ref": "#/components/schemas/Error" | ||
} | |||
} | |||
} | } | ||
} | } | ||
}, | }, | ||
" | "400": { | ||
"description": " | "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": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/Error" | "$ref": "#/components/schemas/Error" | ||
} | |||
} | |||
} | } | ||
} | } | ||
| Zeile 3.679: | Zeile 4.017: | ||
} | } | ||
}, | }, | ||
"/ | "/clients": { | ||
" | "get": { | ||
"tags": [ | "tags": [ | ||
" | "client" | ||
], | ], | ||
"summary": "Requests a | "summary": "Requests a generated client id that can be used for all operations that require a client id.", | ||
"operationId": " | "operationId": "getVerificationStatus_1", | ||
"parameters": [ | "parameters": [ | ||
{ | { | ||
"name": " | "name": "X-CS-ProductKey", | ||
"in": " | "in": "header", | ||
"description": " | "description": "The key of the product that the requesting client belongs to. Default is set to 'api.rest'. Can also be specified by query parameter (product-key).", | ||
"schema": { | "schema": { | ||
"type": "string", | "type": "string", | ||
" | "example": "client.Owa" | ||
} | } | ||
}, | }, | ||
{ | { | ||
" | "name": "X-CS-MajorApiVersion", | ||
"in": "header", | |||
"description": "The major version of the API to use. Can also be specified by query parameter (major-api-version).", | |||
"required": true, | |||
"schema": { | |||
"minimum": 0, | |||
"type": "integer", | |||
"example": 1 | |||
} | |||
}, | }, | ||
{ | { | ||
" | "name": "X-CS-MinimumMinorApiVersion", | ||
"in": "header", | |||
"description": "The minimum minor version of the API that the client requires. Can also be specified by query parameter (minimum-minor-api-version).", | |||
" | "required": true, | ||
"schema": { | |||
"minimum": 0, | |||
"type": "integer", | |||
"example": 9 | |||
} | |||
} | } | ||
], | ], | ||
"responses": { | "responses": { | ||
"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- | "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-ProductKey).\n * 1004 - Invalid request parameter/header value (expected, but wrong format/syntax) (e.g. unknown product key).", | ||
"content": { | "content": { | ||
"application/json": { | "application/json": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/Error" | "$ref": "#/components/schemas/Error" | ||
} | |||
} | |||
} | } | ||
} | } | ||
}, | }, | ||
" | "404": { | ||
"description": "The | "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": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/Error" | "$ref": "#/components/schemas/Error" | ||
} | |||
} | |||
} | } | ||
} | } | ||
}, | }, | ||
" | "200": { | ||
"description": " | "description": "OK.", | ||
"content": { | "content": { | ||
"application/json": { | "application/json": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/ | "$ref": "#/components/schemas/ResponseClientId" | ||
} | |||
} | |||
} | } | ||
} | } | ||
}, | }, | ||
" | "403": { | ||
"description": " | "description": "The client is not allowed to perform the requested operation.\n * 3001 - Product not licensed.", | ||
"content": { | "content": { | ||
"application/json": { | "application/json": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/Error" | "$ref": "#/components/schemas/Error" | ||
} | |||
} | } | ||
} | } | ||
| Zeile 3.790: | Zeile 4.101: | ||
} | } | ||
}, | }, | ||
"/users/{email-address}/ | "/users/{email-address}/transfer-sessions/{tracking-id}/files/{file-id}": { | ||
" | "delete": { | ||
"tags": [ | "tags": [ | ||
" | "transfer-session" | ||
], | ], | ||
"summary": " | "summary": "Deletes an existing file from a transfer session.", | ||
"operationId": " | "operationId": "deleteFile", | ||
"parameters": [ | "parameters": [ | ||
{ | { | ||
"name": "email-address", | "name": "email-address", | ||
"in": "path", | "in": "path", | ||
"description": " | "description": "User to send as.", | ||
"required": true, | "required": true, | ||
"schema": { | "schema": { | ||
"type": "string" | "type": "string" | ||
} | } | ||
}, | }, | ||
{ | { | ||
" | "name": "tracking-id", | ||
"in": "path", | |||
"description": "The tracking ID.", | |||
"required": true, | |||
"schema": { | |||
"type": "string" | |||
} | |||
}, | }, | ||
{ | { | ||
" | "name": "file-id", | ||
}, | "in": "path", | ||
{ | "description": "The file ID to delete.", | ||
"$ | "required": true, | ||
"schema": { | |||
"type": "string" | |||
} | |||
}, | |||
{ | |||
"name": "X-CS-ProductKey", | |||
"in": "header", | |||
"description": "The key of the product that the requesting client belongs to. Default is set to 'api.rest'. Can also be specified by query parameter (product-key).", | |||
"schema": { | |||
"type": "string", | |||
"example": "client.Owa" | |||
} | |||
}, | |||
{ | |||
"name": "X-CS-ClientId", | |||
"in": "header", | |||
"description": "The ID that uniquely identifies the requesting client. Can also be specified by query parameter (client-id). Should be treated as confidential.", | |||
"required": true, | |||
"schema": { | |||
"maxLength": 4000, | |||
"minLength": 50, | |||
"pattern": "^[a-zA-Z0-9]+$", | |||
"type": "string" | |||
} | |||
}, | }, | ||
{ | { | ||
" | "name": "X-CS-MajorApiVersion", | ||
"in": "header", | |||
"description": "The major version of the API to use. Can also be specified by query parameter (major-api-version).", | |||
"required": true, | |||
"schema": { | |||
"minimum": 0, | |||
"type": "integer", | |||
"example": 1 | |||
} | |||
}, | |||
{ | |||
"name": "X-CS-MinimumMinorApiVersion", | |||
"in": "header", | |||
"description": "The minimum minor version of the API that the client requires. Can also be specified by query parameter (minimum-minor-api-version).", | |||
"required": true, | |||
"schema": { | |||
"minimum": 0, | |||
"type": "integer", | |||
"example": 9 | |||
} | |||
} | } | ||
], | ], | ||
"responses": { | "responses": { | ||
" | "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": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/ | "$ref": "#/components/schemas/Error" | ||
} | |||
} | |||
} | } | ||
} | } | ||
}, | }, | ||
" | "403": { | ||
"description": " | "description": "The client is not allowed to perform the requested operation.\n * 3001 - Product not licensed.\n ", | ||
"content": { | "content": { | ||
"application/json": { | "application/json": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/Error" | "$ref": "#/components/schemas/Error" | ||
} | |||
} | |||
} | } | ||
} | } | ||
}, | }, | ||
" | "204": { | ||
"description": " | "description": "No Content.", | ||
"content": { | "content": { | ||
" | "*/*": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/ | "$ref": "#/components/schemas/ResponseVoid" | ||
} | |||
} | |||
} | } | ||
} | } | ||
}, | }, | ||
" | "400": { | ||
"description": " | "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": { | ||
"schema": { | "schema": { | ||
"$ref": "#/components/schemas/Error" | "$ref": "#/components/schemas/Error" | ||
} | |||
} | |||
} | } | ||
} | } | ||
} | |||
}, | |||
"security": [ | |||
{ | |||
"verification": [] | |||
} | |||
] | |||
} | |||
} | |||
}, | |||
"components": { | |||
"schemas": { | |||
"Error": { | |||
"type": "object", | |||
"properties": { | |||
"errorCode": { | |||
"type": "integer", | |||
"description": "Proprietary Cryptshare Server error code.", | |||
"format": "int32" | |||
}, | }, | ||
" | "errorMessage": { | ||
" | "type": "string", | ||
"description": "Short description of the error code in English." | |||
"description": " | |||
} | } | ||
} | } | ||
}, | |||
"RequestVerificationBody": { | |||
" | |||
"type": "object", | "type": "object", | ||
"properties": { | "properties": { | ||
" | "verificationCode": { | ||
"type": "string", | "type": "string", | ||
"description": " | "description": "Code that confirms this verification. Must be present unless requesting a verification using client-id." | ||
} | } | ||
} | } | ||
}, | }, | ||
" | "ResponseVerificationToken": { | ||
"type": "object", | "type": "object", | ||
"properties": { | "properties": { | ||
" | "data": { | ||
"type": " | "$ref": "#/components/schemas/VerificationToken" | ||
" | }, | ||
"meta": { | |||
" | "type": "object", | ||
"additionalProperties": { | |||
"type": "object", | |||
"description": "Additional response metadata." | |||
}, | |||
"description": "Additional response metadata." | |||
} | } | ||
} | } | ||
}, | }, | ||
" | "VerificationToken": { | ||
"type": "object", | "type": "object", | ||
"properties": { | "properties": { | ||
" | "token": { | ||
"type": "string", | "type": "string", | ||
"description": "The | "description": "The verification token" | ||
}, | }, | ||
" | "validUntil": { | ||
"type": "string", | "type": "string", | ||
"description": "The | "description": "The valid to date of the token. ISO 8601 with 'T' separator and numeric timezone.", | ||
" | "example": "2020-10-09T11:51:46+02:00" | ||
} | } | ||
}, | }, | ||
" | "description": "Main data of the response." | ||
}, | }, | ||
" | "Recipient": { | ||
" | "required": [ | ||
"mail" | |||
], | |||
"type": "object", | "type": "object", | ||
"properties": { | "properties": { | ||
" | "mail": { | ||
" | "maxLength": 200, | ||
"minLength": 0, | |||
" | |||
"type": "string", | "type": "string", | ||
"description": " | "description": "The recipient email address." | ||
} | } | ||
}, | }, | ||
" | "description": "The 'BCC' recipients." | ||
}, | }, | ||
" | "Recipients": { | ||
" | "required": [ | ||
"bcc", | |||
"cc", | |||
"to" | |||
], | |||
"type": "object", | "type": "object", | ||
"properties": { | "properties": { | ||
" | "to": { | ||
"type": " | "uniqueItems": true, | ||
"description": " | "type": "array", | ||
" | "description": "The 'To' recipients.", | ||
"items": { | |||
"$ref": "#/components/schemas/Recipient" | |||
} | |||
}, | }, | ||
" | "cc": { | ||
"type": " | "uniqueItems": true, | ||
"description": " | "type": "array", | ||
" | "description": "The 'CC' recipients.", | ||
"items": { | |||
"$ref": "#/components/schemas/Recipient" | |||
} | |||
}, | |||
"bcc": { | |||
"uniqueItems": true, | |||
"type": "array", | |||
"description": "The 'BCC' recipients.", | |||
"items": { | |||
"$ref": "#/components/schemas/Recipient" | |||
} | |||
} | } | ||
}, | }, | ||
" | "description": "The recipients of the transfer grouped by to, cc and bcc." | ||
}, | }, | ||
" | "Sender": { | ||
" | "required": [ | ||
"name", | |||
"phone" | |||
], | |||
"type": "object", | "type": "object", | ||
"properties": { | "properties": { | ||
" | "name": { | ||
"maxLength": 200, | |||
"minLength": 0, | |||
"type": "string", | "type": "string", | ||
"description": "The | "description": "The sender name." | ||
}, | }, | ||
" | "phone": { | ||
"maxLength": 200, | |||
"minLength": 0, | |||
"type": "string", | "type": "string", | ||
"description": "The | "description": "The sender phone." | ||
} | } | ||
}, | }, | ||
" | "description": "The sender of the transfer (without email)." | ||
}, | }, | ||
" | "TransferSessionCreationOptions": { | ||
" | "required": [ | ||
"recipients", | |||
"sender" | |||
], | |||
"type": "object", | "type": "object", | ||
"properties": { | "properties": { | ||
" | "sender": { | ||
"$ref": "#/components/schemas/Sender" | |||
}, | }, | ||
" | "recipients": { | ||
" | "$ref": "#/components/schemas/Recipients" | ||
} | } | ||
}, | }, | ||
" | "description": "The options to use for the creation of the transfer." | ||
}, | }, | ||
" | "TransferFileCreationOptions": { | ||
" | "required": [ | ||
"fileName", | |||
"size" | |||
], | |||
"type": "object", | "type": "object", | ||
"properties": { | "properties": { | ||
" | "fileName": { | ||
"maxLength": 4000, | |||
"minLength": 0, | |||
"type": "string", | "type": "string", | ||
"description": "The file | "description": "The name of the file." | ||
" | }, | ||
"size": { | |||
"minimum": 0, | |||
"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" | |||
}, | }, | ||
" | "checksum": { | ||
"maxLength": 1024, | |||
"minLength": 0, | |||
"type": "string", | "type": "string", | ||
"description": " | "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" | ||
} | |||
}, | |||
"description": "The options to use for the creation of the file." | |||
}, | |||
"ResponseTransferFileCreationOptions": { | |||
"type": "object", | |||
"properties": { | |||
"data": { | |||
"$ref": "#/components/schemas/TransferFileCreationOptions" | |||
}, | }, | ||
" | "meta": { | ||
"type": " | "type": "object", | ||
"description": " | "additionalProperties": { | ||
" | "type": "object", | ||
" | "description": "Additional response metadata." | ||
}, | |||
"description": "Additional response metadata." | |||
} | |||
} | |||
}, | |||
"TransferPolicyRequest": { | |||
"type": "object", | |||
"properties": { | |||
"recipients": { | |||
"type": "array", | |||
"writeOnly": true, | |||
"items": { | |||
"type": "string" | |||
} | |||
} | } | ||
}, | }, | ||
" | "description": "The parameters to perform the policy request with." | ||
}, | }, | ||
" | "FailedRecipient": { | ||
"type": "object", | "type": "object", | ||
"properties": { | "properties": { | ||
" | "emailAddress": { | ||
"type": "string", | "type": "string", | ||
"description": " | "description": "The email address of the failed recipient.", | ||
"example": " | "example": "abc.def@example.com" | ||
}, | }, | ||
" | "reason": { | ||
"type": "string", | "type": "string", | ||
"description": " | "description": "The reason of the denial of the recipient. Currently, only 'ADMINISTRATIVE_REASONS' is supported.", | ||
"enum": [ | "enum": [ | ||
" | "ADMINISTRATIVE_REASONS" | ||
] | ] | ||
} | } | ||
}, | }, | ||
" | "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." | ||
}, | }, | ||
" | "ResponseTransferPolicyResult": { | ||
"type": "object", | "type": "object", | ||
"properties": { | "properties": { | ||
" | "data": { | ||
" | "$ref": "#/components/schemas/TransferPolicyResult" | ||
}, | }, | ||
" | "meta": { | ||
"type": " | "type": "object", | ||
" | "additionalProperties": { | ||
"type": "object", | |||
"description": "Additional response metadata." | |||
}, | |||
"description": "Additional response metadata." | |||
"description": " | |||
} | } | ||
}, | } | ||
" | }, | ||
"SecurityModeConfigDto": { | |||
"type": "object", | |||
"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')." | |||
}, | }, | ||
" | "SecurityModeDtoSecurityModeConfigDto": { | ||
"type": "object", | "type": "object", | ||
"properties": { | "properties": { | ||
" | "name": { | ||
"type": "string", | "type": "string", | ||
"description": " | "description": "Name of the security mode.", | ||
"enum": [ | "enum": [ | ||
" | "ONE_TIME_PASSWORD", | ||
" | "QUICK", | ||
" | "EID" | ||
] | ] | ||
}, | }, | ||
" | "config": { | ||
" | "$ref": "#/components/schemas/SecurityModeConfigDto" | ||
} | |||
} | |||
}, | }, | ||
" | "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." | ||
}, | }, | ||
" | "TransferPolicyResult": { | ||
"type": "object", | "type": "object", | ||
"properties": { | "properties": { | ||
" | "allowed": { | ||
"type": " | "type": "boolean", | ||
"description": " | "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 | ||
}, | |||
"settings": { | |||
"$ref": "#/components/schemas/TransferPolicySettings" | |||
}, | }, | ||
" | "failedRecipients": { | ||
"type": " | "uniqueItems": true, | ||
"description": " | "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.", | ||
"items": { | |||
"$ref": "#/components/schemas/FailedRecipient" | |||
} | |||
} | } | ||
}, | }, | ||
" | "description": "Main data of the response." | ||
}, | }, | ||
" | "TransferPolicySettings": { | ||
"type": "object", | "type": "object", | ||
"properties": { | "properties": { | ||
" | "maxRetentionPeriod": { | ||
"description": " | "type": "integer", | ||
" | "description": "Max. number of days the transfer is retrievable, starting at the transfer's provision time.", | ||
" | "format": "int64", | ||
"example": 30 | |||
}, | }, | ||
" | "maxTotalSize": { | ||
"type": " | "type": "integer", | ||
"description": " | "description": "Max. total size of all files in bytes.", | ||
" | "format": "int64", | ||
" | "example": 2147483648 | ||
}, | |||
"showFileNamesDefault": { | |||
"type": "boolean", | |||
"description": "Default setting for showing file names in notifications and logs." | |||
} | }, | ||
"showFileNamesChangeable": { | |||
"type": "boolean", | |||
"description": "Specifies whether the showFileNamesDefault setting is changeable or not." | |||
}, | |||
"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." | |||
" | }, | ||
"sendDownloadNotificationsDefault": { | |||
"type": "boolean", | |||
"description": "Default setting for sending download notifications on file retrieval." | |||
}, | |||
"sendDownloadNotificationsChangeable": { | |||
"type": "boolean", | |||
"description": "Specifies whether the sendDownloadNotificationsDefault setting is changeable or not." | |||
}, | |||
"confidentialMessageAllowed": { | |||
"type": "boolean", | |||
"description": "Specifies whether a confidential message can be part of the transfer or not." | |||
}, | |||
"confidentialMessageRequired": { | |||
"type": "boolean", | |||
"description": "Specifies whether a confidential message has to be part of the transfer or not." | |||
}, | |||
"recipientNotificationEditable": { | |||
"type": "boolean", | |||
"description": "Specifies whether the recipient notification can be edited or not." | |||
}, | |||
"securityModes": { | |||
"type": "array", | "type": "array", | ||
"description": " | "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.", | ||
"items": { | "items": { | ||
" | "$ref": "#/components/schemas/SecurityModeDtoSecurityModeConfigDto" | ||
} | } | ||
} | } | ||
}, | }, | ||
" | "description": "The evaluated policy settings of the matching policy rules. This is only set the transfer would be allowed at all." | ||
}, | }, | ||
" | "Password-Wrapper": { | ||
" | "required": [ | ||
"password" | |||
], | |||
"type": "object", | "type": "object", | ||
"properties": { | "properties": { | ||
"rulesNotFulfilled": { | "password": { | ||
"type": "string" | |||
} | |||
} | |||
}, | |||
"Details": { | |||
"type": "object", | |||
"description": "Details of the rule." | |||
}, | |||
"PasswordValidationResult": { | |||
"type": "object", | |||
"properties": { | |||
"valid": { | |||
"type": "boolean", | |||
"description": "Whether the given password is valid." | |||
}, | |||
"rulesNotFulfilled": { | |||
"type": "array", | "type": "array", | ||
"description": "List of rules that are not fulfilled by the given password", | "description": "List of rules that are not fulfilled by the given password", | ||
"items": { | "items": { | ||
"$ref": "#/components/schemas/PasswordValidationRule" | "$ref": "#/components/schemas/PasswordValidationRule" | ||
} | } | ||
} | } | ||
}, | }, | ||
"description": "Results of the validation of a given password" | "description": "Results of the validation of a given password" | ||
}, | }, | ||
"PasswordValidationRule": { | "PasswordValidationRule": { | ||
"type": "object", | "type": "object", | ||
"properties": { | "properties": { | ||
"name": { | "name": { | ||
"type": "string", | "type": "string", | ||
"description": "Name of the rule.", | "description": "Name of the rule." | ||
" | }, | ||
"details": { | |||
"$ref": "#/components/schemas/Details" | |||
} | } | ||
}, | }, | ||
"description": "Represents a rule a password has to fulfill to be valid" | "description": "Represents a rule a password has to fulfill to be valid" | ||
}, | }, | ||
" | "ResponsePasswordValidationResult": { | ||
"type": "object", | "type": "object", | ||
"properties": { | "properties": { | ||
" | "data": { | ||
"type": " | "$ref": "#/components/schemas/PasswordValidationResult" | ||
" | }, | ||
"meta": { | |||
"type": "object", | |||
"additionalProperties": { | |||
"type": "object", | |||
"description": "Additional response metadata." | |||
}, | |||
"description": "Additional response metadata." | |||
} | } | ||
} | } | ||
}, | }, | ||
" | "LogEntry": { | ||
"type": "object", | "type": "object", | ||
"properties": { | "properties": { | ||
" | "timestamp": { | ||
" | "type": "string", | ||
" | "description": "ISO 8601 with 'T' separator and numeric timezone.", | ||
" | "example": "2020-10-09T11:51:46+02:00" | ||
}, | }, | ||
" | "level": { | ||
"type": "string", | "type": "string", | ||
"description": " | "description": "Assumes a severity ordering as specified by RFC 5424.", | ||
"enum": [ | "enum": [ | ||
" | "trace", | ||
" | "debug", | ||
" | "info", | ||
"warn", | |||
"error" | |||
] | ] | ||
}, | |||
"message": { | |||
"type": "string", | |||
"description": "The log message." | |||
} | } | ||
} | } | ||
}, | }, | ||
" | "TransferNotificationMessage": { | ||
"type": "object", | "type": "object", | ||
"properties": { | "properties": { | ||
" | "subject": { | ||
" | "maxLength": 255, | ||
" | "minLength": 0, | ||
" | "pattern": "^[^\u003C\u003E\\\\/#,\\]\\[\\}\\{%\\$~]*$", | ||
"type": "string", | |||
"description": "The subject of the transfer notification." | |||
}, | }, | ||
" | "body": { | ||
"type": " | "type": "string", | ||
"description": " | "description": "The body of the transfer notification. May contain HTML." | ||
} | } | ||
}, | }, | ||
" | "description": "The notification mail that will be sent to the recipients." | ||
}, | }, | ||
" | "TransferOneTimePasswordSecurityMode": { | ||
" | "type": "object", | ||
" | "allOf": [ | ||
" | { | ||
], | "$ref": "#/components/schemas/TransferSecurityModeObject" | ||
}, | |||
{ | |||
"type": "object", | |||
"properties": { | |||
"config": { | |||
"$ref": "#/components/schemas/TransferOneTimePasswordSecurityModeConfig" | |||
} | |||
} | |||
} | |||
] | |||
}, | |||
"TransferOneTimePasswordSecurityModeConfig": { | |||
"type": "object", | "type": "object", | ||
"properties": { | "properties": { | ||
" | "passwordMode": { | ||
"type": "string", | |||
"description": "The password mode to use. Note that if 'GENERATED' is used, the password is calculated by the server.", | |||
"enum": [ | |||
"MANUAL", | |||
"GENERATED", | |||
"NONE" | |||
] | |||
}, | |||
"password": { | |||
"type": "string", | "type": "string", | ||
"description": "The | "description": "The password for the transfer." | ||
} | } | ||
}, | }, | ||
" | "description": "The configuration of the security mode." | ||
}, | }, | ||
" | "TransferSecurityModeObject": { | ||
"type": "object", | "type": "object", | ||
"properties": { | "properties": { | ||
" | "name": { | ||
"type": "string", | "type": "string", | ||
"description": "The | "description": "The identifier for this security mode.", | ||
" | "enum": [ | ||
"ONE_TIME_PASSWORD" | |||
] | |||
}, | }, | ||
" | "config": { | ||
"type": "object", | |||
"description": "The configuration of the security mode." | |||
"type": " | |||
"description": "The | |||
} | } | ||
}, | }, | ||
" | "description": "Security mode. Possible implementations are: 'TransferOneTimePasswordSecurityMode'", | ||
"discriminator": { | |||
"propertyName": "name" | |||
} | |||
}, | }, | ||
" | "TransferSessionPatchable": { | ||
"type": "object", | "type": "object", | ||
"properties": { | "properties": { | ||
" | "sender": { | ||
"$ref": "#/components/schemas/Sender" | |||
}, | }, | ||
" | "expirationDate": { | ||
"type": "string", | |||
"type": " | "description": "The expiration date of the transfer. ISO 8601 with 'T' separator and numeric timezone.", | ||
"description": "The ' | "example": "2020-10-09T11:51:46+02:00" | ||
" | |||
}, | }, | ||
" | "securityMode": { | ||
" | "oneOf": [ | ||
{ | |||
"$ref": "#/components/schemas/TransferOneTimePasswordSecurityMode" | |||
} | |||
] | |||
}, | |||
"notificationMessage": { | |||
"$ref": "#/components/schemas/TransferNotificationMessage" | |||
}, | |||
"fileChecksumAlgorithm": { | |||
"maxLength": 50, | |||
"minLength": 0, | |||
"type": "string", | "type": "string", | ||
"description": " | "description": "The name of the hashing algorithm that will be used for files in this transfer.", | ||
" | "example": "SHA-256" | ||
}, | }, | ||
" | "senderLanguage": { | ||
"type": " | "type": "string", | ||
"description": " | "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" | |||
" | |||
}, | }, | ||
" | "recipientLanguage": { | ||
"type": " | "type": "string", | ||
"description": " | "description": "The recipient language. IETF BCP 47 language tag, RFC 5646. Format: \u0026lt;language\u0026gt;[-\u0026lt;region\u0026gt;]. Case insensitive.", | ||
" | "example": "en" | ||
}, | |||
"showFileNames": { | |||
"type": "boolean", | |||
"description": "If file names should be shown in notification mails." | |||
}, | |||
"showZipFileContent": { | |||
"type": "boolean", | |||
"description": "If the contents of ZIP files should be shown in notification mails. Has no effect if `showFileNames` is false." | |||
}, | |||
"sendDownloadNotifications": { | |||
"type": "boolean", | |||
"description": "If notification mails should be sent to the sender when a file is downloaded." | |||
}, | |||
"sendDownloadSummary": { | |||
"type": "boolean", | |||
"description": "If a summary notification mail should be sent to the sender the transfer expires." | |||
}, | |||
"sendUploadSummary": { | |||
"type": "boolean", | |||
"description": "If a confirmation notification mail should be sent to the sender after the transfer is provided." | |||
}, | |||
"sendRecipientNotification": { | |||
"type": "boolean", | |||
"description": "If notification mails should be sent to the recipients after the transfer is provided." | |||
}, | |||
"classificationId": { | |||
"maxLength": 4000, | |||
"minLength": 0, | |||
"type": "string", | |||
"description": "An optional ID for the type of classification used for this transfer." | |||
}, | |||
"confidentialMessageFileId": { | |||
"type": "string", | |||
"description": "The file ID of the confidential message. May be null." | |||
} | } | ||
} | } | ||
}, | }, | ||
" | "ResponseTransferSessionTransferSecurityModeObject": { | ||
"type": "object", | "type": "object", | ||
"properties": { | "properties": { | ||
"data": { | "data": { | ||
"$ref": "#/components/schemas/TransferSessionTransferSecurityModeObject" | |||
"$ref": "#/components/schemas/ | |||
}, | }, | ||
"meta": { | "meta": { | ||
"type": "object", | "type": "object", | ||
"description": "Additional response metadata.", | "additionalProperties": { | ||
" | "type": "object", | ||
"description": "Additional response metadata." | |||
}, | |||
"description": "Additional response metadata." | |||
} | } | ||
} | } | ||
}, | }, | ||
" | "TransferSessionFile": { | ||
"type": "object", | "type": "object", | ||
"properties": { | "properties": { | ||
" | "id": { | ||
" | "type": "string", | ||
" | "description": "The ID of this file.", | ||
" | "example": "a58dFp1Tr7" | ||
}, | }, | ||
" | "fileName": { | ||
"type": " | "type": "string", | ||
"description": " | "description": "The name of the file.", | ||
" | "example": "Invoice.pdf" | ||
}, | |||
"size": { | |||
"type": "integer", | |||
"description": "The file size in bytes.", | |||
"format": "int64", | |||
"example": 13987 | |||
}, | |||
"checksum": { | |||
" | "type": "string", | ||
"type": " | "description": "The checksum of the file.", | ||
"description": " | "example": "737b6a930368b34c9ef9022ab088ac9b0b7abf8ef9046929c5d2fea3f87e7d15" | ||
" | }, | ||
"href": { | |||
"type": "string", | |||
"description": "The absolute path to the transfer file." | |||
}, | }, | ||
" | "state": { | ||
"type": " | "type": "string", | ||
"description": " | "description": "The state of this file.", | ||
" | "enum": [ | ||
"ACTIVE", | |||
"INITIALIZED", | |||
"UPLOADED", | |||
"REMOVED" | |||
] | |||
} | } | ||
}, | }, | ||
" | "description": "The files of this transfer." | ||
}, | }, | ||
" | "TransferSessionTransferSecurityModeObject": { | ||
"type": "object", | "type": "object", | ||
"properties": { | "properties": { | ||
" | "sender": { | ||
" | "$ref": "#/components/schemas/Sender" | ||
}, | |||
"recipients": { | |||
"$ref": "#/components/schemas/Recipients" | |||
}, | }, | ||
" | "expirationDate": { | ||
"type": " | "type": "string", | ||
"description": " | "description": "The expiration date of the transfer. ISO 8601 with 'T' separator and numeric timezone.", | ||
" | "example": "2020-10-09T11:51:46+02:00" | ||
}, | |||
"securityMode": { | |||
"oneOf": [ | |||
{ | |||
"$ref": "#/components/schemas/TransferOneTimePasswordSecurityMode" | |||
} | |||
] | |||
" | |||
" | |||
}, | }, | ||
" | "notificationMessage": { | ||
"$ref": "#/components/schemas/TransferNotificationMessage" | |||
}, | }, | ||
" | "senderLanguage": { | ||
"type": " | "type": "string", | ||
"description": " | "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" | |||
" | |||
}, | }, | ||
" | "recipientLanguage": { | ||
"type": " | "type": "string", | ||
"description": " | "description": "The recipient language. IETF BCP 47 language tag, RFC 5646. Format: \u0026lt;language\u0026gt;[-\u0026lt;region\u0026gt;]. Case insensitive.", | ||
" | "example": "en" | ||
} | }, | ||
}, | "showFileNames": { | ||
" | "type": "boolean", | ||
"description": "If file names should be shown in notification mails." | |||
}, | |||
"showZipFileContent": { | |||
"type": "boolean", | |||
"description": "If the contents of ZIP files should be shown in notification mails. Has no effect if `showFileNames` is false." | |||
}, | |||
"sendDownloadNotifications": { | |||
"type": "boolean", | |||
"description": "If notification mails should be sent to the sender when a file is downloaded." | |||
}, | |||
"sendDownloadSummary": { | |||
"type": "boolean", | |||
"description": "If a summary notification mail should be sent to the sender the transfer expires." | |||
}, | |||
"sendUploadSummary": { | |||
"type": "boolean", | |||
"description": "If a confirmation notification mail should be sent to the sender after the transfer is provided." | |||
}, | |||
"sendRecipientNotification": { | |||
"type": "boolean", | |||
"description": "If notification mails should be sent to the recipients after the transfer is provided." | |||
}, | |||
"classificationId": { | |||
"maxLength": 4000, | |||
"minLength": 0, | |||
"type": "string", | |||
"description": "An optional ID for the type of classification used for this transfer." | |||
}, | |||
"fileChecksumAlgorithm": { | |||
"maxLength": 50, | |||
"minLength": 0, | |||
"type": "string", | |||
"description": "The name of the hashing algorithm that will be used for files in this transfer.", | |||
"example": "SHA-256" | |||
}, | |||
"confidentialMessageFileId": { | |||
"type": "string", | |||
"description": "The file ID of the confidential message. May be null." | |||
}, | |||
"files": { | |||
"uniqueItems": true, | |||
"type": "array", | |||
"description": "The files of this transfer.", | |||
"items": { | |||
"$ref": "#/components/schemas/TransferSessionFile" | |||
} | |||
} | |||
}, | |||
"description": "Main data of the response." | |||
}, | }, | ||
" | "ResponseVerificationStatus": { | ||
"type": "object", | "type": "object", | ||
"properties": { | "properties": { | ||
"data": { | "data": { | ||
"$ref": "#/components/schemas/VerificationStatus" | |||
"$ref": "#/components/schemas/ | |||
}, | }, | ||
"meta": { | "meta": { | ||
"type": "object", | "type": "object", | ||
"description": "Additional response metadata.", | "additionalProperties": { | ||
" | "type": "object", | ||
"description": "Additional response metadata." | |||
}, | |||
"description": "Additional response metadata." | |||
} | } | ||
} | } | ||
}, | }, | ||
" | "VerificationStatus": { | ||
"type": "object", | "type": "object", | ||
"properties": { | "properties": { | ||
" | "validUntil": { | ||
"description": " | "type": "string", | ||
" | "description": "The valid to date of the token. ISO 8601 with 'T' separator and numeric timezone.", | ||
" | "example": "2020-10-09T11:51:46+02:00" | ||
}, | |||
"verified": { | |||
"type": "boolean", | |||
"description": "The state if the client is verified for the specified email address.", | |||
"example": true | |||
}, | }, | ||
" | "verificationMethods": { | ||
"type": " | "uniqueItems": true, | ||
"description": " | "type": "array", | ||
" | "description": "A list of available verification methods.", | ||
"items": { | |||
"type": "string", | |||
"description": "A list of available verification methods.", | |||
"enum": [ | |||
"clientId", | |||
"email", | |||
"clientId", | |||
"email" | |||
] | |||
}, | |||
"enum": [ | |||
"clientId", | |||
"email" | |||
] | |||
} | } | ||
}, | }, | ||
" | "description": "Main data of the response." | ||
}, | }, | ||
" | "DownloadDto": { | ||
"type": "object", | "type": "object", | ||
"properties": { | "properties": { | ||
" | "downloadDate": { | ||
" | "type": "string", | ||
" | "description": "The date of the download. ISO 8601 with 'T' separator and numeric timezone.", | ||
" | "example": "2020-10-09T11:51:46+02:00" | ||
}, | }, | ||
" | "retrievalMethod": { | ||
"type": " | "type": "string", | ||
"description": " | "description": "The method how the file was retrieved: Downloaded or viewed in Content Viewer.", | ||
" | "enum": [ | ||
"DOWNLOADED", | |||
"VIEWED" | |||
] | |||
} | } | ||
}, | }, | ||
" | "description": "The list of downloads of this file." | ||
}, | }, | ||
" | "FileDownloadDto": { | ||
"type": "object", | "type": "object", | ||
"properties": { | "properties": { | ||
" | "id": { | ||
" | "type": "string", | ||
" | "description": "The file ID." | ||
}, | }, | ||
" | "downloads": { | ||
"type": " | "type": "array", | ||
"description": " | "description": "The list of downloads of this file.", | ||
" | "items": { | ||
"$ref": "#/components/schemas/DownloadDto" | |||
} | |||
} | } | ||
} | } | ||
}, | }, | ||
" | "RecipientStatusDto": { | ||
"type": "object", | "type": "object", | ||
"properties": { | "properties": { | ||
" | "mail": { | ||
"description": " | "type": "string", | ||
" | "description": "The recipient email address." | ||
" | }, | ||
"downloadUrl": { | |||
"type": "string", | |||
"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." | |||
}, | |||
"id": { | |||
"type": "string", | |||
"description": "The recipient transfer ID." | |||
}, | |||
"notificationFailed": { | |||
"type": "boolean", | |||
"description": "If notification of this recipient failed." | |||
}, | }, | ||
" | "fileDownloads": { | ||
" | "uniqueItems": true, | ||
" | "type": "array", | ||
" | "items": { | ||
"$ref": "#/components/schemas/FileDownloadDto" | |||
} | |||
} | } | ||
} | } | ||
}, | }, | ||
" | "ResponseListTransferBasicInfoDto": { | ||
"type": "object", | "type": "object", | ||
"properties": { | "properties": { | ||
"data": { | "data": { | ||
"type": "array", | |||
"description": "Main data of the response.", | "description": "Main data of the response.", | ||
"$ref": "#/components/schemas/ | "items": { | ||
"$ref": "#/components/schemas/TransferBasicInfoDto" | |||
} | |||
}, | }, | ||
"meta": { | "meta": { | ||
"type": "object", | "type": "object", | ||
"description": "Additional response metadata.", | "additionalProperties": { | ||
" | "type": "object", | ||
"description": "Additional response metadata." | |||
}, | |||
"description": "Additional response metadata." | |||
} | } | ||
} | } | ||
}, | }, | ||
" | "TransferBasicInfoDto": { | ||
"type": "object", | "type": "object", | ||
"properties": { | "properties": { | ||
" | "trackingId": { | ||
" | "type": "string", | ||
" | "description": "The tracking ID." | ||
}, | }, | ||
" | "state": { | ||
"type": " | "type": "string", | ||
"description": " | "description": "The state of the transfer.", | ||
" | "enum": [ | ||
"UNKNOWN", | |||
"PENDING", | |||
"ACTIVE", | |||
"DELETED_BY_EXPIRATION", | |||
"DELETED_BY_REVOCATION", | |||
"DELETED_BY_ADMIN", | |||
"DELETED_BY_SECURITY", | |||
"PROCESSING", | |||
"FAILED" | |||
] | |||
}, | |||
"recipients": { | |||
"uniqueItems": true, | |||
"type": "array", | |||
"items": { | |||
"$ref": "#/components/schemas/RecipientStatusDto" | |||
} | |||
}, | |||
"href": { | |||
"type": "string", | |||
"description": "The absolute path to the transfer." | |||
} | } | ||
}, | }, | ||
" | "description": "Main data of the response." | ||
}, | }, | ||
" | "FileStatusDto": { | ||
"type": "object", | "type": "object", | ||
"properties": { | "properties": { | ||
" | "id": { | ||
"description": " | "type": "string", | ||
" | "description": "The file ID." | ||
" | }, | ||
"removed": { | |||
"type": "boolean", | |||
"description": "If this file was removed." | |||
}, | }, | ||
" | "removalCause": { | ||
"type": " | "type": "string", | ||
"description": " | "description": "A formatted text with details why this file was removed. May be null." | ||
} | } | ||
} | } | ||
}, | }, | ||
" | "ResponseTransferStatus": { | ||
"type": "object", | "type": "object", | ||
"properties": { | "properties": { | ||
"data": { | "data": { | ||
"$ref": "#/components/schemas/TransferStatus" | |||
"$ref": "#/components/schemas/ | |||
}, | }, | ||
"meta": { | "meta": { | ||
"type": "object", | "type": "object", | ||
"description": "Additional response metadata.", | "additionalProperties": { | ||
" | "type": "object", | ||
"description": "Additional response metadata." | |||
}, | |||
"description": "Additional response metadata." | |||
} | } | ||
} | } | ||
}, | }, | ||
" | "SenderStatusDto": { | ||
"type": "object", | "type": "object", | ||
"properties": { | "properties": { | ||
" | "email": { | ||
"type": "string", | "type": "string", | ||
"description": "The sender email address." | |||
"description": "The sender email address." | |||
}, | }, | ||
"notificationFailed": { | "notificationFailed": { | ||
"type": "boolean", | "type": "boolean", | ||
"description": "If notification of the sender failed." | "description": "If notification of the sender failed." | ||
} | } | ||
} | } | ||
}, | }, | ||
"StatusDto": { | "StatusDto": { | ||
"type": "object", | "type": "object", | ||
"properties": { | "properties": { | ||
"emlCreationFailed": { | "state": { | ||
"type": "boolean", | "type": "string", | ||
"description": "If the creation of the EML file failed.", | "description": "The state of the transfer.", | ||
"enum": [ | |||
" | "ACTIVE", | ||
}, | "DELETED_BY_EXPIRATION", | ||
" | "DELETED_BY_REVOCATION", | ||
"DELETED_BY_ADMIN", | |||
"DELETED_BY_SECURITY", | |||
"PROCESSING", | |||
"FAILED" | |||
] | |||
}, | |||
"warnings": { | |||
"type": "boolean", | |||
"description": "If any warnings were encountered. This could be for example files that were removed." | |||
}, | |||
"emlCreationFailed": { | |||
"type": "boolean", | |||
"description": "If the creation of the EML file failed." | |||
}, | |||
"sender": { | |||
"$ref": "#/components/schemas/SenderStatusDto" | |||
}, | |||
"recipients": { | |||
"uniqueItems": true, | "uniqueItems": true, | ||
"type": "array", | "type": "array", | ||
"items": { | "items": { | ||
"$ref": "#/components/schemas/ | "$ref": "#/components/schemas/RecipientStatusDto" | ||
} | } | ||
}, | }, | ||
" | "files": { | ||
"uniqueItems": true, | "uniqueItems": true, | ||
"type": "array", | "type": "array", | ||
"items": { | "items": { | ||
"$ref": "#/components/schemas/ | "$ref": "#/components/schemas/FileStatusDto" | ||
} | } | ||
} | |||
} | |||
}, | |||
"TransferSessionObject": { | |||
"type": "object", | |||
"properties": { | |||
"sender": { | |||
"$ref": "#/components/schemas/Sender" | |||
}, | }, | ||
" | "recipients": { | ||
"$ref": "#/components/schemas/ | "$ref": "#/components/schemas/Recipients" | ||
}, | }, | ||
" | "expirationDate": { | ||
"type": "string", | "type": "string", | ||
"description": "The | "description": "The expiration date of the transfer. ISO 8601 with 'T' separator and numeric timezone.", | ||
" | "example": "2020-10-09T11:51:46+02:00" | ||
}, | }, | ||
" | "securityMode": { | ||
"type": " | "type": "object", | ||
"description": " | "description": "The security mode for this transfer." | ||
}, | |||
"notificationMessage": { | |||
"$ref": "#/components/schemas/TransferNotificationMessage" | |||
" | |||
" | |||
}, | }, | ||
" | "senderLanguage": { | ||
"type": "string", | "type": "string", | ||
"description": "IETF BCP 47 language tag, RFC 5646. Format: \u0026lt;language\u0026gt;[-\u0026lt;region\u0026gt;]. Case insensitive.", | "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 | "example": "en" | ||
}, | }, | ||
" | "recipientLanguage": { | ||
"type": "string", | "type": "string", | ||
"description": " | "description": "The recipient language. IETF BCP 47 language tag, RFC 5646. Format: \u0026lt;language\u0026gt;[-\u0026lt;region\u0026gt;]. Case insensitive.", | ||
"example": " | "example": "en" | ||
}, | }, | ||
" | "showFileNames": { | ||
"type": "boolean", | "type": "boolean", | ||
"description": " | "description": "If file names should be shown in notification mails." | ||
}, | }, | ||
" | "showZipFileContent": { | ||
"type": " | "type": "boolean", | ||
"description": " | "description": "If the contents of ZIP files should be shown in notification mails. Has no effect if `showFileNames` is false." | ||
}, | }, | ||
" | "sendDownloadNotifications": { | ||
"type": "boolean", | |||
"description": "If notification mails should be sent to the sender when a file is downloaded." | |||
}, | |||
"sendDownloadSummary": { | |||
"type": "boolean", | |||
"description": "If a summary notification mail should be sent to the sender the transfer expires." | |||
}, | |||
"sendUploadSummary": { | |||
"type": "boolean", | |||
"description": "If a confirmation notification mail should be sent to the sender after the transfer is provided." | |||
}, | |||
"sendRecipientNotification": { | |||
"type": "boolean", | |||
"description": "If notification mails should be sent to the recipients after the transfer is provided." | |||
}, | |||
"classificationId": { | |||
"maxLength": 4000, | |||
"minLength": 0, | |||
"type": "string", | |||
"description": "An optional ID for the type of classification used for this transfer." | |||
}, | |||
"fileChecksumAlgorithm": { | |||
"maxLength": 50, | |||
"minLength": 0, | |||
"type": "string", | |||
"description": "The name of the hashing algorithm that will be used for files in this transfer.", | |||
"example": "SHA-256" | |||
}, | |||
"confidentialMessageFileId": { | |||
"type": "string", | |||
"description": "The file ID of the confidential message. May be null." | |||
}, | |||
"files": { | |||
"uniqueItems": true, | |||
"type": "array", | "type": "array", | ||
"description": "The | "description": "The files of this transfer.", | ||
"items": { | "items": { | ||
"$ref": "#/components/schemas/ | "$ref": "#/components/schemas/TransferSessionFile" | ||
} | } | ||
} | |||
} | |||
}, | |||
"TransferStatus": { | |||
"type": "object", | |||
"properties": { | |||
"transfer": { | |||
"$ref": "#/components/schemas/TransferSessionObject" | |||
}, | |||
"status": { | |||
"$ref": "#/components/schemas/StatusDto" | |||
} | } | ||
}, | }, | ||
" | "description": "Main data of the response." | ||
}, | }, | ||
" | "ResponseTransferInfo": { | ||
"type": "object", | "type": "object", | ||
"properties": { | "properties": { | ||
" | "data": { | ||
" | "$ref": "#/components/schemas/TransferInfo" | ||
}, | }, | ||
" | "meta": { | ||
" | "type": "object", | ||
"additionalProperties": { | |||
"type": "object", | |||
"description": "Additional response metadata." | |||
}, | |||
"description": "Additional response metadata." | |||
} | |||
} | |||
}, | |||
"TransferInfo": { | |||
"type": "object", | |||
"properties": { | |||
"totalSize": { | |||
"type": "integer", | |||
"description": "The total file size in bytes.", | |||
"format": "int64", | |||
"example": 13987 | |||
}, | |||
"checksumAlgorithm": { | |||
"type": "string", | |||
"description": "The checksum algorithm used for checksum generation.", | |||
"example": "SHA-256" | |||
} | |||
}, | |||
"description": "Main data of the response." | |||
}, | |||
"ResponseListTransferFile": { | |||
"type": "object", | |||
"properties": { | |||
"data": { | |||
"type": "array", | "type": "array", | ||
" | "description": "Main data of the response.", | ||
"items": { | "items": { | ||
"$ref": "#/components/schemas/ | "$ref": "#/components/schemas/TransferFile" | ||
} | } | ||
}, | }, | ||
" | "meta": { | ||
"type": " | "type": "object", | ||
" | "additionalProperties": { | ||
"type": "object", | |||
"description": "Additional response metadata." | |||
}, | |||
" | "description": "Additional response metadata." | ||
"description": " | |||
} | } | ||
} | } | ||
}, | }, | ||
"TransferFile": { | "TransferFile": { | ||
"type": "object", | "type": "object", | ||
"properties": { | "properties": { | ||
" | "id": { | ||
"type": "string", | "type": "string", | ||
"description": "The | "description": "The ID of this file.", | ||
"example": " | "example": "a58dFp1Tr7" | ||
}, | }, | ||
"fileName": { | "fileName": { | ||
"type": "string", | "type": "string", | ||
"description": "The name of the file.", | "description": "The name of the file.", | ||
"example": "Invoice.pdf" | "example": "Invoice.pdf" | ||
}, | }, | ||
"size": { | "size": { | ||
| Zeile 5.042: | Zeile 5.365: | ||
"description": "The file size in bytes.", | "description": "The file size in bytes.", | ||
"format": "int64", | "format": "int64", | ||
"example": 13987 | "example": 13987 | ||
}, | |||
} | |||
"checksum": { | "checksum": { | ||
"type": "string", | "type": "string", | ||
"description": "The checksum of the file | "description": "The checksum of the file.", | ||
"example": "737b6a930368b34c9ef9022ab088ac9b0b7abf8ef9046929c5d2fea3f87e7d15" | "example": "737b6a930368b34c9ef9022ab088ac9b0b7abf8ef9046929c5d2fea3f87e7d15" | ||
}, | }, | ||
" | "href": { | ||
"type": "string", | "type": "string", | ||
"description": "The | "description": "The absolute path to the transfer file." | ||
} | } | ||
}, | }, | ||
" | "description": "Main data of the response." | ||
}, | }, | ||
" | "LoggingSettings": { | ||
"type": "object", | "type": "object", | ||
"properties": { | "properties": { | ||
" | "level": { | ||
"type": "string", | "type": "string", | ||
"description": " | "description": "Assumes a severity ordering as specified by RFC 5424.", | ||
" | "enum": [ | ||
"trace", | |||
"debug", | |||
"info", | |||
"warn", | |||
"error" | |||
] | |||
}, | }, | ||
" | "remoteLoggingEnabled": { | ||
"type": " | "type": "boolean", | ||
"description": " | "description": "Specifies whether the requesting client should send its log entries to the Cryptshare Server.", | ||
"example": true | |||
"example | |||
} | } | ||
}, | }, | ||
" | "description": "Main data of the response." | ||
}, | }, | ||
" | "ResponseLoggingSettings": { | ||
"type": "object", | "type": "object", | ||
"properties": { | "properties": { | ||
" | "data": { | ||
" | "$ref": "#/components/schemas/LoggingSettings" | ||
}, | }, | ||
" | "meta": { | ||
"type": " | "type": "object", | ||
"description": " | "additionalProperties": { | ||
" | "type": "object", | ||
"description": "Additional response metadata." | |||
}, | |||
"description": "Additional response metadata." | |||
} | } | ||
} | } | ||
}, | }, | ||
" | "ResponseTermsOfUseInfo": { | ||
"type": "object", | "type": "object", | ||
"properties": { | "properties": { | ||
" | "data": { | ||
" | "$ref": "#/components/schemas/TermsOfUseInfo" | ||
}, | }, | ||
" | "meta": { | ||
"type": " | "type": "object", | ||
" | "additionalProperties": { | ||
"type": "object", | |||
"description": "Additional response metadata." | |||
}, | |||
"description": "Additional response metadata." | |||
} | } | ||
} | } | ||
}, | }, | ||
" | "TermsOfUse": { | ||
"type": "object", | "type": "object", | ||
"properties": { | "properties": { | ||
" | "locale": { | ||
"type": "string", | "type": "string", | ||
"description": " | "description": "IETF BCP 47 language tag, RFC 5646. Format: \u0026lt;language\u0026gt;[-\u0026lt;region\u0026gt;]. Case insensitive.", | ||
" | "example": "en-US" | ||
}, | |||
"title": { | |||
"type": "string", | |||
"description": "Title of the terms of use, in the respective language.", | |||
"example": "Cryptshare at ACME Inc., Terms of Use" | |||
}, | }, | ||
" | "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" | |||
}, | |||
"type": { | |||
"type": "string", | "type": "string", | ||
"description": " | "description": "Specifies the value type of the content property.", | ||
" | "example": "html", | ||
"enum": [ | "enum": [ | ||
" | "link", | ||
" | "html" | ||
] | ] | ||
} | } | ||
}, | }, | ||
" | "description": "The terms of use in specific languages." | ||
}, | }, | ||
" | "TermsOfUseInfo": { | ||
"type": "object", | "type": "object", | ||
"properties": { | "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 | ||
}, | }, | ||
" | "lastChangeTimestamp": { | ||
"type": "string", | "type": "string", | ||
"description": "The | "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.", | ||
" | "nullable": true, | ||
" | "example": "2020-10-09T11:51:46+02:00" | ||
" | }, | ||
"terms": { | |||
"type": "array", | |||
"description": "The terms of use in specific languages.", | |||
"items": { | |||
"$ref": "#/components/schemas/TermsOfUse" | |||
} | |||
} | } | ||
}, | }, | ||
" | "description": "Main data of the response." | ||
}, | }, | ||
" | "Imprint": { | ||
"type": "object", | "type": "object", | ||
"properties": { | "properties": { | ||
" | "content": { | ||
" | "type": "string", | ||
" | "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" | ||
}, | }, | ||
" | "type": { | ||
"type": "string", | "type": "string", | ||
"description": " | "description": "Specifies value type of the content property..", | ||
" | "example": "html", | ||
"enum": [ | "enum": [ | ||
" | "link", | ||
"html" | |||
] | ] | ||
} | } | ||
}, | }, | ||
" | "description": "Main data of the response." | ||
}, | }, | ||
" | "ResponseImprint": { | ||
"type": "object", | "type": "object", | ||
"properties": { | "properties": { | ||
" | "data": { | ||
" | "$ref": "#/components/schemas/Imprint" | ||
" | }, | ||
" | "meta": { | ||
"type": " | "type": "object", | ||
" | "additionalProperties": { | ||
} | "type": "object", | ||
"description": "Additional response metadata." | |||
}, | |||
"description": "Additional response metadata." | |||
} | } | ||
} | } | ||
}, | }, | ||
" | "LanguagePack": { | ||
"type": "object", | "type": "object", | ||
"properties": { | "properties": { | ||
" | "id": { | ||
"type": " | "type": "string", | ||
"description": " | "description": "Id of the language pack, contains locale and major version.", | ||
"example": | "example": "en-US_2" | ||
}, | }, | ||
" | "displayName": { | ||
"type": "string", | |||
"type": " | "description": "The display name of the language, in the respective language.", | ||
"description": " | "example": "English (US)" | ||
" | |||
}, | }, | ||
" | "locale": { | ||
"type": "string", | |||
"description": "IETF BCP 47 language tag, RFC 5646. Format: \u0026lt;language\u0026gt;[-\u0026lt;region\u0026gt;]. Case insensitive.", | |||
"example": "en-US" | |||
" | |||
"example": | |||
}, | }, | ||
" | "version": { | ||
"type": " | "type": "string", | ||
"description": " | "description": "The version of the language pack, consisting of major and minor version.", | ||
"example": | "example": "2.1" | ||
}, | }, | ||
" | "lastChangeTimestamp": { | ||
"type": " | "type": "string", | ||
"description": " | "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.", | ||
" | "nullable": true, | ||
"example": | "example": "2020-10-09T11:51:46+02:00" | ||
}, | }, | ||
" | "href": { | ||
"type": " | "type": "string", | ||
"description": " | "description": "The absolute path to the language pack resources.", | ||
" | "example": "/api/products/api.rest/language-packs/en-US_2" | ||
} | |||
}, | |||
"description": "Main data of the response." | |||
}, | |||
"ResponseListLanguagePack": { | |||
"type": "object", | |||
"properties": { | |||
"data": { | |||
" | |||
"type": "array", | "type": "array", | ||
"description": " | "description": "Main data of the response.", | ||
"items": { | "items": { | ||
"$ref": " | "$ref": "#/components/schemas/LanguagePack" | ||
} | } | ||
}, | }, | ||
" | "meta": { | ||
"type": " | "type": "object", | ||
" | "additionalProperties": { | ||
"type": "object", | |||
" | "description": "Additional response metadata." | ||
}, | }, | ||
"description": "Additional response metadata." | |||
} | |||
} | |||
" | }, | ||
"ResponseLanguagePack": { | |||
"type": "object", | |||
"properties": { | |||
"data": { | |||
"$ref": "#/components/schemas/LanguagePack" | |||
}, | }, | ||
" | "meta": { | ||
"type": "object", | |||
"additionalProperties": { | |||
"type": "object", | |||
"description": "Additional response metadata." | |||
}, | |||
"description": "Additional response metadata." | |||
} | |||
} | |||
}, | |||
"CorsStatus": { | |||
"type": "object", | |||
"properties": { | |||
"active": { | |||
"type": "boolean", | "type": "boolean", | ||
"description": "Specifies whether | "description": "Specifies whether CORS is active or not for requesting origin", | ||
"example": true | |||
"example | |||
} | } | ||
}, | }, | ||
" | "description": "Main data of the response." | ||
}, | }, | ||
" | "ResponseCorsStatus": { | ||
"type": "object", | "type": "object", | ||
"properties": { | "properties": { | ||
" | "data": { | ||
"$ref": "#/components/schemas/CorsStatus" | |||
}, | |||
"meta": { | |||
"type": "object", | "type": "object", | ||
"description": " | "additionalProperties": { | ||
" | "type": "object", | ||
"description": "Additional response metadata." | |||
}, | |||
"description": "Additional response metadata." | |||
} | |||
} | |||
}, | |||
"MicrosoftGraphSettings": { | |||
"type": "object", | |||
"properties": { | |||
"applicationId": { | |||
"type": "string", | |||
"description": "The application ID." | |||
}, | }, | ||
" | "authority": { | ||
"type": "string", | "type": "string", | ||
"description": "The | "description": "The authority." | ||
} | } | ||
}, | }, | ||
"description": " | "description": "Microsoft Graph settings." | ||
}, | }, | ||
" | "OwaSettings": { | ||
"type": "object", | "type": "object", | ||
"properties": { | "properties": { | ||
" | "microsoftGraphSettings": { | ||
" | "$ref": "#/components/schemas/MicrosoftGraphSettings" | ||
} | |||
" | }, | ||
"description": "Settings for Cryptshare for OWA." | |||
}, | |||
"ResponseOwaSettings": { | |||
"type": "object", | |||
"properties": { | |||
"data": { | |||
"$ref": "#/components/schemas/OwaSettings" | |||
}, | }, | ||
" | "meta": { | ||
"type": " | "type": "object", | ||
"description": " | "additionalProperties": { | ||
" | "type": "object", | ||
"description": "Additional response metadata." | |||
}, | |||
"description": "Additional response metadata." | |||
} | |||
} | |||
}, | |||
"ResponsePassword-Wrapper": { | |||
"type": "object", | |||
"properties": { | |||
"data": { | |||
"$ref": "#/components/schemas/Password-Wrapper" | |||
}, | }, | ||
" | "meta": { | ||
"type": " | "type": "object", | ||
" | "additionalProperties": { | ||
"type": "object", | |||
"description": "Additional response metadata." | |||
}, | |||
"description": "Additional response metadata." | |||
} | |||
"description": " | } | ||
}, | |||
"ResponseArrayListPasswordValidationRule": { | |||
"type": "object", | |||
"properties": { | |||
"data": { | |||
"type": "array", | "type": "array", | ||
"description": " | "description": "Main data of the response.", | ||
"items": { | "items": { | ||
"$ref": "#/components/schemas/ | "$ref": "#/components/schemas/PasswordValidationRule" | ||
} | } | ||
}, | }, | ||
" | "meta": { | ||
"type": "object", | |||
"additionalProperties": { | |||
"type": "object", | |||
"description": "Additional response metadata." | |||
}, | |||
"type": " | "description": "Additional response metadata." | ||
" | |||
"description": " | |||
} | } | ||
} | } | ||
}, | }, | ||
" | "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." | ||
} | } | ||
}, | }, | ||
" | "description": "Main data of the response." | ||
}, | }, | ||
" | "ResponseClientId": { | ||
"type": "object", | "type": "object", | ||
"properties": { | "properties": { | ||
" | "data": { | ||
"$ref": "#/components/schemas/ClientId" | |||
"$ref": "#/components/schemas/ | |||
}, | }, | ||
" | "meta": { | ||
"type": "object", | |||
"type": " | "additionalProperties": { | ||
" | "type": "object", | ||
"description": "Additional response metadata." | |||
}, | |||
"type": " | "description": "Additional response metadata." | ||
" | |||
} | |||
"description": " | |||
} | } | ||
} | } | ||
}, | }, | ||
" | "ResponseVoid": { | ||
"type": "object", | "type": "object", | ||
"properties": { | "properties": { | ||
" | "data": { | ||
"type": " | "type": "object", | ||
"description": " | "description": "Main data of the response." | ||
}, | }, | ||
" | "meta": { | ||
"type": " | "type": "object", | ||
" | "additionalProperties": { | ||
"type": "object", | |||
"description": "Additional response metadata." | |||
}, | }, | ||
" | "description": "Additional response metadata." | ||
} | } | ||
} | } | ||
} | } | ||
Aktuelle Version vom 13. Februar 2024, 12:36 Uhr
| openapi | "3.0.1" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| info |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| servers |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| tags |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| paths |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| components |
|