{ "openapi": "3.0.1", "info": { "title": "Boomi Managed File Transfer - AFT Management API", "description": "Download OpenAPI Specification: Download \n\n Configuration API for Boomi Managed File Transfer platform. Manages organizations, credentials, flows, endpoints, processing options, schedules, and alerts. \n\n ## Authentication\n\nThe MFT Management API uses either tokens generated from username and passwords or API keys to authenticate requests. You can view and manage API keys generated per user in the MFT portal under the user profile.\n\n### Generate a user token to authenticate with the API\n\nTo generate a token for API calls, follow these steps on our Swagger page or from an external application or script. To generate a user token to authenticate with the API:\n\n1. To begin, you must determine the specific Swagger page that you need to connect to [US, UK, EU or AU](https://developer.boomi.com/docs/APIs/MFT/AFTRESTAPIs/swagger-ui-api).\n2. To access the appropriate Swagger page, navigate to the **Users** section.\n3. Locate the POST /api/Users/authenticate endpoint and click it to open the request details.\n4. Click the **Try it out** button.\n\n> **Warning:** If multi-factor authentication (MFA) is enabled for your account, you must first run the **ResendMfaCode** call to get your one-time password.\n\n5. The API call can be edited. Ensure you replace the **username**, **password**, and **MFA code** placeholders with your actual credentials.\n\n> **Info:** \"userName\": \"**your-userName**\", \"password\": \"**your-password**\", \"oneTimePasscode\": \"**your-oneTimePasscode**\"\n\n6. Enter your username, password, and MFA code in the placeholder strings and click the **Execute** button. If the process is successful, it displays the curl command, the request URL, the response body, and the response header.\n7. Information you need from here comes from the **response body**. You only need the data between the quotation marks after the semicolon. For examples, refer to [Authentication](https://developer.boomi.com/docs/APIs/MFT/AFTRESTAPIs/authentication#generate-a-user-token-to-authenticate-with-the-api) on Boomi Developer Docs. \n8. Once you have copied this information, return to the top of the page and click the **Authorize** button.\n9. Paste your data in the the **value** box and click the **Authorize** button. If the process is successful, a confirmation message appears.\n\nYou can now execute example API calls. Note that the bearer token will expire in approximately 10-15 minutes as a security measure. To maintain access, use the refresh token obtained from the authentication request. By providing this refresh token in the refresh access token call, you will reset the expiration timer. If you do not do this, you need to go through the entire authentication process again or use an API key.\n\n### Create an API Key to authenticate with the API\n\nYou can create API keys under a user profile for API authentication to the MFT service. To create an API Key:\n\n1. Navigate to the user's profile section.\n2. Click **Create API Key**.\n3. Provide the following information: **API Key Name**: Provide the key a name so it can be identified. **Expiration**: Keys can have an expiration date. An expired key can cause integrations to fail. **Associated Entities**: Keys can be associated with Organizations. **Permissions**: Keys can be given access to different API types.\n4. Click **Save**.\n\nOnce a key is created, it is listed as shown below.\n\n> **Note:** When using the API key from any external application the header should be called **ApiKey**.", "contact": { "name": "Customer Support", "url": "https://community.boomi.com/boomi_support", "email": "support@boomi.com" }, "version": "v1" }, "servers": [ { "url": "https://us.thruinc.com/" }, { "url": "https://uk.thruinc.com/" }, { "url": "https://eu.thruinc.com/" }, { "url": "https://au.thruinc.com/" } ], "paths": { "/api/Account": { "get": { "tags": [ "Account" ], "summary": "Retrieves the current user's profile information", "operationId": "Account_GetUserProfile", "responses": { "200": { "description": "Successfully retrieved user profile", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AccountUserProfileEditorViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AccountUserProfileEditorViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AccountUserProfileEditorViewModel" } } } }, "401": { "description": "Missing or invalid authentication credentials (ApiKey header or Bearer token required)", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "User is not authorized to access profile information", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "Internal server error occurred while retrieving profile", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "description": "Returns complete user profile including personal information, contact details, and account preferences." } }, "/api/Account/updateProfile": { "put": { "tags": [ "Account" ], "summary": "Updates the current user's profile information", "description": "Users can only update their own profile information.", "operationId": "Account_UpdateUserProfile", "requestBody": { "description": "Updated user profile data including preferences and settings", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountUserProfileEditorViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AccountUserProfileEditorViewModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AccountUserProfileEditorViewModel" } } } }, "responses": { "200": { "description": "Successfully updated user profile", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/UpdateUserProfileResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateUserProfileResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateUserProfileResponseViewModel" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } }, "401": { "description": "Missing or invalid authentication credentials", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "User is not authorized to update profile or attempting to update another user's profile", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "Internal server error occurred while updating profile", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } } } }, "/api/Account/changePassword": { "post": { "tags": [ "Account" ], "summary": "Changes the current user's password", "description": "Users can only change their own password. Requires password change permissions.", "operationId": "Account_ChangePassword", "requestBody": { "description": "Password change request containing current and new password", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChangePasswordViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChangePasswordViewModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ChangePasswordViewModel" } } } }, "responses": { "200": { "description": "Successfully changed password", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ChangePasswordResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ChangePasswordResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChangePasswordResponseViewModel" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } }, "401": { "description": "Missing or invalid authentication credentials", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "User is not authorized to change password or attempting to change another user's password", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "Internal server error occurred while changing password", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } } } }, "/api/Account/updateSession": { "post": { "tags": [ "Account" ], "summary": "Updates or invalidates user session", "description": "This endpoint allows anonymous access but requires Bearer token for session validation.\r\nUsed to handle session timeouts and logout scenarios.", "operationId": "Account_UpdateSession", "requestBody": { "description": "Session information including timeout and logout status", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserSessionViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UserSessionViewModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UserSessionViewModel" } } } }, "responses": { "200": { "description": "Successfully updated or invalidated session", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/UserSessionViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UserSessionViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UserSessionViewModel" } } } }, "400": { "description": "Invalid request or missing Bearer token", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } }, "401": { "description": "Invalid or expired Bearer token", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error occurred while updating session", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } } } }, "/api/Accounting/getCustomerTransferQuota": { "get": { "tags": [ "Accounting" ], "summary": "Retrieves the transfer quota information for the current customer", "description": "Requires billing API permissions to access customer transfer quota data.", "operationId": "Accounting_GetCustomerTransferQuota", "responses": { "200": { "description": "Successfully retrieved customer transfer quota", "content": { "text/plain": { "schema": { "type": "integer", "format": "int32" } }, "application/json": { "schema": { "type": "integer", "format": "int32" } }, "text/json": { "schema": { "type": "integer", "format": "int32" } } } }, "401": { "description": "Missing or invalid authentication credentials", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "User is not authorized to view billing information", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error occurred while retrieving quota information", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } } } } }, "/api/Accounting/getCustomerTransfers": { "get": { "tags": [ "Accounting" ], "summary": "Retrieves transfer usage data for the current customer", "description": "Requires billing API permissions to access customer transfer usage data.", "operationId": "Accounting_GetCustomerTransfers", "responses": { "200": { "description": "Successfully retrieved customer transfer data", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BillingCountsViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BillingCountsViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BillingCountsViewModel" } } } }, "401": { "description": "Missing or invalid authentication credentials", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "User is not authorized to view billing information", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error occurred while retrieving transfer data", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } } } } }, "/api/Accounting/GetCustomerMTDTransfers": { "get": { "tags": [ "Accounting" ], "summary": "Retrieves month-to-date transfer statistics for a specific organization", "description": "Requires billing API permissions. Use orgid=0 to get data for all accessible organizations.", "operationId": "Accounting_GetCustomerMTDTransfers", "parameters": [ { "name": "orgid", "in": "query", "description": "Organization identifier (0 for all accessible organizations)", "schema": { "type": "integer", "format": "int32" } }, { "name": "monthnum", "in": "query", "description": "Month number (1-12)", "schema": { "type": "integer", "format": "int32" } }, { "name": "year", "in": "query", "description": "Year for the transfer data", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully retrieved MTD transfer data", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BillingCountsMTDViewModel" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BillingCountsMTDViewModel" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BillingCountsMTDViewModel" } } } } }, "401": { "description": "Missing or invalid authentication credentials", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "User is not authorized to view billing information or access the specified organization", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Organization not found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error occurred while retrieving MTD data", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } } } } }, "/api/Accounting/GetCustomerDailyTransfersForMonth": { "get": { "tags": [ "Accounting" ], "summary": "Retrieves daily transfer statistics for a specific organization and month", "description": "Requires billing API permissions to access daily transfer breakdown data.", "operationId": "Accounting_GetCustomerDailyTransfersForMonth", "parameters": [ { "name": "orgid", "in": "query", "description": "Organization identifier", "schema": { "type": "integer", "format": "int32" } }, { "name": "monthnum", "in": "query", "description": "Month number (1-12)", "schema": { "type": "integer", "format": "int32" } }, { "name": "year", "in": "query", "description": "Year for the transfer data", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully retrieved daily transfer data", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BillingCountsDailyForMonthViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BillingCountsDailyForMonthViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BillingCountsDailyForMonthViewModel" } } } }, "401": { "description": "Missing or invalid authentication credentials", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "User is not authorized to view billing information", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error occurred while retrieving daily transfer data", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } } } } }, "/api/Accounting/GetDailyByMonth": { "get": { "tags": [ "Accounting" ], "summary": "Retrieves daily transfer statistics for a specific month and organization", "description": "Requires billing API permissions. Use orgId=0 to get data for all accessible organizations.", "operationId": "Accounting_GetDailyByMonth", "parameters": [ { "name": "year", "in": "query", "description": "Year for the transfer data", "schema": { "type": "integer", "format": "int32" } }, { "name": "month", "in": "query", "description": "Month number (1-12)", "schema": { "type": "integer", "format": "int32" } }, { "name": "orgId", "in": "query", "description": "Optional organization identifier (default: 0 for all accessible organizations)", "schema": { "type": "integer", "format": "int32", "default": 0 } } ], "responses": { "200": { "description": "Successfully retrieved daily transfer statistics", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BillingDashboardViewModel" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BillingDashboardViewModel" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BillingDashboardViewModel" } } } } }, "400": { "description": "Invalid parameters provided", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } }, "401": { "description": "Missing or invalid authentication credentials", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "User is not authorized to view billing information", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error occurred while retrieving transfer statistics", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } } } } }, "/api/Activity/getFileActivity": { "post": { "tags": [ "Activity" ], "summary": "Retrieves file activity based on the provided filters.", "description": "viewType:= SourceAndTargetStructured, Source, Target\r\n \r\ntransferStatusID:= Scheduled (1), Queued (2), Started (3), Progress (4), Completed (5), Cancelled (6), Error (7)\r\n \r\nExample requests:\r\n\r\nPOST /api/Activity/getFileActivity - Example using the minimum set of filer fields\r\n{\r\n \"showPurged\": false,\r\n \"viewType\": \"SourceAndTargetStructured\",\r\n \"flowCode\": \"\",\r\n \"flowId\": 0,\r\n \"organizationCode\": \"\",\r\n \"endpointCode\": \"\",\r\n \"filename\": \"\",\r\n \"fromDate\": \"2022-08-09\",\r\n \"transferStatusId\": [],\r\n \"processingStatus\": [],\r\n \"paging\": {\r\n \"pageNumber\": 1,\r\n \"totalCount\": 0,\r\n \"pageSize\": 30,\r\n \"orderBy\": \"\",\r\n \"orderDirection\": \"desc\"\r\n }\r\n}\r\n \r\nPOST /api/Activity/getFileActivity - Example filtering target files, purged, and with a timestamp\r\n{\r\n \"showPurged\": true,\r\n \"viewType\": \"Target\",\r\n \"flowCode\": \"\",\r\n \"flowId\": 0,\r\n \"organizationCode\": \"\",\r\n \"endpointCode\": \"\",\r\n \"filename\": \"\",\r\n \"fromDate\": \"2022-10-25T20:40:55.260Z\",\r\n \"transferStatusId\": [],\r\n \"processingStatus\": [],\r\n \"paging\": {\r\n \"pageNumber\": 1,\r\n \"totalCount\": 0,\r\n \"pageSize\": 50,\r\n \"orderBy\": \"\",\r\n \"orderDirection\": \"desc\"\r\n }\r\n}\r\n\r\nPOST /api/Activity/getFileActivity - Example filtering for Errors, Cancelled, and Queued files\r\n{\r\n\"viewType\":\"SourceAndTargetStructured\",\r\n\"showPurged\":false,\r\n\"flowCode\":\"\",\r\n\"organizationCode\":\"\",\r\n\"endpointCode\":\"\",\r\n\"fromDate\":\"2022-11-01T05:00:00.000Z\",\r\n\"filename\":\"\",\r\n\"transferStatusId\":[\"7\",\"6\",\"2\"],\r\n\"processingStatus\":[],\r\n\"paging\":{\r\n \"pageNumber\":1,\r\n \"totalCount\":0,\r\n \"pageSize\":50,\r\n \"orderBy\":\"TransferStateDateTimeConvert\",\r\n \"orderDirection\":\"desc\"\r\n }\r\n}", "operationId": "Activity_GetFileActivity", "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActivityFilesListViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ActivityFilesListViewModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ActivityFilesListViewModel" } } } }, "responses": { "200": { "description": "Successfully retrieved file activity records", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ActivityFilesListViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ActivityFilesListViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ActivityFilesListViewModel" } } } }, "400": { "description": "Invalid request parameters", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } } } }, "/api/Activity/getFileDownloadHistory": { "get": { "tags": [ "Activity" ], "summary": "Retrieves download history for a specific file", "operationId": "Activity_GetFileDownloadHistory", "parameters": [ { "name": "reportId", "in": "query", "description": "Unique identifier for the file report (must be a valid 24-digit hex string)", "schema": { "type": "string" } }, { "name": "flowEndpointType", "in": "query", "description": "Type of flow endpoint: 1 = Source, 2 = Target, 0 = All/Undefined", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully retrieved file download history", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FileDownloadHistoryItem" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FileDownloadHistoryItem" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FileDownloadHistoryItem" } } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "description": "Returns chronological list of download attempts including user information and download status for audit tracking." } }, "/api/Activity/getOrganizationEndpointsByFlow": { "get": { "tags": [ "Activity" ], "summary": "Gets organization endpoints associated with a specific flow", "operationId": "Activity_GetOrganizationEndpointsByFlow", "parameters": [ { "name": "flowId", "in": "query", "description": "Unique identifier for the flow", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully retrieved organization endpoints", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ActivityOrganizationEndpoint" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ActivityOrganizationEndpoint" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ActivityOrganizationEndpoint" } } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "description": "Returns list of organization endpoints configured for the specified flow, including endpoint codes and names." } }, "/api/Activity/getFilterItems": { "post": { "tags": [ "Activity" ], "summary": "Retrieves available filter options for activity searches", "operationId": "Activity_GetFilterItems", "requestBody": { "description": "Filter criteria to determine available options", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActivityFilterViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ActivityFilterViewModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ActivityFilterViewModel" } } } }, "responses": { "200": { "description": "Successfully retrieved filter options", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ActivityFilterViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ActivityFilterViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ActivityFilterViewModel" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "description": "Returns dynamic filter options including flows, organizations, endpoints, and flow endpoints based on user access." } }, "/api/Activity/getFileHistory": { "get": { "tags": [ "Activity" ], "summary": "Retrieves complete transfer history for a specific file", "operationId": "Activity_GetFileHistory", "parameters": [ { "name": "reportId", "in": "query", "description": "Unique identifier for the file report (must be a valid 24-digit hex string)", "schema": { "type": "string" } }, { "name": "flowEndpointId", "in": "query", "description": "Identifier for the flow endpoint", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully retrieved file history", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BaseResponse" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BaseResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BaseResponse" } } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "description": "Returns detailed transfer history including all state transitions and processing events for the specified file." } }, "/api/Activity/resendTargetFiles": { "post": { "tags": [ "Activity" ], "summary": "Resends target files for processing", "operationId": "Activity_ResendTargetFiles", "requestBody": { "description": "List of report identifiers for files to be resent (each must be a valid 24-digit hex string)", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } }, "text/json": { "schema": { "type": "array", "items": { "type": "string" } } }, "application/*+json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "responses": { "200": { "description": "Successfully initiated resend operation", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ResendTargetFilesResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ResendTargetFilesResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ResendTargetFilesResult" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "description": "Initiates reprocessing of previously transferred target files, useful for retry operations or error recovery." } }, "/api/Activity/deleteFiles": { "post": { "tags": [ "Activity" ], "summary": "Deletes files with optional associated file cleanup", "operationId": "Activity_DeleteFiles", "parameters": [ { "name": "deleteAssociatedFiles", "in": "query", "description": "Whether to delete associated files (default: false)", "schema": { "type": "boolean", "default": false } } ], "requestBody": { "description": "List of report identifiers for files to be deleted (each must be a valid 24-digit hex string)", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } }, "text/json": { "schema": { "type": "array", "items": { "type": "string" } } }, "application/*+json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "responses": { "200": { "description": "Successfully deleted files" }, "400": { "description": "Some errors occurred during bulk delete operation", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "description": "Removes specified files from the system, optionally including associated files in the deletion operation." } }, "/api/Activity/getTransferHistory": { "post": { "tags": [ "Activity" ], "summary": "Retrieves comprehensive transfer history for audit and reporting", "operationId": "Activity_GetTransferHistory", "requestBody": { "description": "Filter criteria for transfer history search", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransferHistoryFilterViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TransferHistoryFilterViewModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/TransferHistoryFilterViewModel" } } } }, "responses": { "200": { "description": "Successfully retrieved transfer history", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TransferHistoryReturnViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TransferHistoryReturnViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TransferHistoryReturnViewModel" } } } }, "400": { "description": "Invalid filter parameters provided", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "description": "Returns paginated transfer history with detailed action states, file metadata, and processing information for compliance and monitoring." } }, "/api/AdminCustomerRetentions": { "get": { "tags": [ "AdminCustomerRetentions" ], "summary": "Retrieves customer data retention policy configuration", "operationId": "AdminCustomerRetentions_GetCustomerRetention", "responses": { "200": { "description": "Successfully retrieved customer retention configuration", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomerRetentions" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomerRetentions" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomerRetentions" } } } }, "403": { "description": "User is not authorized to view retention policies", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "Internal server error occurred while retrieving retention policy", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "description": "Returns current retention policy settings including retention period and hard limit configurations." }, "post": { "tags": [ "AdminCustomerRetentions" ], "summary": "Creates a new customer data retention policy", "operationId": "AdminCustomerRetentions_Create", "requestBody": { "description": "Customer retention policy configuration details", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerRetentions" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomerRetentions" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CustomerRetentions" } } } }, "responses": { "200": { "description": "Successfully created customer retention policy", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomerRetentionResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomerRetentionResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomerRetentionResponseViewModel" } } } }, "400": { "description": "Invalid request data or validation errors", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "User is not authorized to create retention policies", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "Internal server error occurred while creating retention policy", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "description": "Establishes new data retention policy with specified period and hard limit settings for customer data management." }, "put": { "tags": [ "AdminCustomerRetentions" ], "summary": "Updates an existing customer data retention policy", "operationId": "AdminCustomerRetentions_Update", "requestBody": { "description": "Updated customer retention policy configuration", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerRetentions" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomerRetentions" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CustomerRetentions" } } } }, "responses": { "200": { "description": "Successfully updated customer retention policy", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomerRetentionResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomerRetentionResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomerRetentionResponseViewModel" } } } }, "400": { "description": "Invalid request data or validation errors", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "User is not authorized to update retention policies", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "Internal server error occurred while updating retention policy", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "description": "Modifies existing retention policy configuration including retention periods and enforcement settings." } }, "/api/AdminCustomerRetentions/save": { "put": { "tags": [ "AdminCustomerRetentions" ], "summary": "Saves customer data retention policy (creates new or updates existing based on ID)", "description": "Performs upsert operation: creates new policy if ID is 0, otherwise updates existing policy", "operationId": "AdminCustomerRetentions_Save", "requestBody": { "description": "Customer retention policy configuration to save", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerRetentions" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomerRetentions" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CustomerRetentions" } } } }, "responses": { "200": { "description": "Successfully saved customer retention policy", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomerRetentionResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomerRetentionResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomerRetentionResponseViewModel" } } } }, "400": { "description": "Invalid request data or validation errors", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "User is not authorized to save retention policies", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "Internal server error occurred while saving retention policy", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } } } }, "/api/AdminFeatureFlag": { "get": { "tags": [ "AdminFeatureFlag" ], "summary": "Retrieves all available feature flags and their current settings", "operationId": "AdminFeatureFlag_GetFeatureFlags", "responses": { "200": { "description": "Successfully retrieved feature flags", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerFeatureFlags" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerFeatureFlags" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerFeatureFlags" } } } } }, "400": { "description": "Failed to retrieve feature flags", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "401": { "description": "User is not authorized to view feature flags" }, "500": { "description": "Internal server error occurred" } }, "description": "Returns list of all feature flags and their current enabled/disabled state for the customer instance." }, "put": { "tags": [ "AdminFeatureFlag" ], "summary": "Updates feature flag settings for customer configurations", "operationId": "AdminFeatureFlag_SaveFeatureFlags", "requestBody": { "description": "List of customer feature flag configurations to save", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerFeatureFlags" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerFeatureFlags" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerFeatureFlags" } } } } }, "responses": { "200": { "description": "Successfully updated feature flags", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerFeatureFlags" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerFeatureFlags" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerFeatureFlags" } } } } }, "400": { "description": "Failed to update feature flags due to invalid data", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "401": { "description": "User is not authorized to update feature flags" }, "500": { "description": "Internal server error occurred" } }, "description": "Updates feature flag configurations to enable or disable specific features across the customer instance." } }, "/api/AdminMfaSettings": { "get": { "tags": [ "AdminMfaSettings" ], "summary": "Retrieves customer multi-factor authentication (MFA) settings", "operationId": "AdminMfaSettings_GetMfaSettings", "responses": { "200": { "description": "Successfully retrieved MFA settings", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomerMfaSettings" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomerMfaSettings" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomerMfaSettings" } } } }, "403": { "description": "User is not authorized to view MFA settings", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "Internal server error occurred while retrieving MFA settings", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "description": "Returns multi-factor authentication configuration including enabled status and trusted device TTL settings." }, "post": { "tags": [ "AdminMfaSettings" ], "summary": "Creates new customer multi-factor authentication (MFA) settings", "operationId": "AdminMfaSettings_Create", "requestBody": { "description": "Customer MFA configuration details", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerMfaSettings" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomerMfaSettings" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CustomerMfaSettings" } } } }, "responses": { "200": { "description": "Successfully created MFA settings", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomerMfaSettingsResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomerMfaSettingsResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomerMfaSettingsResponseViewModel" } } } }, "400": { "description": "Invalid request data or validation errors", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "User is not authorized to create MFA settings", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "Internal server error occurred while creating MFA settings", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "description": "Establishes new MFA configuration with specified authentication requirements and device trust settings." }, "put": { "tags": [ "AdminMfaSettings" ], "summary": "Updates existing customer multi-factor authentication (MFA) settings", "operationId": "AdminMfaSettings_Update", "requestBody": { "description": "Updated customer MFA configuration", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerMfaSettings" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomerMfaSettings" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CustomerMfaSettings" } } } }, "responses": { "200": { "description": "Successfully updated MFA settings", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomerMfaSettingsResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomerMfaSettingsResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomerMfaSettingsResponseViewModel" } } } }, "400": { "description": "Invalid request data or validation errors", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "User is not authorized to update MFA settings", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "Internal server error occurred while updating MFA settings", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "description": "Modifies existing MFA configuration including authentication requirements and trusted device settings." } }, "/api/AdminMfaSettings/save": { "put": { "tags": [ "AdminMfaSettings" ], "summary": "Saves customer multi-factor authentication (MFA) settings (creates new or updates existing based on ID)", "description": "Performs upsert operation: creates new MFA settings if ID is 0, otherwise updates existing settings", "operationId": "AdminMfaSettings_Save", "requestBody": { "description": "Customer MFA configuration to save", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerMfaSettings" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomerMfaSettings" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CustomerMfaSettings" } } } }, "responses": { "200": { "description": "Successfully saved MFA settings", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomerMfaSettingsResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomerMfaSettingsResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomerMfaSettingsResponseViewModel" } } } }, "400": { "description": "Invalid request data or validation errors", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "User is not authorized to save MFA settings", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "Internal server error occurred while saving MFA settings", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } } } }, "/api/AdminRoles": { "get": { "tags": [ "AdminRoles" ], "summary": "Retrieves a list of user roles with optional permission details", "operationId": "AdminRoles_ListRoles", "parameters": [ { "name": "includePermissions", "in": "query", "description": "Whether to include permission details for each role (default: false)", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Successfully retrieved user roles", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserRoleViewModel" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserRoleViewModel" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserRoleViewModel" } } } } }, "400": { "description": "Failed to retrieve user roles", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "403": { "description": "User is not authorized to view user roles" } }, "description": "Returns list of user roles with optional permission details for role management and assignment." }, "post": { "tags": [ "AdminRoles" ], "summary": "Creates a new user role with specified permissions", "operationId": "AdminRoles_CreateRole", "requestBody": { "description": "User role configuration including name and permissions", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserRoleViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UserRoleViewModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UserRoleViewModel" } } } }, "responses": { "200": { "description": "Successfully created user role", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/UserRoleViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UserRoleViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UserRoleViewModel" } } } }, "400": { "description": "Failed to create user role due to invalid data", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "403": { "description": "User is not authorized to create user roles" } }, "description": "Establishes new user role with specified permissions and role configuration." }, "put": { "tags": [ "AdminRoles" ], "summary": "Updates an existing user role and its permissions", "operationId": "AdminRoles_UpdateRole", "requestBody": { "description": "Updated user role configuration", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserRoleViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UserRoleViewModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UserRoleViewModel" } } } }, "responses": { "200": { "description": "Successfully updated user role", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/UserRoleViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UserRoleViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UserRoleViewModel" } } } }, "400": { "description": "Failed to update user role due to invalid data", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "403": { "description": "User is not authorized to update user roles" } }, "description": "Modifies existing user role configuration including permissions and role settings." } }, "/api/AdminRoles/getAssignablePermissions": { "get": { "tags": [ "AdminRoles" ], "summary": "Retrieves permissions that can be assigned to user roles", "operationId": "AdminRoles_GetAssignablePermissions", "responses": { "200": { "description": "Successfully retrieved assignable permissions", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Permission" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Permission" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Permission" } } } } }, "400": { "description": "Failed to retrieve assignable permissions", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "403": { "description": "User is not authorized to view assignable permissions" } }, "description": "Returns list of permissions that can be assigned to custom user roles." } }, "/api/AdminRoles/getAllPermissions": { "get": { "tags": [ "AdminRoles" ], "summary": "Retrieves all available permissions in the system", "operationId": "AdminRoles_GetAllPermissions", "responses": { "200": { "description": "Successfully retrieved all permissions", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Permission" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Permission" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Permission" } } } } }, "400": { "description": "Failed to retrieve permissions", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "403": { "description": "User is not authorized to view system permissions" } }, "description": "Returns complete list of all system permissions including hidden and assignable permissions." } }, "/api/AdminRoles/{roleId}": { "get": { "tags": [ "AdminRoles" ], "summary": "Retrieves a specific user role by its identifier", "operationId": "AdminRoles_GetRole", "parameters": [ { "name": "roleId", "in": "path", "description": "Unique identifier of the user role", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully retrieved user role", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/UserRoleViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UserRoleViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UserRoleViewModel" } } } }, "400": { "description": "Failed to retrieve user role", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "403": { "description": "User is not authorized to view this user role" } }, "description": "Returns detailed configuration for a specific user role including assigned permissions." }, "delete": { "tags": [ "AdminRoles" ], "summary": "Deletes a user role from the system", "operationId": "AdminRoles_DeleteRole", "parameters": [ { "name": "roleId", "in": "path", "description": "Unique identifier of the user role to delete", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully deleted user role" }, "400": { "description": "Failed to delete user role", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "409": { "description": "Cannot delete role due to existing dependencies", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "User is not authorized to delete user roles" } }, "description": "Removes user role from the system, preventing future role assignments." } }, "/api/AdminSsoMapping": { "get": { "tags": [ "AdminSsoMapping" ], "summary": "Retrieves all single sign-on (SSO) mapping configurations", "operationId": "AdminSsoMapping_GetSsoMappings", "responses": { "200": { "description": "Successfully retrieved SSO mappings", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AdminSsoMappingRequest" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AdminSsoMappingRequest" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AdminSsoMappingRequest" } } } } }, "403": { "description": "User is not authorized to view SSO mappings", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error occurred while retrieving SSO mappings" } }, "description": "Returns list of all SSO attribute mappings configured for identity provider integration." }, "post": { "tags": [ "AdminSsoMapping" ], "summary": "Creates a new single sign-on (SSO) mapping configuration", "operationId": "AdminSsoMapping_Create", "requestBody": { "description": "SSO mapping configuration details for identity provider integration", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminSsoMappingRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AdminSsoMappingRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AdminSsoMappingRequest" } } } }, "responses": { "200": { "description": "Successfully created SSO mapping", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AdminSsoMappingRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AdminSsoMappingRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AdminSsoMappingRequest" } } } }, "400": { "description": "Invalid request data or validation errors", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "User is not authorized to create SSO mappings", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error occurred while creating SSO mapping" } }, "description": "Establishes new SSO attribute mapping for automatic role and organization assignment during SSO login." }, "put": { "tags": [ "AdminSsoMapping" ], "summary": "Updates an existing single sign-on (SSO) mapping configuration", "operationId": "AdminSsoMapping_Update", "requestBody": { "description": "Updated SSO mapping configuration details", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminSsoMappingRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AdminSsoMappingRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AdminSsoMappingRequest" } } } }, "responses": { "200": { "description": "Successfully updated SSO mapping", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AdminSsoMappingRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AdminSsoMappingRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AdminSsoMappingRequest" } } } }, "400": { "description": "Invalid request data or validation errors", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "User is not authorized to update SSO mappings", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error occurred while updating SSO mapping" } }, "description": "Modifies existing SSO mapping configuration including attribute matching and role assignments." } }, "/api/AdminSsoMapping/{id}": { "get": { "tags": [ "AdminSsoMapping" ], "summary": "Retrieves a specific single sign-on (SSO) mapping configuration", "operationId": "AdminSsoMapping_GetSsoMapping", "parameters": [ { "name": "id", "in": "path", "description": "Unique identifier of the SSO mapping", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully retrieved SSO mapping", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AdminSsoMappingRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AdminSsoMappingRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AdminSsoMappingRequest" } } } }, "403": { "description": "User is not authorized to view this SSO mapping", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "SSO mapping not found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error occurred while retrieving SSO mapping" } }, "description": "Returns detailed SSO mapping configuration including attribute matching rules and assigned roles." }, "delete": { "tags": [ "AdminSsoMapping" ], "summary": "Deletes a single sign-on (SSO) mapping configuration", "operationId": "AdminSsoMapping_Delete", "parameters": [ { "name": "id", "in": "path", "description": "Unique identifier of the SSO mapping to delete", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully deleted SSO mapping", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DeleteResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DeleteResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeleteResponseViewModel" } } } }, "403": { "description": "User is not authorized to delete SSO mappings", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "SSO mapping not found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error occurred while deleting SSO mapping" } }, "description": "Removes SSO mapping configuration from the system." } }, "/api/AdminSsoMapping/bulk": { "put": { "tags": [ "AdminSsoMapping" ], "summary": "Updates multiple single sign-on (SSO) mapping configurations in bulk", "operationId": "AdminSsoMapping_BulkUpdate", "requestBody": { "description": "List of SSO mapping configurations to update", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AdminSsoMappingRequest" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AdminSsoMappingRequest" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AdminSsoMappingRequest" } } } } }, "responses": { "200": { "description": "Successfully completed bulk update of SSO mappings", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AdminSsoMappingRequest" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AdminSsoMappingRequest" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AdminSsoMappingRequest" } } } } }, "400": { "description": "Invalid request data or validation errors", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "User is not authorized to update SSO mappings", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error occurred during bulk update operation" } }, "description": "Updates multiple SSO mapping configurations in a single operation for efficient bulk management." } }, "/api/AdminThruNode/List": { "get": { "tags": [ "AdminThruNode" ], "summary": "Retrieves a comprehensive list of all nodes in the system", "operationId": "AdminThruNode_GetList", "responses": { "200": { "description": "Successfully retrieved nodes list", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/vwThruNodeList" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/vwThruNodeList" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/vwThruNodeList" } } } } }, "401": { "description": "Missing or invalid authentication credentials" }, "403": { "description": "User is not authorized to view nodes" }, "500": { "description": "Internal server error occurred while retrieving nodes list" } }, "description": "Returns complete list of all nodes across all organizations in the system for administrative monitoring." } }, "/api/AdminUsers/{userId}": { "get": { "tags": [ "AdminUsers" ], "summary": "Retrieves a specific user by their identifier", "description": "Requires instance admin API permissions and user get permissions to retrieve user details.", "operationId": "AdminUsers_GetById", "parameters": [ { "name": "userId", "in": "path", "description": "Unique identifier of the user to retrieve", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully retrieved user details", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AdminUserEditorViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AdminUserEditorViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AdminUserEditorViewModel" } } } }, "403": { "description": "User is not authorized to view this user", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error occurred while retrieving user", "content": { "text/plain": { "schema": { } }, "application/json": { "schema": { } }, "text/json": { "schema": { } } } } } }, "delete": { "tags": [ "AdminUsers" ], "summary": "Deletes a user from the system", "operationId": "AdminUsers_Delete", "parameters": [ { "name": "userId", "in": "path", "description": "Unique identifier of the user to delete", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully deleted user", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResult" } } } }, "403": { "description": "User is not authorized to delete users", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "User not found or access denied", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error occurred while deleting user", "content": { "text/plain": { "schema": { } }, "application/json": { "schema": { } }, "text/json": { "schema": { } } } } }, "description": "Removes user account and revokes all associated access and permissions." } }, "/api/AdminUsers/getUsersList": { "get": { "tags": [ "AdminUsers" ], "summary": "Retrieves a list of all users in the current customer instance", "description": "Requires instance admin API permissions and user get permissions to retrieve users list.", "operationId": "AdminUsers_GetUsersList", "responses": { "200": { "description": "Successfully retrieved users list", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AdminUsersLineItemViewModel" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AdminUsersLineItemViewModel" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AdminUsersLineItemViewModel" } } } } }, "403": { "description": "User is not authorized to view users", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error occurred while retrieving users", "content": { "text/plain": { "schema": { } }, "application/json": { "schema": { } }, "text/json": { "schema": { } } } } } } }, "/api/AdminUsers/getUsersListByCustomerId": { "get": { "tags": [ "AdminUsers" ], "summary": "Retrieves a list of users for a specific customer identifier", "description": "Requires instance admin API permissions and user get permissions.", "operationId": "AdminUsers_GetUsersListByCustomerId", "parameters": [ { "name": "customerId", "in": "query", "description": "Unique identifier of the customer", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully retrieved users list for customer", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AdminUsersLineItemViewModel" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AdminUsersLineItemViewModel" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AdminUsersLineItemViewModel" } } } } }, "403": { "description": "User is not authorized to view users for this customer", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error occurred while retrieving users", "content": { "text/plain": { "schema": { } }, "application/json": { "schema": { } }, "text/json": { "schema": { } } } } } } }, "/api/AdminUsers": { "post": { "tags": [ "AdminUsers" ], "summary": "Creates a new user in the system", "description": "Creates users with different role levels:\r\n- Administrator: Full system access with isAdmin = true\r\n- Instance User: Standard user access with isAdmin = false\r\n- Organization User: Organization-scoped access with organizationIds specified\r\n \r\nExample Administrator user:\r\n{\r\n \"firstName\": \"Admin\",\r\n \"lastName\": \"User\",\r\n \"username\": \"admin_user\",\r\n \"email\": \"admin@example.org\",\r\n \"isEnabled\": true,\r\n \"isAdmin\": true,\r\n \"isActive\": true,\r\n \"isLogSession\": true\r\n}", "operationId": "AdminUsers_Create", "requestBody": { "description": "User configuration details including roles and permissions", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminUserEditorViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AdminUserEditorViewModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AdminUserEditorViewModel" } } } }, "responses": { "200": { "description": "Successfully created user", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AdminUserEditorViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AdminUserEditorViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AdminUserEditorViewModel" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "User is not authorized to create users", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error occurred while creating user", "content": { "text/plain": { "schema": { } }, "application/json": { "schema": { } }, "text/json": { "schema": { } } } } } }, "put": { "tags": [ "AdminUsers" ], "summary": "Updates an existing user's configuration and settings", "description": "Required fields for user updates:\r\n{\r\n \"id\": valid user id,\r\n \"customerId\": valid customer id,\r\n \"firstName\": \"updated_first_name\",\r\n \"lastName\": \"updated_last_name\",\r\n \"username\": \"updated_username\",\r\n \"email\": \"updated_email@example.org\",\r\n \"isEnabled\": true,\r\n \"isActive\": true,\r\n \"isLogSession\": true\r\n }", "operationId": "AdminUsers_Update", "requestBody": { "description": "Updated user configuration details", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminUserEditorViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AdminUserEditorViewModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AdminUserEditorViewModel" } } } }, "responses": { "200": { "description": "Successfully updated user", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AdminUserEditorViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AdminUserEditorViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AdminUserEditorViewModel" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "User is not authorized to update users", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error occurred while updating user", "content": { "text/plain": { "schema": { } }, "application/json": { "schema": { } }, "text/json": { "schema": { } } } } } } }, "/api/AdminUsers/save": { "put": { "tags": [ "AdminUsers" ], "summary": "Saves user configuration (creates new or updates existing based on ID)", "description": "Performs upsert operation: creates new user if ID is 0, otherwise updates existing user", "operationId": "AdminUsers_Save", "requestBody": { "description": "User configuration to save", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminUserEditorViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AdminUserEditorViewModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AdminUserEditorViewModel" } } } }, "responses": { "200": { "description": "Successfully saved user", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AdminUserEditorViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AdminUserEditorViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AdminUserEditorViewModel" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "User is not authorized to save users", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error occurred while saving user", "content": { "text/plain": { "schema": { } }, "application/json": { "schema": { } }, "text/json": { "schema": { } } } } } } }, "/api/AdminUsers/unbanUser": { "get": { "tags": [ "AdminUsers" ], "summary": "Removes ban status from a user account to restore access", "operationId": "AdminUsers_UnbanUser", "parameters": [ { "name": "userId", "in": "query", "description": "Unique identifier of the user to unban", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully unbanned user", "content": { "text/plain": { "schema": { } }, "application/json": { "schema": { } }, "text/json": { "schema": { } } } }, "403": { "description": "User is not authorized to unban users", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error occurred while unbanning user", "content": { "text/plain": { "schema": { } }, "application/json": { "schema": { } }, "text/json": { "schema": { } } } } }, "description": "Removes temporary account ban to restore user access after failed login attempts." } }, "/api/AdminUsers/saveSelectedUserRoles": { "post": { "tags": [ "AdminUsers" ], "summary": "Assigns selected roles to a user", "operationId": "AdminUsers_SaveSelectedUserRoles", "requestBody": { "description": "User role assignment request containing user and role information", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SaveUserRoleRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SaveUserRoleRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SaveUserRoleRequest" } } } }, "responses": { "200": { "description": "Successfully assigned roles to user", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/thruStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/thruStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/thruStatus" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "User is not authorized to assign user roles", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error occurred while assigning roles", "content": { "text/plain": { "schema": { } }, "application/json": { "schema": { } }, "text/json": { "schema": { } } } } }, "description": "Updates role assignments for a user, replacing previous role configuration." } }, "/api/AdminUsers/getAvailableRoles": { "get": { "tags": [ "AdminUsers" ], "summary": "Retrieves all available roles that can be assigned to users", "operationId": "AdminUsers_GetAvailableRoles", "responses": { "200": { "description": "Successfully retrieved available roles", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserRole" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserRole" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserRole" } } } } }, "403": { "description": "User is not authorized to view available roles", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error occurred while retrieving roles", "content": { "text/plain": { "schema": { } }, "application/json": { "schema": { } }, "text/json": { "schema": { } } } } }, "description": "Returns list of all roles that can be assigned to users." } }, "/api/AdminUsers/getUserRoles/{userId}": { "get": { "tags": [ "AdminUsers" ], "summary": "Retrieves all roles assigned to a specific user", "description": "Requires instance admin API permissions and user role get permissions.\r\nRetrieves role assignments for the specified user within the current customer context.", "operationId": "AdminUsers_GetUserRoles", "parameters": [ { "name": "userId", "in": "path", "description": "Unique identifier of the user", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully retrieved user roles", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserInRole" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserInRole" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserInRole" } } } } }, "403": { "description": "User is not authorized to view user roles", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error occurred while retrieving user roles", "content": { "text/plain": { "schema": { } }, "application/json": { "schema": { } }, "text/json": { "schema": { } } } } } } }, "/api/AdminUsers/getUserSessionsList/{userId}": { "get": { "tags": [ "AdminUsers" ], "summary": "Retrieves session history for a specific user", "operationId": "AdminUsers_GetUserSessionsList", "parameters": [ { "name": "userId", "in": "path", "description": "Unique identifier of the user", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully retrieved user sessions", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/vwUserSessionsList" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/vwUserSessionsList" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/vwUserSessionsList" } } } } }, "403": { "description": "User is not authorized to view user sessions", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "User not found or access denied", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error occurred while retrieving sessions", "content": { "text/plain": { "schema": { } }, "application/json": { "schema": { } }, "text/json": { "schema": { } } } } }, "description": "Returns session history for a user including login times, IP addresses, and session status." } }, "/api/AdminUsers/resendActivationEmail": { "post": { "tags": [ "AdminUsers" ], "summary": "Resends activation email to a user for account activation", "operationId": "AdminUsers_ResendUserActivationEmail", "parameters": [ { "name": "userId", "in": "query", "description": "Unique identifier of the user", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully resent activation email", "content": { "text/plain": { "schema": { "type": "integer", "format": "int32" } }, "application/json": { "schema": { "type": "integer", "format": "int32" } }, "text/json": { "schema": { "type": "integer", "format": "int32" } } } }, "403": { "description": "User is not authorized to resend activation emails", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "User not found or access denied", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error occurred while sending email", "content": { "text/plain": { "schema": { } }, "application/json": { "schema": { } }, "text/json": { "schema": { } } } } }, "description": "Sends new activation email to user for account activation or password setup." } }, "/api/Alerts/getAlertHistory": { "get": { "tags": [ "Alerts" ], "summary": "Retrieves an alert history record by ID", "operationId": "Alerts_GetAlertHistory", "parameters": [ { "name": "alertHistoryId", "in": "query", "description": "Unique identifier of the alert history record to retrieve", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Successfully retrieved alert history record", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AlertHistory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AlertHistory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AlertHistory" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "description": "Returns detailed information for a specific historical alert record." } }, "/api/Alerts/getAlertHistoryView": { "get": { "tags": [ "Alerts" ], "summary": "Retrieves a formatted view of alert history for display purposes", "operationId": "Alerts_GetAlertHistoryView", "parameters": [ { "name": "alertHistoryId", "in": "query", "description": "Unique identifier of the alert history record", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Successfully retrieved alert history view", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AlertHistoryLineItemViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AlertHistoryLineItemViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AlertHistoryLineItemViewModel" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "description": "Returns formatted alert history record optimized for display purposes." } }, "/api/Alerts/getActiveAlert": { "get": { "tags": [ "Alerts" ], "summary": "Retrieves a specific active alert by ID", "operationId": "Alerts_GetActiveAlert", "parameters": [ { "name": "activeAlertId", "in": "query", "description": "Unique identifier of the active alert to retrieve", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Successfully retrieved active alert", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ActiveAlerts" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ActiveAlerts" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ActiveAlerts" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "description": "Returns detailed information for a specific active alert." } }, "/api/Alerts/getActiveAlertsList": { "post": { "tags": [ "Alerts" ], "summary": "Retrieves a filtered list of active alerts", "description": "Supports filtering by date range, alert type, severity level, and affected components", "operationId": "Alerts_GetActiveAlertsList", "requestBody": { "description": "Filter criteria for active alerts including date range, severity, and affected components", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertFilterViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AlertFilterViewModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AlertFilterViewModel" } } } }, "responses": { "200": { "description": "Successfully retrieved active alerts list", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ActiveAlerts" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ActiveAlerts" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ActiveAlerts" } } } } }, "400": { "description": "Invalid filter parameters provided", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } } } }, "/api/Alerts/getAlertHistoryList": { "post": { "tags": [ "Alerts" ], "summary": "Retrieves historical alert records with filtering capabilities", "description": "Provides comprehensive alert history for monitoring and audit purposes", "operationId": "Alerts_GetAlertHistoryList", "requestBody": { "description": "Filter criteria for alert history including date range, state, severity, and alert type", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertFilterViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AlertFilterViewModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AlertFilterViewModel" } } } }, "responses": { "200": { "description": "Successfully retrieved alert history list", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AlertHistoryLineItemViewModel" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AlertHistoryLineItemViewModel" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AlertHistoryLineItemViewModel" } } } } }, "400": { "description": "Invalid filter parameters provided", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } } } }, "/api/Alerts/getActiveAlertCount": { "get": { "tags": [ "Alerts" ], "summary": "Retrieves the total count of active alerts", "operationId": "Alerts_GetActiveAlertCount", "responses": { "200": { "description": "Successfully retrieved active alert count", "content": { "text/plain": { "schema": { "type": "integer", "format": "int32" } }, "application/json": { "schema": { "type": "integer", "format": "int32" } }, "text/json": { "schema": { "type": "integer", "format": "int32" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "description": "Returns total count of currently active alerts in the system." } }, "/api/Alerts/acknowledgeActiveAlert": { "post": { "tags": [ "Alerts" ], "summary": "Acknowledges an active alert to indicate it has been reviewed", "operationId": "Alerts_AcknowledgeActiveAlert", "parameters": [ { "name": "alertId", "in": "query", "description": "Unique identifier of the active alert to acknowledge", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Successfully acknowledged active alert", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResult" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "description": "Marks an active alert as reviewed by the current user." } }, "/api/Alerts/acknowledgeAlertHistory": { "post": { "tags": [ "Alerts" ], "summary": "Acknowledges a historical alert to indicate it has been reviewed", "operationId": "Alerts_AcknowledgeAlertHistory", "parameters": [ { "name": "alertId", "in": "query", "description": "Unique identifier of the historical alert to acknowledge", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Successfully acknowledged alert history record", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResult" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "description": "Marks a historical alert record as reviewed by the current user." } }, "/api/Alerts/clearActiveAlert": { "post": { "tags": [ "Alerts" ], "summary": "Clears an active alert from the system", "operationId": "Alerts_ClearActiveAlert", "parameters": [ { "name": "alertId", "in": "query", "description": "Unique identifier of the active alert to clear", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Successfully cleared active alert", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResult" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "description": "Removes an active alert from the active alerts list." } }, "/api/Alerts/clearAlertHistory": { "post": { "tags": [ "Alerts" ], "summary": "Clears a historical alert record from the system", "operationId": "Alerts_ClearAlertHistory", "parameters": [ { "name": "alertId", "in": "query", "description": "Unique identifier of the historical alert to clear", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Successfully cleared alert history record", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResult" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "description": "Removes a historical alert record from the alert history." } }, "/api/Alerts/clearAlertHistoryList": { "post": { "tags": [ "Alerts" ], "summary": "Clears multiple historical alert records in bulk operation", "operationId": "Alerts_ClearAlertHistoryList", "requestBody": { "description": "List of unique identifiers for historical alerts to clear", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int64" } } }, "text/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int64" } } }, "application/*+json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int64" } } } } }, "responses": { "200": { "description": "Successfully processed bulk clear operation", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResult" } } } }, "400": { "description": "Invalid alert ID list provided", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "description": "Removes multiple historical alert records in a single bulk operation." } }, "/api/Alerts/clearAllAlerts": { "post": { "tags": [ "Alerts" ], "summary": "Clears all alerts from the system (both active and historical)", "operationId": "Alerts_ClearAllAlerts", "responses": { "200": { "description": "Successfully cleared all alerts", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResult" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "description": "Removes all alerts from the system including both active and historical records." } }, "/api/ApiKey": { "get": { "tags": [ "ApiKey" ], "summary": "Retrieves a specific API key by identifier", "operationId": "ApiKey_Get", "parameters": [ { "name": "id", "in": "query", "description": "Unique identifier of the API key to retrieve", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successfully retrieved API key", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiKeys" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiKeys" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiKeys" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "404": { "description": "API key not found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "description": "Returns detailed API key configuration including name, permissions, and expiration settings." }, "put": { "tags": [ "ApiKey" ], "summary": "Updates an existing API key configuration", "operationId": "ApiKey_Update", "requestBody": { "description": "Updated API key configuration", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiKeys" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiKeys" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ApiKeys" } } } }, "responses": { "200": { "description": "Successfully updated API key", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiKeys" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiKeys" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiKeys" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "404": { "description": "API key not found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "description": "Modifies existing API key configuration including enabled status and allowed APIs." }, "delete": { "tags": [ "ApiKey" ], "summary": "Deletes an API key and revokes its access", "operationId": "ApiKey_Delete", "parameters": [ { "name": "id", "in": "query", "description": "Unique identifier of the API key to delete", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successfully deleted API key", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DeleteResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DeleteResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeleteResponseViewModel" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "404": { "description": "API key not found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "description": "Revokes and removes an API key from the system." } }, "/api/ApiKey/list": { "get": { "tags": [ "ApiKey" ], "summary": "Retrieves all API keys for the current user", "operationId": "ApiKey_List", "responses": { "200": { "description": "Successfully retrieved API keys list", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ApiKeys" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ApiKeys" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ApiKeys" } } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "description": "Returns list of all API keys for the current user with configuration details." } }, "/api/ApiKey/createApiKey": { "post": { "tags": [ "ApiKey" ], "summary": "Creates a new API key for programmatic access", "operationId": "ApiKey_Create", "requestBody": { "description": "API key configuration including name, permissions, and expiration", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiKeys" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiKeys" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ApiKeys" } } } }, "responses": { "200": { "description": "Successfully created API key", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiKeys" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiKeys" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiKeys" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "description": "Generates new API key with specified permissions, expiration, and access restrictions." } }, "/api/Certificates/getOrganizationCertificatesList": { "get": { "tags": [ "Certificates" ], "summary": "Retrieves all certificates associated with a specific organization", "operationId": "Certificates_GetOrganizationCertificatesList", "parameters": [ { "name": "organizationId", "in": "query", "description": "Organization identifier to retrieve certificates for", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully retrieved organization certificates", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CertificateViewModel" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CertificateViewModel" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CertificateViewModel" } } } } }, "401": { "description": "Unauthorized - Invalid or missing authentication", "content": { "text/plain": { "schema": { } }, "application/json": { "schema": { } }, "text/json": { "schema": { } } } }, "403": { "description": "Forbidden - Insufficient permissions", "content": { "text/plain": { "schema": { } }, "application/json": { "schema": { } }, "text/json": { "schema": { } } } }, "500": { "description": "Internal server error", "content": { "text/plain": { "schema": { } }, "application/json": { "schema": { } }, "text/json": { "schema": { } } } } }, "description": "Returns list of all certificates configured for a specific organization." } }, "/api/Certificates/getCertificate": { "get": { "tags": [ "Certificates" ], "summary": "Retrieves detailed information for a specific certificate", "operationId": "Certificates_GetCertificate", "parameters": [ { "name": "certificateId", "in": "query", "description": "Unique identifier of the certificate to retrieve", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully retrieved certificate details", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CertificateViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CertificateViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CertificateViewModel" } } } }, "401": { "description": "Unauthorized - Invalid or missing authentication", "content": { "text/plain": { "schema": { } }, "application/json": { "schema": { } }, "text/json": { "schema": { } } } }, "403": { "description": "Forbidden - Insufficient permissions", "content": { "text/plain": { "schema": { } }, "application/json": { "schema": { } }, "text/json": { "schema": { } } } }, "500": { "description": "Internal server error - including when certificate is not found", "content": { "text/plain": { "schema": { } }, "application/json": { "schema": { } }, "text/json": { "schema": { } } } } }, "description": "Returns detailed certificate information including type, filename, and metadata." } }, "/api/Certificates/getCertificateOptions": { "get": { "tags": [ "Certificates" ], "summary": "Retrieves available certificate configuration options and metadata", "operationId": "Certificates_GetCertificateOptions", "responses": { "200": { "description": "Successfully retrieved certificate options", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CertificateTypes" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CertificateTypes" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CertificateTypes" } } } } }, "401": { "description": "Unauthorized - Invalid or missing authentication", "content": { "text/plain": { "schema": { } }, "application/json": { "schema": { } }, "text/json": { "schema": { } } } }, "403": { "description": "Forbidden - Insufficient permissions", "content": { "text/plain": { "schema": { } }, "application/json": { "schema": { } }, "text/json": { "schema": { } } } }, "500": { "description": "Internal server error", "content": { "text/plain": { "schema": { } }, "application/json": { "schema": { } }, "text/json": { "schema": { } } } } }, "description": "Returns available certificate types and configuration options for certificate management." } }, "/api/Certificates/updateCertificate": { "put": { "tags": [ "Certificates" ], "summary": "Updates an existing certificate configuration", "operationId": "Certificates_UpdateCertificate", "requestBody": { "description": "Updated certificate configuration details and metadata", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CertificateEditorViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CertificateEditorViewModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CertificateEditorViewModel" } } } }, "responses": { "200": { "description": "Successfully updated certificate", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CertificateViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CertificateViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CertificateViewModel" } } } }, "401": { "description": "Unauthorized - Invalid or missing authentication", "content": { "text/plain": { "schema": { } }, "application/json": { "schema": { } }, "text/json": { "schema": { } } } }, "403": { "description": "Forbidden - Insufficient permissions", "content": { "text/plain": { "schema": { } }, "application/json": { "schema": { } }, "text/json": { "schema": { } } } }, "500": { "description": "Internal server error - including validation errors and certificate not found", "content": { "text/plain": { "schema": { } }, "application/json": { "schema": { } }, "text/json": { "schema": { } } } } }, "description": "Modifies existing certificate configuration including name and description metadata." } }, "/api/Certificates/createCertificate": { "post": { "tags": [ "Certificates" ], "summary": "Creates a new certificate for secure file transfer operations", "operationId": "Certificates_CreateCertificate", "requestBody": { "description": "Certificate configuration details including name, file data, and metadata", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CertificateEditorViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CertificateEditorViewModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CertificateEditorViewModel" } } } }, "responses": { "200": { "description": "Successfully created certificate", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Certificates" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Certificates" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Certificates" } } } }, "401": { "description": "Unauthorized - Invalid or missing authentication", "content": { "text/plain": { "schema": { } }, "application/json": { "schema": { } }, "text/json": { "schema": { } } } }, "403": { "description": "Forbidden - Insufficient permissions", "content": { "text/plain": { "schema": { } }, "application/json": { "schema": { } }, "text/json": { "schema": { } } } }, "500": { "description": "Internal server error - including validation errors", "content": { "text/plain": { "schema": { } }, "application/json": { "schema": { } }, "text/json": { "schema": { } } } } }, "description": "Uploads and configures new certificate for secure file transfer operations." } }, "/api/Certificates/deleteCertificate": { "delete": { "tags": [ "Certificates" ], "summary": "Deletes a certificate from the organization", "operationId": "Certificates_DeleteCertificate", "parameters": [ { "name": "id", "in": "query", "description": "Unique identifier of the certificate to delete", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully deleted certificate", "content": { "text/plain": { "schema": { } }, "application/json": { "schema": { } }, "text/json": { "schema": { } } } }, "400": { "description": "Invalid request, certificate not found, or certificate cannot be deleted", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized - Invalid or missing authentication", "content": { "text/plain": { "schema": { } }, "application/json": { "schema": { } }, "text/json": { "schema": { } } } }, "403": { "description": "Forbidden - Insufficient permissions", "content": { "text/plain": { "schema": { } }, "application/json": { "schema": { } }, "text/json": { "schema": { } } } }, "409": { "description": "Certificate is in use and cannot be deleted", "content": { "text/plain": { "schema": { } }, "application/json": { "schema": { } }, "text/json": { "schema": { } } } } }, "description": "Removes certificate from the organization, preventing future use in endpoint configurations." } }, "/api/EndpointOptions/getProtocols": { "get": { "tags": [ "EndpointOptions" ], "summary": "Retrieves all available protocols for endpoint configuration", "operationId": "EndpointOptions_GetProtocols", "responses": { "200": { "description": "Successfully retrieved protocols list", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/vwProtocolsList" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/vwProtocolsList" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/vwProtocolsList" } } } } }, "401": { "description": "Invalid or missing API key", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "User is not authorized to view endpoint protocols", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error occurred while retrieving protocols", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "description": "Returns list of all available transfer protocols for endpoint configuration." } }, "/api/EndpointOptions/getProtocolOptionsForProtocol": { "get": { "tags": [ "EndpointOptions" ], "summary": "Retrieves configuration options for a specific protocol", "operationId": "EndpointOptions_GetProtocolOptions", "parameters": [ { "name": "protocolId", "in": "query", "description": "Unique identifier of the protocol to get options for", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully retrieved protocol options", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProtocolTypeViewItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProtocolTypeViewItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProtocolTypeViewItem" } } } }, "403": { "description": "User is not authorized to view protocol options", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error occurred while retrieving protocol options", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "description": "Returns detailed configuration options and settings available for a specific protocol." } }, "/api/EndpointOptions/getAllProtocolTypes": { "get": { "tags": [ "EndpointOptions" ], "summary": "Retrieves all protocol types", "operationId": "EndpointOptions_GetAllProtocolTypes", "responses": { "200": { "description": "Successfully retrieved all protocol types", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProtocolWithOptionsViewModel" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProtocolWithOptionsViewModel" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProtocolWithOptionsViewModel" } } } } }, "401": { "description": "Invalid or missing API key", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "User is not authorized to view protocol types", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error occurred while retrieving protocol types", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "description": "Returns complete list of protocols with their associated endpoint types and configuration options." } }, "/api/EndpointOptions/getThruServerPath": { "get": { "tags": [ "EndpointOptions" ], "summary": "Retrieves the server path configuration", "operationId": "EndpointOptions_GetServerPath", "responses": { "200": { "description": "Successfully retrieved server path configuration", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "401": { "description": "Invalid or missing API key", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "User is not authorized to view server path configuration", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error occurred while retrieving server path", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "description": "Returns configured server path for endpoint setup and configuration." } }, "/api/EndpointOptions/getS3Regions": { "get": { "tags": [ "EndpointOptions" ], "summary": "Retrieves available AWS S3 regions for endpoint configuration", "operationId": "EndpointOptions_GetS3Regions", "responses": { "200": { "description": "Successfully retrieved S3 regions list", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AmazonRegions" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AmazonRegions" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AmazonRegions" } } } } }, "401": { "description": "Invalid or missing API key", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "User is not authorized to view S3 regions", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error occurred while retrieving S3 regions", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "description": "Returns list of available AWS S3 regions with endpoint URLs for S3 configuration." } }, "/api/EndpointOptions/getAzureBlobAuthTypes": { "get": { "tags": [ "EndpointOptions" ], "summary": "Retrieves available Azure Blob Storage authentication types for endpoints", "operationId": "EndpointOptions_GetAzureBlobAuthTypes", "responses": { "200": { "description": "Successfully retrieved Azure Blob auth types", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EndpointAuthTypes" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EndpointAuthTypes" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EndpointAuthTypes" } } } } }, "401": { "description": "Invalid or missing API key", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "User is not authorized to view Azure Blob auth types", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error occurred while retrieving auth types", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "description": "Returns available authentication methods for Azure Blob Storage endpoints." } }, "/api/Endpoints/{endpointId}": { "get": { "tags": [ "Endpoints" ], "summary": "Retrieves a specific endpoint configuration by ID", "description": "Requires organization endpoint read permissions to access endpoint configuration data.", "operationId": "Endpoints_GetById", "parameters": [ { "name": "endpointId", "in": "path", "description": "The unique identifier of the endpoint to retrieve", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully retrieved endpoint configuration", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/EndpointEditorViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/EndpointEditorViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EndpointEditorViewModel" } } } }, "401": { "description": "Missing or invalid authentication credentials", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "User is not authorized to view endpoint configurations", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "404": { "description": "Endpoint not found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "Internal server error occurred while retrieving endpoint", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } } }, "delete": { "tags": [ "Endpoints" ], "summary": "Deletes an endpoint configuration and removes all associated data", "description": "Requires organization endpoint delete permissions to remove endpoint configurations.", "operationId": "Endpoints_Delete", "parameters": [ { "name": "endpointId", "in": "path", "description": "Unique identifier of the endpoint to delete", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully deleted endpoint configuration", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResult" } } } }, "401": { "description": "Missing or invalid authentication credentials", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "User is not authorized to delete endpoint configurations", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "404": { "description": "Endpoint not found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "Internal server error occurred while deleting endpoint", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } } } }, "/api/Endpoints/getEndpoints": { "get": { "tags": [ "Endpoints" ], "summary": "Retrieves all endpoints for a specific organization", "description": "Requires organization endpoint read permissions to access endpoint configurations.", "operationId": "Endpoints_GetByOrganization", "parameters": [ { "name": "organizationId", "in": "query", "description": "The unique identifier of the organization", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully retrieved endpoints list", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/vwEndpointsList" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/vwEndpointsList" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/vwEndpointsList" } } } } }, "401": { "description": "Missing or invalid authentication credentials", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "User is not authorized to view endpoints for this organization", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "Internal server error occurred while retrieving endpoints", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } } } }, "/api/Endpoints/getThruNodeEndpoints": { "get": { "tags": [ "Endpoints" ], "summary": "Retrieves endpoints for a specific node within an organization", "description": "Requires organization endpoint read permissions to access node endpoint data.", "operationId": "Endpoints_GetByNode", "parameters": [ { "name": "organizationId", "in": "query", "description": "The unique identifier of the organization", "schema": { "type": "integer", "format": "int32" } }, { "name": "nodeId", "in": "query", "description": "The unique identifier of the node", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully retrieved node endpoints", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/vwEndpointsList" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/vwEndpointsList" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/vwEndpointsList" } } } } }, "401": { "description": "Missing or invalid authentication credentials", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "User is not authorized to view node endpoints", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "404": { "description": "Node not found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "Internal server error occurred while retrieving node endpoints", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } } } }, "/api/Endpoints": { "put": { "tags": [ "Endpoints" ], "summary": "Updates an existing endpoint configuration", "description": "Requires organization endpoint update permissions to modify endpoint configurations.\r\nRequest body must contain valid EndpointEditorViewModel data.", "operationId": "Endpoints_Update", "requestBody": { "description": "Updated endpoint configuration including connection details, authentication settings, and processing options", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EndpointEditorViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EndpointEditorViewModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EndpointEditorViewModel" } } } }, "responses": { "200": { "description": "Successfully updated endpoint configuration", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/EndpointEditorViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/EndpointEditorViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EndpointEditorViewModel" } } } }, "400": { "description": "Invalid request data or validation errors", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } }, "401": { "description": "Missing or invalid authentication credentials", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "User is not authorized to update endpoint configurations", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "404": { "description": "Endpoint not found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "Internal server error occurred while updating endpoint", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } } }, "post": { "tags": [ "Endpoints" ], "summary": "Creates a new endpoint configuration", "description": "Requires organization endpoint create permissions to create new endpoint configurations.\r\nRequest body must contain valid EndpointEditorViewModel data.", "operationId": "Endpoints_Create", "requestBody": { "description": "New endpoint configuration including connection details, authentication settings, and processing options", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EndpointEditorViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EndpointEditorViewModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EndpointEditorViewModel" } } } }, "responses": { "200": { "description": "Successfully created endpoint configuration", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/EndpointEditorViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/EndpointEditorViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EndpointEditorViewModel" } } } }, "400": { "description": "Invalid request data or validation errors", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } }, "401": { "description": "Missing or invalid authentication credentials", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "User is not authorized to create endpoint configurations", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "Internal server error occurred while creating endpoint", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } } } }, "/api/Endpoints/getInternalServerPath": { "get": { "tags": [ "Endpoints" ], "summary": "Retrieves the internal server path configuration for endpoint setup", "description": "Requires organization endpoint read permissions to access server path configuration.", "operationId": "Endpoints_GetInternalServerPath", "responses": { "200": { "description": "Successfully retrieved internal server path", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "401": { "description": "Missing or invalid authentication credentials", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "User is not authorized to view server path configuration", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "Internal server error occurred while retrieving server path", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } } } }, "/api/Endpoints/getThruPublicApiPath": { "get": { "tags": [ "Endpoints" ], "summary": "Retrieves the public API path configuration for endpoint integration", "description": "Requires organization endpoint read permissions to access public API path configuration.", "operationId": "Endpoints_GetPublicApiPath", "responses": { "200": { "description": "Successfully retrieved public API path", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "401": { "description": "Missing or invalid authentication credentials", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "User is not authorized to view API path configuration", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "Internal server error occurred while retrieving API path", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } } } }, "/api/Endpoints/downloadV1Installer": { "get": { "tags": [ "Endpoints" ], "summary": "Downloads the V1 installer package for endpoint deployment", "description": "Requires organization endpoint read permissions to download installer package.", "operationId": "Endpoints_DownloadV1Installer", "responses": { "200": { "description": "Successfully downloaded installer package", "content": { "text/plain": { "schema": { "type": "string", "format": "binary" } }, "application/json": { "schema": { "type": "string", "format": "binary" } }, "text/json": { "schema": { "type": "string", "format": "binary" } } } }, "401": { "description": "Missing or invalid authentication credentials", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "User is not authorized to download installer", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "Internal server error occurred while preparing download", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } } } }, "/api/Endpoints/downloadV1Config": { "get": { "tags": [ "Endpoints" ], "summary": "Retrieves the V1 configuration data for a specific endpoint", "description": "Requires organization endpoint read permissions to retrieve endpoint configuration.", "operationId": "Endpoints_DownloadV1Config", "parameters": [ { "name": "endpointId", "in": "query", "description": "Unique identifier of the endpoint to generate configuration for", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully retrieved configuration data", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResult" } } } }, "401": { "description": "Missing or invalid authentication credentials", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "User is not authorized to retrieve endpoint configuration", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "404": { "description": "Endpoint not found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "Internal server error occurred while generating configuration", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } } } }, "/api/Endpoints/regenerateTransportClientSecret": { "post": { "tags": [ "Endpoints" ], "summary": "Regenerates the transport client secret for an endpoint", "description": "Requires organization endpoint update permissions to regenerate transport client secrets.", "operationId": "Endpoints_RegenerateTransportClientSecret", "parameters": [ { "name": "endpointId", "in": "query", "description": "Unique identifier of the endpoint to regenerate secret for", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully regenerated transport client secret", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResult" } } } }, "401": { "description": "Missing or invalid authentication credentials", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "User is not authorized to regenerate client secrets", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "404": { "description": "Endpoint not found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "Internal server error occurred while regenerating secret", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } } } }, "/api/Endpoints/testSFTPConnection": { "post": { "tags": [ "Endpoints" ], "summary": "Tests SFTP connection using the provided endpoint configuration", "description": "Requires organization endpoint read permissions to test SFTP connections.\r\nRequest body must contain valid EndpointEditorViewModel data.", "operationId": "Endpoints_TestSftpConnection", "requestBody": { "description": "SFTP endpoint configuration to test", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EndpointEditorViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EndpointEditorViewModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EndpointEditorViewModel" } } } }, "responses": { "200": { "description": "Connection test completed", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResult" } } } }, "400": { "description": "Invalid request data or validation errors", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } }, "401": { "description": "Missing or invalid authentication credentials", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "User is not authorized to test connections", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "404": { "description": "Specified node not found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "Internal server error occurred during connection test", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } } } }, "/api/Endpoints/testFTPSConnection": { "post": { "tags": [ "Endpoints" ], "summary": "Tests FTPS connection using the provided endpoint configuration", "description": "Requires organization endpoint read permissions to test FTPS connections.\r\nRequest body must contain valid EndpointEditorViewModel data.", "operationId": "Endpoints_TestFtpsConnection", "requestBody": { "description": "FTPS endpoint configuration to test", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EndpointEditorViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EndpointEditorViewModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EndpointEditorViewModel" } } } }, "responses": { "200": { "description": "Connection test completed", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResult" } } } }, "400": { "description": "Invalid request data or validation errors", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } }, "401": { "description": "Missing or invalid authentication credentials", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "User is not authorized to test connections", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "404": { "description": "Specified node not found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "Internal server error occurred during connection test", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } } } }, "/api/Endpoints/testS3Connection": { "post": { "tags": [ "Endpoints" ], "summary": "Tests Amazon S3 connection using the provided endpoint configuration", "description": "Requires organization endpoint read permissions to test S3 connections.\r\nRequest body must contain valid EndpointEditorViewModel data.", "operationId": "Endpoints_TestS3Connection", "requestBody": { "description": "S3 endpoint configuration to test", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EndpointEditorViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EndpointEditorViewModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EndpointEditorViewModel" } } } }, "responses": { "200": { "description": "Connection test completed", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResult" } } } }, "400": { "description": "Invalid request data or validation errors", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } }, "401": { "description": "Missing or invalid authentication credentials", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "User is not authorized to test connections", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "404": { "description": "Specified node not found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "Internal server error occurred during connection test", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } } } }, "/api/Endpoints/testAzureBlobConnection": { "post": { "tags": [ "Endpoints" ], "summary": "Tests Azure Blob Storage connection using the provided endpoint configuration", "description": "Requires organization endpoint read permissions to test Azure Blob connections.\r\nRequest body must contain valid EndpointEditorViewModel data.", "operationId": "Endpoints_TestAzureBlobConnection", "requestBody": { "description": "Azure Blob endpoint configuration to test", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EndpointEditorViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EndpointEditorViewModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EndpointEditorViewModel" } } } }, "responses": { "200": { "description": "Connection test completed", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResult" } } } }, "400": { "description": "Invalid request data or validation errors", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } }, "401": { "description": "Missing or invalid authentication credentials", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "User is not authorized to test connections", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "404": { "description": "Specified node not found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "Internal server error occurred during connection test", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } } } }, "/api/Endpoints/testAzureFilesConnection": { "post": { "tags": [ "Endpoints" ], "summary": "Tests Azure Files connection using the provided endpoint configuration", "description": "Requires organization endpoint read permissions to test Azure Files connections.\r\nRequest body must contain valid EndpointEditorViewModel data.", "operationId": "Endpoints_TestAzureFilesConnection", "requestBody": { "description": "Azure Files endpoint configuration to test", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EndpointEditorViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EndpointEditorViewModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EndpointEditorViewModel" } } } }, "responses": { "200": { "description": "Connection test completed", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResult" } } } }, "400": { "description": "Invalid request data or validation errors", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } }, "401": { "description": "Missing or invalid authentication credentials", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "User is not authorized to test connections", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "404": { "description": "Specified node not found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "Internal server error occurred during connection test", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } } } }, "/api/Endpoints/testSharePointConnection": { "post": { "tags": [ "Endpoints" ], "summary": "Tests SharePoint connection using the provided endpoint configuration", "description": "Requires organization endpoint read permissions to test SharePoint connections.\r\nRequest body must contain valid EndpointEditorViewModel data.", "operationId": "Endpoints_TestSharePointConnection", "requestBody": { "description": "SharePoint endpoint configuration to test", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EndpointEditorViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EndpointEditorViewModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EndpointEditorViewModel" } } } }, "responses": { "200": { "description": "Connection test completed", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResult" } } } }, "400": { "description": "Invalid request data or validation errors", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } }, "401": { "description": "Missing or invalid authentication credentials", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "User is not authorized to test connections", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "404": { "description": "Specified node not found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "Internal server error occurred during connection test", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } } } }, "/api/Endpoints/testThruFileShareConnection": { "post": { "tags": [ "Endpoints" ], "summary": "Tests file share connection using the provided endpoint configuration", "description": "Requires organization endpoint read permissions to test file share connections.\r\nRequest body must contain valid EndpointEditorViewModel data.", "operationId": "Endpoints_TestFileShareConnection", "requestBody": { "description": "File share endpoint configuration to test", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EndpointEditorViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EndpointEditorViewModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EndpointEditorViewModel" } } } }, "responses": { "200": { "description": "Connection test completed", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResult" } } } }, "400": { "description": "Invalid request data or validation errors", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } }, "401": { "description": "Missing or invalid authentication credentials", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "User is not authorized to test connections", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "404": { "description": "Specified node not found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "Internal server error occurred during connection test", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } } } }, "/api/Endpoints/testGoogleCloudStorageConnection": { "post": { "tags": [ "Endpoints" ], "summary": "Tests Google Cloud Storage connection using the provided endpoint configuration", "description": "Requires organization endpoint read permissions to test Google Cloud Storage connections.\r\nRequest body must contain valid EndpointEditorViewModel data.", "operationId": "Endpoints_TestGoogleCloudStorageConnection", "requestBody": { "description": "Google Cloud Storage endpoint configuration to test", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EndpointEditorViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EndpointEditorViewModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EndpointEditorViewModel" } } } }, "responses": { "200": { "description": "Connection test completed", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResult" } } } }, "400": { "description": "Invalid request data or validation errors", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } }, "401": { "description": "Missing or invalid authentication credentials", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "User is not authorized to test connections", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "404": { "description": "Specified node not found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "Internal server error occurred during connection test", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } } } }, "/api/Endpoints/testLanConnection": { "post": { "tags": [ "Endpoints" ], "summary": "Tests LAN connection using the provided endpoint configuration", "description": "Requires organization endpoint read permissions to test LAN connections.\r\nRequest body must contain valid EndpointEditorViewModel data.", "operationId": "Endpoints_TestLanConnection", "requestBody": { "description": "LAN endpoint configuration to test", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EndpointEditorViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EndpointEditorViewModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EndpointEditorViewModel" } } } }, "responses": { "200": { "description": "Connection test completed successfully" }, "400": { "description": "Invalid request data or validation errors", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } }, "401": { "description": "Missing or invalid authentication credentials", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "User is not authorized to test connections", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "Internal server error occurred during connection test", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } } } }, "/api/Endpoints/getRecentEndpointActivity": { "get": { "tags": [ "Endpoints" ], "summary": "Retrieves recent activity data for all accessible endpoints", "description": "Requires organization endpoint read permissions to view endpoint activity.", "operationId": "Endpoints_GetRecentEndpointActivity", "parameters": [ { "name": "count", "in": "query", "description": "Maximum number of recent activity records to retrieve", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully retrieved recent endpoint activity", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EndpointActivityViewModel" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EndpointActivityViewModel" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EndpointActivityViewModel" } } } } }, "401": { "description": "Missing or invalid authentication credentials", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "User is not authorized to view endpoint activity", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "Internal server error occurred while retrieving activity data", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } } } }, "/api/Endpoints/getFlows": { "get": { "tags": [ "Endpoints" ], "summary": "Retrieves all flows associated with a specific endpoint", "description": "Requires organization endpoint read permissions to view endpoint flows.", "operationId": "Endpoints_GetFlows", "parameters": [ { "name": "endpointId", "in": "query", "description": "Unique identifier of the endpoint to retrieve flows for", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully retrieved endpoint flows", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Flows" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Flows" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Flows" } } } } }, "401": { "description": "Missing or invalid authentication credentials", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "User is not authorized to view endpoint flows", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "Internal server error occurred while retrieving flows", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } } } }, "/api/Endpoints/saveAndApply": { "put": { "tags": [ "Endpoints" ], "summary": "Saves endpoint configuration and applies flows synchronously", "description": "Requires organization endpoint update permissions to save and apply flows.\r\nRequest body must contain valid EndpointEditorViewModel data.", "operationId": "Endpoints_SaveAndApplyFlows", "requestBody": { "description": "Endpoint configuration with flow assignments to save and apply", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EndpointEditorViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EndpointEditorViewModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EndpointEditorViewModel" } } } }, "responses": { "200": { "description": "Successfully saved and applied flows", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FlowApplyResult" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FlowApplyResult" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FlowApplyResult" } } } } }, "400": { "description": "Invalid request data or validation errors", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } }, "401": { "description": "Missing or invalid authentication credentials", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "User is not authorized to update endpoint flows", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "Internal server error occurred during save and apply operation", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } } } }, "/api/Endpoints/saveAndApplyAsync": { "put": { "tags": [ "Endpoints" ], "summary": "Saves endpoint configuration and applies flows asynchronously", "description": "Requires organization endpoint update permissions to save and apply flows asynchronously.\r\nRequest body must contain valid EndpointEditorViewModel data.", "operationId": "Endpoints_SaveAndApplyFlowsAsync", "requestBody": { "description": "Endpoint configuration with flow assignments to save and apply", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EndpointEditorViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EndpointEditorViewModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EndpointEditorViewModel" } } } }, "responses": { "200": { "description": "Successfully initiated async flow application", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/FlowApplyJobResultDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FlowApplyJobResultDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FlowApplyJobResultDto" } } } }, "400": { "description": "Invalid request data or validation errors", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } }, "401": { "description": "Missing or invalid authentication credentials", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "User is not authorized to update endpoint flows", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "Internal server error occurred during save and apply operation", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } } } }, "/api/Endpoints/flowApplyJob/{jobId}": { "get": { "tags": [ "Endpoints" ], "summary": "Retrieves the status and results of an asynchronous flow application job", "description": "Requires organization endpoint read permissions to view flow application job status.", "operationId": "Endpoints_GetFlowApplyJobStatus", "parameters": [ { "name": "jobId", "in": "path", "description": "Unique identifier of the flow application job", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successfully retrieved job status", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/FlowApplyJobStatusDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FlowApplyJobStatusDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FlowApplyJobStatusDto" } } } }, "401": { "description": "Missing or invalid authentication credentials", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "User is not authorized to view job status", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "404": { "description": "Job not found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "Internal server error occurred while retrieving job status", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } } } }, "/api/Flow/getFlow": { "get": { "tags": [ "Flow" ], "summary": "Retrieves a specific flow configuration by ID", "description": "Requires flow read permissions to access flow configuration data.", "operationId": "Flow_GetFlow", "parameters": [ { "name": "flowId", "in": "query", "description": "The unique identifier of the flow to retrieve", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully retrieved flow configuration", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Flows" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Flows" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Flows" } } } }, "401": { "description": "Missing or invalid authentication credentials", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "User is not authorized to view flow configurations", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "404": { "description": "Flow not found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } }, "500": { "description": "Internal server error occurred while retrieving flow", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } } } } }, "/api/Flow/getFlowByName": { "get": { "tags": [ "Flow" ], "summary": "Retrieves a specific flow configuration by name", "description": "Requires flow read permissions to access flow configuration data.", "operationId": "Flow_GetFlowByName", "parameters": [ { "name": "flowName", "in": "query", "description": "The name of the flow to retrieve", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successfully retrieved flow configuration", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Flows" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Flows" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Flows" } } } }, "401": { "description": "Missing or invalid authentication credentials", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "User is not authorized to view flow configurations", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "404": { "description": "Flow not found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } }, "500": { "description": "Internal server error occurred while retrieving flow", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } } } } }, "/api/Flow/getFlowList": { "get": { "tags": [ "Flow" ], "summary": "Retrieves a list of all flow configurations", "description": "Requires flow read permissions to access flow configuration list.", "operationId": "Flow_GetFlowList", "responses": { "200": { "description": "Successfully retrieved flow list", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FlowEditorViewModel" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FlowEditorViewModel" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FlowEditorViewModel" } } } } }, "401": { "description": "Missing or invalid authentication credentials", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "User is not authorized to view flow configurations", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "Internal server error occurred while retrieving flows", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } } } }, "/api/Flow/updateFlowStatus": { "post": { "tags": [ "Flow" ], "summary": "Updates the operational status of a flow", "description": "Requires flow update permissions to modify flow operational status.\r\nRequest body must contain valid FlowUpdate model data.", "operationId": "Flow_UpdateFlowStatus", "requestBody": { "description": "Flow update request containing flow ID and new enabled status", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlowUpdate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FlowUpdate" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/FlowUpdate" } } } }, "responses": { "200": { "description": "Successfully updated flow status", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Flows" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Flows" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Flows" } } } }, "400": { "description": "Invalid request data or validation errors", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } }, "401": { "description": "Missing or invalid authentication credentials", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "User is not authorized to update flow status", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "404": { "description": "Flow not found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } }, "500": { "description": "Internal server error occurred while updating flow status", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } } } } }, "/api/Flow/updateFlow": { "put": { "tags": [ "Flow" ], "summary": "Updates an existing flow configuration", "description": "Requires flow update permissions to modify flow configurations.\r\nRequest body must contain valid Flows model data.", "operationId": "Flow_UpdateFlow", "requestBody": { "description": "Complete flow model with updated configuration settings", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Flows" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Flows" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Flows" } } } }, "responses": { "200": { "description": "Successfully updated flow configuration", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Flows" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Flows" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Flows" } } } }, "400": { "description": "Invalid request data or validation errors", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } }, "401": { "description": "Missing or invalid authentication credentials", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "User is not authorized to update flow configurations", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "404": { "description": "Flow not found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } }, "500": { "description": "Internal server error occurred while updating flow", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } } } } }, "/api/Flow/createFlow": { "post": { "tags": [ "Flow" ], "summary": "Creates a new flow configuration", "description": "Requires flow create permissions to create new flow configurations.\r\nRequest body must contain valid Flows model data.", "operationId": "Flow_CreateFlow", "requestBody": { "description": "Complete flow model with configuration settings for the new flow", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Flows" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Flows" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Flows" } } } }, "responses": { "200": { "description": "Successfully created flow configuration", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Flows" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Flows" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Flows" } } } }, "400": { "description": "Invalid request data or validation errors", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } }, "401": { "description": "Missing or invalid authentication credentials", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "User is not authorized to create flow configurations", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "Internal server error occurred while creating flow", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } } } }, "/api/Flow/deleteFlow": { "delete": { "tags": [ "Flow" ], "summary": "Deletes a flow configuration", "operationId": "Flow_DeleteFlow", "parameters": [ { "name": "id", "in": "query", "description": "The unique identifier of the flow to delete", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully deleted flow configuration", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResult" } } } }, "401": { "description": "Missing or invalid authentication credentials", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "User is not authorized to delete flow configurations", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "404": { "description": "Flow not found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } }, "500": { "description": "Internal server error occurred while deleting flow", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } } }, "description": "Removes flow configuration and all associated flow endpoint relationships." } }, "/api/Flow/applyFlow": { "post": { "tags": [ "Flow" ], "summary": "Applies and activates a flow configuration", "operationId": "Flow_ApplyFlow", "parameters": [ { "name": "flowId", "in": "query", "description": "The unique identifier of the flow to apply", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully applied flow configuration", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResult" } } } }, "401": { "description": "Missing or invalid authentication credentials", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "User is not authorized to apply flow configurations", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "404": { "description": "Flow not found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } }, "500": { "description": "Internal server error occurred while applying flow", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } } }, "description": "Activates flow configuration changes by applying them to the runtime environment." } }, "/api/Flow/runFlowEndpointNow": { "get": { "tags": [ "Flow" ], "summary": "Immediately executes a specific flow endpoint", "operationId": "Flow_RunFlowEndpointNow", "parameters": [ { "name": "flowEndpointId", "in": "query", "description": "The unique identifier of the flow endpoint to execute", "schema": { "type": "integer", "format": "int32" } }, { "name": "flowId", "in": "query", "description": "The unique identifier of the parent flow", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully initiated flow endpoint execution", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResult" } } } }, "401": { "description": "Missing or invalid authentication credentials", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "User is not authorized to execute flow endpoints", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "404": { "description": "Flow endpoint not found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } }, "500": { "description": "Internal server error occurred while executing flow endpoint", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } } }, "description": "Immediately triggers execution of a specific flow endpoint outside of scheduled times." }, "post": { "tags": [ "Flow" ], "summary": "Immediately executes a specific flow endpoint using request body", "operationId": "Flow_RunFlowEndpointNowPost", "requestBody": { "description": "Flow endpoint execution request containing the endpoint identifier", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RunFlowEndpointRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RunFlowEndpointRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RunFlowEndpointRequest" } } } }, "responses": { "200": { "description": "Successfully initiated flow endpoint execution", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResult" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "User is not authorized to execute flow endpoints", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "Internal server error occurred while executing flow endpoint", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "description": "Immediately triggers execution of a specific flow endpoint using POST request body." } }, "/api/Flow/getFlowState": { "get": { "tags": [ "Flow" ], "summary": "Retrieves the current operational state of a flow", "operationId": "Flow_GetFlowState", "parameters": [ { "name": "flowId", "in": "query", "description": "The unique identifier of the flow", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully retrieved flow state", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResult" } } } }, "404": { "description": "Flow not found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "User is not authorized to view flow state" }, "500": { "description": "Internal server error occurred while retrieving flow state" } }, "description": "Returns current operational state information for a flow." } }, "/api/Flow/getRecentFlowActivity": { "get": { "tags": [ "Flow" ], "summary": "Retrieves recent activity for flows", "operationId": "Flow_GetRecentActivity", "parameters": [ { "name": "count", "in": "query", "description": "Number of recent activity records to retrieve", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully retrieved flow activity", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResult" } } } }, "401": { "description": "Missing or invalid authentication credentials", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "User is not authorized to view flow activity", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "Internal server error occurred while retrieving flow activity", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } } }, "description": "Returns recent flow activity including transfer counts and execution history." } }, "/api/Flow/getFileZillaConfig": { "get": { "tags": [ "Flow" ], "summary": "Retrieves FileZilla FTP client configuration for a flow", "operationId": "Flow_GetFileZillaConfig", "parameters": [ { "name": "flowId", "in": "query", "description": "The unique identifier of the flow", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully retrieved FileZilla configuration", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResult" } } } }, "404": { "description": "Flow not found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "User is not authorized to access FileZilla configuration" }, "500": { "description": "Internal server error occurred while retrieving FileZilla configuration" } }, "description": "Returns FileZilla configuration XML for FTP/FTPS flow endpoint setup." }, "post": { "tags": [ "Flow" ], "summary": "Retrieves FileZilla FTP client configuration for multiple flows", "operationId": "Flow_GetFileZillaConfigMultiple", "requestBody": { "description": "List of flow identifiers to generate configuration for", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, "text/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, "application/*+json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } }, "responses": { "200": { "description": "Successfully retrieved FileZilla configuration for multiple flows", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResult" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "User is not authorized to access FileZilla configuration" }, "500": { "description": "Internal server error occurred while retrieving FileZilla configuration" } }, "description": "Returns FileZilla configuration XML for multiple flows in a single response." } }, "/api/Flow/exportFlowsById": { "post": { "tags": [ "Flow" ], "summary": "Exports multiple flow configurations for backup or migration", "operationId": "Flow_ExportFlowsById", "requestBody": { "description": "List of flow identifiers to export", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, "text/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, "application/*+json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } }, "responses": { "200": { "description": "Successfully exported flow configurations", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResult" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "One or more flows not found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "User is not authorized to export flow configurations" }, "500": { "description": "Internal server error occurred while exporting flows" } }, "description": "Exports flow configurations as JSON for backup or migration to another environment." } }, "/api/Flow/exportFlowByCode": { "get": { "tags": [ "Flow" ], "summary": "Exports a single flow configuration by flow code", "operationId": "Flow_ExportFlowByCode", "parameters": [ { "name": "flowCode", "in": "query", "description": "The unique code identifier of the flow to export", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successfully exported flow configuration", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResult" } } } }, "404": { "description": "Flow not found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "User is not authorized to export flow configurations" }, "500": { "description": "Internal server error occurred while exporting flow" } }, "description": "Exports single flow configuration identified by flow code as JSON." } }, "/api/Flow/importFlows": { "post": { "tags": [ "Flow" ], "summary": "Imports flow configurations from JSON data", "operationId": "Flow_ImportFlows", "requestBody": { "description": "JSON string containing flow configuration data to import", "content": { "application/json": { "schema": { } }, "text/json": { "schema": { } }, "application/*+json": { "schema": { } } } }, "responses": { "200": { "description": "Successfully imported flow configurations", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResult" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "User is not authorized to import flow configurations" }, "500": { "description": "Internal server error occurred while importing flows" } }, "description": "Imports flow configurations from JSON data into the current environment." } }, "/api/Flow/getTransferRequests": { "get": { "tags": [ "Flow" ], "summary": "Retrieves transfer requests for a flow", "operationId": "Flow_GetTransferRequests", "parameters": [ { "name": "flowId", "in": "query", "description": "The unique identifier of the flow", "schema": { "type": "integer", "format": "int32" } }, { "name": "fromDate", "in": "query", "description": "Optional start date filter for transfer requests", "schema": { "type": "string", "format": "date-time" } }, { "name": "toDate", "in": "query", "description": "Optional end date filter for transfer requests", "schema": { "type": "string", "format": "date-time" } }, { "name": "filters", "in": "query", "description": "Optional additional filters for transfer request search", "schema": { "type": "object", "additionalProperties": { "type": "string" } } } ], "responses": { "200": { "description": "Successfully retrieved transfer requests", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResult" } } } }, "403": { "description": "User is not authorized to view transfer requests" }, "500": { "description": "Internal server error occurred while retrieving transfer requests" } }, "description": "Returns transfer request history for a flow with optional date filtering." } }, "/api/Flow/getClientResponses": { "get": { "tags": [ "Flow" ], "summary": "Retrieves client responses for a specific transfer request", "operationId": "Flow_GetClientResponses", "parameters": [ { "name": "requestId", "in": "query", "description": "The unique identifier of the transfer request", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Successfully retrieved client responses", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResult" } } } }, "403": { "description": "User is not authorized to view client responses" }, "500": { "description": "Internal server error occurred while retrieving client responses" } }, "description": "Returns client responses associated with a specific transfer request." } }, "/api/Flow/getActiveSchedules": { "get": { "tags": [ "Flow" ], "summary": "Retrieves active schedules for a flow", "operationId": "Flow_GetActiveSchedules", "parameters": [ { "name": "flowId", "in": "query", "description": "The unique identifier of the flow", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully retrieved active schedules", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResult" } } } }, "400": { "description": "Invalid flow identifier provided", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "User is not authorized to view flow schedules" }, "500": { "description": "Internal server error occurred while retrieving schedules" } }, "description": "Returns list of currently active schedules configured for a flow." } }, "/api/Flow/getAvailableNodes": { "get": { "tags": [ "Flow" ], "summary": "Retrieves available nodes for a flow", "operationId": "Flow_GetAvailableNodes", "parameters": [ { "name": "flowId", "in": "query", "description": "The unique identifier of the flow", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully retrieved available nodes", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResult" } } } }, "403": { "description": "User is not authorized to view available nodes" }, "500": { "description": "Internal server error occurred while retrieving available nodes" } }, "description": "Returns list of nodes available for assignment to the specified flow." } }, "/api/Flow/applyFlowJob": { "post": { "tags": [ "Flow" ], "summary": "Initiates an asynchronous job to apply a flow configuration", "operationId": "Flow_ApplyFlowJob", "requestBody": { "description": "Apply flow job request containing the flow identifier", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplyFlowJobRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApplyFlowJobRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ApplyFlowJobRequest" } } } }, "responses": { "200": { "description": "Successfully initiated apply flow job", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResult" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "User is not authorized to apply flow configurations" }, "500": { "description": "Internal server error occurred while initiating apply job" } }, "description": "Initiates asynchronous job to apply flow configuration changes to runtime environment." } }, "/api/Flow/applyFlowJob/{jobId}": { "get": { "tags": [ "Flow" ], "summary": "Retrieves the status of a flow apply job", "operationId": "Flow_GetApplyFlowJobStatus", "parameters": [ { "name": "jobId", "in": "path", "description": "The unique identifier of the apply flow job", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successfully retrieved job status", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResult" } } } }, "404": { "description": "Job not found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "User is not authorized to view job status" }, "500": { "description": "Internal server error occurred while retrieving job status" } }, "description": "Returns current status and progress of an asynchronous flow apply job." } }, "/api/FlowEndpoint/getFlowEndpoint": { "get": { "tags": [ "FlowEndpoint" ], "summary": "Retrieves a specific flow endpoint configuration", "operationId": "FlowEndpoint_Get", "parameters": [ { "name": "flowEndpointId", "in": "query", "description": "Unique identifier of the flow endpoint", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully retrieved flow endpoint", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/FlowEndpoints" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FlowEndpoints" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FlowEndpoints" } } } }, "401": { "description": "User is not authenticated", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "User is not authorized to view flow endpoints", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } }, "404": { "description": "Flow endpoint not found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } }, "500": { "description": "Internal server error occurred while retrieving flow endpoint", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } } }, "description": "Returns complete flow endpoint configuration including processing options, schedules, and alerts." } }, "/api/FlowEndpoint/getFlowEndpointsList": { "get": { "tags": [ "FlowEndpoint" ], "summary": "Retrieves a list of flow endpoints with optional filtering", "operationId": "FlowEndpoint_GetList", "parameters": [ { "name": "flowId", "in": "query", "description": "Optional flow identifier to filter endpoints", "schema": { "type": "integer", "format": "int32" } }, { "name": "flowEndpointTypeId", "in": "query", "description": "Optional endpoint type identifier to filter by type: 1 = Source, 2 = Target, 0 = All/Undefined", "schema": { "type": "integer", "format": "int32" } }, { "name": "orgIds", "in": "query", "description": "Optional organization identifiers to filter by organizations", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successfully retrieved flow endpoints list", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FlowEndpoints" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FlowEndpoints" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FlowEndpoints" } } } } }, "401": { "description": "User is not authenticated", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "User is not authorized to view flow endpoints", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } }, "500": { "description": "Internal server error occurred while retrieving flow endpoints", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } } }, "description": "Returns list of flow endpoints with optional filtering by flow, type, or organization." } }, "/api/FlowEndpoint/getThruNodeFlowEndpoints": { "get": { "tags": [ "FlowEndpoint" ], "summary": "Retrieves flow endpoints associated with a specific node", "operationId": "FlowEndpoint_GetByNode", "parameters": [ { "name": "nodeId", "in": "query", "description": "Unique identifier of the node", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully retrieved node flow endpoints", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FlowEndpoints" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FlowEndpoints" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FlowEndpoints" } } } } }, "401": { "description": "User is not authenticated", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "User is not authorized to view node flow endpoints", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } }, "404": { "description": "Node not found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } }, "500": { "description": "Internal server error occurred while retrieving node flow endpoints", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } } }, "description": "Returns list of flow endpoints configured to use a specific node." } }, "/api/FlowEndpoint/getUnassignedFlowEndpointsList": { "get": { "tags": [ "FlowEndpoint" ], "summary": "Retrieves flow endpoints that are not yet assigned to a flow", "operationId": "FlowEndpoint_GetUnassigned", "parameters": [ { "name": "flowId", "in": "query", "description": "Flow identifier to check for unassigned endpoints", "schema": { "type": "integer", "format": "int32" } }, { "name": "organizationId", "in": "query", "description": "Organization identifier to filter endpoints", "schema": { "type": "integer", "format": "int32" } }, { "name": "flowEndpointTypeId", "in": "query", "description": "Endpoint type identifier to filter by type: 1 = Source, 2 = Target, 0 = All/Undefined", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully retrieved unassigned flow endpoints", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FlowEndpoints" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FlowEndpoints" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FlowEndpoints" } } } } }, "401": { "description": "User is not authenticated", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "User is not authorized to view flow endpoints", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } }, "500": { "description": "Internal server error occurred while retrieving unassigned endpoints", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } } }, "description": "Returns list of flow endpoints not yet assigned to any flow configuration." } }, "/api/FlowEndpoint/createFlowEndpoint": { "post": { "tags": [ "FlowEndpoint" ], "summary": "Creates a new flow endpoint configuration", "operationId": "FlowEndpoint_Create", "requestBody": { "description": "Flow endpoint configuration details", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlowEndpoints" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FlowEndpoints" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/FlowEndpoints" } } } }, "responses": { "200": { "description": "Successfully created flow endpoint", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/FlowEndpoints" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FlowEndpoints" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FlowEndpoints" } } } }, "400": { "description": "Invalid flow endpoint data provided", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } }, "401": { "description": "User is not authenticated", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "User is not authorized to create flow endpoints", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } }, "500": { "description": "Internal server error occurred while creating flow endpoint", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } } }, "description": "Establishes new flow endpoint with specified endpoint reference and configuration." } }, "/api/FlowEndpoint/updateFlowEndpoint": { "put": { "tags": [ "FlowEndpoint" ], "summary": "Updates an existing flow endpoint configuration", "operationId": "FlowEndpoint_Update", "requestBody": { "description": "Updated flow endpoint configuration details", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlowEndpoints" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FlowEndpoints" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/FlowEndpoints" } } } }, "responses": { "200": { "description": "Successfully updated flow endpoint", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/FlowEndpoints" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FlowEndpoints" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FlowEndpoints" } } } }, "400": { "description": "Invalid flow endpoint data provided", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } }, "401": { "description": "User is not authenticated", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "User is not authorized to update flow endpoints", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } }, "404": { "description": "Flow endpoint not found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } }, "500": { "description": "Internal server error occurred while updating flow endpoint", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } } }, "description": "Modifies existing flow endpoint configuration including processing options and schedules." } }, "/api/FlowEndpoint/deleteFlowEndpoint": { "delete": { "tags": [ "FlowEndpoint" ], "summary": "Deletes a flow endpoint configuration", "operationId": "FlowEndpoint_Delete", "parameters": [ { "name": "flowEndpointId", "in": "query", "description": "Unique identifier of the flow endpoint to delete", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully deleted flow endpoint", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResult" } } } }, "401": { "description": "User is not authenticated", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "User is not authorized to delete flow endpoints", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } }, "404": { "description": "Flow endpoint not found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } }, "500": { "description": "Internal server error occurred while deleting flow endpoint", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } } }, "description": "Removes flow endpoint configuration and all associated settings." } }, "/api/FlowEndpoint/getFlowEndpointPaths": { "get": { "tags": [ "FlowEndpoint" ], "summary": "Retrieves file paths configured for flow endpoints", "operationId": "FlowEndpoint_GetPaths", "parameters": [ { "name": "flowId", "in": "query", "description": "Unique identifier of the flow", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully retrieved flow endpoint paths", "content": { "text/plain": { "schema": { "type": "array", "items": { "type": "string" } } }, "application/json": { "schema": { "type": "array", "items": { "type": "string" } } }, "text/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "401": { "description": "User is not authenticated", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "User is not authorized to view flow endpoint paths", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } }, "404": { "description": "Flow not found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } }, "500": { "description": "Internal server error occurred while retrieving paths", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } } }, "description": "Returns list of file paths configured for flow endpoint processing." } }, "/api/FlowEndpoint/testConnection": { "post": { "tags": [ "FlowEndpoint" ], "summary": "Tests connectivity to a flow endpoint", "operationId": "FlowEndpoint_TestConnection", "parameters": [ { "name": "flowEndpointId", "in": "query", "description": "Unique identifier of the flow endpoint to test", "schema": { "type": "integer", "format": "int32" } }, { "name": "thruNodeId", "in": "query", "description": "Optional node identifier for testing specific node connectivity", "schema": { "type": "string" } }, { "name": "path", "in": "query", "description": "Optional path to test specific directory access", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Connection test completed successfully" }, "401": { "description": "User is not authenticated", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "User is not authorized to test flow endpoint connections", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } }, "404": { "description": "Flow endpoint not found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } }, "500": { "description": "Internal server error occurred during connection test", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } } }, "description": "Validates flow endpoint connectivity by attempting connection to configured endpoint." } }, "/api/FlowEndpointAlerts/{flowEndpointAlertId}": { "get": { "tags": [ "FlowEndpointAlerts" ], "summary": "Retrieves a specific flow endpoint alert configuration", "operationId": "FlowEndpointAlerts_GetById", "parameters": [ { "name": "flowEndpointAlertId", "in": "path", "description": "Unique identifier of the flow endpoint alert", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully retrieved flow endpoint alert", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/FlowEndpointAlerts" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointAlerts" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointAlerts" } } } }, "204": { "description": "No content - alert not found" }, "403": { "description": "User is not authorized to view flow endpoint alerts", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error occurred while retrieving alert", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } } }, "description": "Returns alert configuration for a specific flow endpoint including thresholds and notification settings." }, "delete": { "tags": [ "FlowEndpointAlerts" ], "summary": "Deletes a specific flow endpoint alert configuration", "operationId": "FlowEndpointAlerts_Delete", "parameters": [ { "name": "flowEndpointAlertId", "in": "path", "description": "Unique identifier of the flow endpoint alert to delete", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully deleted flow endpoint alert", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResult" } } } }, "403": { "description": "User is not authorized to delete flow endpoint alerts", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error occurred while deleting alert", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } } }, "description": "Removes alert configuration from flow endpoint." } }, "/api/FlowEndpointAlerts/getByFlowEndpointId": { "get": { "tags": [ "FlowEndpointAlerts" ], "summary": "Retrieves alert configurations for a specific flow endpoint", "operationId": "FlowEndpointAlerts_GetByFlowEndpoint", "parameters": [ { "name": "flowEndpointId", "in": "query", "description": "Unique identifier of the flow endpoint", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully retrieved flow endpoint alerts", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/FlowEndpointAlerts" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointAlerts" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointAlerts" } } } }, "204": { "description": "No content - no alerts found for flow endpoint" }, "403": { "description": "User is not authorized to view flow endpoint alerts", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error occurred while retrieving alerts", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } } }, "description": "Returns alert configuration for a specific flow endpoint." } }, "/api/FlowEndpointAlerts": { "post": { "tags": [ "FlowEndpointAlerts" ], "summary": "Creates a new flow endpoint alert configuration", "operationId": "FlowEndpointAlerts_Create", "requestBody": { "description": "Flow endpoint alert configuration details", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointAlerts" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointAlerts" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/FlowEndpointAlerts" } } } }, "responses": { "200": { "description": "Successfully created flow endpoint alert", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/FlowEndpointAlerts" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointAlerts" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointAlerts" } } } }, "403": { "description": "User is not authorized to create flow endpoint alerts", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error occurred while creating alert", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } } }, "description": "Establishes new alert configuration with activity and queue depth thresholds." }, "put": { "tags": [ "FlowEndpointAlerts" ], "summary": "Updates an existing flow endpoint alert configuration", "operationId": "FlowEndpointAlerts_Update", "requestBody": { "description": "Updated flow endpoint alert configuration", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointAlerts" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointAlerts" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/FlowEndpointAlerts" } } } }, "responses": { "200": { "description": "Successfully updated flow endpoint alert", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/FlowEndpointAlerts" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointAlerts" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointAlerts" } } } }, "403": { "description": "User is not authorized to update flow endpoint alerts", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error occurred while updating alert", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } } }, "description": "Modifies existing alert configuration including notification thresholds and settings." } }, "/api/FlowEndpointAlerts/save": { "put": { "tags": [ "FlowEndpointAlerts" ], "summary": "Saves flow endpoint alert configuration (creates new or updates existing)", "operationId": "FlowEndpointAlerts_Save", "requestBody": { "description": "Flow endpoint alert configuration to save", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointAlerts" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointAlerts" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/FlowEndpointAlerts" } } } }, "responses": { "200": { "description": "Successfully saved flow endpoint alert", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/FlowEndpointAlerts" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointAlerts" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointAlerts" } } } }, "403": { "description": "User is not authorized to save flow endpoint alerts", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error occurred while saving alert", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } } }, "description": "Creates new alert configuration if ID is 0, otherwise updates existing configuration." } }, "/api/FlowEndpointAlerts/deleteByFlowEndpointId": { "delete": { "tags": [ "FlowEndpointAlerts" ], "summary": "Deletes all alert configurations for a specific flow endpoint", "description": "Deletes all alert configurations for a specific flow endpoint", "operationId": "FlowEndpointAlerts_DeleteByFlowEndpoint", "parameters": [ { "name": "flowEndpointId", "in": "query", "description": "Unique identifier of the flow endpoint", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully deleted all alerts for the flow endpoint", "content": { "text/plain": { "schema": { } }, "application/json": { "schema": { } }, "text/json": { "schema": { } } } }, "403": { "description": "User is not authorized to delete flow endpoint alerts", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error occurred while deleting alerts", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } } } } }, "/api/FlowEndpointAntiVirusOptions/{flowEndpointAntiVirusOptionId}": { "get": { "tags": [ "FlowEndpointAntiVirusOptions" ], "summary": "Retrieves a specific anti-virus configuration by ID", "operationId": "FlowEndpointAntiVirusOptions_GetById", "parameters": [ { "name": "flowEndpointAntiVirusOptionId", "in": "path", "description": "Unique identifier of the anti-virus configuration", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully retrieved anti-virus configuration", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/FlowEndpointAntiVirusOptions" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointAntiVirusOptions" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointAntiVirusOptions" } } } }, "403": { "description": "User is not authorized to view anti-virus configurations", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error occurred while retrieving configuration", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } } }, "description": "Returns anti-virus scanning configuration for a specific flow endpoint." }, "delete": { "tags": [ "FlowEndpointAntiVirusOptions" ], "summary": "Deletes a specific anti-virus configuration", "operationId": "FlowEndpointAntiVirusOptions_Delete", "parameters": [ { "name": "flowEndpointAntiVirusOptionId", "in": "path", "description": "Unique identifier of the anti-virus configuration to delete", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully deleted anti-virus configuration", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResult" } } } }, "403": { "description": "User is not authorized to delete anti-virus configurations", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error occurred while deleting configuration", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } } }, "description": "Removes anti-virus configuration from flow endpoint." } }, "/api/FlowEndpointAntiVirusOptions/getByFlowEndpointId": { "get": { "tags": [ "FlowEndpointAntiVirusOptions" ], "summary": "Retrieves all anti-virus configurations for a specific flow endpoint", "operationId": "FlowEndpointAntiVirusOptions_GetByFlowEndpointId", "parameters": [ { "name": "flowEndpointId", "in": "query", "description": "Unique identifier of the flow endpoint", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully retrieved anti-virus configurations", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FlowEndpointAntiVirusOptions" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FlowEndpointAntiVirusOptions" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FlowEndpointAntiVirusOptions" } } } } }, "403": { "description": "User is not authorized to view anti-virus configurations", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error occurred while retrieving configurations", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } } }, "description": "Returns anti-virus configuration for a specific flow endpoint including enabled status." } }, "/api/FlowEndpointAntiVirusOptions": { "post": { "tags": [ "FlowEndpointAntiVirusOptions" ], "summary": "Creates a new anti-virus configuration for a flow endpoint", "operationId": "FlowEndpointAntiVirusOptions_Create", "requestBody": { "description": "Anti-virus configuration details including scanning rules and file type filters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointAntiVirusOptions" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointAntiVirusOptions" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/FlowEndpointAntiVirusOptions" } } } }, "responses": { "200": { "description": "Successfully created anti-virus configuration", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/FlowEndpointAntiVirusOptions" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointAntiVirusOptions" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointAntiVirusOptions" } } } }, "403": { "description": "User is not authorized to create anti-virus configurations", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error occurred while creating configuration", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } } }, "description": "Establishes new anti-virus scanning configuration for file security." }, "put": { "tags": [ "FlowEndpointAntiVirusOptions" ], "summary": "Updates an existing anti-virus configuration for a flow endpoint", "operationId": "FlowEndpointAntiVirusOptions_Update", "requestBody": { "description": "Updated anti-virus configuration details", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointAntiVirusOptions" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointAntiVirusOptions" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/FlowEndpointAntiVirusOptions" } } } }, "responses": { "200": { "description": "Successfully updated anti-virus configuration", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/FlowEndpointAntiVirusOptions" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointAntiVirusOptions" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointAntiVirusOptions" } } } }, "403": { "description": "User is not authorized to update anti-virus configurations", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error occurred while updating configuration", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } } }, "description": "Modifies existing anti-virus configuration including scan settings." } }, "/api/FlowEndpointAntiVirusOptions/save": { "put": { "tags": [ "FlowEndpointAntiVirusOptions" ], "summary": "Saves anti-virus configuration (creates new or updates existing based on ID)", "description": "Performs upsert operation: creates new configuration if ID is 0, otherwise updates existing configuration", "operationId": "FlowEndpointAntiVirusOptions_Save", "requestBody": { "description": "Anti-virus configuration to save (performs upsert based on record ID)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointAntiVirusOptions" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointAntiVirusOptions" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/FlowEndpointAntiVirusOptions" } } } }, "responses": { "200": { "description": "Successfully saved anti-virus configuration", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/FlowEndpointAntiVirusOptions" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointAntiVirusOptions" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointAntiVirusOptions" } } } }, "403": { "description": "User is not authorized to save anti-virus configurations", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error occurred while saving configuration", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } } } } }, "/api/FlowEndpointAntiVirusOptions/deleteByFlowEndpointId": { "delete": { "tags": [ "FlowEndpointAntiVirusOptions" ], "summary": "Deletes all anti-virus configurations for a specific flow endpoint", "operationId": "FlowEndpointAntiVirusOptions_DeleteByFlowEndpointId", "parameters": [ { "name": "flowEndpointId", "in": "query", "description": "Unique identifier of the flow endpoint to remove all anti-virus configurations for", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully deleted all anti-virus configurations for the flow endpoint", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResult" } } } }, "403": { "description": "User is not authorized to delete anti-virus configurations", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error occurred while deleting configurations", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } } }, "description": "Removes all anti-virus configurations from a flow endpoint." } }, "/api/FlowEndpointCompressionOptions/getActiveCompressionTypes": { "get": { "tags": [ "FlowEndpointCompressionOptions" ], "summary": "Retrieves all active compression types available for flow endpoints", "operationId": "FlowEndpointCompressionOptions_GetActiveCompressionTypes", "responses": { "200": { "description": "Successfully retrieved active compression types", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CompressionTypeViewModel" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CompressionTypeViewModel" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CompressionTypeViewModel" } } } } }, "403": { "description": "User is not authorized to view compression options", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error occurred while retrieving compression types", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } } }, "description": "Returns list of available compression algorithms and formats." } }, "/api/FlowEndpointCompressionOptions/{flowEndpointCompressionOptionId}": { "get": { "tags": [ "FlowEndpointCompressionOptions" ], "summary": "Retrieves a specific compression configuration by ID", "operationId": "FlowEndpointCompressionOptions_GetById", "parameters": [ { "name": "flowEndpointCompressionOptionId", "in": "path", "description": "Unique identifier of the compression configuration", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully retrieved compression configuration", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/FlowEndpointCompressionOptions" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointCompressionOptions" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointCompressionOptions" } } } }, "204": { "description": "No compression configuration found for the specified ID" }, "403": { "description": "User is not authorized to view compression configurations", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error occurred while retrieving configuration", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } } }, "description": "Returns compression configuration including algorithm, password, and batch settings." }, "delete": { "tags": [ "FlowEndpointCompressionOptions" ], "summary": "Deletes a specific compression configuration", "operationId": "FlowEndpointCompressionOptions_Delete", "parameters": [ { "name": "flowEndpointCompressionOptionId", "in": "path", "description": "Unique identifier of the compression configuration to delete", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully deleted compression configuration", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResult" } } } }, "403": { "description": "User is not authorized to delete compression configurations", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error occurred while deleting configuration", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } } }, "description": "Removes compression configuration from flow endpoint." } }, "/api/FlowEndpointCompressionOptions/getByFlowEndpointId": { "get": { "tags": [ "FlowEndpointCompressionOptions" ], "summary": "Retrieves compression configuration for a specific flow endpoint", "operationId": "FlowEndpointCompressionOptions_GetByFlowEndpointId", "parameters": [ { "name": "flowEndpointId", "in": "query", "description": "Unique identifier of the flow endpoint", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully retrieved compression configuration", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/FlowEndpointCompressionOptions" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointCompressionOptions" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointCompressionOptions" } } } }, "204": { "description": "No compression configuration found for the specified flow endpoint" }, "403": { "description": "User is not authorized to view compression configurations", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error occurred while retrieving configuration", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } } }, "description": "Returns compression configuration for a specific flow endpoint." } }, "/api/FlowEndpointCompressionOptions": { "post": { "tags": [ "FlowEndpointCompressionOptions" ], "summary": "Creates a new compression configuration for a flow endpoint", "operationId": "FlowEndpointCompressionOptions_Create", "requestBody": { "description": "Compression configuration details including algorithm and settings", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointCompressionOptions" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointCompressionOptions" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/FlowEndpointCompressionOptions" } } } }, "responses": { "200": { "description": "Successfully created compression configuration", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/FlowEndpointCompressionOptions" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointCompressionOptions" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointCompressionOptions" } } } }, "403": { "description": "User is not authorized to create compression configurations", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error occurred while creating configuration", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } } }, "description": "Establishes new compression configuration with specified algorithm and settings." }, "put": { "tags": [ "FlowEndpointCompressionOptions" ], "summary": "Updates an existing compression configuration for a flow endpoint", "operationId": "FlowEndpointCompressionOptions_Update", "requestBody": { "description": "Updated compression configuration details", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointCompressionOptions" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointCompressionOptions" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/FlowEndpointCompressionOptions" } } } }, "responses": { "200": { "description": "Successfully updated compression configuration", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/FlowEndpointCompressionOptions" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointCompressionOptions" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointCompressionOptions" } } } }, "403": { "description": "User is not authorized to update compression configurations", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error occurred while updating configuration", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } } }, "description": "Modifies existing compression configuration including algorithm and batch settings." } }, "/api/FlowEndpointCompressionOptions/save": { "put": { "tags": [ "FlowEndpointCompressionOptions" ], "summary": "Saves compression configuration (creates new or updates existing based on ID)", "description": "Performs upsert operation: creates new configuration if ID is 0, otherwise updates existing configuration", "operationId": "FlowEndpointCompressionOptions_Save", "requestBody": { "description": "Compression configuration to save (performs upsert based on record ID)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointCompressionOptions" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointCompressionOptions" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/FlowEndpointCompressionOptions" } } } }, "responses": { "200": { "description": "Successfully saved compression configuration", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/FlowEndpointCompressionOptions" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointCompressionOptions" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointCompressionOptions" } } } }, "403": { "description": "User is not authorized to save compression configurations", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error occurred while saving configuration", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } } } } }, "/api/FlowEndpointCompressionOptions/deleteByFlowEndpointId": { "delete": { "tags": [ "FlowEndpointCompressionOptions" ], "summary": "Deletes all compression configurations for a specific flow endpoint", "operationId": "FlowEndpointCompressionOptions_DeleteByFlowEndpointId", "parameters": [ { "name": "flowEndpointId", "in": "query", "description": "Unique identifier of the flow endpoint to remove all compression configurations for", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully deleted all compression configurations for the flow endpoint", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResult" } } } }, "403": { "description": "User is not authorized to delete compression configurations", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error occurred while deleting configurations", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } } }, "description": "Removes all compression configurations from a flow endpoint." } }, "/api/FlowEndpointConfigurations/{flowEndpointConfigurationId}": { "get": { "tags": [ "FlowEndpointConfigurations" ], "summary": "Retrieves a specific flow endpoint configuration by ID", "operationId": "FlowEndpointConfigurations_GetById", "parameters": [ { "name": "flowEndpointConfigurationId", "in": "path", "description": "Unique identifier of the flow endpoint configuration", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully retrieved flow endpoint configuration", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/FlowEndpointConfigurationTemp" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointConfigurationTemp" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointConfigurationTemp" } } } }, "204": { "description": "No content found for the specified configuration" }, "401": { "description": "Authentication required", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "User is not authorized to view flow endpoint configurations", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error occurred while retrieving configuration", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } } }, "description": "Returns flow endpoint configuration including paths, filters, and processing settings." }, "delete": { "tags": [ "FlowEndpointConfigurations" ], "summary": "Deletes a specific flow endpoint configuration", "operationId": "FlowEndpointConfigurations_Delete", "parameters": [ { "name": "flowEndpointConfigurationId", "in": "path", "description": "Unique identifier of the flow endpoint configuration to delete", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully deleted flow endpoint configuration", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResult" } } } }, "401": { "description": "Authentication required", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "User is not authorized to delete flow endpoint configurations", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error occurred while deleting configuration", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } } }, "description": "Removes flow endpoint configuration from the system." } }, "/api/FlowEndpointConfigurations/getByFlowEndpointId": { "get": { "tags": [ "FlowEndpointConfigurations" ], "summary": "Retrieves flow endpoint configuration for a specific flow endpoint", "operationId": "FlowEndpointConfigurations_GetByFlowEndpointId", "parameters": [ { "name": "flowEndpointId", "in": "query", "description": "Unique identifier of the flow endpoint", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully retrieved flow endpoint configuration", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/FlowEndpointConfigurationTemp" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointConfigurationTemp" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointConfigurationTemp" } } } }, "204": { "description": "No content found for the specified flow endpoint" }, "401": { "description": "Authentication required", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "User is not authorized to view flow endpoint configurations", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error occurred while retrieving configuration", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } } }, "description": "Returns configuration for a specific flow endpoint including file filters and processing options." } }, "/api/FlowEndpointConfigurations": { "post": { "tags": [ "FlowEndpointConfigurations" ], "summary": "Creates a new flow endpoint configuration", "description": " Example dateFilters:\r\n\r\n [\r\n\t {\r\n\t\t \"condition\": \"BETWEEN\",\r\n\t\t \"date\": \"2022-11-01T05:00:00.000Z\",\r\n\t\t \"secondaryDate\": \"2022-11-30T06:00:00.000Z\"\r\n\t },\r\n\t {\r\n\t\t \"condition\": \"AFTER\",\r\n\t\t \"date\": \"2023-01-01T06:00:00.000Z\",\r\n\t\t \"secondaryDate\": \"2023-01-26T21:15:38.367Z\"\r\n\t },\r\n\t {\r\n \"condition\": \"BEFORE\",\r\n\t\t \"date\": \"2022-09-30T05:00:00.000Z\",\r\n\t\t \"secondaryDate\": \"2023-01-26T19:56:32.830Z\"\r\n }\r\n ]", "operationId": "FlowEndpointConfigurations_Create", "requestBody": { "description": "Flow endpoint configuration details including paths, filters, and processing settings", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointConfigurationTemp" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointConfigurationTemp" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/FlowEndpointConfigurationTemp" } } } }, "responses": { "200": { "description": "Successfully created flow endpoint configuration", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/FlowEndpointConfigurationTemp" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointConfigurationTemp" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointConfigurationTemp" } } } }, "401": { "description": "Authentication required", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "User is not authorized to create flow endpoint configurations", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error occurred while creating configuration", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } } } }, "put": { "tags": [ "FlowEndpointConfigurations" ], "summary": "Updates an existing flow endpoint configuration", "description": " Example dateFilters:\r\n\r\n [\r\n\t {\r\n\t\t \"condition\": \"BETWEEN\",\r\n\t\t \"date\": \"2022-11-01T05:00:00.000Z\",\r\n\t\t \"secondaryDate\": \"2022-11-30T06:00:00.000Z\"\r\n\t },\r\n\t {\r\n\t\t \"condition\": \"AFTER\",\r\n\t\t \"date\": \"2023-01-01T06:00:00.000Z\",\r\n\t\t \"secondaryDate\": \"2023-01-26T21:15:38.367Z\"\r\n\t },\r\n\t {\r\n \"condition\": \"BEFORE\",\r\n\t\t \"date\": \"2022-09-30T05:00:00.000Z\",\r\n\t\t \"secondaryDate\": \"2023-01-26T19:56:32.830Z\"\r\n }\r\n ]", "operationId": "FlowEndpointConfigurations_Update", "requestBody": { "description": "Updated flow endpoint configuration details", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointConfigurationTemp" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointConfigurationTemp" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/FlowEndpointConfigurationTemp" } } } }, "responses": { "200": { "description": "Successfully updated flow endpoint configuration", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/FlowEndpointConfigurationTemp" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointConfigurationTemp" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointConfigurationTemp" } } } }, "401": { "description": "Authentication required", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "User is not authorized to update flow endpoint configurations", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error occurred while updating configuration", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } } } } }, "/api/FlowEndpointConfigurations/save": { "put": { "tags": [ "FlowEndpointConfigurations" ], "summary": "Saves flow endpoint configuration (creates new or updates existing based on ID)", "description": " Performs upsert operation: creates new configuration if ID is 0, otherwise updates existing configuration\r\n\r\n Example dateFilters:\r\n\r\n [\r\n\t {\r\n\t\t \"condition\": \"BETWEEN\",\r\n\t\t \"date\": \"2022-11-01T05:00:00.000Z\",\r\n\t\t \"secondaryDate\": \"2022-11-30T06:00:00.000Z\"\r\n\t },\r\n\t {\r\n\t\t \"condition\": \"AFTER\",\r\n\t\t \"date\": \"2023-01-01T06:00:00.000Z\",\r\n\t\t \"secondaryDate\": \"2023-01-26T21:15:38.367Z\"\r\n\t },\r\n\t {\r\n \"condition\": \"BEFORE\",\r\n\t\t \"date\": \"2022-09-30T05:00:00.000Z\",\r\n\t\t \"secondaryDate\": \"2023-01-26T19:56:32.830Z\"\r\n }\r\n ]", "operationId": "FlowEndpointConfigurations_Save", "requestBody": { "description": "Flow endpoint configuration to save (performs upsert based on record ID)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointConfigurationTemp" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointConfigurationTemp" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/FlowEndpointConfigurationTemp" } } } }, "responses": { "200": { "description": "Successfully saved flow endpoint configuration", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/FlowEndpointConfigurationTemp" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointConfigurationTemp" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointConfigurationTemp" } } } }, "401": { "description": "Authentication required", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "User is not authorized to save flow endpoint configurations", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error occurred while saving configuration", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } } } } }, "/api/FlowEndpointConfigurations/deleteByFlowEndpointId": { "delete": { "tags": [ "FlowEndpointConfigurations" ], "summary": "Deletes all flow endpoint configurations for a specific flow endpoint", "operationId": "FlowEndpointConfigurations_DeleteByFlowEndpointId", "parameters": [ { "name": "flowEndpointId", "in": "query", "description": "Unique identifier of the flow endpoint to remove all configurations for", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully deleted all flow endpoint configurations for the flow endpoint", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResult" } } } }, "401": { "description": "Authentication required", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "User is not authorized to delete flow endpoint configurations", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error occurred while deleting configurations", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } } }, "description": "Removes all configurations associated with a flow endpoint." } }, "/api/FlowEndpointEmailNotifications/{flowEndpointEmailNotificationId}": { "get": { "tags": [ "FlowEndpointEmailNotifications" ], "summary": "Retrieves a specific email notification configuration by ID", "operationId": "FlowEndpointEmailNotifications_GetById", "parameters": [ { "name": "flowEndpointEmailNotificationId", "in": "path", "description": "Unique identifier of the email notification configuration", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully retrieved email notification configuration", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/FlowEndpointEmailNotifications" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointEmailNotifications" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointEmailNotifications" } } } }, "204": { "description": "Email notification configuration not found" }, "403": { "description": "User is not authorized to view email notification configurations", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } }, "500": { "description": "Internal server error occurred while retrieving configuration", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } } }, "description": "Returns email notification configuration including recipients and trigger events." }, "delete": { "tags": [ "FlowEndpointEmailNotifications" ], "summary": "Deletes a specific email notification configuration", "operationId": "FlowEndpointEmailNotifications_Delete", "parameters": [ { "name": "flowEndpointEmailNotificationId", "in": "path", "description": "Unique identifier of the email notification configuration to delete", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully deleted email notification configuration", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResult" } } } }, "204": { "description": "Email notification configuration not found" }, "403": { "description": "User is not authorized to delete email notification configurations", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } }, "500": { "description": "Internal server error occurred while deleting configuration", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } } }, "description": "Removes email notification configuration from flow endpoint." } }, "/api/FlowEndpointEmailNotifications/getFlowEndpointServerUsersList": { "get": { "tags": [ "FlowEndpointEmailNotifications" ], "summary": "Retrieves all email notification configurations for a specific flow endpoint", "operationId": "FlowEndpointEmailNotifications_GetFlowEndpointServerUsersList", "parameters": [ { "name": "flowEndpointId", "in": "query", "description": "Unique identifier of the flow endpoint", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully retrieved email notification configurations", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FlowEndpointEmailNotifications" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FlowEndpointEmailNotifications" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FlowEndpointEmailNotifications" } } } } }, "403": { "description": "User is not authorized to view email notification configurations", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } }, "500": { "description": "Internal server error occurred while retrieving configurations", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } } }, "description": "Returns list of email notification configurations for a flow endpoint." } }, "/api/FlowEndpointEmailNotifications": { "post": { "tags": [ "FlowEndpointEmailNotifications" ], "summary": "Creates a new email notification configuration for a flow endpoint", "operationId": "FlowEndpointEmailNotifications_Create", "requestBody": { "description": "Email notification configuration details including recipients and triggers", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointEmailNotifications" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointEmailNotifications" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/FlowEndpointEmailNotifications" } } } }, "responses": { "200": { "description": "Successfully created email notification configuration", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/FlowEndpointEmailNotifications" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointEmailNotifications" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointEmailNotifications" } } } }, "403": { "description": "User is not authorized to create email notification configurations", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } }, "500": { "description": "Internal server error occurred while creating configuration", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } } }, "description": "Establishes new email notification with specified recipients and event triggers." }, "put": { "tags": [ "FlowEndpointEmailNotifications" ], "summary": "Updates an existing email notification configuration for a flow endpoint", "operationId": "FlowEndpointEmailNotifications_Update", "requestBody": { "description": "Updated email notification configuration details", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointEmailNotifications" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointEmailNotifications" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/FlowEndpointEmailNotifications" } } } }, "responses": { "200": { "description": "Successfully updated email notification configuration", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/FlowEndpointEmailNotifications" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointEmailNotifications" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointEmailNotifications" } } } }, "403": { "description": "User is not authorized to update email notification configurations", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } }, "500": { "description": "Internal server error occurred while updating configuration", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } } }, "description": "Modifies existing email notification configuration including recipients and triggers." } }, "/api/FlowEndpointEmailNotifications/save": { "put": { "tags": [ "FlowEndpointEmailNotifications" ], "summary": "Saves email notification configuration (creates new or updates existing based on ID)", "description": "Performs upsert operation: creates new configuration if ID is 0, otherwise updates existing configuration", "operationId": "FlowEndpointEmailNotifications_Save", "requestBody": { "description": "Email notification configuration to save (performs upsert based on record ID)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointEmailNotifications" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointEmailNotifications" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/FlowEndpointEmailNotifications" } } } }, "responses": { "200": { "description": "Successfully saved email notification configuration", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/FlowEndpointEmailNotifications" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointEmailNotifications" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointEmailNotifications" } } } }, "403": { "description": "User is not authorized to save email notification configurations", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } }, "500": { "description": "Internal server error occurred while saving configuration", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } } } } }, "/api/FlowEndpointEmailNotifications/deleteByFlowEndpointId": { "delete": { "tags": [ "FlowEndpointEmailNotifications" ], "summary": "Deletes all email notification configurations for a specific flow endpoint", "operationId": "FlowEndpointEmailNotifications_DeleteByFlowEndpointId", "parameters": [ { "name": "flowEndpointId", "in": "query", "description": "Unique identifier of the flow endpoint to remove all email notification configurations for", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully deleted all email notification configurations for the flow endpoint", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResult" } } } }, "403": { "description": "User is not authorized to delete email notification configurations", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } }, "500": { "description": "Internal server error occurred while deleting configurations", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } } }, "description": "Removes all email notification configurations from a flow endpoint." } }, "/api/FlowEndpointEncryptionOptions/{flowEndpointEncryptionOptionId}": { "get": { "tags": [ "FlowEndpointEncryptionOptions" ], "summary": "Retrieves a specific encryption configuration by ID", "operationId": "FlowEndpointEncryptionOptions_GetById", "parameters": [ { "name": "flowEndpointEncryptionOptionId", "in": "path", "description": "Unique identifier of the encryption configuration", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully retrieved encryption configuration", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/FlowEndpointEncryptionOptions" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointEncryptionOptions" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointEncryptionOptions" } } } }, "204": { "description": "No encryption configuration found for the specified ID" }, "403": { "description": "User is not authorized to view encryption configurations", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error occurred while retrieving configuration", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } } }, "description": "Returns encryption configuration including PGP key assignments and verification settings." }, "delete": { "tags": [ "FlowEndpointEncryptionOptions" ], "summary": "Deletes a specific encryption configuration", "operationId": "FlowEndpointEncryptionOptions_Delete", "parameters": [ { "name": "flowEndpointEncryptionOptionId", "in": "path", "description": "Unique identifier of the encryption configuration to delete", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully deleted encryption configuration", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResult" } } } }, "403": { "description": "User is not authorized to delete encryption configurations", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error occurred while deleting configuration", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } } }, "description": "Removes encryption configuration from flow endpoint." } }, "/api/FlowEndpointEncryptionOptions/getByFlowEndpointId": { "get": { "tags": [ "FlowEndpointEncryptionOptions" ], "summary": "Retrieves encryption configuration for a specific flow endpoint", "operationId": "FlowEndpointEncryptionOptions_GetByFlowEndpointId", "parameters": [ { "name": "flowEndpointId", "in": "query", "description": "Unique identifier of the flow endpoint", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully retrieved encryption configuration", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/FlowEndpointEncryptionOptions" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointEncryptionOptions" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointEncryptionOptions" } } } }, "204": { "description": "No encryption configuration found for the specified flow endpoint" }, "403": { "description": "User is not authorized to view encryption configurations", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error occurred while retrieving configuration", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } } }, "description": "Returns encryption configuration for a specific flow endpoint." } }, "/api/FlowEndpointEncryptionOptions": { "post": { "tags": [ "FlowEndpointEncryptionOptions" ], "summary": "Creates a new encryption configuration for a flow endpoint", "operationId": "FlowEndpointEncryptionOptions_Create", "requestBody": { "description": "Encryption configuration details including algorithms and key management settings", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointEncryptionOptions" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointEncryptionOptions" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/FlowEndpointEncryptionOptions" } } } }, "responses": { "200": { "description": "Successfully created encryption configuration", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/FlowEndpointEncryptionOptions" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointEncryptionOptions" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointEncryptionOptions" } } } }, "403": { "description": "User is not authorized to create encryption configurations", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error occurred while creating configuration", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } } }, "description": "Establishes new encryption configuration with PGP key and signing settings." }, "put": { "tags": [ "FlowEndpointEncryptionOptions" ], "summary": "Updates an existing encryption configuration for a flow endpoint", "operationId": "FlowEndpointEncryptionOptions_Update", "requestBody": { "description": "Updated encryption configuration details", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointEncryptionOptions" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointEncryptionOptions" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/FlowEndpointEncryptionOptions" } } } }, "responses": { "200": { "description": "Successfully updated encryption configuration", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/FlowEndpointEncryptionOptions" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointEncryptionOptions" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointEncryptionOptions" } } } }, "403": { "description": "User is not authorized to update encryption configurations", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error occurred while updating configuration", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } } }, "description": "Modifies existing encryption configuration including key assignments and verification." } }, "/api/FlowEndpointEncryptionOptions/save": { "put": { "tags": [ "FlowEndpointEncryptionOptions" ], "summary": "Saves encryption configuration (creates new or updates existing based on ID)", "description": "Performs upsert operation: creates new configuration if ID is 0, otherwise updates existing configuration", "operationId": "FlowEndpointEncryptionOptions_Save", "requestBody": { "description": "Encryption configuration to save (performs upsert based on record ID)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointEncryptionOptions" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointEncryptionOptions" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/FlowEndpointEncryptionOptions" } } } }, "responses": { "200": { "description": "Successfully saved encryption configuration", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/FlowEndpointEncryptionOptions" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointEncryptionOptions" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointEncryptionOptions" } } } }, "403": { "description": "User is not authorized to save encryption configurations", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error occurred while saving configuration", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } } } } }, "/api/FlowEndpointEncryptionOptions/deleteByFlowEndpointId": { "delete": { "tags": [ "FlowEndpointEncryptionOptions" ], "summary": "Deletes all encryption configurations for a specific flow endpoint", "operationId": "FlowEndpointEncryptionOptions_DeleteByFlowEndpointId", "parameters": [ { "name": "flowEndpointId", "in": "query", "description": "Unique identifier of the flow endpoint to remove all encryption configurations for", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully deleted all encryption configurations for the flow endpoint", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResult" } } } }, "403": { "description": "User is not authorized to delete encryption configurations", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error occurred while deleting configurations", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } } }, "description": "Removes all encryption configurations from a flow endpoint." } }, "/api/FlowEndpointProcessingOptions/{flowEndpointProcessingOptionId}": { "get": { "tags": [ "FlowEndpointProcessingOptions" ], "summary": "Retrieves a specific processing option configuration by ID", "operationId": "FlowEndpointProcessingOptions_GetById", "parameters": [ { "name": "flowEndpointProcessingOptionId", "in": "path", "description": "Unique identifier of the processing option configuration", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully retrieved processing option configuration", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/FlowEndpointProcessingOptionTemp" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointProcessingOptionTemp" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointProcessingOptionTemp" } } } }, "204": { "description": "No processing option configuration found for the specified ID" }, "403": { "description": "User is not authorized to view processing option configurations", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error occurred while retrieving configuration", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } } }, "description": "Returns processing options including encryption, compression, and transfer behavior settings." }, "delete": { "tags": [ "FlowEndpointProcessingOptions" ], "summary": "Deletes a specific processing option configuration", "operationId": "FlowEndpointProcessingOptions_Delete", "parameters": [ { "name": "flowEndpointProcessingOptionId", "in": "path", "description": "Unique identifier of the processing option configuration to delete", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully deleted processing option configuration", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DeleteFlowEndpointProcessingOptionResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DeleteFlowEndpointProcessingOptionResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeleteFlowEndpointProcessingOptionResponseViewModel" } } } }, "403": { "description": "User is not authorized to delete processing option configurations", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error occurred while deleting configuration", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } } }, "description": "Removes processing option configuration from flow endpoint." } }, "/api/FlowEndpointProcessingOptions/getByFlowEndpointId": { "get": { "tags": [ "FlowEndpointProcessingOptions" ], "summary": "Retrieves all processing option configurations for a specific flow endpoint", "operationId": "FlowEndpointProcessingOptions_GetByFlowEndpointId", "parameters": [ { "name": "flowEndpointId", "in": "query", "description": "Unique identifier of the flow endpoint", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully retrieved processing option configurations", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FlowEndpointProcessingOptionTemp" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FlowEndpointProcessingOptionTemp" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FlowEndpointProcessingOptionTemp" } } } } }, "204": { "description": "No processing option configurations found for the specified flow endpoint" }, "403": { "description": "User is not authorized to view processing option configurations", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error occurred while retrieving configurations", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } } }, "description": "Returns list of processing options configured for a flow endpoint." } }, "/api/FlowEndpointProcessingOptions/save": { "put": { "tags": [ "FlowEndpointProcessingOptions" ], "summary": "Saves processing option configuration (creates new or updates existing based on service logic)", "description": "Uses service-level upsert logic to determine whether to create or update the configuration", "operationId": "FlowEndpointProcessingOptions_Save", "requestBody": { "description": "Processing option configuration to save", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointProcessingOptionTemp" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointProcessingOptionTemp" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/FlowEndpointProcessingOptionTemp" } } } }, "responses": { "200": { "description": "Successfully saved processing option configuration", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/FlowEndpointProcessingOptionTemp" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointProcessingOptionTemp" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointProcessingOptionTemp" } } } }, "403": { "description": "User is not authorized to save processing option configurations", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error occurred while saving configuration", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } } } } }, "/api/FlowEndpointProcessingOptions/deleteByFlowEndpointId": { "delete": { "tags": [ "FlowEndpointProcessingOptions" ], "summary": "Deletes all processing option configurations for a specific flow endpoint", "operationId": "FlowEndpointProcessingOptions_DeleteByFlowEndpointId", "parameters": [ { "name": "flowEndpointId", "in": "query", "description": "Unique identifier of the flow endpoint to remove all processing option configurations for", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully deleted all processing option configurations for the flow endpoint", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DeleteFlowEndpointProcessingOptionResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DeleteFlowEndpointProcessingOptionResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeleteFlowEndpointProcessingOptionResponseViewModel" } } } }, "403": { "description": "User is not authorized to delete processing option configurations", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error occurred while deleting configurations", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } } }, "description": "Removes all processing option configurations from a flow endpoint." } }, "/api/FlowEndpointRenameOptions/{flowEndpointRenameOptionId}": { "get": { "tags": [ "FlowEndpointRenameOptions" ], "summary": "Retrieves a specific file rename configuration by ID", "operationId": "FlowEndpointRenameOptions_GetById", "parameters": [ { "name": "flowEndpointRenameOptionId", "in": "path", "description": "Unique identifier of the file rename configuration", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully retrieved file rename configuration", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/FlowEndpointRenameOptionTemp" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointRenameOptionTemp" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointRenameOptionTemp" } } } }, "401": { "description": "User is not authenticated", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "User is not authorized to view file rename configurations", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "File rename configuration not found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error occurred while retrieving configuration", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } } }, "description": "Returns file rename configuration including regex patterns and path assignments." }, "delete": { "tags": [ "FlowEndpointRenameOptions" ], "summary": "Deletes a specific file rename configuration", "operationId": "FlowEndpointRenameOptions_Delete", "parameters": [ { "name": "flowEndpointRenameOptionId", "in": "path", "description": "Unique identifier of the file rename configuration to delete", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully deleted file rename configuration", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResult" } } } }, "401": { "description": "User is not authenticated", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "User is not authorized to delete file rename configurations", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "File rename configuration not found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error occurred while deleting configuration", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } } }, "description": "Removes file rename configuration from flow endpoint." } }, "/api/FlowEndpointRenameOptions/getFlowEndpointRenameOptionsList": { "get": { "tags": [ "FlowEndpointRenameOptions" ], "summary": "Retrieves all file rename configurations for a specific flow endpoint", "operationId": "FlowEndpointRenameOptions_GetFlowEndpointRenameOptionsList", "parameters": [ { "name": "flowEndpointId", "in": "query", "description": "Unique identifier of the flow endpoint (required)", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully retrieved file rename configurations", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FlowEndpointRenameOptionTemp" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FlowEndpointRenameOptionTemp" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FlowEndpointRenameOptionTemp" } } } } }, "401": { "description": "User is not authenticated", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "User is not authorized to view file rename configurations", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error occurred while retrieving configurations", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } } }, "description": "Returns list of file rename configurations for a flow endpoint." } }, "/api/FlowEndpointRenameOptions": { "post": { "tags": [ "FlowEndpointRenameOptions" ], "summary": "Creates a new file rename configuration for a flow endpoint", "operationId": "FlowEndpointRenameOptions_Create", "requestBody": { "description": "File rename configuration details including patterns and replacement rules", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointRenameOptionTemp" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointRenameOptionTemp" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/FlowEndpointRenameOptionTemp" } } } }, "responses": { "200": { "description": "Successfully created file rename configuration", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/FlowEndpointRenameOptionTemp" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointRenameOptionTemp" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointRenameOptionTemp" } } } }, "401": { "description": "User is not authenticated", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "User is not authorized to create file rename configurations", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error occurred while creating configuration", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } } }, "description": "Establishes new file rename rule with regex pattern and replacement settings." }, "put": { "tags": [ "FlowEndpointRenameOptions" ], "summary": "Updates an existing file rename configuration for a flow endpoint", "operationId": "FlowEndpointRenameOptions_Update", "requestBody": { "description": "Updated file rename configuration details", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointRenameOptionTemp" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointRenameOptionTemp" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/FlowEndpointRenameOptionTemp" } } } }, "responses": { "200": { "description": "Successfully updated file rename configuration", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/FlowEndpointRenameOptionTemp" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointRenameOptionTemp" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointRenameOptionTemp" } } } }, "401": { "description": "User is not authenticated", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "User is not authorized to update file rename configurations", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error occurred while updating configuration", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } } }, "description": "Modifies existing file rename configuration including patterns and path assignments." } }, "/api/FlowEndpointRenameOptions/save": { "put": { "tags": [ "FlowEndpointRenameOptions" ], "summary": "Saves file rename configuration (creates new or updates existing based on ID)", "description": "Performs upsert operation: creates new configuration if ID is 0, otherwise updates existing configuration", "operationId": "FlowEndpointRenameOptions_Save", "requestBody": { "description": "File rename configuration to save (performs upsert based on record ID)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointRenameOptionTemp" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointRenameOptionTemp" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/FlowEndpointRenameOptionTemp" } } } }, "responses": { "200": { "description": "Successfully saved file rename configuration", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/FlowEndpointRenameOptionTemp" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointRenameOptionTemp" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointRenameOptionTemp" } } } }, "401": { "description": "User is not authenticated", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "User is not authorized to save file rename configurations", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error occurred while saving configuration", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } } } } }, "/api/FlowEndpointRenameOptions/deleteByFlowEndpointId": { "delete": { "tags": [ "FlowEndpointRenameOptions" ], "summary": "Deletes all file rename configurations for a specific flow endpoint", "operationId": "FlowEndpointRenameOptions_DeleteByFlowEndpointId", "parameters": [ { "name": "flowEndpointId", "in": "query", "description": "Unique identifier of the flow endpoint to remove all file rename configurations for", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully deleted all file rename configurations for the flow endpoint", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResult" } } } }, "401": { "description": "User is not authenticated", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "User is not authorized to delete file rename configurations", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error occurred while deleting configurations", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } } }, "description": "Removes all file rename configurations from a flow endpoint." } }, "/api/FlowEndpointSchedules/{flowEndpointScheduleId}": { "get": { "tags": [ "FlowEndpointSchedules" ], "summary": "Retrieves a specific flow endpoint schedule configuration by ID", "operationId": "FlowEndpointSchedules_GetById", "parameters": [ { "name": "flowEndpointScheduleId", "in": "path", "description": "Unique identifier of the flow endpoint schedule", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully retrieved flow endpoint schedule", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/FlowEndpointSchedule" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointSchedule" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointSchedule" } } } }, "204": { "description": "No content found for the specified schedule" }, "403": { "description": "User is not authorized to view flow endpoint schedules", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error occurred while retrieving schedule", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } } }, "description": "Returns schedule configuration including type, frequency, and timing settings." }, "delete": { "tags": [ "FlowEndpointSchedules" ], "summary": "Deletes a specific flow endpoint schedule configuration", "operationId": "FlowEndpointSchedules_Delete", "parameters": [ { "name": "flowEndpointScheduleId", "in": "path", "description": "Unique identifier of the flow endpoint schedule to delete", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully deleted flow endpoint schedule", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResult" } } } }, "403": { "description": "User is not authorized to delete flow endpoint schedules", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Flow endpoint schedule not found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } }, "500": { "description": "Internal server error occurred while deleting schedule", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } } }, "description": "Removes schedule configuration from flow endpoint." } }, "/api/FlowEndpointSchedules/getByFlowEndpointId": { "get": { "tags": [ "FlowEndpointSchedules" ], "summary": "Retrieves flow endpoint schedule configuration for a specific flow endpoint", "operationId": "FlowEndpointSchedules_GetByFlowEndpointId", "parameters": [ { "name": "flowEndpointId", "in": "query", "description": "Unique identifier of the flow endpoint", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully retrieved flow endpoint schedule", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/FlowEndpointSchedule" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointSchedule" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointSchedule" } } } }, "204": { "description": "No content found for the specified flow endpoint" }, "403": { "description": "User is not authorized to view flow endpoint schedules", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error occurred while retrieving schedule", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } } }, "description": "Returns schedule configuration for a specific flow endpoint." } }, "/api/FlowEndpointSchedules": { "post": { "tags": [ "FlowEndpointSchedules" ], "summary": "Creates a new flow endpoint schedule configuration", "operationId": "FlowEndpointSchedules_Create", "requestBody": { "description": "Flow endpoint schedule configuration details including timing, frequency, and execution settings", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointSchedule" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointSchedule" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/FlowEndpointSchedule" } } } }, "responses": { "200": { "description": "Successfully created flow endpoint schedule", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/FlowEndpointSchedule" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointSchedule" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointSchedule" } } } }, "403": { "description": "User is not authorized to create flow endpoint schedules", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error occurred while creating schedule", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } } }, "description": "Establishes new schedule with specified timing, frequency, and execution settings." }, "put": { "tags": [ "FlowEndpointSchedules" ], "summary": "Updates an existing flow endpoint schedule configuration", "operationId": "FlowEndpointSchedules_Update", "requestBody": { "description": "Updated flow endpoint schedule configuration details", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointSchedule" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointSchedule" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/FlowEndpointSchedule" } } } }, "responses": { "200": { "description": "Successfully updated flow endpoint schedule", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/FlowEndpointSchedule" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointSchedule" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointSchedule" } } } }, "403": { "description": "User is not authorized to update flow endpoint schedules", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error occurred while updating schedule", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } } }, "description": "Modifies existing schedule configuration including timing and recurrence settings." } }, "/api/FlowEndpointSchedules/save": { "put": { "tags": [ "FlowEndpointSchedules" ], "summary": "Saves flow endpoint schedule configuration (creates new or updates existing based on ID)", "description": "Performs upsert operation: creates new schedule if ID is 0, otherwise updates existing schedule", "operationId": "FlowEndpointSchedules_Save", "requestBody": { "description": "Flow endpoint schedule configuration to save (performs upsert based on record ID)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointSchedule" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointSchedule" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/FlowEndpointSchedule" } } } }, "responses": { "200": { "description": "Successfully saved flow endpoint schedule", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/FlowEndpointSchedule" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointSchedule" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointSchedule" } } } }, "403": { "description": "User is not authorized to save flow endpoint schedules", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error occurred while saving schedule", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } } } } }, "/api/FlowEndpointSchedules/deleteByFlowEndpointId": { "delete": { "tags": [ "FlowEndpointSchedules" ], "summary": "Deletes all flow endpoint schedule configurations for a specific flow endpoint", "operationId": "FlowEndpointSchedules_DeleteByFlowEndpointId", "parameters": [ { "name": "flowEndpointId", "in": "query", "description": "Unique identifier of the flow endpoint to remove all schedule configurations for", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully deleted all flow endpoint schedules for the flow endpoint", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResult" } } } }, "403": { "description": "User is not authorized to delete flow endpoint schedules", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error occurred while deleting schedules", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } } }, "description": "Removes all schedule configurations from a flow endpoint." } }, "/api/FlowEndpointServerPathMappings/{flowEndpointServerPathMappingId}": { "get": { "tags": [ "FlowEndpointServerPathMappings" ], "summary": "Retrieves a specific server path mapping configuration by ID", "operationId": "FlowEndpointServerPathMappings_GetById", "parameters": [ { "name": "flowEndpointServerPathMappingId", "in": "path", "description": "Unique identifier of the server path mapping", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully retrieved server path mapping", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/FlowEndpointServerPathMappings" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointServerPathMappings" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointServerPathMappings" } } } }, "204": { "description": "No content found for the specified mapping" }, "403": { "description": "User is not authorized to view server path mappings", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error occurred while retrieving mapping" } }, "description": "Returns server path mapping configuration including source and target path relationships." }, "delete": { "tags": [ "FlowEndpointServerPathMappings" ], "summary": "Deletes a specific server path mapping configuration", "operationId": "FlowEndpointServerPathMappings_Delete", "parameters": [ { "name": "flowEndpointServerPathMappingId", "in": "path", "description": "Unique identifier of the server path mapping to delete", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully deleted server path mapping", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResult" } } } }, "403": { "description": "User is not authorized to delete server path mappings", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error occurred while deleting mapping" } }, "description": "Removes server path mapping configuration from flow endpoint." } }, "/api/FlowEndpointServerPathMappings/getByFlowEndpointId": { "get": { "tags": [ "FlowEndpointServerPathMappings" ], "summary": "Retrieves all server path mappings for a specific flow endpoint", "operationId": "FlowEndpointServerPathMappings_GetByFlowEndpointId", "parameters": [ { "name": "flowEndpointId", "in": "query", "description": "Unique identifier of the flow endpoint", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully retrieved server path mappings", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FlowEndpointServerPathMappings" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FlowEndpointServerPathMappings" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FlowEndpointServerPathMappings" } } } } }, "204": { "description": "No content found for the specified flow endpoint" }, "403": { "description": "User is not authorized to view server path mappings", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error occurred while retrieving mappings" } }, "description": "Returns list of server path mappings for a flow endpoint." } }, "/api/FlowEndpointServerPathMappings": { "post": { "tags": [ "FlowEndpointServerPathMappings" ], "summary": "Creates a new server path mapping configuration for a flow endpoint", "operationId": "FlowEndpointServerPathMappings_Create", "requestBody": { "description": "Server path mapping configuration details including source and destination path mappings", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointServerPathMappings" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointServerPathMappings" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/FlowEndpointServerPathMappings" } } } }, "responses": { "200": { "description": "Successfully created server path mapping", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/FlowEndpointServerPathMappings" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointServerPathMappings" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointServerPathMappings" } } } }, "403": { "description": "User is not authorized to create server path mappings", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error occurred while creating mapping" } }, "description": "Establishes new path mapping between source and target server paths." }, "put": { "tags": [ "FlowEndpointServerPathMappings" ], "summary": "Updates an existing server path mapping configuration for a flow endpoint", "operationId": "FlowEndpointServerPathMappings_Update", "requestBody": { "description": "Updated server path mapping configuration details", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointServerPathMappings" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointServerPathMappings" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/FlowEndpointServerPathMappings" } } } }, "responses": { "200": { "description": "Successfully updated server path mapping", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/FlowEndpointServerPathMappings" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointServerPathMappings" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointServerPathMappings" } } } }, "403": { "description": "User is not authorized to update server path mappings", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error occurred while updating mapping" } }, "description": "Modifies existing path mapping configuration including subfolder inclusion." } }, "/api/FlowEndpointServerPathMappings/save": { "put": { "tags": [ "FlowEndpointServerPathMappings" ], "summary": "Saves server path mapping configuration (creates new or updates existing based on ID)", "description": "Performs upsert operation: creates new mapping if ID is 0, otherwise updates existing mapping", "operationId": "FlowEndpointServerPathMappings_Save", "requestBody": { "description": "Server path mapping configuration to save (performs upsert based on record ID)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointServerPathMappings" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointServerPathMappings" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/FlowEndpointServerPathMappings" } } } }, "responses": { "200": { "description": "Successfully saved server path mapping", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/FlowEndpointServerPathMappings" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointServerPathMappings" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointServerPathMappings" } } } }, "403": { "description": "User is not authorized to save server path mappings", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error occurred while saving mapping" } } } }, "/api/FlowEndpointServerPathMappings/deleteByFlowEndpointId": { "delete": { "tags": [ "FlowEndpointServerPathMappings" ], "summary": "Deletes all server path mapping configurations for a specific flow endpoint", "operationId": "FlowEndpointServerPathMappings_DeleteByFlowEndpointId", "parameters": [ { "name": "flowEndpointId", "in": "query", "description": "Unique identifier of the flow endpoint to remove all server path mappings for", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully deleted all server path mappings for the flow endpoint", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResult" } } } }, "403": { "description": "User is not authorized to delete server path mappings", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error occurred while deleting mappings" } }, "description": "Removes all server path mappings from a flow endpoint." } }, "/api/FlowEndpointServerUsers/{flowEndpointServerUserId}": { "get": { "tags": [ "FlowEndpointServerUsers" ], "summary": "Retrieves a specific server user configuration by ID", "operationId": "FlowEndpointServerUsers_GetById", "parameters": [ { "name": "flowEndpointServerUserId", "in": "path", "description": "Unique identifier of the server user configuration", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully retrieved server user configuration", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/FlowEndpointServerUsers" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointServerUsers" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointServerUsers" } } } }, "204": { "description": "Server user configuration not found" }, "401": { "description": "User is not authenticated", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "User is not authorized to view server user configurations", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error occurred while retrieving configuration", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } } }, "description": "Returns server user configuration including username, authentication type, and credentials." }, "delete": { "tags": [ "FlowEndpointServerUsers" ], "summary": "Deletes a specific server user configuration", "operationId": "FlowEndpointServerUsers_Delete", "parameters": [ { "name": "flowEndpointServerUserId", "in": "path", "description": "Unique identifier of the server user configuration to delete", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully deleted server user configuration", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResult" } } } }, "401": { "description": "User is not authenticated", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "User is not authorized to delete server user configurations", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Server user configuration not found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error occurred while deleting configuration", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } } }, "description": "Removes server user configuration from flow endpoint." } }, "/api/FlowEndpointServerUsers/getFlowEndpointServerUsersList": { "get": { "tags": [ "FlowEndpointServerUsers" ], "summary": "Retrieves all server user configurations for a specific flow endpoint", "operationId": "FlowEndpointServerUsers_GetFlowEndpointServerUsersList", "parameters": [ { "name": "flowEndpointId", "in": "query", "description": "Unique identifier of the flow endpoint", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully retrieved server user configurations", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FlowEndpointServerUsers" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FlowEndpointServerUsers" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FlowEndpointServerUsers" } } } } }, "401": { "description": "User is not authenticated", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "User is not authorized to view server user configurations", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error occurred while retrieving configurations", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } } }, "description": "Returns list of server user configurations for a flow endpoint." } }, "/api/FlowEndpointServerUsers": { "post": { "tags": [ "FlowEndpointServerUsers" ], "summary": "Creates a new server user configuration for a flow endpoint", "operationId": "FlowEndpointServerUsers_Create", "requestBody": { "description": "Server user configuration details including credentials and access settings", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointServerUsers" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointServerUsers" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/FlowEndpointServerUsers" } } } }, "responses": { "200": { "description": "Successfully created server user configuration", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/FlowEndpointServerUsers" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointServerUsers" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointServerUsers" } } } }, "401": { "description": "User is not authenticated", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "User is not authorized to create server user configurations", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error occurred while creating configuration", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } } }, "description": "Establishes new server user with authentication credentials and access settings." }, "put": { "tags": [ "FlowEndpointServerUsers" ], "summary": "Updates an existing server user configuration for a flow endpoint", "operationId": "FlowEndpointServerUsers_Update", "requestBody": { "description": "Updated server user configuration details", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointServerUsers" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointServerUsers" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/FlowEndpointServerUsers" } } } }, "responses": { "200": { "description": "Successfully updated server user configuration", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/FlowEndpointServerUsers" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointServerUsers" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointServerUsers" } } } }, "401": { "description": "User is not authenticated", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "User is not authorized to update server user configurations", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error occurred while updating configuration", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } } }, "description": "Modifies existing server user configuration including credentials and authentication type." } }, "/api/FlowEndpointServerUsers/save": { "put": { "tags": [ "FlowEndpointServerUsers" ], "summary": "Saves server user configuration (creates new or updates existing based on ID)", "description": "Performs upsert operation: creates new configuration if ID is 0, otherwise updates existing configuration", "operationId": "FlowEndpointServerUsers_Save", "requestBody": { "description": "Server user configuration to save (performs upsert based on record ID)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointServerUsers" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointServerUsers" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/FlowEndpointServerUsers" } } } }, "responses": { "200": { "description": "Successfully saved server user configuration", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/FlowEndpointServerUsers" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointServerUsers" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointServerUsers" } } } }, "401": { "description": "User is not authenticated", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "User is not authorized to save server user configurations", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error occurred while saving configuration", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } } } } }, "/api/FlowEndpointTriggerFiles/{flowEndpointTriggerFilesId}": { "get": { "tags": [ "FlowEndpointTriggerFiles" ], "summary": "Retrieves a specific trigger file configuration by ID", "operationId": "FlowEndpointTriggerFiles_GetById", "parameters": [ { "name": "flowEndpointTriggerFilesId", "in": "path", "description": "Unique identifier of the trigger file configuration", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully retrieved trigger file configuration", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/FlowEndpointTriggers" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointTriggers" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointTriggers" } } } }, "204": { "description": "No content found for the specified trigger file" }, "403": { "description": "User is not authorized to view trigger file configurations", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error occurred while retrieving configuration", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } } }, "description": "Returns trigger file configuration including semaphore and temporary file settings." }, "delete": { "tags": [ "FlowEndpointTriggerFiles" ], "summary": "Deletes a specific trigger file configuration", "operationId": "FlowEndpointTriggerFiles_Delete", "parameters": [ { "name": "flowEndpointTriggerFilesId", "in": "path", "description": "Unique identifier of the trigger file configuration to delete", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully deleted trigger file configuration", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DeleteFlowEndpointTriggerFilesResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DeleteFlowEndpointTriggerFilesResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeleteFlowEndpointTriggerFilesResponseViewModel" } } } }, "403": { "description": "User is not authorized to delete trigger file configurations", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error occurred while deleting configuration", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } } }, "description": "Removes trigger file configuration from flow endpoint." } }, "/api/FlowEndpointTriggerFiles/getByFlowEndpointId": { "get": { "tags": [ "FlowEndpointTriggerFiles" ], "summary": "Retrieves all trigger file configurations for a specific flow endpoint", "operationId": "FlowEndpointTriggerFiles_GetByFlowEndpointId", "parameters": [ { "name": "flowEndpointId", "in": "query", "description": "Unique identifier of the flow endpoint", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully retrieved trigger file configurations", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FlowEndpointTriggers" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FlowEndpointTriggers" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FlowEndpointTriggers" } } } } }, "204": { "description": "No content found for the specified flow endpoint" }, "403": { "description": "User is not authorized to view trigger file configurations", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error occurred while retrieving configurations", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } } }, "description": "Returns list of trigger file configurations for a flow endpoint." } }, "/api/FlowEndpointTriggerFiles": { "post": { "tags": [ "FlowEndpointTriggerFiles" ], "summary": "Creates a new trigger file configuration for a flow endpoint", "operationId": "FlowEndpointTriggerFiles_Create", "requestBody": { "description": "Trigger file configuration details including trigger conditions and file patterns", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointTriggers" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointTriggers" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/FlowEndpointTriggers" } } } }, "responses": { "200": { "description": "Successfully created trigger file configuration", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/FlowEndpointTriggers" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointTriggers" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointTriggers" } } } }, "403": { "description": "User is not authorized to create trigger file configurations", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error occurred while creating configuration", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } } }, "description": "Establishes new trigger file configuration with semaphore and naming rules." }, "put": { "tags": [ "FlowEndpointTriggerFiles" ], "summary": "Updates an existing trigger file configuration for a flow endpoint", "operationId": "FlowEndpointTriggerFiles_Update", "requestBody": { "description": "Updated trigger file configuration details", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointTriggers" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointTriggers" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/FlowEndpointTriggers" } } } }, "responses": { "200": { "description": "Successfully updated trigger file configuration", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/FlowEndpointTriggers" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointTriggers" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointTriggers" } } } }, "403": { "description": "User is not authorized to update trigger file configurations", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error occurred while updating configuration", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } } }, "description": "Modifies existing trigger file configuration including semaphore settings." } }, "/api/FlowEndpointTriggerFiles/save": { "put": { "tags": [ "FlowEndpointTriggerFiles" ], "summary": "Saves trigger file configuration (creates new or updates existing based on ID)", "description": "Performs upsert operation: creates new configuration if ID is 0, otherwise updates existing configuration", "operationId": "FlowEndpointTriggerFiles_Save", "requestBody": { "description": "Trigger file configuration to save (performs upsert based on record ID)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointTriggers" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointTriggers" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/FlowEndpointTriggers" } } } }, "responses": { "200": { "description": "Successfully saved trigger file configuration", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/FlowEndpointTriggers" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointTriggers" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FlowEndpointTriggers" } } } }, "403": { "description": "User is not authorized to save trigger file configurations", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error occurred while saving configuration", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } } } } }, "/api/FlowEndpointTriggerFiles/deleteByFlowEndpointId": { "delete": { "tags": [ "FlowEndpointTriggerFiles" ], "summary": "Deletes all trigger file configurations for a specific flow endpoint", "operationId": "FlowEndpointTriggerFiles_DeleteByFlowEndpointId", "parameters": [ { "name": "flowEndpointId", "in": "query", "description": "Unique identifier of the flow endpoint to remove all trigger file configurations for", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully deleted all trigger file configurations for the flow endpoint", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DeleteFlowEndpointTriggerFilesResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DeleteFlowEndpointTriggerFilesResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeleteFlowEndpointTriggerFilesResponseViewModel" } } } }, "403": { "description": "User is not authorized to delete trigger file configurations", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error occurred while deleting configurations", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } } }, "description": "Removes all trigger file configurations from a flow endpoint." } }, "/api/FlowHistory/getHistoryList": { "get": { "tags": [ "FlowHistory" ], "summary": "Retrieves the change history list for a specific flow", "description": "Returns chronological list of changes including creation, modifications, and status updates for the specified flow.\r\nRequires flow history read permissions.", "operationId": "FlowHistory_GetHistoryList", "parameters": [ { "name": "flowId", "in": "query", "description": "The unique identifier of the flow to retrieve history for", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully retrieved flow history list", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FlowHistoryLineItemViewModel" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FlowHistoryLineItemViewModel" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FlowHistoryLineItemViewModel" } } } } }, "204": { "description": "No content - no history found" }, "401": { "description": "Unauthorized - invalid or missing API key", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden - insufficient permissions", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/FlowHistory/compareChanges": { "get": { "tags": [ "FlowHistory" ], "summary": "Compares changes between flow versions to show modifications", "description": "Provides side-by-side comparison of flow configuration changes, highlighting additions, modifications, and deletions.\r\nRequires flow history read permissions.", "operationId": "FlowHistory_CompareChanges", "parameters": [ { "name": "auditLogId", "in": "query", "description": "The unique identifier of the audit log entry to compare changes for", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully retrieved flow change comparison", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CompareChangesViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CompareChangesViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CompareChangesViewModel" } } } }, "204": { "description": "No content - no changes to compare" }, "401": { "description": "Unauthorized - invalid or missing API key", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden - insufficient permissions", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/FlowHistory/rollback": { "post": { "tags": [ "FlowHistory" ], "summary": "Rolls back a flow configuration to a previous version", "description": "Reverts the flow configuration to the state recorded in the specified audit log entry.\r\nThis operation creates a new audit entry documenting the rollback action.\r\nRequires flow history rollback permissions.", "operationId": "FlowHistory_Rollback", "parameters": [ { "name": "auditLogId", "in": "query", "description": "The unique identifier of the audit log entry to rollback to", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully rolled back flow configuration", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/FlowRollbackResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FlowRollbackResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FlowRollbackResponseViewModel" } } } }, "401": { "description": "Unauthorized - invalid or missing API key", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden - insufficient permissions", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/FlowHistory/viewPendingChanges": { "get": { "tags": [ "FlowHistory" ], "summary": "Retrieves pending changes for a specific flow that have not yet been committed", "description": "Shows changes that have been made to a flow configuration but are not yet committed to the active configuration.\r\nRequires flow history read permissions.", "operationId": "FlowHistory_ViewPendingChanges", "parameters": [ { "name": "flowId", "in": "query", "description": "The unique identifier of the flow to check for pending changes", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully retrieved pending changes", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CompareChangesViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CompareChangesViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CompareChangesViewModel" } } } }, "204": { "description": "No content - no pending changes" }, "401": { "description": "Unauthorized - invalid or missing API key", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden - insufficient permissions", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/FlowHistory/rollbackPendingChanges": { "post": { "tags": [ "FlowHistory" ], "summary": "Rolls back pending changes for a specific flow, discarding uncommitted modifications", "description": "Discards all pending changes for the specified flow, reverting to the last committed configuration.\r\nThis operation cannot be undone and all uncommitted changes will be permanently lost.\r\nRequires flow history rollback permissions.", "operationId": "FlowHistory_RollbackPendingChanges", "parameters": [ { "name": "flowId", "in": "query", "description": "The unique identifier of the flow to rollback pending changes for", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully rolled back pending changes", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/FlowRollbackResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FlowRollbackResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FlowRollbackResponseViewModel" } } } }, "401": { "description": "Unauthorized - invalid or missing API key", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden - insufficient permissions", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/FlowSubscribers/getSubscribersList": { "get": { "tags": [ "FlowSubscribers" ], "summary": "Retrieves all subscribers for a specific flow", "operationId": "FlowSubscribers_GetSubscribersList", "parameters": [ { "name": "flowId", "in": "query", "description": "Unique identifier of the flow to retrieve subscribers for", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully retrieved flow subscribers list", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/vwFlowSubscribersList" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/vwFlowSubscribersList" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/vwFlowSubscribersList" } } } } }, "401": { "description": "Authentication credentials are missing or invalid", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "User is not authorized to view flow subscribers", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error occurred while retrieving subscribers", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "description": "Returns list of organizations subscribed to a flow." } }, "/api/FlowSubscribers/getSubscriberOptionsList": { "get": { "tags": [ "FlowSubscribers" ], "summary": "Retrieves available subscriber options for a specific flow", "operationId": "FlowSubscribers_GetSubscriberOptionsList", "parameters": [ { "name": "flowId", "in": "query", "description": "Unique identifier of the flow to retrieve subscriber options for", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully retrieved subscriber options", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/vwFlowSubscribersList" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/vwFlowSubscribersList" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/vwFlowSubscribersList" } } } } }, "401": { "description": "Authentication credentials are missing or invalid", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "User is not authorized to view subscriber options", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error occurred while retrieving options", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "description": "Returns list of organizations available for subscription to a flow." } }, "/api/FlowSubscribers/createSubscriber": { "post": { "tags": [ "FlowSubscribers" ], "summary": "Creates a new subscriber for a flow", "operationId": "FlowSubscribers_CreateSubscriber", "requestBody": { "description": "Flow subscriber configuration details including notification settings and recipient information", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlowSubscriberViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FlowSubscriberViewModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/FlowSubscriberViewModel" } } } }, "responses": { "200": { "description": "Successfully created flow subscriber", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Subscribers" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Subscribers" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Subscribers" } } } }, "400": { "description": "Invalid request data or validation errors", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "401": { "description": "Authentication credentials are missing or invalid", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "User is not authorized to create flow subscribers", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error occurred while creating subscriber", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "description": "Subscribes an organization to a flow for file distribution." } }, "/api/FlowSubscribers/deleteSubscriber": { "delete": { "tags": [ "FlowSubscribers" ], "summary": "Deletes a specific flow subscriber", "operationId": "FlowSubscribers_DeleteSubscriber", "parameters": [ { "name": "subscriberId", "in": "query", "description": "Unique identifier of the subscriber to delete", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully deleted flow subscriber", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResult" } } } }, "401": { "description": "Authentication credentials are missing or invalid", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "User is not authorized to delete flow subscribers", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Subscriber with the specified ID was not found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "Internal server error occurred while deleting subscriber", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "description": "Removes organization subscription from a flow." } }, "/api/ForgotUser/password": { "post": { "tags": [ "ForgotUser" ], "summary": "Initiates password reset process by sending reset email to user", "description": "This endpoint does not require authentication and can be accessed anonymously for security reasons", "operationId": "ForgotUser_ForgotPassword", "requestBody": { "description": "User information containing username for password reset", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForgotUserModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ForgotUserModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ForgotUserModel" } } } }, "responses": { "200": { "description": "Password reset email sent successfully" }, "500": { "description": "Internal server error occurred while processing password reset", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } } } } }, "/api/ForgotUser/username": { "post": { "tags": [ "ForgotUser" ], "summary": "Initiates username recovery process by sending username to user's email", "description": "This endpoint does not require authentication and can be accessed anonymously for security reasons", "operationId": "ForgotUser_ForgotUsername", "requestBody": { "description": "User information containing email address for username recovery", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForgotUserModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ForgotUserModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ForgotUserModel" } } } }, "responses": { "200": { "description": "Username recovery email sent successfully" }, "500": { "description": "Internal server error occurred while processing username recovery", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseViewModel" } } } } } } }, "/api/MachineUser": { "get": { "tags": [ "MachineUser" ], "summary": "Retrieves all machine users for a specific organization", "operationId": "MachineUser_List", "parameters": [ { "name": "organizationId", "in": "query", "description": "Unique identifier of the organization to retrieve machine users for", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully retrieved machine users list", "content": { "text/plain": { "schema": { } }, "application/json": { "schema": { } }, "text/json": { "schema": { } } } }, "400": { "description": "Bad request - invalid parameters", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized - invalid or missing API key", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden - insufficient permissions", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "description": "Returns list of machine users configured for automated API access." } }, "/api/Monitoring/logWebVitals": { "post": { "tags": [ "Monitoring" ], "summary": "Logs web vitals metrics for application performance monitoring", "operationId": "Monitoring_LogWebVitals", "requestBody": { "description": "Web vitals performance metrics including page load times and user experience measurements", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebVitalsModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WebVitalsModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/WebVitalsModel" } } } }, "responses": { "200": { "description": "Successfully logged web vitals metrics" }, "500": { "description": "Internal server error occurred while processing the request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "description": "Records web performance metrics for application monitoring and optimization." } }, "/api/Monitoring/logError": { "post": { "tags": [ "Monitoring" ], "summary": "Logs application errors for debugging and monitoring purposes", "operationId": "Monitoring_LogError", "requestBody": { "description": "Error details including message, path, and additional diagnostic information", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } }, "responses": { "200": { "description": "Successfully logged error information" }, "500": { "description": "Internal server error occurred while processing the request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "description": "Records client-side error information for debugging and monitoring." } }, "/api/Organization/{id}": { "get": { "tags": [ "Organization" ], "summary": "Retrieves a specific organization configuration by ID", "operationId": "Organization_GetById", "parameters": [ { "name": "id", "in": "path", "description": "The unique identifier of the organization", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully retrieved organization configuration", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OrganizationViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OrganizationViewModel" } } } }, "401": { "description": "Missing or invalid authentication credentials", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "User is not authorized to view organization configurations", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "404": { "description": "Organization not found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "Internal server error occurred while retrieving organization", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "description": "Returns complete organization configuration including status, codes, and metadata." }, "delete": { "tags": [ "Organization" ], "summary": "Deletes an organization configuration", "operationId": "Organization_Delete", "parameters": [ { "name": "id", "in": "path", "description": "The unique identifier of the organization to delete", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully deleted organization configuration", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResult" } } } }, "401": { "description": "Missing or invalid authentication credentials", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "User is not authorized to delete organization configurations", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "Internal server error occurred while deleting organization", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "description": "Removes organization configuration and marks it as deleted." } }, "/api/Organization": { "get": { "tags": [ "Organization" ], "summary": "Retrieves a list of all organizations", "operationId": "Organization_GetAll", "parameters": [ { "name": "showDeleted", "in": "query", "description": "Whether to include deleted organizations in the results (default: false)", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Successfully retrieved organizations list", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Organizations" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Organizations" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Organizations" } } } } }, "401": { "description": "Missing or invalid authentication credentials", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "User is not authorized to view organizations", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "Internal server error occurred while retrieving organizations", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "description": "Returns list of all organizations with optional inclusion of deleted organizations." }, "put": { "tags": [ "Organization" ], "summary": "Updates an existing organization configuration", "operationId": "Organization_Update", "requestBody": { "description": "Organization view model with updated configuration settings", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OrganizationViewModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OrganizationViewModel" } } } }, "responses": { "200": { "description": "Successfully updated organization configuration", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OrganizationViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OrganizationViewModel" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } }, "401": { "description": "Missing or invalid authentication credentials", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "User is not authorized to update organization configurations", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "Internal server error occurred while updating organization", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "description": "Modifies existing organization configuration including name and status." }, "post": { "tags": [ "Organization" ], "summary": "Creates a new organization configuration", "operationId": "Organization_Create", "requestBody": { "description": "Complete organization model with configuration settings for the new organization", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OrganizationViewModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OrganizationViewModel" } } } }, "responses": { "201": { "description": "Successfully created organization configuration", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OrganizationViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OrganizationViewModel" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } }, "401": { "description": "Missing or invalid authentication credentials", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "User is not authorized to create organization configurations", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "Internal server error occurred while creating organization", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "description": "Establishes new organization with specified configuration and metadata." } }, "/api/Organization/getRecentOrganizationActivity": { "get": { "tags": [ "Organization" ], "summary": "Retrieves recent activity for organizations", "operationId": "Organization_GetRecentActivity", "parameters": [ { "name": "count", "in": "query", "description": "Number of recent activity records to retrieve (required)", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully retrieved organization activity", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OrganizationActivityViewModel" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OrganizationActivityViewModel" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OrganizationActivityViewModel" } } } } }, "401": { "description": "Missing or invalid authentication credentials", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "User is not authorized to view organization activity", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "Internal server error occurred while retrieving organization activity", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "description": "Returns recent organization activity including creation and modification timestamps." } }, "/api/OrganizationSubscriptions/getSubscriptionsList": { "get": { "tags": [ "OrganizationSubscriptions" ], "summary": "Retrieve organization subscriptions list", "description": "Gets a list of all subscriptions for the specified organization", "operationId": "OrganizationSubscriptions_GetSubscriptionsList", "parameters": [ { "name": "organizationId", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/vwOrganizationSubscriptionsList" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/vwOrganizationSubscriptionsList" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/vwOrganizationSubscriptionsList" } } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } } } }, "/api/OrganizationSubscriptions/getSubscriptionOptionsList": { "get": { "tags": [ "OrganizationSubscriptions" ], "summary": "Retrieve subscription options list", "description": "Gets a list of available subscription options for the specified organization", "operationId": "OrganizationSubscriptions_GetSubscriptionOptionsList", "parameters": [ { "name": "organizationId", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/vwFlowSubscribersList" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/vwFlowSubscribersList" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/vwFlowSubscribersList" } } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } } } }, "/api/OrganizationSubscriptions/createSubscription": { "post": { "tags": [ "OrganizationSubscriptions" ], "summary": "Create organization subscription", "description": "Creates a new subscription for an organization to a flow", "operationId": "OrganizationSubscriptions_CreateSubscription", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlowSubscriberViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FlowSubscriberViewModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/FlowSubscriberViewModel" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Subscribers" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Subscribers" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Subscribers" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } } } }, "/api/OrganizationSubscriptions/createSubscriptions": { "post": { "tags": [ "OrganizationSubscriptions" ], "summary": "Create multiple organization subscriptions", "description": "Creates multiple subscriptions for an organization to flows in a single operation", "operationId": "OrganizationSubscriptions_CreateSubscriptions", "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FlowSubscriberViewModel" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FlowSubscriberViewModel" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FlowSubscriberViewModel" } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Subscribers" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Subscribers" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Subscribers" } } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } } } }, "/api/OrganizationSubscriptions/deleteSubscription": { "delete": { "tags": [ "OrganizationSubscriptions" ], "summary": "Delete organization subscription", "description": "Deletes an existing subscription by subscription ID", "operationId": "OrganizationSubscriptions_DeleteSubscription", "parameters": [ { "name": "subscriptionId", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { } }, "application/json": { "schema": { } }, "text/json": { "schema": { } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } } } }, "/api/Password/validate": { "get": { "tags": [ "Password" ], "summary": "Validates a password set link using the provided key", "operationId": "Password_ValidateSetPassword", "parameters": [ { "name": "key", "in": "query", "description": "Unique identifier for the password set operation", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Password set link is valid and active", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PasswordModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PasswordModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PasswordModel" } } } }, "400": { "description": "Invalid request parameters", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } }, "500": { "description": "Internal server error occurred while validating the link", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PasswordErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PasswordErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PasswordErrorResponseViewModel" } } } } }, "description": "Validates password set link and returns user information for password setup." } }, "/api/Password/setPassword": { "post": { "tags": [ "Password" ], "summary": "Sets a new password using the validated password set link", "operationId": "Password_SetPassword", "requestBody": { "description": "Password model containing the key, new password, and confirmation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PasswordModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PasswordModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PasswordModel" } } } }, "responses": { "200": { "description": "Password was successfully set", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "400": { "description": "Invalid request parameters or validation failed", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } }, "500": { "description": "Internal server error occurred while setting the password", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PasswordErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PasswordErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PasswordErrorResponseViewModel" } } } } }, "description": "Sets new password for user account using validated password set link." } }, "/api/Password/validateReset": { "get": { "tags": [ "Password" ], "summary": "Validates a password reset link using the provided key", "operationId": "Password_ValidateResetPassword", "parameters": [ { "name": "key", "in": "query", "description": "Unique identifier for the password reset operation", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Password reset link is valid and active", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PasswordModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PasswordModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PasswordModel" } } } }, "400": { "description": "Invalid request parameters", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } }, "500": { "description": "Internal server error occurred while validating the reset link", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PasswordErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PasswordErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PasswordErrorResponseViewModel" } } } } }, "description": "Validates password reset link and returns user information for password reset." } }, "/api/Password/resetPassword": { "post": { "tags": [ "Password" ], "summary": "Resets a password using the validated password reset link", "operationId": "Password_ResetPassword", "requestBody": { "description": "Password model containing the key, new password, and confirmation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PasswordModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PasswordModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PasswordModel" } } } }, "responses": { "200": { "description": "Password was successfully reset", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "400": { "description": "Invalid request parameters or validation failed", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } }, "500": { "description": "Internal server error occurred while resetting the password", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PasswordErrorResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PasswordErrorResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PasswordErrorResponseViewModel" } } } } }, "description": "Resets user password using validated password reset link." } }, "/api/PGPKeys/getOrganizationPgpList": { "get": { "tags": [ "PGPKeys" ], "summary": "Retrieves all PGP keys for a specific organization", "operationId": "PGPKeys_GetOrganizationPgpList", "parameters": [ { "name": "organizationId", "in": "query", "description": "Unique identifier of the organization to retrieve PGP keys for", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully retrieved PGP keys list", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PgpKeyViewModel" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PgpKeyViewModel" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PgpKeyViewModel" } } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "description": "Returns list of PGP keys configured for an organization." } }, "/api/PGPKeys/{pgpKeyId}": { "get": { "tags": [ "PGPKeys" ], "summary": "Retrieves detailed information for a specific PGP key", "operationId": "PGPKeys_GetPgpKeyInfo", "parameters": [ { "name": "pgpKeyId", "in": "path", "description": "Unique identifier of the PGP key to retrieve", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully retrieved PGP key information", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PgpKeyViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PgpKeyViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PgpKeyViewModel" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "description": "Returns detailed PGP key information including algorithm, strength, and expiration." }, "delete": { "tags": [ "PGPKeys" ], "summary": "Deletes a specific PGP key from the organization", "operationId": "PGPKeys_Delete", "parameters": [ { "name": "pgpKeyId", "in": "path", "description": "Unique identifier of the PGP key to delete", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully deleted PGP key", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/thruStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/thruStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/thruStatus" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "404": { "description": "PGP key with the specified ID does not exist", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "description": "Removes PGP key from organization configuration." } }, "/api/PGPKeys/getPgpOptions": { "get": { "tags": [ "PGPKeys" ], "summary": "Retrieves available PGP configuration options and settings", "operationId": "PGPKeys_GetPgpOptions", "responses": { "200": { "description": "Successfully retrieved PGP options", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PgpOptionsViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PgpOptionsViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PgpOptionsViewModel" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "description": "Returns available PGP algorithms, key strengths, and configuration options." } }, "/api/PGPKeys/getPgpPublicKey": { "get": { "tags": [ "PGPKeys" ], "summary": "Retrieves the public key data for a specific PGP key", "operationId": "PGPKeys_GetPgpPublicKey", "parameters": [ { "name": "pgpKeyId", "in": "query", "description": "Unique identifier of the PGP key to retrieve public key for", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully retrieved PGP public key (Base64 encoded)", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "204": { "description": "No public key data available for the specified PGP key" }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "description": "Returns Base64-encoded public key data for a PGP key." } }, "/api/PGPKeys/generatePgpKey": { "post": { "tags": [ "PGPKeys" ], "summary": "Generates a new PGP key pair for the organization", "description": "Example: required fields\r\n \r\n{\r\n \"customerId\": 0,\r\n \"firstName\": \"example_first_name\",\r\n \"lastName\": \"example_last_name\",\r\n \"username\": \"example_user_name\",\r\n \"password\": \"example_password\",\r\n \"email\": \"example_email\",\r\n \"isEnabled\": true,\r\n \"isActive\": true,\r\n \"isLogSession\": true\r\n }", "operationId": "PGPKeys_GeneratePgpKey", "requestBody": { "description": "PGP key configuration including user identity information and key parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PGPKeys" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PGPKeys" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PGPKeys" } } } }, "responses": { "200": { "description": "Successfully generated PGP key pair", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PgpKeyViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PgpKeyViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PgpKeyViewModel" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "404": { "description": "Required resources for key generation not available", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } } } }, "/api/PGPKeys/importPgpKey": { "post": { "tags": [ "PGPKeys" ], "summary": "Imports an existing PGP key into the organization", "operationId": "PGPKeys_ImportPgpKey", "requestBody": { "description": "PGP key data including the key material and associated metadata", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PGPKeys" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PGPKeys" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PGPKeys" } } } }, "responses": { "200": { "description": "Successfully imported PGP key", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PgpKeyViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PgpKeyViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PgpKeyViewModel" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "404": { "description": "Required resources for key import not available", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "description": "Imports existing PGP key into organization from provided key material." } }, "/api/PGPKeys": { "put": { "tags": [ "PGPKeys" ], "summary": "Updates an existing PGP key configuration", "description": "Example: required fields\r\n \r\n{\r\n \"customerId\": 0,\r\n \"firstName\": \"example_first_name\",\r\n \"lastName\": \"example_last_name\",\r\n \"username\": \"example_user_name\",\r\n \"password\": \"example_password\",\r\n \"email\": \"example_email\",\r\n \"isEnabled\": true,\r\n \"isActive\": true,\r\n \"isLogSession\": true\r\n }", "operationId": "PGPKeys_UpdatePgpKeyInfo", "requestBody": { "description": "Updated PGP key configuration including metadata and settings", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PGPKeys" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PGPKeys" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PGPKeys" } } } }, "responses": { "200": { "description": "Successfully updated PGP key configuration", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PgpKeyViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PgpKeyViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PgpKeyViewModel" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } } } }, "/api/Report/fileActivityExport": { "post": { "tags": [ "Report" ], "summary": "Initiates a file activity export job for audit data", "operationId": "Report_CreateFileActivityExport", "requestBody": { "description": "Export configuration including filters, date range, and output format for activity data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActivityFilesListViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ActivityFilesListViewModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ActivityFilesListViewModel" } } } }, "responses": { "200": { "description": "Successfully initiated file activity export job", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/JobCreationResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/JobCreationResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/JobCreationResponseViewModel" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "User is not authorized to export file activity data", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "Internal server error occurred while initiating export job", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "description": "Initiates asynchronous job to export file activity data based on specified filters." }, "get": { "tags": [ "Report" ], "summary": "Retrieves the status and progress of a file activity export job", "operationId": "Report_GetFileActivityExportStatus", "parameters": [ { "name": "guid", "in": "query", "description": "Unique identifier of the export job to check", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successfully retrieved export job status", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Reports" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Reports" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Reports" } } } }, "204": { "description": "No content returned when result data is null" }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "User is not authorized to view export job status", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "404": { "description": "Export job not found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "Internal server error occurred while retrieving job status", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "description": "Returns current status and progress of a file activity export job." } }, "/api/Report/list": { "get": { "tags": [ "Report" ], "summary": "Retrieves a list of all available reports for the current organization", "operationId": "Report_ListReports", "responses": { "200": { "description": "Successfully retrieved reports list", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Reports" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Reports" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Reports" } } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "User is not authorized to view reports", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "Internal server error occurred while retrieving reports list", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "description": "Returns list of all available reports with status and metadata." } }, "/api/Report/download/{reportId}": { "get": { "tags": [ "Report" ], "summary": "Downloads a generated report file", "operationId": "Report_DownloadReport", "parameters": [ { "name": "reportId", "in": "path", "description": "Unique identifier of the report to download", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successfully downloaded report file" }, "401": { "description": "Unauthorized", "content": { "application/octet-stream": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "User is not authorized to download this report", "content": { "application/octet-stream": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "404": { "description": "Report not found or no longer available", "content": { "application/octet-stream": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "Internal server error occurred while downloading report", "content": { "application/octet-stream": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "description": "Returns generated report file for download." } }, "/api/Saml/sitesetting": { "get": { "tags": [ "Saml" ], "summary": "Retrieves SAML configuration settings for the current site", "operationId": "Saml_GetSiteSettings", "responses": { "200": { "description": "Successfully retrieved SAML settings", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SamlSiteSettingsResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SamlSiteSettingsResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SamlSiteSettingsResponseViewModel" } } } } }, "description": "Returns SAML configuration status including whether SSO is enabled." } }, "/api/Saml/InitiateSingleSignOn": { "get": { "tags": [ "Saml" ], "summary": "Initiates SAML Single Sign-On authentication process", "operationId": "Saml_InitiateSingleSignOn", "parameters": [ { "name": "customerCode", "in": "query", "description": "Optional customer code for customer-specific SAML configuration", "schema": { "type": "string" } }, { "name": "returnUrl", "in": "query", "description": "URL to redirect to after successful authentication", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successfully initiated SSO process" }, "404": { "description": "SAML configuration not found or SSO disabled", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "description": "Redirects user to identity provider for SAML authentication." } }, "/api/Saml/AssertionConsumerService": { "post": { "tags": [ "Saml" ], "summary": "Processes SAML authentication response from identity provider", "operationId": "Saml_AssertionConsumerService", "parameters": [ { "name": "code", "in": "query", "description": "Customer code for SAML configuration identification", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successfully processed SAML response and authenticated user" }, "302": { "description": "Redirect to application with authentication tokens" }, "404": { "description": "Invalid customer code or IdP-initiated SSO disabled", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "SAML configuration error or processing failure", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "description": "Processes SAML authentication response from identity provider and establishes user session." }, "get": { "tags": [ "Saml" ], "summary": "Processes SAML authentication response from identity provider", "operationId": "Saml_AssertionConsumerService", "parameters": [ { "name": "code", "in": "query", "description": "Customer code for SAML configuration identification", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successfully processed SAML response and authenticated user" }, "302": { "description": "Redirect to application with authentication tokens" }, "404": { "description": "Invalid customer code or IdP-initiated SSO disabled", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "SAML configuration error or processing failure", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "description": "Processes SAML authentication response from identity provider and establishes user session." } }, "/api/Search/search": { "get": { "tags": [ "Search" ], "summary": "Performs a global search across multiple entity types in the system", "description": "Requires search permissions and reader role. The search scope is automatically filtered based on user permissions:\r\n- Organizations (name, code) - requires OrganizationGet permission\r\n- Endpoints (name, code, host, username, domain, network path) - requires OrganizationEndpointGet permission\r\n- PGP Keys (name, username/email) - requires OrganizationPGPKeyGet permission\r\n- Certificates (name, filename) - requires OrganizationCertificateGet permission\r\n- Flows (name, code) - requires FlowGet permission\r\n- Flow Endpoints (name, id, path, server username, alert email) - requires FlowEndpointGet permission", "operationId": "Search_Search", "parameters": [ { "name": "searchString", "in": "query", "description": "The search term to match against organizations, endpoints, flows, PGP keys, certificates, and flow endpoints. Supports partial matching and is case-insensitive.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successfully completed search. Returns list of matching entities (may be empty if no results found)", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SearchResultItemViewModel" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SearchResultItemViewModel" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SearchResultItemViewModel" } } } } }, "400": { "description": "Invalid search parameters (e.g., missing or empty search string)", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } }, "401": { "description": "Missing or invalid authentication credentials", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "User is not authorized to perform searches", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "Internal server error occurred while executing search", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } } } }, "/api/SSHKey/migrateCertificates": { "put": { "tags": [ "SSHKey" ], "summary": "Migrates existing certificates to SSH key format", "operationId": "SSHKey_MigrateCertificates", "responses": { "200": { "description": "Successfully migrated certificates", "content": { "text/plain": { "schema": { } }, "application/json": { "schema": { } }, "text/json": { "schema": { } } } }, "500": { "description": "Internal server error occurred during migration", "content": { "text/plain": { "schema": { } }, "application/json": { "schema": { } }, "text/json": { "schema": { } } } } }, "description": "Converts existing certificate records to SSH key format for system upgrade." } }, "/api/SSHKey/generateKey": { "post": { "tags": [ "SSHKey" ], "summary": "Generates a new SSH key pair for the organization", "operationId": "SSHKey_GenerateKey", "requestBody": { "description": "SSH key configuration including key type and metadata (username is required)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SSHKeys" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SSHKeys" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SSHKeys" } } } }, "responses": { "200": { "description": "Successfully generated SSH key pair", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SSHKeys" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SSHKeys" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SSHKeys" } } } }, "400": { "description": "Bad request - missing required fields", "content": { "text/plain": { "schema": { } }, "application/json": { "schema": { } }, "text/json": { "schema": { } } } }, "500": { "description": "Internal server error occurred during key generation", "content": { "text/plain": { "schema": { } }, "application/json": { "schema": { } }, "text/json": { "schema": { } } } } }, "description": "Generates new SSH key pair with specified algorithm and key strength." } }, "/api/SSHKey/importKey": { "post": { "tags": [ "SSHKey" ], "summary": "Imports an existing SSH key into the organization", "operationId": "SSHKey_ImportKey", "requestBody": { "description": "SSH key data including the key material and associated metadata", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SSHKeys" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SSHKeys" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SSHKeys" } } } }, "responses": { "200": { "description": "Successfully imported SSH key", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SshKeyViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SshKeyViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SshKeyViewModel" } } } }, "400": { "description": "Bad request - invalid key format or missing required fields", "content": { "text/plain": { "schema": { } }, "application/json": { "schema": { } }, "text/json": { "schema": { } } } }, "500": { "description": "Internal server error occurred during key import", "content": { "text/plain": { "schema": { } }, "application/json": { "schema": { } }, "text/json": { "schema": { } } } } }, "description": "Imports existing SSH key into organization from provided key material." } }, "/api/SSHKey/updateKey": { "put": { "tags": [ "SSHKey" ], "summary": "Updates an existing SSH key configuration", "operationId": "SSHKey_UpdateKey", "requestBody": { "description": "Updated SSH key configuration including metadata and settings", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SSHKeys" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SSHKeys" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SSHKeys" } } } }, "responses": { "200": { "description": "Successfully updated SSH key configuration", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SshKeyViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SshKeyViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SshKeyViewModel" } } } }, "400": { "description": "Bad request - invalid update operation or business rule violation", "content": { "text/plain": { "schema": { } }, "application/json": { "schema": { } }, "text/json": { "schema": { } } } }, "404": { "description": "SSH key not found", "content": { "text/plain": { "schema": { } }, "application/json": { "schema": { } }, "text/json": { "schema": { } } } }, "500": { "description": "Internal server error occurred during key update", "content": { "text/plain": { "schema": { } }, "application/json": { "schema": { } }, "text/json": { "schema": { } } } } }, "description": "Modifies SSH key metadata including name and description." } }, "/api/SSHKey/listKeys": { "get": { "tags": [ "SSHKey" ], "summary": "Retrieves all SSH keys for a specific organization", "operationId": "SSHKey_ListKeys", "parameters": [ { "name": "organizationId", "in": "query", "description": "Unique identifier of the organization to retrieve SSH keys for", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully retrieved SSH keys list", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SshKeyViewModel" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SshKeyViewModel" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SshKeyViewModel" } } } } }, "404": { "description": "Organization not found", "content": { "text/plain": { "schema": { } }, "application/json": { "schema": { } }, "text/json": { "schema": { } } } }, "500": { "description": "Internal server error occurred during retrieval", "content": { "text/plain": { "schema": { } }, "application/json": { "schema": { } }, "text/json": { "schema": { } } } } }, "description": "Returns list of SSH keys configured for an organization." } }, "/api/SSHKey/getKey": { "get": { "tags": [ "SSHKey" ], "summary": "Retrieves detailed information for a specific SSH key", "operationId": "SSHKey_GetKey", "parameters": [ { "name": "sshKeyId", "in": "query", "description": "Unique identifier of the SSH key to retrieve", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully retrieved SSH key information", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SshKeyViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SshKeyViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SshKeyViewModel" } } } }, "404": { "description": "SSH key not found", "content": { "text/plain": { "schema": { } }, "application/json": { "schema": { } }, "text/json": { "schema": { } } } }, "500": { "description": "Internal server error occurred during retrieval", "content": { "text/plain": { "schema": { } }, "application/json": { "schema": { } }, "text/json": { "schema": { } } } } }, "description": "Returns detailed SSH key information including algorithm, strength, and public key data." } }, "/api/SSHKey/deleteKey": { "delete": { "tags": [ "SSHKey" ], "summary": "Deletes a specific SSH key from the organization", "operationId": "SSHKey_DeleteKey", "parameters": [ { "name": "sshKeyId", "in": "query", "description": "Unique identifier of the SSH key to delete", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully deleted SSH key" }, "404": { "description": "SSH key not found or already deleted", "content": { "text/plain": { "schema": { } }, "application/json": { "schema": { } }, "text/json": { "schema": { } } } }, "500": { "description": "Internal server error occurred during deletion", "content": { "text/plain": { "schema": { } }, "application/json": { "schema": { } }, "text/json": { "schema": { } } } } }, "description": "Removes SSH key from organization configuration." } }, "/api/ThruNodes/List": { "get": { "tags": [ "ThruNodes" ], "summary": "Retrieves a list of nodes for a specific organization", "operationId": "ThruNodes_GetList", "parameters": [ { "name": "organizationId", "in": "query", "description": "Unique identifier of the organization", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully retrieved node list", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/vwThruNodeList" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/vwThruNodeList" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/vwThruNodeList" } } } } }, "400": { "description": "Invalid organization identifier provided", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "403": { "description": "User is not authorized to view nodes", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "Internal server error occurred while retrieving nodes", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "description": "Returns list of nodes configured for a specific organization." } }, "/api/ThruNodes/GetSingle": { "get": { "tags": [ "ThruNodes" ], "summary": "Retrieves a specific node by its identifier", "operationId": "ThruNodes_GetSingle", "parameters": [ { "name": "id", "in": "query", "description": "Unique identifier of the node", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully retrieved node details", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ThruNodeListViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ThruNodeListViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ThruNodeListViewModel" } } } }, "400": { "description": "Invalid node identifier provided", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "403": { "description": "User is not authorized to view nodes", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "404": { "description": "Node not found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "Internal server error occurred while retrieving node", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "description": "Returns detailed node configuration including status, key, and heartbeat information." } }, "/api/ThruNodes/getByThruNodeId": { "get": { "tags": [ "ThruNodes" ], "summary": "Retrieves a specific node by its node identifier", "operationId": "ThruNodes_GetByThruNodeId", "parameters": [ { "name": "thruNodeId", "in": "query", "description": "Unique node identifier string", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successfully retrieved node details", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ThruNodeViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ThruNodeViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ThruNodeViewModel" } } } }, "400": { "description": "Invalid node identifier provided", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "403": { "description": "User is not authorized to view nodes", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "404": { "description": "Node not found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "Internal server error occurred while retrieving node", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "description": "Returns node configuration identified by node string identifier." } }, "/api/ThruNodes/Update": { "put": { "tags": [ "ThruNodes" ], "summary": "Updates an existing node configuration", "operationId": "ThruNodes_Update", "requestBody": { "description": "Updated node configuration details", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThruNodeViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ThruNodeViewModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ThruNodeViewModel" } } } }, "responses": { "200": { "description": "Successfully updated node", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/UpdateThruNodeResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateThruNodeResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateThruNodeResponseViewModel" } } } }, "400": { "description": "Invalid node configuration provided", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "403": { "description": "User is not authorized to update nodes", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "Internal server error occurred while updating node", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "description": "Modifies existing node configuration including name, enabled status, and alert settings." } }, "/api/ThruNodes/Create": { "post": { "tags": [ "ThruNodes" ], "summary": "Creates a new node configuration", "operationId": "ThruNodes_Create", "requestBody": { "description": "Node configuration details", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThruNodeViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ThruNodeViewModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ThruNodeViewModel" } } } }, "responses": { "200": { "description": "Successfully created node", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ThruNodeViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ThruNodeViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ThruNodeViewModel" } } } }, "400": { "description": "Invalid node configuration provided", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "403": { "description": "User is not authorized to create nodes", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "Internal server error occurred while creating node", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "description": "Establishes new node with generated authentication key and configuration." } }, "/api/ThruNodes/RegenerateKey": { "post": { "tags": [ "ThruNodes" ], "summary": "Regenerates the authentication key for a node", "operationId": "ThruNodes_RegenerateKey", "requestBody": { "description": "Key regeneration request containing node details", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThruNodeGenerateRequestViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ThruNodeGenerateRequestViewModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ThruNodeGenerateRequestViewModel" } } } }, "responses": { "200": { "description": "Successfully regenerated node key", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/RegenerateKeyResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RegenerateKeyResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RegenerateKeyResponseViewModel" } } } }, "400": { "description": "Invalid regeneration request provided", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "403": { "description": "User is not authorized to regenerate node keys", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "Internal server error occurred while regenerating key", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "description": "Generates new authentication key for node, invalidating previous key." } }, "/api/ThruNodes/Delete": { "delete": { "tags": [ "ThruNodes" ], "summary": "Deletes a node configuration", "operationId": "ThruNodes_Delete", "parameters": [ { "name": "id", "in": "query", "description": "Unique identifier of the node to delete", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully deleted node", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DeleteThruNodeResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DeleteThruNodeResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeleteThruNodeResponseViewModel" } } } }, "400": { "description": "Cannot delete node due to dependencies or invalid request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "User is not authorized to delete nodes", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "Internal server error occurred while deleting node", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "description": "Removes node configuration if no endpoints are currently using it." } }, "/api/ThruNodes/getAssociatedEndpointList": { "get": { "tags": [ "ThruNodes" ], "summary": "Retrieves a list of endpoint identifiers associated with a node", "operationId": "ThruNodes_GetAssociatedEndpointList", "parameters": [ { "name": "thruNodeId", "in": "query", "description": "Unique node identifier string", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successfully retrieved associated endpoint list", "content": { "text/plain": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, "application/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, "text/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } }, "400": { "description": "Invalid node identifier provided", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "403": { "description": "User is not authorized to view node associations", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "Internal server error occurred while retrieving associations", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } } } }, "/api/ThruNodes/Commands": { "get": { "tags": [ "ThruNodes" ], "summary": "Retrieves the install and uninstall commands for a node.\r\nCommands are built using DB-backed templates with all placeholders replaced.", "operationId": "ThruNodes_GetCommands", "parameters": [ { "name": "thruNodeId", "in": "query", "description": "Unique node identifier string (e.g., \"TN123456\")", "schema": { "type": "string" } }, { "name": "platform", "in": "query", "description": "Target platform (\"win-x64\" or \"linux-x64\")", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successfully retrieved commands", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ThruNodeCommandsViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ThruNodeCommandsViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ThruNodeCommandsViewModel" } } } }, "400": { "description": "Invalid parameters provided (e.g., invalid platform)", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "User is not authorized to view node commands", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Node not found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error occurred while building commands", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/Users/authenticate": { "post": { "tags": [ "Users" ], "summary": "Authenticates a user and returns access tokens", "description": "Supports MFA authentication for enhanced security. API Keys are the recommended method for programmatic access.\r\nFor MFA setup, send initial request with username and password only to receive MFA challenge.", "operationId": "Users_Authenticate", "requestBody": { "description": "Login credentials including username, password, and optional MFA code", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoginModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LoginModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/LoginModel" } } } }, "responses": { "200": { "description": "Successfully authenticated and returned access tokens", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AuthenticationResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AuthenticationResponseViewModel" } } } }, "401": { "description": "Invalid credentials, MFA code required, or generic authentication error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "409": { "description": "Invalid MFA code provided", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ThruMfaResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ThruMfaResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ThruMfaResponse" } } } }, "500": { "description": "Internal server error occurred during authentication", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Users/refreshAccessToken": { "post": { "tags": [ "Users" ], "summary": "Refreshes an expired access token for continued access", "operationId": "Users_RefreshAccessToken", "requestBody": { "description": "Refresh token model containing the refresh token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RefreshTokenViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RefreshTokenViewModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RefreshTokenViewModel" } } } }, "responses": { "200": { "description": "Successfully refreshed access token", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AuthenticationResponseViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationResponseViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AuthenticationResponseViewModel" } } } }, "401": { "description": "Invalid or expired refresh token", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } }, "description": "Generates new access token using valid refresh token for continued API access." } }, "/api/Users/ResendMfaCode": { "post": { "tags": [ "Users" ], "summary": "Resends MFA verification code for authentication", "operationId": "Users_ResendMfaCode", "requestBody": { "description": "Resend MFA model containing SID and email for code delivery", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResendMfaCodeModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ResendMfaCodeModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ResendMfaCodeModel" } } } }, "responses": { "200": { "description": "Successfully processed MFA code resend request. Note: Always returns 200 even if SID/email mismatch occurs (failure is logged but not exposed to client)" }, "500": { "description": "Internal server error during MFA code resend", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } }, "description": "Sends new MFA verification code to user's registered email or phone." } } }, "components": { "schemas": { "AccountUserProfileEditorViewModel": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "firstName": { "type": "string", "nullable": true }, "lastName": { "type": "string", "nullable": true }, "username": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "emailAddress": { "type": "string", "nullable": true }, "phone": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ActionTypes": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23 ], "type": "integer", "format": "int32" }, "ActiveAlerts": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "tenantId": { "type": "integer", "format": "int32" }, "referenceId": { "type": "integer", "format": "int64" }, "referenceType": { "type": "string", "nullable": true }, "alertTypeId": { "type": "integer", "format": "int32" }, "alertSeverityId": { "type": "integer", "format": "int32" }, "message": { "type": "string", "nullable": true }, "flowCode": { "type": "string", "nullable": true }, "endpointCode": { "type": "string", "nullable": true }, "organizationCode": { "type": "string", "nullable": true }, "createdDate": { "type": "string", "format": "date-time" }, "acknowledgedDate": { "type": "string", "format": "date-time", "nullable": true }, "acknowledgedBy": { "type": "integer", "format": "int32", "nullable": true }, "clearedDate": { "type": "string", "format": "date-time", "nullable": true }, "clearedBy": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "ActivityFilesListViewModel": { "type": "object", "properties": { "showPurged": { "type": "boolean" }, "viewType": { "type": "string", "nullable": true }, "flowCode": { "type": "string", "nullable": true }, "flowId": { "type": "integer", "format": "int32" }, "organizationCode": { "type": "string", "nullable": true }, "organizationId": { "type": "integer", "format": "int32" }, "endpointCode": { "type": "string", "nullable": true }, "endpointId": { "type": "integer", "format": "int32" }, "flowEndpointCode": { "type": "string", "nullable": true }, "flowEndpointId": { "type": "integer", "format": "int32" }, "filename": { "type": "string", "nullable": true }, "fromDate": { "type": "string", "format": "date-time", "nullable": true }, "toDate": { "type": "string", "format": "date-time", "nullable": true }, "transferStatusId": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "processingStatus": { "type": "array", "items": { "type": "string" }, "nullable": true }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/FileActivitiesListItem" }, "nullable": true }, "paging": { "$ref": "#/components/schemas/PagingModel" } }, "additionalProperties": false }, "ActivityFilterViewModel": { "type": "object", "properties": { "flowId": { "type": "integer", "format": "int32" }, "organizationId": { "type": "integer", "format": "int32" }, "endpointId": { "type": "integer", "format": "int32" }, "flowEndpointId": { "type": "integer", "format": "int32" }, "flowList": { "type": "array", "items": { "$ref": "#/components/schemas/FilterOption" }, "nullable": true }, "organizationList": { "type": "array", "items": { "$ref": "#/components/schemas/FilterOption" }, "nullable": true }, "endpointList": { "type": "array", "items": { "$ref": "#/components/schemas/FilterOption" }, "nullable": true }, "flowEndpointList": { "type": "array", "items": { "$ref": "#/components/schemas/FilterOption" }, "nullable": true } }, "additionalProperties": false }, "ActivityOrganizationEndpoint": { "type": "object", "properties": { "endpointId": { "type": "integer", "format": "int32" }, "endpointCode": { "type": "string", "nullable": true }, "endpointName": { "type": "string", "nullable": true }, "organizationId": { "type": "integer", "format": "int32" }, "organizationCode": { "type": "string", "nullable": true }, "organizationName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AdminSsoMappingRequest": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "customerId": { "type": "integer", "format": "int32" }, "attributeName": { "type": "string", "nullable": true }, "attributeValue": { "type": "string", "nullable": true }, "isDefault": { "type": "boolean" }, "createdBy": { "type": "string", "nullable": true }, "createdDate": { "type": "string", "format": "date-time", "nullable": true }, "updatedBy": { "type": "string", "nullable": true }, "updatedDate": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "deletedDate": { "type": "string", "format": "date-time", "nullable": true }, "organizationIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "roleIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true } }, "additionalProperties": false }, "AdminUserEditorViewModel": { "required": [ "email", "firstName", "isActive", "isEnabled", "isLogSession", "lastName", "username" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "customerId": { "type": "integer", "format": "int32" }, "firstName": { "minLength": 1, "type": "string" }, "lastName": { "minLength": 1, "type": "string" }, "username": { "minLength": 1, "type": "string" }, "password": { "type": "string", "nullable": true }, "email": { "minLength": 1, "type": "string" }, "isEnabled": { "type": "boolean" }, "isActive": { "type": "boolean" }, "isLogSession": { "type": "boolean" }, "organizationIds": { "type": "string", "nullable": true }, "defaultUploadFlowEndpointId": { "type": "integer", "format": "int32", "nullable": true }, "roleIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true } }, "additionalProperties": false }, "AdminUsersLineItemViewModel": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "firstName": { "type": "string", "nullable": true }, "lastName": { "type": "string", "nullable": true }, "username": { "type": "string", "nullable": true }, "isEnabled": { "type": "boolean" }, "isActive": { "type": "boolean" }, "isAdmin": { "type": "boolean" }, "created": { "type": "string", "format": "date-time" }, "email": { "type": "string", "nullable": true }, "customerName": { "type": "string", "nullable": true }, "customerId": { "type": "integer", "format": "int32" }, "failedAttempts": { "type": "integer", "format": "int32" }, "bannedUntil": { "type": "string", "format": "date-time" }, "lastLogin": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "AlertFilterViewModel": { "type": "object", "properties": { "tenantId": { "type": "integer", "format": "int32" }, "alertTypeId": { "type": "integer", "format": "int32" }, "state": { "type": "string", "nullable": true }, "flowCode": { "type": "string", "nullable": true }, "endpointCode": { "type": "string", "nullable": true }, "organizationCode": { "type": "string", "nullable": true }, "fromDate": { "type": "string", "nullable": true }, "toDate": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AlertHistory": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "tenantId": { "type": "integer", "format": "int32" }, "activeAlertId": { "type": "integer", "format": "int64" }, "referenceId": { "type": "integer", "format": "int64" }, "referenceType": { "type": "string", "nullable": true }, "alertTypeId": { "type": "integer", "format": "int32" }, "alertSeverityId": { "type": "integer", "format": "int32" }, "message": { "type": "string", "nullable": true }, "flowCode": { "type": "string", "nullable": true }, "endpointCode": { "type": "string", "nullable": true }, "organizationCode": { "type": "string", "nullable": true }, "createdDate": { "type": "string", "format": "date-time" }, "acknowledgedDate": { "type": "string", "format": "date-time", "nullable": true }, "acknowledgedBy": { "type": "integer", "format": "int32", "nullable": true }, "clearedDate": { "type": "string", "format": "date-time", "nullable": true }, "clearedBy": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "AlertHistoryLineItemViewModel": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "tenantId": { "type": "integer", "format": "int32" }, "activeAlertId": { "type": "integer", "format": "int64" }, "referenceId": { "type": "integer", "format": "int64" }, "referenceType": { "type": "string", "nullable": true }, "alertTypeId": { "type": "integer", "format": "int32" }, "alertType": { "type": "string", "nullable": true }, "alertSeverityId": { "type": "integer", "format": "int32" }, "severityName": { "type": "string", "nullable": true }, "message": { "type": "string", "nullable": true }, "flowCode": { "type": "string", "nullable": true }, "flowName": { "type": "string", "nullable": true }, "flowId": { "type": "integer", "format": "int32", "nullable": true }, "isFlowDeleted": { "type": "boolean" }, "endpointCode": { "type": "string", "nullable": true }, "endpointName": { "type": "string", "nullable": true }, "endpointId": { "type": "integer", "format": "int32", "nullable": true }, "isEndpointDeleted": { "type": "boolean" }, "organizationCode": { "type": "string", "nullable": true }, "organizationName": { "type": "string", "nullable": true }, "organizationId": { "type": "integer", "format": "int32", "nullable": true }, "isOrganizationDeleted": { "type": "boolean" }, "nodeName": { "type": "string", "nullable": true }, "nodeId": { "type": "integer", "format": "int32" }, "thruNodeId": { "type": "string", "nullable": true }, "isNodeDeleted": { "type": "boolean" }, "createdDate": { "type": "string", "nullable": true }, "acknowledgedDate": { "type": "string", "nullable": true }, "acknowledgedBy": { "type": "integer", "format": "int32", "nullable": true }, "clearedDate": { "type": "string", "nullable": true }, "clearedBy": { "type": "integer", "format": "int32", "nullable": true }, "state": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AmazonRegions": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "region": { "type": "string", "nullable": true }, "endpoint": { "type": "string", "nullable": true }, "protocol": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ApiErrorResponse": { "type": "object", "properties": { "message": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ApiKeys": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "enabled": { "type": "boolean" }, "keyName": { "type": "string", "nullable": true }, "tenantId": { "type": "integer", "format": "int32" }, "allowedApis": { "type": "string", "nullable": true }, "allowedOrgs": { "type": "string", "nullable": true }, "expirationDate": { "type": "string", "format": "date-time", "nullable": true }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "nullable": true }, "updatedBy": { "type": "string", "nullable": true }, "updatedDate": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "deletedDate": { "type": "string", "format": "date-time", "nullable": true }, "name": { "type": "string", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "ApplyFlowJobRequest": { "type": "object", "properties": { "flowId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "AuthenticationResponseViewModel": { "type": "object", "properties": { "accessToken": { "type": "string", "nullable": true }, "refreshToken": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BaseResponse": { "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "id": { "type": "string", "nullable": true }, "flowEndpointId": { "type": "integer", "format": "int32" }, "stateId": { "type": "integer", "format": "int32" }, "stateName": { "type": "string", "nullable": true }, "stateMessage": { "type": "string", "nullable": true }, "reportId": { "type": "string", "nullable": true }, "flowCode": { "type": "string", "nullable": true }, "endpointCode": { "type": "string", "nullable": true }, "organizationCode": { "type": "string", "nullable": true }, "dateTime": { "type": "string", "format": "date-time" }, "progress": { "type": "integer", "format": "int32", "nullable": true }, "bytesCompleted": { "type": "integer", "format": "int64" }, "thruNodeId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BillingCountsDailyForMonthViewModel": { "type": "object", "properties": { "entityName": { "type": "string", "nullable": true }, "transferDate": { "type": "string", "format": "date-time" }, "sourceTransfers": { "type": "integer", "format": "int64" }, "targetTransfers": { "type": "integer", "format": "int64" }, "guiDownloads": { "type": "integer", "format": "int64" }, "sourceTransferBytes": { "type": "integer", "format": "int64" }, "targetTransferBytes": { "type": "integer", "format": "int64" }, "storageBytes": { "type": "integer", "format": "int64" }, "peakStorageBytes": { "type": "integer", "format": "int64" }, "compressionCount": { "type": "integer", "format": "int64" }, "decompressionCount": { "type": "integer", "format": "int64" }, "encryptionCount": { "type": "integer", "format": "int64" }, "decryptionCount": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "BillingCountsMTDViewModel": { "type": "object", "properties": { "entityName": { "type": "string", "nullable": true }, "transferDate": { "type": "string", "format": "date-time" }, "sourceTransfers": { "type": "integer", "format": "int64" }, "targetTransfers": { "type": "integer", "format": "int64" }, "guiDownloads": { "type": "integer", "format": "int64" }, "sourceTransferBytes": { "type": "integer", "format": "int64" }, "targetTransferBytes": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "BillingCountsViewModel": { "type": "object", "properties": { "customerId": { "type": "integer", "format": "int32" }, "transferDate": { "type": "string", "format": "date-time" }, "transferHour": { "type": "string", "nullable": true }, "pullCount": { "type": "integer", "format": "int32" }, "pushCount": { "type": "integer", "format": "int32" }, "guiDownloadCount": { "type": "integer", "format": "int32" }, "transferBytes": { "type": "integer", "format": "int64" }, "storageBytes": { "type": "integer", "format": "int64" }, "peakStorageBytes": { "type": "integer", "format": "int64" }, "compressionCount": { "type": "integer", "format": "int32" }, "decompressionCount": { "type": "integer", "format": "int32" }, "encryptionCount": { "type": "integer", "format": "int32" }, "decryptionCount": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "BillingDailyActionItem": { "type": "object", "properties": { "actionType": { "$ref": "#/components/schemas/ActionTypes" }, "flowEndpointType": { "$ref": "#/components/schemas/FlowEndpointTypes" }, "count": { "type": "integer", "format": "int32" }, "isNode": { "type": "boolean" } }, "additionalProperties": false }, "BillingDashboardViewModel": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "flowEndpointId": { "type": "integer", "format": "int32" }, "flowId": { "type": "integer", "format": "int32" }, "organizationId": { "type": "integer", "format": "int32" }, "endpointId": { "type": "integer", "format": "int32" }, "thruNodeId": { "type": "string", "nullable": true }, "flowEndpointType": { "type": "string", "nullable": true }, "protocol": { "type": "string", "nullable": true }, "dayIndex": { "type": "integer", "format": "int32" }, "totalSourceCloudTransferCount": { "type": "integer", "format": "int32" }, "totalTargetCloudTransferCount": { "type": "integer", "format": "int32" }, "totalSourceNodeTransferCount": { "type": "integer", "format": "int32" }, "totalTargetNodeTransferCount": { "type": "integer", "format": "int32" }, "totalNodeCloudUploadCount": { "type": "integer", "format": "int32" }, "totalNodeCloudDownloadCount": { "type": "integer", "format": "int32" }, "totalSourceLanTransferCount": { "type": "integer", "format": "int32" }, "totalTargetLanTransferCount": { "type": "integer", "format": "int32" }, "totalCloudIngressBytes": { "type": "integer", "format": "int64" }, "totalCloudEgressBytes": { "type": "integer", "format": "int64" }, "totalNodeIngressBytes": { "type": "integer", "format": "int64" }, "totalNodeEgressBytes": { "type": "integer", "format": "int64" }, "totalNodeCloudUploadBytes": { "type": "integer", "format": "int64" }, "totalNodeCloudDownloadBytes": { "type": "integer", "format": "int64" }, "totalLanIngressBytes": { "type": "integer", "format": "int64" }, "totalLanEgressBytes": { "type": "integer", "format": "int64" }, "peakSourceActiveCloudFileBytes": { "type": "integer", "format": "int64" }, "peakTargetActiveCloudFileBytes": { "type": "integer", "format": "int64" }, "lastUpdated": { "type": "string", "format": "date-time" }, "lastHourIndex": { "type": "integer", "format": "int32" }, "actionCounts": { "type": "array", "items": { "$ref": "#/components/schemas/BillingDailyActionItem" }, "nullable": true }, "organizationName": { "type": "string", "nullable": true }, "endpointName": { "type": "string", "nullable": true }, "flowName": { "type": "string", "nullable": true }, "flowEndpointName": { "type": "string", "nullable": true }, "thruNodeName": { "type": "string", "nullable": true }, "totalSourceActiveCloudFileBytes": { "type": "integer", "format": "int64" }, "totalTargetActiveCloudFileBytes": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "CertificateEditorViewModel": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "organizationId": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "certificateTypeId": { "type": "integer", "format": "int32" }, "file": { "type": "string", "nullable": true }, "fileName": { "type": "string", "nullable": true }, "certificateData": { "type": "string", "format": "byte", "nullable": true }, "password": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CertificateTypes": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CertificateViewModel": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "organizationId": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "fileName": { "type": "string", "nullable": true }, "certificateTypeId": { "type": "integer", "format": "int32" }, "type": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "createdBy": { "type": "string", "nullable": true }, "createdDate": { "type": "string", "format": "date-time", "nullable": true }, "updatedBy": { "type": "string", "nullable": true }, "updatedDate": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "deletedDate": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "Certificates": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "organizationId": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "fileName": { "type": "string", "nullable": true }, "certificateTypeId": { "type": "integer", "format": "int32" }, "certificateData": { "type": "string", "format": "byte", "nullable": true }, "password": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "createdBy": { "type": "string", "nullable": true }, "createdDate": { "type": "string", "format": "date-time", "nullable": true }, "updatedBy": { "type": "string", "nullable": true }, "updatedDate": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "deletedDate": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "ChangePasswordResponseViewModel": { "type": "object", "properties": { "message": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ChangePasswordViewModel": { "type": "object", "properties": { "userId": { "type": "integer", "format": "int32" }, "currentPassword": { "type": "string", "nullable": true }, "newPassword": { "type": "string", "nullable": true }, "confirmPassword": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CompareChangeItem": { "type": "object", "properties": { "changeArea": { "type": "string", "nullable": true }, "changeType": { "type": "string", "nullable": true }, "oldValue": { "type": "string", "nullable": true }, "newValue": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CompareChangesViewModel": { "type": "object", "properties": { "auditLogId": { "type": "integer", "format": "int32" }, "modifiedDate": { "type": "string", "nullable": true }, "_ctx": { "type": "integer", "format": "int32" }, "status": { "$ref": "#/components/schemas/thruStatus" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/CompareChangeItem" }, "nullable": true } }, "additionalProperties": false }, "CompressionTypeViewModel": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "isEnabled": { "type": "boolean" }, "description": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CustomerFeatureFlags": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "customerId": { "type": "integer", "format": "int32" }, "featureFlagId": { "type": "integer", "format": "int32" }, "isEnabled": { "type": "boolean" } }, "additionalProperties": false }, "CustomerMfaSettings": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "customerId": { "type": "integer", "format": "int32" }, "isEnabled": { "type": "boolean" }, "trustedDeviceTTLMinutes": { "type": "integer", "format": "int64" }, "createdBy": { "type": "string", "nullable": true }, "createdDate": { "type": "string", "format": "date-time" }, "updatedBy": { "type": "string", "nullable": true }, "updatedDate": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "deletedDate": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "CustomerMfaSettingsResponseViewModel": { "type": "object", "properties": { "viewModel": { "$ref": "#/components/schemas/CustomerMfaSettings" }, "recordsAffected": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "CustomerRetentionResponseViewModel": { "type": "object", "properties": { "viewModel": { "$ref": "#/components/schemas/CustomerRetentions" }, "recordsAffected": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "CustomerRetentions": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "customerId": { "type": "integer", "format": "int32" }, "period": { "type": "integer", "format": "int32" }, "periodHardLimit": { "type": "integer", "format": "int32" }, "createdBy": { "type": "string", "nullable": true }, "createdDate": { "type": "string", "format": "date-time" }, "updatedBy": { "type": "string", "nullable": true }, "updatedDate": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "deletedDate": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "CustomerUserViewModel": { "type": "object", "properties": { "email": { "type": "string", "nullable": true }, "id": { "type": "integer", "format": "int32" }, "userId": { "type": "integer", "format": "int32" }, "customerId": { "type": "integer", "format": "int32" }, "tenantId": { "type": "integer", "format": "int32" }, "phoneNumber": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "createdBy": { "type": "string", "nullable": true }, "createdDate": { "type": "string", "format": "date-time" }, "updatedBy": { "type": "string", "nullable": true }, "updatedDate": { "type": "string", "format": "date-time" }, "deletedBy": { "type": "string", "nullable": true }, "deletedDate": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "DeleteFlowEndpointProcessingOptionResponseViewModel": { "type": "object", "properties": { "isDeleted": { "type": "boolean" } }, "additionalProperties": false }, "DeleteFlowEndpointTriggerFilesResponseViewModel": { "type": "object", "properties": { "isDeleted": { "type": "boolean" } }, "additionalProperties": false }, "DeleteResponseViewModel": { "type": "object", "properties": { "recordsAffected": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "DeleteThruNodeResponseViewModel": { "type": "object", "properties": { "isDeleted": { "type": "boolean" } }, "additionalProperties": false }, "EndpointActivityViewModel": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "organizationId": { "type": "integer", "format": "int32" }, "organizationName": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true }, "createdDate": { "type": "string", "format": "date-time" }, "updatedDate": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "EndpointAuthTypes": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true } }, "additionalProperties": false }, "EndpointEditorViewModel": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "organizationId": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true }, "location": { "type": "string", "nullable": true }, "ipAddress": { "type": "string", "nullable": true }, "cidRmask": { "type": "integer", "format": "int32", "nullable": true }, "description": { "type": "string", "nullable": true }, "thruNodeId": { "type": "string", "nullable": true }, "protocolId": { "type": "integer", "format": "int32" }, "endpointTypeId": { "type": "integer", "format": "int32" }, "isEnabled": { "type": "boolean" }, "s3BucketName": { "type": "string", "nullable": true }, "s3AccessKey": { "type": "string", "nullable": true }, "s3SecretKey": { "type": "string", "nullable": true }, "s3RegionTypeId": { "type": "integer", "format": "int32" }, "s3ServiceUrl": { "type": "string", "nullable": true }, "transferSecretKey": { "type": "string", "nullable": true }, "transferInstallationKey": { "type": "string", "nullable": true }, "ftpsClientIPAddress": { "type": "string", "nullable": true }, "ftpsClientHost": { "type": "string", "nullable": true }, "ftpsClientPort": { "type": "integer", "format": "int32" }, "ftpsClientUser": { "type": "string", "nullable": true }, "ftpsClientPassword": { "type": "string", "nullable": true }, "ftpsClientAuthTypeId": { "type": "integer", "format": "int32" }, "ftpsClientCertificateId": { "type": "integer", "format": "int32", "nullable": true }, "sftpClientIPAddress": { "type": "string", "nullable": true }, "sftpClientHost": { "type": "string", "nullable": true }, "sftpClientPort": { "type": "integer", "format": "int32" }, "sftpClientUser": { "type": "string", "nullable": true }, "sftpUserPassword": { "type": "string", "nullable": true }, "sftpClientAuthTypeId": { "type": "integer", "format": "int32" }, "sftpClientSshKeyId": { "type": "integer", "format": "int32", "nullable": true }, "sftpAllowSimultaneousTransfers": { "type": "boolean" }, "aS2RemoteUrl": { "type": "string", "nullable": true }, "aS2RemoteOrgIdentifier": { "type": "string", "nullable": true }, "aS2PublicCertificate": { "type": "string", "nullable": true }, "mailTo": { "type": "string", "nullable": true }, "mailCC": { "type": "string", "nullable": true }, "mailBCC": { "type": "string", "nullable": true }, "mailSubject": { "type": "string", "nullable": true }, "mailMessage": { "type": "string", "nullable": true }, "mailLinkExpirationId": { "type": "integer", "format": "int32" }, "azureAuthTypeId": { "type": "integer", "format": "int32" }, "azureAccessKey": { "type": "string", "nullable": true }, "azureConnectionString": { "type": "string", "nullable": true }, "azureContainerName": { "type": "string", "nullable": true }, "azureContainerUrl": { "type": "string", "nullable": true }, "azureStorageAccountName": { "type": "string", "nullable": true }, "azureSharedAccessToken": { "type": "string", "nullable": true }, "azureBlobClientId": { "type": "string", "nullable": true }, "azureBlobClientSecret": { "type": "string", "nullable": true }, "azureBlobTenantId": { "type": "string", "nullable": true }, "externalIdpTokenEndpoint": { "type": "string", "nullable": true }, "externalIdpClientId": { "type": "string", "nullable": true }, "externalIdpClientSecret": { "type": "string", "nullable": true }, "externalIdpScope": { "type": "string", "nullable": true }, "azureFilesShareName": { "type": "string", "nullable": true }, "azureFilesShareUrl": { "type": "string", "nullable": true }, "httpServerUrl": { "type": "string", "nullable": true }, "httpClientUrl": { "type": "string", "nullable": true }, "lanNetworkSharePath": { "type": "string", "nullable": true }, "lanDomain": { "type": "string", "nullable": true }, "lanUsername": { "type": "string", "nullable": true }, "lanPassword": { "type": "string", "nullable": true }, "sharePointTenantName": { "type": "string", "nullable": true }, "sharePointSiteUrl": { "type": "string", "nullable": true }, "sharePointClientId": { "type": "string", "nullable": true }, "sharePointClientSecret": { "type": "string", "nullable": true }, "sharePointDocumentLibrary": { "type": "string", "nullable": true }, "thruFileShareSiteUrl": { "type": "string", "nullable": true }, "thruFileShareUsername": { "type": "string", "nullable": true }, "thruFileSharePassword": { "type": "string", "nullable": true }, "googleCloudStorageBucketName": { "type": "string", "nullable": true }, "googleCloudStorageServiceAccountKeyJson": { "type": "string", "nullable": true } }, "additionalProperties": false }, "EndpointTypes": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "label": { "type": "string", "nullable": true }, "isEnabled": { "type": "boolean" }, "isServer": { "type": "boolean", "nullable": true }, "isClient": { "type": "boolean", "nullable": true }, "protocolId": { "type": "integer", "format": "int32", "nullable": true }, "description": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ErrorModel": { "type": "object", "properties": { "message": { "type": "string", "nullable": true }, "pathName": { "type": "string", "nullable": true }, "details": { "nullable": true } }, "additionalProperties": false }, "ErrorResponseViewModel": { "type": "object", "properties": { "message": { "type": "string", "nullable": true } }, "additionalProperties": false }, "FileActivitiesListItem": { "type": "object", "properties": { "archivePath": { "type": "string", "nullable": true }, "flowEndpointType": { "type": "string", "nullable": true }, "reportId": { "type": "string", "nullable": true }, "requestId": { "type": "integer", "format": "int64" }, "sourceReportId": { "type": "string", "nullable": true }, "transferType": { "type": "string", "nullable": true }, "transferState": { "type": "string", "nullable": true }, "transferStateMessage": { "type": "string", "nullable": true }, "transferStateDateTime": { "type": "string", "format": "date-time", "nullable": true }, "transferStateDateTimeConvert": { "type": "string", "nullable": true }, "processingType": { "type": "string", "nullable": true }, "processingStateId": { "type": "integer", "format": "int32" }, "processingState": { "type": "string", "nullable": true }, "processingStateMessage": { "type": "string", "nullable": true }, "processingStateDateTime": { "type": "string", "format": "date-time", "nullable": true }, "flowCode": { "type": "string", "nullable": true }, "flowName": { "type": "string", "nullable": true }, "flowDeletedDate": { "type": "string", "format": "date-time", "nullable": true }, "flowId": { "type": "string", "nullable": true }, "flowEndpointName": { "type": "string", "nullable": true }, "flowEndpointDeletedDate": { "type": "string", "format": "date-time", "nullable": true }, "flowEndpointId": { "type": "integer", "format": "int32" }, "endpointCode": { "type": "string", "nullable": true }, "endpointName": { "type": "string", "nullable": true }, "endpointId": { "type": "string", "nullable": true }, "endpointTypeId": { "type": "integer", "format": "int32" }, "endpointTypeLabel": { "type": "string", "nullable": true }, "organizationId": { "type": "string", "nullable": true }, "organizationCode": { "type": "string", "nullable": true }, "organizationName": { "type": "string", "nullable": true }, "organizationDeletedDate": { "type": "string", "format": "date-time", "nullable": true }, "transferStarted": { "type": "string", "format": "date-time", "nullable": true }, "transferComplete": { "type": "string", "format": "date-time", "nullable": true }, "progress": { "type": "integer", "format": "int32" }, "bytesTransferred": { "type": "integer", "format": "int64" }, "protocol": { "type": "string", "nullable": true }, "filename": { "type": "string", "nullable": true }, "originalFilename": { "type": "string", "nullable": true }, "remoteFilePath": { "type": "string", "nullable": true }, "isOverwritten": { "type": "boolean" }, "isDeleted": { "type": "boolean" }, "isRetentionApplied": { "type": "boolean" }, "retentionDate": { "type": "string", "format": "date-time", "nullable": true }, "originalFileSize": { "type": "integer", "format": "int64" }, "fileSize": { "type": "integer", "format": "int64" }, "isArchived": { "type": "boolean" }, "isDeletedFromSource": { "type": "boolean" }, "retryCount": { "type": "integer", "format": "int32" }, "warnings": { "type": "array", "items": { "type": "string" }, "nullable": true }, "existsInCloud": { "type": "boolean" }, "canReplay": { "type": "boolean" }, "thruNodeName": { "type": "string", "nullable": true }, "thruNodeId": { "type": "integer", "format": "int32" }, "thruNodeCode": { "type": "string", "nullable": true }, "uploaderUserId": { "type": "string", "nullable": true }, "uploaderUsername": { "type": "string", "nullable": true }, "uploaderUserType": { "type": "string", "nullable": true } }, "additionalProperties": false }, "FileDownloadHistoryItem": { "type": "object", "properties": { "downloadStartedDateTime": { "type": "string", "format": "date-time", "nullable": true }, "downloadStateId": { "type": "integer", "format": "int32" }, "firstName": { "type": "string", "nullable": true }, "lastName": { "type": "string", "nullable": true }, "lastStateDateTime": { "type": "string", "format": "date-time", "nullable": true }, "userId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "FilterOption": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true }, "deleted": { "type": "string", "nullable": true }, "createdDate": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "FlowApplyJobResultDto": { "type": "object", "properties": { "jobId": { "type": "string", "nullable": true }, "message": { "type": "string", "nullable": true }, "flows": { "type": "array", "items": { "$ref": "#/components/schemas/FlowJobItemDto" }, "nullable": true } }, "additionalProperties": false }, "FlowApplyJobStatusDto": { "type": "object", "properties": { "jobId": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "endpointId": { "type": "integer", "format": "int32", "nullable": true }, "endpointName": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "completedAt": { "type": "string", "format": "date-time", "nullable": true }, "errorMessage": { "type": "string", "nullable": true }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/FlowApplyResultDto" }, "nullable": true } }, "additionalProperties": false }, "FlowApplyResult": { "type": "object", "properties": { "flowId": { "type": "integer", "format": "int32" }, "flowName": { "type": "string", "nullable": true }, "success": { "type": "boolean" }, "message": { "type": "string", "nullable": true } }, "additionalProperties": false }, "FlowApplyResultDto": { "type": "object", "properties": { "flowId": { "type": "integer", "format": "int32" }, "flowName": { "type": "string", "nullable": true }, "success": { "type": "boolean" }, "message": { "type": "string", "nullable": true } }, "additionalProperties": false }, "FlowEditorViewModel": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "flowStatusId": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true }, "isPublished": { "type": "boolean" }, "isIPaaSSubscription": { "type": "boolean" }, "isBroadcast": { "type": "boolean" }, "retentionPolicyId": { "type": "integer", "format": "int32" }, "connectorId": { "type": "integer", "format": "int32" }, "description": { "type": "string", "nullable": true }, "subscriberCount": { "type": "integer", "format": "int32" }, "createdBy": { "type": "string", "nullable": true }, "createdDate": { "type": "string", "format": "date-time", "nullable": true }, "updatedBy": { "type": "string", "nullable": true }, "updatedDate": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "FlowEndpointAlerts": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "flowEndpointId": { "type": "integer", "format": "int32" }, "isEnabled": { "type": "boolean" }, "activityAlertMinutes": { "type": "integer", "format": "int32" }, "queueDepthIsEnabled": { "type": "boolean" }, "queueDepthAlertHours": { "type": "integer", "format": "int32" }, "createdBy": { "type": "string", "nullable": true }, "createdDate": { "type": "string", "format": "date-time", "nullable": true }, "updatedBy": { "type": "string", "nullable": true }, "updatedDate": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "deletedDate": { "type": "string", "format": "date-time", "nullable": true }, "queueDepthAlertCount": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "FlowEndpointAntiVirusOptions": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "flowEndpointId": { "type": "integer", "format": "int32" }, "isEnabled": { "type": "boolean" }, "createdBy": { "type": "string", "nullable": true }, "createdDate": { "type": "string", "format": "date-time", "nullable": true }, "updatedBy": { "type": "string", "nullable": true }, "updatedDate": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "deletedDate": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "FlowEndpointCompressionOptions": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "flowEndpointId": { "type": "integer", "format": "int32" }, "compressionTypeId": { "type": "integer", "format": "int32" }, "compressionPassword": { "type": "string", "nullable": true }, "compressBatch": { "type": "boolean" }, "createdBy": { "type": "string", "nullable": true }, "createdDate": { "type": "string", "format": "date-time", "nullable": true }, "updatedBy": { "type": "string", "nullable": true }, "updatedDate": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "deletedDate": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "FlowEndpointConfigurationTemp": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "flowEndpointId": { "type": "integer", "format": "int32" }, "isEnabled": { "type": "boolean" }, "isOverwriteExistingFiles": { "type": "boolean" }, "isDeleteDeliveredFiles": { "type": "boolean" }, "isCustomerArchive": { "type": "boolean" }, "alertHour": { "type": "integer", "format": "int32" }, "isSubfolders": { "type": "boolean" }, "flowEndpointName": { "type": "string", "nullable": true }, "serverPath": { "type": "string", "nullable": true }, "thruPath": { "type": "string", "nullable": true }, "filenameFilters": { "type": "string", "nullable": true }, "excludeFilenameFilters": { "type": "string", "nullable": true }, "bucketName": { "type": "string", "nullable": true }, "sourceServerArchivePath": { "type": "string", "nullable": true }, "archiveSourceEndpointCode": { "type": "string", "nullable": true }, "note": { "type": "string", "nullable": true }, "createdBy": { "type": "string", "nullable": true }, "createdDate": { "type": "string", "format": "date-time", "nullable": true }, "updatedBy": { "type": "string", "nullable": true }, "updatedDate": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "deletedDate": { "type": "string", "format": "date-time", "nullable": true }, "dateFilters": { "type": "string", "nullable": true }, "associatedThruNodeId": { "type": "string", "nullable": true }, "numConcurrentFiles": { "type": "integer", "format": "int32" }, "nodeRootPath": { "type": "string", "nullable": true }, "serverPathList": { "type": "array", "items": { "$ref": "#/components/schemas/FlowEndpointServerPaths" }, "nullable": true } }, "additionalProperties": false }, "FlowEndpointContinuousSchedules": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "flowEndpointId": { "type": "integer", "format": "int32" }, "period": { "type": "string", "nullable": true }, "units": { "type": "integer", "format": "int32" }, "createdBy": { "type": "string", "nullable": true }, "createdDate": { "type": "string", "format": "date-time", "nullable": true }, "updatedBy": { "type": "string", "nullable": true }, "updatedDate": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "deletedDate": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "FlowEndpointDailySchedules": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "flowEndpointId": { "type": "integer", "format": "int32" }, "isSunday": { "type": "boolean" }, "isMonday": { "type": "boolean" }, "isTuesday": { "type": "boolean" }, "isWednesday": { "type": "boolean" }, "isThursday": { "type": "boolean" }, "isFriday": { "type": "boolean" }, "isSaturday": { "type": "boolean" }, "period": { "type": "string", "nullable": true }, "units": { "type": "integer", "format": "int32" }, "startTime": { "type": "string", "format": "date-time", "nullable": true }, "endDate": { "type": "string", "format": "date-time", "nullable": true }, "endTime": { "type": "string", "format": "date-time", "nullable": true }, "createdBy": { "type": "string", "nullable": true }, "createdDate": { "type": "string", "format": "date-time", "nullable": true }, "updatedBy": { "type": "string", "nullable": true }, "updatedDate": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "deletedDate": { "type": "string", "format": "date-time", "nullable": true }, "startDate": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "FlowEndpointEmailNotifications": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "flowEndpointId": { "type": "integer", "format": "int32" }, "email": { "type": "string", "nullable": true }, "notifyQueueDepth": { "type": "boolean" }, "notifyInactivity": { "type": "boolean" }, "notifyError": { "type": "boolean" }, "notifyTranferComplete": { "type": "boolean" }, "notifyQuarantined": { "type": "boolean" }, "createdBy": { "type": "string", "nullable": true }, "createdDate": { "type": "string", "format": "date-time", "nullable": true }, "updatedBy": { "type": "string", "nullable": true }, "updatedDate": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "deletedDate": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "FlowEndpointEncryptionOptions": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "flowEndpointId": { "type": "integer", "format": "int32" }, "pgpKeyId": { "type": "integer", "format": "int32" }, "createdBy": { "type": "string", "nullable": true }, "createdDate": { "type": "string", "format": "date-time", "nullable": true }, "updatedBy": { "type": "string", "nullable": true }, "updatedDate": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "deletedDate": { "type": "string", "format": "date-time", "nullable": true }, "isVerify": { "type": "boolean" }, "verifyPgpKeyId": { "type": "integer", "format": "int32", "nullable": true }, "isSign": { "type": "boolean" }, "signPgpKeyId": { "type": "integer", "format": "int32", "nullable": true }, "isAsciiArmor": { "type": "boolean" } }, "additionalProperties": false }, "FlowEndpointMonthlySchedules": { "type": "object", "properties": { "period": { "type": "string", "nullable": true }, "units": { "type": "integer", "format": "int32" }, "id": { "type": "integer", "format": "int32" }, "flowEndpointId": { "type": "integer", "format": "int32" }, "repeatDay": { "type": "integer", "format": "int32" }, "startDate": { "type": "string", "format": "date-time", "nullable": true }, "startTime": { "type": "string", "format": "date-time", "nullable": true }, "endDate": { "type": "string", "format": "date-time", "nullable": true }, "endTime": { "type": "string", "format": "date-time", "nullable": true }, "createdBy": { "type": "string", "nullable": true }, "createdDate": { "type": "string", "format": "date-time", "nullable": true }, "updatedBy": { "type": "string", "nullable": true }, "updatedDate": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "deletedDate": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "FlowEndpointOnArrivalSchedules": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "flowEndpointId": { "type": "integer", "format": "int32" }, "attempts": { "type": "integer", "format": "int32" }, "createdBy": { "type": "string", "nullable": true }, "createdDate": { "type": "string", "format": "date-time", "nullable": true }, "updatedBy": { "type": "string", "nullable": true }, "updatedDate": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "deletedDate": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "FlowEndpointProcessingOptionTemp": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "flowEndpointId": { "type": "integer", "format": "int32" }, "isEncryption": { "type": "boolean" }, "isDecryption": { "type": "boolean" }, "isCompression": { "type": "boolean" }, "isDecompression": { "type": "boolean" }, "isNotifications": { "type": "boolean" }, "isTransferIfFileSizeChanged": { "type": "boolean" }, "isTransferIfCreateDateNewer": { "type": "boolean" }, "isTransferIfModifiedDateNewer": { "type": "boolean" }, "isTransferAllBatches": { "type": "boolean" }, "isTransferLatestBatchOnly": { "type": "boolean" }, "errorActionId": { "type": "integer", "format": "int32" }, "createdBy": { "type": "string", "nullable": true }, "createdDate": { "type": "string", "format": "date-time", "nullable": true }, "updatedBy": { "type": "string", "nullable": true }, "updatedDate": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "deletedDate": { "type": "string", "format": "date-time", "nullable": true }, "pgpKeyId": { "type": "integer", "format": "int32" }, "compressionTypeId": { "type": "integer", "format": "int32" }, "compressionPassword": { "type": "string", "nullable": true }, "compressBatch": { "type": "boolean" }, "isVerify": { "type": "boolean" }, "verifyPgpKeyId": { "type": "integer", "format": "int32", "nullable": true }, "isSign": { "type": "boolean" }, "signPgpKeyId": { "type": "integer", "format": "int32", "nullable": true }, "isAsciiArmor": { "type": "boolean" }, "isEncryptionOrDecryption": { "type": "boolean", "readOnly": true }, "isCompressionOrDecompression": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "FlowEndpointRenameOptionTemp": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "flowEndpointId": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "filter": { "type": "string", "nullable": true }, "regexString": { "type": "string", "nullable": true }, "testString": { "type": "string", "nullable": true }, "jsonString": { "type": "string", "nullable": true }, "createdBy": { "type": "string", "nullable": true }, "createdDate": { "type": "string", "format": "date-time", "nullable": true }, "updatedBy": { "type": "string", "nullable": true }, "updatedDate": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "deletedDate": { "type": "string", "format": "date-time", "nullable": true }, "assignedPathIdList": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true } }, "additionalProperties": false }, "FlowEndpointSchedule": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "flowEndpointId": { "type": "integer", "format": "int32" }, "flowScheduleTypeId": { "type": "integer", "format": "int32" }, "createdBy": { "type": "string", "nullable": true }, "createdDate": { "type": "string", "format": "date-time", "nullable": true }, "updatedBy": { "type": "string", "nullable": true }, "updatedDate": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "deletedDate": { "type": "string", "format": "date-time", "nullable": true }, "flowEndpointOnArrivalSchedule": { "$ref": "#/components/schemas/FlowEndpointOnArrivalSchedules" }, "flowEndpointContinuousSchedule": { "$ref": "#/components/schemas/FlowEndpointContinuousSchedules" }, "flowEndpointDailySchedule": { "$ref": "#/components/schemas/FlowEndpointDailySchedules" }, "flowEndpointWeeklySchedule": { "$ref": "#/components/schemas/FlowEndpointWeeklySchedules" }, "flowEndpointMonthlySchedule": { "$ref": "#/components/schemas/FlowEndpointMonthlySchedules" } }, "additionalProperties": false }, "FlowEndpointServerPathMappings": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "flowEndpointId": { "type": "integer", "format": "int32" }, "sourceFlowEndpointId": { "type": "integer", "format": "int32" }, "sourceServerPathId": { "type": "integer", "format": "int32" }, "targetServerPathId": { "type": "integer", "format": "int32" }, "isIncludeSubfolders": { "type": "boolean" }, "createdBy": { "type": "string", "nullable": true }, "createdDate": { "type": "string", "format": "date-time" }, "updatedBy": { "type": "string", "nullable": true }, "updatedDate": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "deletedDate": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "FlowEndpointServerPaths": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "flowEndpointId": { "type": "integer", "format": "int32" }, "path": { "type": "string", "nullable": true }, "createdBy": { "type": "string", "nullable": true }, "createdDate": { "type": "string", "format": "date-time", "nullable": true }, "updatedBy": { "type": "string", "nullable": true }, "updatedDate": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "deletedDate": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "FlowEndpointServerUsers": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "flowEndpointId": { "type": "integer", "format": "int32" }, "isEnabled": { "type": "boolean" }, "username": { "type": "string", "nullable": true }, "authTypeId": { "type": "integer", "format": "int32", "nullable": true }, "userPassword": { "type": "string", "nullable": true }, "certificateId": { "type": "integer", "format": "int32", "nullable": true }, "sshKeyId": { "type": "integer", "format": "int32", "nullable": true }, "description": { "type": "string", "nullable": true }, "createdBy": { "type": "string", "nullable": true }, "createdDate": { "type": "string", "format": "date-time", "nullable": true }, "updatedBy": { "type": "string", "nullable": true }, "updatedDate": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "deletedDate": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "FlowEndpointTriggers": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "flowEndpointId": { "type": "integer", "format": "int32" }, "isEnabled": { "type": "boolean" }, "isTriggerSemaphoreFile": { "type": "boolean" }, "isTriggerTemporaryFilename": { "type": "boolean" }, "isTriggerBatchSemaphore": { "type": "boolean" }, "isAddExtension": { "type": "boolean" }, "isReplaceExtension": { "type": "boolean" }, "isTemporaryPrefix": { "type": "boolean" }, "isTemporaryExtension": { "type": "boolean" }, "createdBy": { "type": "string", "nullable": true }, "createdDate": { "type": "string", "format": "date-time", "nullable": true }, "updatedBy": { "type": "string", "nullable": true }, "updatedDate": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "deletedDate": { "type": "string", "format": "date-time", "nullable": true }, "filePrefix": { "type": "string", "nullable": true }, "fileExtension": { "type": "string", "nullable": true }, "batchSemaphoreFilename": { "type": "string", "nullable": true } }, "additionalProperties": false }, "FlowEndpointTypes": { "enum": [ 0, 1, 2 ], "type": "integer", "format": "int32" }, "FlowEndpointWeeklySchedules": { "type": "object", "properties": { "period": { "type": "string", "nullable": true }, "units": { "type": "integer", "format": "int32" }, "id": { "type": "integer", "format": "int32" }, "flowEndpointId": { "type": "integer", "format": "int32" }, "repeatDay": { "type": "integer", "format": "int32" }, "startDate": { "type": "string", "format": "date-time", "nullable": true }, "startTime": { "type": "string", "format": "date-time", "nullable": true }, "endDate": { "type": "string", "format": "date-time", "nullable": true }, "endTime": { "type": "string", "format": "date-time", "nullable": true }, "createdBy": { "type": "string", "nullable": true }, "createdDate": { "type": "string", "format": "date-time", "nullable": true }, "updatedBy": { "type": "string", "nullable": true }, "updatedDate": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "deletedDate": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "FlowEndpoints": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "flowId": { "type": "integer", "format": "int32" }, "flowEndpointTypeId": { "type": "integer", "format": "int32" }, "endpointId": { "type": "integer", "format": "int32" }, "createdBy": { "type": "string", "nullable": true }, "createdDate": { "type": "string", "format": "date-time", "nullable": true }, "updatedBy": { "type": "string", "nullable": true }, "updatedDate": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "deletedDate": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "FlowHistoryLineItemViewModel": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "area": { "type": "string", "nullable": true }, "modifiedDate": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "string", "nullable": true } }, "additionalProperties": false }, "FlowJobItemDto": { "type": "object", "properties": { "flowId": { "type": "integer", "format": "int32" }, "flowName": { "type": "string", "nullable": true }, "flowCode": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true } }, "additionalProperties": false }, "FlowRollbackResponseViewModel": { "type": "object", "properties": { "isRolledBack": { "type": "boolean" }, "message": { "type": "string", "nullable": true } }, "additionalProperties": false }, "FlowSubscriberViewModel": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "flowId": { "type": "integer", "format": "int32" }, "organizationId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "FlowUpdate": { "type": "object", "properties": { "flowId": { "type": "integer", "format": "int32" }, "enabled": { "type": "boolean" } }, "additionalProperties": false }, "Flows": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "tenantId": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "flowStatusId": { "type": "integer", "format": "int32" }, "isBroadcast": { "type": "boolean" }, "isPublished": { "type": "boolean" }, "isIPaaSSubscription": { "type": "boolean" }, "connectorId": { "type": "integer", "format": "int32" }, "code": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "createdBy": { "type": "string", "nullable": true }, "createdDate": { "type": "string", "format": "date-time", "nullable": true }, "updatedBy": { "type": "string", "nullable": true }, "updatedDate": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "deletedDate": { "type": "string", "format": "date-time", "nullable": true }, "contactId": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "ForgotUserModel": { "type": "object", "properties": { "username": { "type": "string", "nullable": true }, "emailAddress": { "type": "string", "nullable": true } }, "additionalProperties": false }, "JobCreationResponseViewModel": { "type": "object", "properties": { "reportId": { "type": "integer", "format": "int64" }, "message": { "type": "string", "nullable": true } }, "additionalProperties": false }, "LoginModel": { "required": [ "password", "userName" ], "type": "object", "properties": { "userName": { "minLength": 1, "type": "string" }, "password": { "minLength": 1, "type": "string" }, "oneTimePasscode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ObjectId": { "type": "object", "properties": { "timestamp": { "type": "integer", "format": "int32", "readOnly": true }, "creationTime": { "type": "string", "format": "date-time", "readOnly": true } }, "additionalProperties": false }, "OrganizationActivityViewModel": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "systemCode": { "type": "string", "nullable": true }, "createdDate": { "type": "string", "format": "date-time" }, "updatedDate": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "OrganizationViewModel": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "tenantId": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "organizationStatusId": { "type": "integer", "format": "int32" }, "publicCode": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "tags": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Organizations": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "tenantId": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "organizationTypeId": { "type": "integer", "format": "int32" }, "organizationStatusId": { "type": "integer", "format": "int32" }, "publicCode": { "type": "string", "nullable": true }, "systemCode": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "secretKey": { "type": "string", "nullable": true }, "createdBy": { "type": "string", "nullable": true }, "createdDate": { "type": "string", "format": "date-time", "nullable": true }, "updatedBy": { "type": "string", "nullable": true }, "updatedDate": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "deletedDate": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "PGPKeys": { "type": "object", "properties": { "username": { "type": "string", "nullable": true }, "id": { "type": "integer", "format": "int32" }, "organizationId": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "publicKeyText": { "type": "string", "nullable": true }, "privateKeyText": { "type": "string", "nullable": true }, "algorithmId": { "type": "integer", "format": "int32", "nullable": true }, "keyStrengthId": { "type": "integer", "format": "int32", "nullable": true }, "compressionId": { "type": "integer", "format": "int32", "nullable": true }, "passPhrase": { "type": "string", "nullable": true }, "expirationDate": { "type": "string", "format": "date-time", "nullable": true }, "isASCIIArmor": { "type": "boolean", "nullable": true }, "description": { "type": "string", "nullable": true }, "createdBy": { "type": "string", "nullable": true }, "createdDate": { "type": "string", "format": "date-time", "nullable": true }, "updatedBy": { "type": "string", "nullable": true }, "updatedDate": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "deletedDate": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "PagingModel": { "type": "object", "properties": { "pageNumber": { "type": "integer", "format": "int32" }, "totalCount": { "type": "integer", "format": "int64" }, "pageSize": { "type": "integer", "format": "int32" }, "skip": { "type": "integer", "format": "int32" }, "orderBy": { "type": "string", "nullable": true }, "orderDirection": { "type": "string", "nullable": true }, "lastReportId": { "type": "string", "nullable": true }, "lastSortValue": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PasswordErrorResponseViewModel": { "type": "object", "properties": { "message": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PasswordModel": { "type": "object", "properties": { "key": { "type": "string", "format": "uuid" }, "mfaEnabled": { "type": "boolean" }, "username": { "type": "string", "nullable": true }, "password": { "type": "string", "nullable": true }, "confirmPassword": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Permission": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "description": { "type": "string", "nullable": true }, "isHidden": { "type": "boolean" }, "deletedDate": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "PgpAlgorithmOption": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PgpKeyStrengthOption": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "bitStrength": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PgpKeyViewModel": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "organizationId": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "publicKeyText": { "type": "string", "nullable": true }, "algorithmId": { "type": "integer", "format": "int32", "nullable": true }, "keyStrengthId": { "type": "integer", "format": "int32", "nullable": true }, "username": { "type": "string", "nullable": true }, "expirationDate": { "type": "string", "format": "date-time", "nullable": true }, "isASCIIArmor": { "type": "boolean", "nullable": true }, "description": { "type": "string", "nullable": true }, "createdBy": { "type": "string", "nullable": true }, "createdDate": { "type": "string", "format": "date-time", "nullable": true }, "updatedBy": { "type": "string", "nullable": true }, "updatedDate": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "deletedDate": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "PgpOptionsViewModel": { "type": "object", "properties": { "algorithmTypesList": { "type": "array", "items": { "$ref": "#/components/schemas/PgpAlgorithmOption" }, "nullable": true }, "keyStrengthTypesList": { "type": "array", "items": { "$ref": "#/components/schemas/PgpKeyStrengthOption" }, "nullable": true } }, "additionalProperties": false }, "ProblemDetails": { "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "status": { "type": "integer", "format": "int32", "nullable": true }, "detail": { "type": "string", "nullable": true }, "instance": { "type": "string", "nullable": true } }, "additionalProperties": { } }, "ProtocolTypeViewItem": { "type": "object", "properties": { "protocolId": { "type": "integer", "format": "int32" }, "endpointTypesList": { "type": "array", "items": { "$ref": "#/components/schemas/EndpointTypes" }, "nullable": true } }, "additionalProperties": false }, "ProtocolWithOptionsViewModel": { "type": "object", "properties": { "protocol": { "$ref": "#/components/schemas/vwProtocolsList" }, "protocolOptions": { "$ref": "#/components/schemas/ProtocolTypeViewItem" } }, "additionalProperties": false }, "Protocols": { "enum": [ 0, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17 ], "type": "integer", "format": "int32" }, "RefreshTokenViewModel": { "type": "object", "properties": { "refreshToken": { "type": "string", "nullable": true } }, "additionalProperties": false }, "RegenerateKeyResponseViewModel": { "type": "object", "properties": { "thruNodeKey": { "type": "string", "nullable": true }, "keyCreationDateTimeUtc": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "Reports": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "tenantId": { "type": "integer", "format": "int32" }, "contentType": { "type": "string", "nullable": true }, "reportRequestedBy": { "type": "string", "nullable": true }, "reportRequestedDate": { "type": "string", "format": "date-time" }, "status": { "type": "string", "nullable": true }, "scheduledRetention": { "type": "string", "format": "date-time", "nullable": true }, "dateRetentioned": { "type": "string", "format": "date-time", "nullable": true }, "assignedTo": { "type": "string", "nullable": true }, "lastHeartbeat": { "type": "string", "format": "date-time", "nullable": true }, "errorMessage": { "type": "string", "nullable": true }, "reportProcessedDate": { "type": "string", "format": "date-time", "nullable": true }, "filePath": { "type": "string", "nullable": true }, "filters": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ResendFileResult": { "type": "object", "properties": { "reportId": { "type": "string", "nullable": true }, "success": { "type": "boolean" }, "errorMessage": { "type": "string", "nullable": true }, "fileName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ResendMfaCodeModel": { "required": [ "sid" ], "type": "object", "properties": { "sid": { "minLength": 1, "type": "string" }, "email": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ResendTargetFilesResult": { "type": "object", "properties": { "totalFiles": { "type": "integer", "format": "int32" }, "successfulResends": { "type": "integer", "format": "int32" }, "failedResends": { "type": "integer", "format": "int32" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/ResendFileResult" }, "nullable": true } }, "additionalProperties": false }, "RunFlowEndpointRequest": { "type": "object", "properties": { "flowEndpointId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "SSHKeys": { "type": "object", "properties": { "username": { "type": "string", "nullable": true }, "id": { "type": "integer", "format": "int32" }, "organizationId": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "publicKeyText": { "type": "string", "nullable": true }, "privateKeyText": { "type": "string", "nullable": true }, "algorithmId": { "type": "integer", "format": "int32", "nullable": true }, "keyStrengthId": { "type": "integer", "format": "int32", "nullable": true }, "passPhrase": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "createdBy": { "type": "string", "nullable": true }, "createdDate": { "type": "string", "format": "date-time", "nullable": true }, "updatedBy": { "type": "string", "nullable": true }, "updatedDate": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "deletedDate": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "SamlSiteSettingsResponseViewModel": { "type": "object", "properties": { "samlLoginIsEnabled": { "type": "boolean" } }, "additionalProperties": false }, "SaveUserRoleRequest": { "type": "object", "properties": { "userId": { "type": "integer", "format": "int32" }, "userRoleSelectionList": { "type": "array", "items": { "$ref": "#/components/schemas/UserRoleSelection" }, "nullable": true } }, "additionalProperties": false }, "SearchResultItemViewModel": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "property": { "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true }, "flowId": { "type": "integer", "format": "int32", "nullable": true }, "organizationId": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "ServiceResult": { "type": "object", "properties": { "status": { "$ref": "#/components/schemas/thruStatus" }, "data": { "nullable": true } }, "additionalProperties": false }, "Severity": { "enum": [ 0, 1, 2, 3, 4, -1 ], "type": "integer", "format": "int32" }, "SshKeyViewModel": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "username": { "type": "string", "nullable": true }, "organizationId": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "publicKeyText": { "type": "string", "nullable": true }, "hasPrivateKey": { "type": "boolean" }, "algorithmId": { "type": "integer", "format": "int32", "nullable": true }, "keyStrengthId": { "type": "integer", "format": "int32", "nullable": true }, "description": { "type": "string", "nullable": true }, "createdBy": { "type": "string", "nullable": true }, "createdDate": { "type": "string", "format": "date-time", "nullable": true }, "updatedBy": { "type": "string", "nullable": true }, "updatedDate": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "deletedDate": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "Subscribers": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "flowId": { "type": "integer", "format": "int32" }, "organizationId": { "type": "integer", "format": "int32" }, "isEnabled": { "type": "boolean" }, "createdBy": { "type": "string", "nullable": true }, "createdDate": { "type": "string", "format": "date-time", "nullable": true }, "updatedBy": { "type": "string", "nullable": true }, "updatedDate": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "deletedDate": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "ThruMfaResponse": { "type": "object", "properties": { "category": { "type": "string", "nullable": true }, "message": { "type": "string", "nullable": true }, "channel": { "type": "string", "nullable": true }, "to": { "type": "string", "nullable": true }, "sid": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ThruNodeCommandsViewModel": { "type": "object", "properties": { "installCommand": { "type": "string", "nullable": true }, "uninstallCommand": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ThruNodeGenerateRequestViewModel": { "type": "object", "properties": { "thruNodeId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ThruNodeListViewModel": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "thruNodeId": { "type": "string", "nullable": true }, "organizationId": { "type": "integer", "format": "int32" }, "organizationName": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "isEnabled": { "type": "boolean" }, "tenantId": { "type": "integer", "format": "int32" }, "lastActiveTime": { "type": "string", "format": "date-time", "nullable": true }, "thruNodeKey": { "type": "string", "nullable": true }, "keyCreationDateTimeUtc": { "type": "string", "format": "date-time", "nullable": true }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "nullable": true }, "updatedBy": { "type": "string", "nullable": true }, "updatedDate": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "deletedDate": { "type": "string", "format": "date-time", "nullable": true }, "description": { "type": "string", "nullable": true }, "isAlertsEnabled": { "type": "boolean" }, "lastHeartbeatTimeUTC": { "type": "string", "format": "date-time", "nullable": true }, "lanIpAddress": { "type": "string", "nullable": true }, "hostname": { "type": "string", "nullable": true }, "version": { "type": "string", "nullable": true }, "alertEmails": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "ThruNodeViewModel": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "thruNodeId": { "type": "string", "nullable": true }, "organizationId": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "isEnabled": { "type": "boolean" }, "lastActiveTime": { "type": "string", "format": "date-time", "nullable": true }, "thruNodeKey": { "type": "string", "nullable": true }, "keyCreationDateTimeUtc": { "type": "string", "format": "date-time", "nullable": true }, "isAlertsEnabled": { "type": "boolean" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "nullable": true }, "updatedBy": { "type": "string", "nullable": true }, "updatedDate": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "deletedDate": { "type": "string", "format": "date-time", "nullable": true }, "description": { "type": "string", "nullable": true }, "alertEmails": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "TransferHistoryFilterViewModel": { "type": "object", "properties": { "fileId": { "type": "string", "nullable": true }, "flowEndpointId": { "type": "integer", "format": "int32", "nullable": true }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "startDateTimeUtc": { "type": "string", "format": "date-time", "nullable": true }, "endDateTimeUtc": { "type": "string", "format": "date-time", "nullable": true }, "includeTransferErrors": { "type": "boolean" } }, "additionalProperties": false }, "TransferHistoryItemViewModel": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "userId": { "type": "integer", "format": "int32", "nullable": true }, "actionId": { "type": "string", "nullable": true }, "fileId": { "type": "string", "nullable": true }, "fileType": { "type": "string", "nullable": true }, "fileName": { "type": "string", "nullable": true }, "originalFileName": { "type": "string", "nullable": true }, "remoteStoragePath": { "type": "string", "nullable": true }, "fileSize": { "type": "integer", "format": "int64" }, "originalFileSize": { "type": "integer", "format": "int64" }, "protocol": { "type": "string", "nullable": true }, "fileTime": { "type": "string", "nullable": true }, "flowEndpointType": { "type": "string", "nullable": true }, "flowEndpointId": { "type": "integer", "format": "int32" }, "actionType": { "type": "string", "nullable": true }, "actionState": { "type": "string", "nullable": true }, "actionStateMessage": { "type": "string", "nullable": true }, "dateTime": { "type": "string", "format": "date-time" }, "dateIndex": { "type": "integer", "format": "int32" }, "thruNodeId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "TransferHistoryReturnViewModel": { "type": "object", "properties": { "fileId": { "type": "string", "nullable": true }, "flowEndpointId": { "type": "integer", "format": "int32", "nullable": true }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "startDateTimeUtc": { "type": "string", "format": "date-time", "nullable": true }, "endDateTimeUtc": { "type": "string", "format": "date-time", "nullable": true }, "includeTransferErrors": { "type": "boolean" }, "total": { "type": "integer", "format": "int64" }, "transferHistoryList": { "type": "array", "items": { "$ref": "#/components/schemas/TransferHistoryItemViewModel" }, "nullable": true } }, "additionalProperties": false }, "UpdateThruNodeResponseViewModel": { "type": "object", "properties": { "isUpdated": { "type": "boolean" } }, "additionalProperties": false }, "UpdateUserProfileResponseViewModel": { "type": "object", "properties": { "customerUser": { "$ref": "#/components/schemas/CustomerUserViewModel" }, "recordsAffected": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "UserInRole": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "userId": { "type": "integer", "format": "int32" }, "roleId": { "type": "integer", "format": "int32" }, "createdBy": { "type": "string", "nullable": true }, "createdDate": { "type": "string", "format": "date-time" }, "updatedBy": { "type": "string", "nullable": true }, "updatedDate": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "deletedDate": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "UserRole": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "userRoleCode": { "type": "string", "nullable": true }, "userRoleDescription": { "type": "string", "nullable": true }, "isHidden": { "type": "boolean" }, "deletedDate": { "type": "string", "format": "date-time", "nullable": true }, "customerId": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "UserRoleSelection": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "userRoleCode": { "type": "string", "nullable": true }, "userRoleDescription": { "type": "string", "nullable": true }, "isSelected": { "type": "boolean" } }, "additionalProperties": false }, "UserRoleViewModel": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "userRoleCode": { "type": "string", "nullable": true }, "userRoleDescription": { "type": "string", "nullable": true }, "isHidden": { "type": "boolean" }, "deletedDate": { "type": "string", "format": "date-time", "nullable": true }, "permissions": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "customerId": { "type": "integer", "format": "int32", "nullable": true }, "isSystemRole": { "type": "boolean" }, "rank": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "UserSessionViewModel": { "type": "object", "properties": { "isTimedout": { "type": "boolean", "nullable": true }, "isLogout": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "ValidationProblemDetails": { "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "status": { "type": "integer", "format": "int32", "nullable": true }, "detail": { "type": "string", "nullable": true }, "instance": { "type": "string", "nullable": true }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true } }, "additionalProperties": { } }, "WebVitalsModel": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "value": { "type": "number", "format": "double" }, "rating": { "type": "string", "nullable": true }, "delta": { "type": "number", "format": "double" }, "entries": { "type": "string", "nullable": true }, "navigationType": { "type": "string", "nullable": true } }, "additionalProperties": false }, "thruStatus": { "type": "object", "properties": { "status": { "type": "integer", "format": "int32" }, "severity": { "$ref": "#/components/schemas/Severity" }, "module": { "type": "string", "nullable": true }, "method": { "type": "string", "nullable": true }, "message": { "type": "string", "nullable": true } }, "additionalProperties": false }, "vwEndpointsList": { "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "id": { "type": "integer", "format": "int32" }, "organizationId": { "type": "integer", "format": "int32" }, "endpointTypeId": { "type": "integer", "format": "int32" }, "endpointStatusId": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "thruNodeId": { "type": "string", "nullable": true }, "createdBy": { "type": "string", "nullable": true }, "createdDate": { "type": "string", "format": "date-time", "nullable": true }, "updatedBy": { "type": "string", "nullable": true }, "updatedDate": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "deletedDate": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "vwFlowSubscribersList": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "isEnabled": { "type": "boolean" }, "flowId": { "type": "integer", "format": "int32" }, "flowName": { "type": "string", "nullable": true }, "tenantId": { "type": "integer", "format": "int32" }, "organizationId": { "type": "integer", "format": "int32" }, "organizationName": { "type": "string", "nullable": true }, "organizationStatusId": { "type": "integer", "format": "int32" }, "publicCode": { "type": "string", "nullable": true }, "subscriberCount": { "type": "integer", "format": "int32", "nullable": true }, "createdBy": { "type": "string", "nullable": true }, "createdDate": { "type": "string", "format": "date-time", "nullable": true }, "updatedBy": { "type": "string", "nullable": true }, "updatedDate": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "deletedDate": { "type": "string", "format": "date-time", "nullable": true }, "description": { "type": "string", "nullable": true }, "flowStatus": { "type": "string", "nullable": true }, "orgStatus": { "type": "string", "nullable": true } }, "additionalProperties": false }, "vwOrganizationSubscriptionsList": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "isEnabled": { "type": "boolean" }, "tenantId": { "type": "integer", "format": "int32" }, "organizationId": { "type": "integer", "format": "int32" }, "organizationName": { "type": "string", "nullable": true }, "organizationStatus": { "type": "string", "nullable": true }, "flowId": { "type": "integer", "format": "int32" }, "flowName": { "type": "string", "nullable": true }, "isPublished": { "type": "boolean" }, "isIPaaSSubscription": { "type": "boolean" }, "retentionPolicyTypeId": { "type": "integer", "format": "int32" }, "connectorId": { "type": "integer", "format": "int32" }, "code": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "flowStatus": { "type": "string", "nullable": true }, "retentionPolicy": { "type": "string", "nullable": true }, "connectorName": { "type": "string", "nullable": true }, "createdBy": { "type": "string", "nullable": true }, "createdDate": { "type": "string", "format": "date-time", "nullable": true }, "updatedBy": { "type": "string", "nullable": true }, "updatedDate": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "deletedDate": { "type": "string", "format": "date-time", "nullable": true }, "contactId": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "vwProtocolsList": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "displayOrder": { "type": "integer", "format": "int32" }, "description": { "type": "string", "nullable": true } }, "additionalProperties": false }, "vwThruNodeList": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "thruNodeId": { "type": "string", "nullable": true }, "organizationId": { "type": "integer", "format": "int32" }, "organizationName": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "isEnabled": { "type": "boolean" }, "tenantId": { "type": "integer", "format": "int32" }, "lastActiveTime": { "type": "string", "format": "date-time", "nullable": true }, "thruNodeKey": { "type": "string", "nullable": true }, "keyCreationDateTimeUtc": { "type": "string", "format": "date-time", "nullable": true }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "nullable": true }, "updatedBy": { "type": "string", "nullable": true }, "updatedDate": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "deletedDate": { "type": "string", "format": "date-time", "nullable": true }, "description": { "type": "string", "nullable": true }, "isAlertsEnabled": { "type": "boolean" }, "lastHeartbeatTimeUTC": { "type": "string", "format": "date-time", "nullable": true }, "lanIpAddress": { "type": "string", "nullable": true }, "hostname": { "type": "string", "nullable": true }, "version": { "type": "string", "nullable": true } }, "additionalProperties": false }, "vwUserSessionsList": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "userId": { "type": "integer", "format": "int32" }, "lastAction": { "type": "string", "format": "date-time" }, "created": { "type": "string", "format": "date-time" }, "isLoggedOut": { "type": "boolean", "nullable": true }, "isTimedOut": { "type": "boolean", "nullable": true }, "terminated": { "type": "string", "format": "date-time", "nullable": true }, "ipAddress": { "type": "string", "nullable": true }, "userAgent": { "type": "string", "nullable": true } }, "additionalProperties": false } }, "securitySchemes": { "ApiKey": { "type": "apiKey", "description": "API key used in the Authorization header.", "name": "apikey", "in": "header" }, "Bearer": { "type": "http", "description": "JWT Authorization header using the Bearer scheme.", "scheme": "bearer" } } }, "security": [ { "ApiKey": [ ] }, { "Bearer": [ ] } ] }