{ "swagger": "2.0", "info": { "title": "Swimlane API", "version": "2.0" }, "host": "ecolab.cloud.swimlane.app:443", "schemes": [ "https" ], "produces": [ "application/json" ], "paths": { "/auth/token/create": { "post": { "tags": [ "accessToken" ], "summary": "Creates a new access token for the user making the request", "description": "Creates a new access token for the user making the request", "operationId": "createAccessTokenAsync", "parameters": [], "responses": { "200": { "description": "The access token that was created", "schema": { "type": "string" } }, "400": { "description": "The access token that was created", "schema": { "$ref": "#/definitions/Api.Infrastructure.Filters.ErrorCodeResponse" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/auth/user/{userId}/token": { "get": { "tags": [ "accessToken" ], "summary": "Retrieves the metadata for the token belonging to the specified user", "description": "Retrieves the metadata for the token belonging to the specified user", "operationId": "getAccessTokenAsync", "parameters": [ { "name": "userId", "description": "The id of the user to get token metadata for", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "The metadata for the token belonging to the specified user", "schema": { "$ref": "#/definitions/Core.Models.Auth.AccessToken" } }, "400": { "description": "The metadata for the token belonging to the specified user", "schema": { "$ref": "#/definitions/Api.Infrastructure.Filters.ErrorCodeResponse" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false }, "delete": { "tags": [ "accessToken" ], "summary": "Deletes the access token for the specified user", "description": "Deletes the access token for the specified user", "operationId": "deleteAccessTokenAsync", "parameters": [ { "name": "userId", "description": "The id of the user to delete the access token of", "in": "path", "required": true, "type": "string" } ], "responses": { "204": { "description": "200 if the request succeeds, 400 if the user does not have a token", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.NoContentResult" } }, "400": { "description": "200 if the request succeeds, 400 if the user does not have a token", "schema": { "$ref": "#/definitions/Api.Infrastructure.Filters.ErrorCodeResponse" } }, "200": { "description": "200 if the request succeeds, 400 if the user does not have a token", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.IActionResult" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/applet/{id}": { "get": { "tags": [ "applet" ], "summary": "Gets the applet by id.", "description": "Gets the applet by id.", "operationId": "getApplet", "parameters": [ { "name": "id", "description": "The identifier.", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "Applet.", "schema": { "$ref": "#/definitions/Core.Models.Applet.Applet" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false }, "put": { "tags": [ "applet" ], "summary": "Updates the applet.", "description": "Updates the applet.", "operationId": "putApplet", "parameters": [ { "name": "id", "description": "The identifier.", "in": "path", "required": true, "type": "string" }, { "name": "applet", "description": "The applet.", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Core.Models.Applet.Applet" } } ], "responses": { "200": { "description": "Applet.", "schema": { "$ref": "#/definitions/Core.Models.Applet.Applet" } }, "400": { "description": "Applet.", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.ContentResult" } }, "403": { "description": "Applet.", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.StatusCodeResult" } }, "404": { "description": "Applet.", "schema": { "type": "string" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false }, "delete": { "tags": [ "applet" ], "summary": "Deletes the applet.", "description": "Deletes the applet.", "operationId": "deleteApplet", "parameters": [ { "name": "id", "description": "The identifier.", "in": "path", "required": true, "type": "string" } ], "responses": { "204": { "description": "IActionResult.", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.NoContentResult" } }, "400": { "description": "IActionResult.", "schema": { "$ref": "#/definitions/Core.Models.Base.DatabaseResult" } }, "403": { "description": "IActionResult.", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.StatusCodeResult" } }, "404": { "description": "IActionResult.", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.NotFoundObjectResult" } }, "200": { "description": "IActionResult.", "schema": { "type": "object" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/applet": { "get": { "tags": [ "applet" ], "summary": "Gets the applets.", "description": "Gets the applets.", "operationId": "getApplets", "parameters": [], "responses": { "200": { "description": "IEnumerable<Applet>.", "schema": { "items": { "$ref": "#/definitions/Core.Models.Applet.Applet" }, "type": "array" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false }, "post": { "tags": [ "applet" ], "summary": "Inserts the applet.", "description": "Inserts the applet.", "operationId": "postApplet", "parameters": [ { "name": "applet", "description": "The applet.", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Core.Models.Applet.Applet" } } ], "responses": { "200": { "description": "Applet.", "schema": { "$ref": "#/definitions/Core.Models.Applet.Applet" } }, "400": { "description": "Applet.", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.ContentResult" } }, "403": { "description": "Applet.", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.StatusCodeResult" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/applet/{id}/history": { "get": { "tags": [ "applet" ], "summary": "Gets the history for specified applet.", "description": "Gets the history for specified applet.", "operationId": "getAppletHistory", "parameters": [ { "name": "id", "description": "The applet identifier", "in": "path", "required": true, "type": "string" } ], "responses": { "400": { "description": "Applet revisions", "schema": { "$ref": "#/definitions/Core.Models.Base.DatabaseResult" } }, "403": { "description": "Applet revisions", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.StatusCodeResult" } }, "404": { "description": "Applet revisions", "schema": { "type": "string" } }, "200": { "description": "Applet revisions", "schema": { "items": { "$ref": "#/definitions/Core.Models.History.Revision" }, "type": "array" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/applet/{id}/history/{revisionNumber}": { "get": { "tags": [ "applet" ], "summary": "Gets the specified revision for the specified applet.", "description": "Gets the specified revision for the specified applet.", "operationId": "getAppletHistoryForRevision", "parameters": [ { "name": "id", "description": "The applet identifier", "in": "path", "required": true, "type": "string" }, { "name": "revisionNumber", "description": "The revision number", "in": "path", "required": true, "type": "number" } ], "responses": { "400": { "description": "The applet revision", "schema": { "$ref": "#/definitions/Core.Models.Base.DatabaseResult" } }, "403": { "description": "The applet revision", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.StatusCodeResult" } }, "404": { "description": "The applet revision", "schema": { "type": "string" } }, "200": { "description": "The applet revision", "schema": { "$ref": "#/definitions/Core.Models.History.Revision" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/applet/{id}/copy": { "post": { "tags": [ "applet" ], "summary": "Copies the specified applet and inserts the copy", "description": "Copies the specified applet and inserts the copy", "operationId": "copyApplet", "parameters": [ { "name": "command", "description": "The overrides of name, acronym, description and icon for the copy", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Core.Commands.Applets.CopyAppletCommand" } }, { "name": "id", "description": "The id of the applet to copy", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "The saved, copied applet", "schema": { "$ref": "#/definitions/Core.Models.Applet.Applet" } }, "404": { "description": "The saved, copied applet", "schema": { "type": "string" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/applet/{id}/export": { "get": { "tags": [ "applet" ], "summary": "Exports the specified applet", "description": "Exports the specified applet", "operationId": "exportApplet", "parameters": [ { "name": "id", "description": "The id of the applet to export", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "Task<FileResult>.", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.FileResult" } }, "403": { "description": "Task<FileResult>.", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.StatusCodeResult" } }, "404": { "description": "Task<FileResult>.", "schema": { "type": "string" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/applet/import": { "post": { "tags": [ "applet" ], "summary": "Imports the applet.", "description": "Imports the applet.", "operationId": "importApplet", "parameters": [ { "name": "appletImport", "description": "The applet import request.", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Api.Models.Applet.AppletImportModel" } } ], "responses": { "200": { "description": "IActionResult.", "schema": { "type": "string" } }, "400": { "description": "IActionResult.", "schema": { "$ref": "#/definitions/Core.Models.Base.DatabaseResult" } }, "403": { "description": "IActionResult.", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.StatusCodeResult" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/applet/{id}/workflow": { "put": { "tags": [ "applet" ], "summary": "Updates the workflow of the specified applet", "description": "Updates the workflow of the specified applet", "operationId": "putAppletWorkflow", "parameters": [ { "name": "id", "description": "The id of the applet to update the workflow of", "in": "path", "required": true, "type": "string" }, { "name": "workflow", "description": "The workflow to associate with the applet", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Core.Models.Workflow.Workflow" } } ], "responses": { "200": { "description": "The workflow tied to the applet", "schema": { "$ref": "#/definitions/Core.Models.Workflow.Workflow" } }, "400": { "description": "The workflow tied to the applet", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.ContentResult" } }, "403": { "description": "The workflow tied to the applet", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.StatusCodeResult" } }, "404": { "description": "The workflow tied to the applet", "schema": { "type": "string" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/app/light": { "get": { "tags": [ "application" ], "summary": "Gets the Swimlane applications as a light view models.", "description": "Supersedes GetLight method", "operationId": "getAppLight", "parameters": [], "responses": { "200": { "description": "Collection of ApplicationViewModels", "schema": { "items": { "$ref": "#/definitions/Core.Models.Application.ApplicationViewModel" }, "type": "array" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/app": { "get": { "tags": [ "application" ], "summary": "Gets the Swimlane full applications.", "description": "Supersedes Get method", "operationId": "getApp", "parameters": [], "responses": { "200": { "description": "Collection of applications", "schema": { "items": { "$ref": "#/definitions/Core.Models.Application.Application" }, "type": "array" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false }, "put": { "tags": [ "application" ], "summary": "Saves/Updates the Swimlane application.", "description": "Saves/Updates the Swimlane application.", "operationId": "putAppOld", "parameters": [ { "name": "application", "description": "The Swimlane application.", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Core.Models.Application.Application" } } ], "responses": { "200": { "description": "Saved Swimlane application.", "schema": { "$ref": "#/definitions/Core.Models.Application.Application" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false }, "post": { "tags": [ "application" ], "summary": "Inserts new Swimlane application.", "description": "Supersedes Post method", "operationId": "postApp", "parameters": [ { "name": "app", "description": "The Swimlane application.", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Core.Models.Application.Application" } } ], "responses": { "200": { "description": "Saved application", "schema": { "$ref": "#/definitions/Core.Models.Application.Application" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/app/{id}": { "get": { "tags": [ "application" ], "summary": "Gets the Swimlane application by identifier.", "description": "Supersedes Get method with id parameter", "operationId": "getAppId", "parameters": [ { "name": "id", "description": "The identifier.", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "Application", "schema": { "$ref": "#/definitions/Core.Models.Application.Application" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false }, "put": { "tags": [ "application" ], "summary": "Saves/Updates the Swimlane application.", "description": "Rest compliant interface", "operationId": "putApp", "parameters": [ { "name": "application", "description": "The Swimlane application.", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Core.Models.Application.Application" } }, { "name": "id", "description": "The application ID", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "Saved Swimlane application.", "schema": { "$ref": "#/definitions/Core.Models.Application.Application" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false }, "delete": { "tags": [ "application" ], "summary": "Deletes the Swimlane application.", "description": "Supersedes Delete method.", "operationId": "deleteApp", "parameters": [ { "name": "id", "description": "The application identifier.", "in": "path", "required": true, "type": "string" } ], "responses": { "204": { "description": "IActionResult", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.NoContentResult" } }, "404": { "description": "IActionResult", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.NotFoundObjectResult" } }, "200": { "description": "IActionResult", "schema": { "type": "object" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/app/workspace/{id}": { "get": { "tags": [ "application" ], "summary": "Gets the Swimlane applications defined in workspace.", "description": "Supersedes GetByWorkspace method.", "operationId": "getAppWorkspaceId", "parameters": [ { "name": "id", "description": "The workspace identifier.", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "Application collection.", "schema": { "items": { "$ref": "#/definitions/Core.Models.Application.Application" }, "type": "array" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/app/{id}/copy": { "post": { "tags": [ "application" ], "summary": "Get a copy of Swimlane application.", "description": "Supersedes Copy method.", "operationId": "applicationCopyById", "parameters": [ { "name": "command", "description": "The command.", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Core.Requests.Applications.Commands.CopyApplicationCommand" } }, { "name": "id", "description": "The application identifier.", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "Application", "schema": { "$ref": "#/definitions/Core.Models.Application.Application" } }, "404": { "description": "Application", "schema": { "type": "string" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/app/{id}/export": { "get": { "tags": [ "application" ], "summary": "Exports Swimlane application.", "description": "Exports Swimlane application.", "operationId": "appIdExport", "parameters": [ { "name": "id", "description": "The application identifier.", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "Response message", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.FileResult" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/app/{id}/history": { "get": { "tags": [ "application" ], "summary": "Gets the history for specified application.", "description": "Gets the history for specified application.", "operationId": "getHistory", "parameters": [ { "name": "id", "description": "The application identifier.", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "The Revision collection.", "schema": { "items": { "$ref": "#/definitions/Core.Models.History.Revision" }, "type": "array" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/app/{id}/history/{revisionNumber}": { "get": { "tags": [ "application" ], "summary": "Gets the specified revision for specified application.", "description": "Gets the specified revision for specified application.", "operationId": "getHistoryFoRevision", "parameters": [ { "name": "id", "description": "The application identifier.", "in": "path", "required": true, "type": "string" }, { "name": "revisionNumber", "description": "The revision number.", "in": "path", "required": true, "type": "number" } ], "responses": { "200": { "description": "The Revision.", "schema": { "$ref": "#/definitions/Core.Models.History.Revision" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/app/import": { "post": { "tags": [ "application" ], "summary": "Imports Swimlane application", "description": "Imports Swimlane application", "operationId": "postAppImport", "parameters": [ { "name": "request", "description": "The request.", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Core.Requests.Applications.Commands.ImportApplicationCommand" } } ], "responses": { "400": { "description": "Task<ApplicationImportResult>.", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.JsonResult" } }, "403": { "description": "Task<ApplicationImportResult>.", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.StatusCodeResult" } }, "200": { "description": "Task<ApplicationImportResult>.", "schema": { "$ref": "#/definitions/Core.Services.ApplicationImportResult" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/app/{applicationId}/correlation": { "get": { "tags": [ "alertCorrelation" ], "summary": "Gets an amount of groups based on the paged search criteria.", "description": "Gets an amount of groups based on the paged search criteria.", "operationId": "getCorrelation", "parameters": [ { "name": "applicationId", "description": "The application identifier.", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "PagedResponse<Group>.", "schema": { "$ref": "#/definitions/Core.Models.Application.CorrelationConfigurationEntity" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false }, "put": { "tags": [ "alertCorrelation" ], "summary": "Updates the specified correlation configuration.", "description": "Updates the specified correlation configuration.", "operationId": "putCorrelation", "parameters": [ { "name": "applicationId", "description": "The application identifier.", "in": "path", "required": true, "type": "string" }, { "name": "configuration", "description": "The correlation configuration.", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Core.Models.Application.CorrelationConfigurationEntity" } } ], "responses": { "200": { "description": "Saved correlation configuration.", "schema": { "$ref": "#/definitions/Core.Models.Application.CorrelationConfigurationEntity" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false }, "post": { "tags": [ "alertCorrelation" ], "summary": "Inserts/Creates the specified group.", "description": "Inserts/Creates the specified group.", "operationId": "postCorrelation", "parameters": [ { "name": "applicationId", "description": "The application identifier.", "in": "path", "required": true, "type": "string" }, { "name": "configuration", "description": "The correlation configuration.", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Core.Models.Application.CorrelationConfigurationEntity" } } ], "responses": { "200": { "description": "Saved correlation configuration.", "schema": { "$ref": "#/definitions/Core.Models.Application.CorrelationConfigurationEntity" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false }, "delete": { "tags": [ "alertCorrelation" ], "summary": "Deletes the specified correlation configuration.", "description": "Deletes the specified correlation configuration.", "operationId": "deleteCorrelation", "parameters": [ { "name": "applicationId", "description": "The application identifier.", "in": "path", "required": true, "type": "string" } ], "responses": { "204": { "description": "IActionResult", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.NoContentResult" } }, "404": { "description": "IActionResult", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.NotFoundObjectResult" } }, "200": { "description": "IActionResult", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.IActionResult" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/app/correlationvaluetypes": { "get": { "tags": [ "alertCorrelation" ], "summary": "Fetches all Correlation Value Types", "description": "Fetches all Correlation Value Types", "operationId": "getCorrelationValueTypes", "parameters": [], "responses": { "200": { "description": "Dictionary of Enum Value and Description", "schema": { "additionalProperties": { "enum": [ "Domain", "URL", "Email", "Filename", "FileAttachment", "IPv4Private", "IPv4Public", "IPv6Private", "IPv6Public", "MD5", "SHA1", "SHA256", "Ssdeep", "RawText", "Unknown" ], "type": "string" }, "type": "object" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/asset/{id}": { "get": { "tags": [ "asset" ], "summary": "Gets the asset.", "description": "Gets the asset.", "operationId": "getAsset", "parameters": [ { "name": "id", "description": "The identifier.", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "Asset.", "schema": { "$ref": "#/definitions/Core.Models.Integrations.Assets.Asset" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false }, "put": { "tags": [ "asset" ], "summary": "Updates the asset.", "description": "Updates the asset.", "operationId": "putAsset", "parameters": [ { "name": "id", "description": "The identifier of asset to update.", "in": "path", "required": true, "type": "string" }, { "name": "asset", "description": "The asset with desired changes.", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Core.Models.Integrations.Assets.Asset" } } ], "responses": { "200": { "description": "The updated asset.", "schema": { "$ref": "#/definitions/Core.Models.Integrations.Assets.Asset" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false }, "delete": { "tags": [ "asset" ], "summary": "Deletes the asset.", "description": "Deletes the asset.", "operationId": "deleteAsset", "parameters": [ { "name": "id", "description": "The identifier.", "in": "path", "required": true, "type": "string" } ], "responses": { "204": { "description": "IActionResult", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.NoContentResult" } }, "404": { "description": "IActionResult", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.NotFoundObjectResult" } }, "200": { "description": "IActionResult", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.IActionResult" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/asset": { "get": { "tags": [ "asset" ], "summary": "Gets the assets.", "description": "Gets the assets.", "operationId": "getAssets", "parameters": [], "responses": { "200": { "description": "IEnumerable<Asset>.", "schema": { "items": { "$ref": "#/definitions/Core.Models.Integrations.Assets.Asset" }, "type": "array" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false }, "put": { "tags": [ "asset" ], "summary": "Puts the asset old.", "description": "Puts the asset old.", "operationId": "putAssetOld", "parameters": [ { "name": "asset", "description": "The asset.", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Core.Models.Integrations.Assets.Asset" } } ], "responses": { "200": { "description": "Asset.", "schema": { "$ref": "#/definitions/Core.Models.Integrations.Assets.Asset" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false }, "post": { "tags": [ "asset" ], "summary": "Adds the asset.", "description": "Adds the asset.", "operationId": "postAsset", "parameters": [ { "name": "asset", "description": "The asset to add.", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Core.Models.Integrations.Assets.Asset" } } ], "responses": { "200": { "description": "The added asset.", "schema": { "$ref": "#/definitions/Core.Models.Integrations.Assets.Asset" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/asset/list": { "get": { "tags": [ "asset" ], "summary": "Gets the assets list for UI.", "description": "Gets the assets list for UI.", "operationId": "getAssetsList", "parameters": [], "responses": { "200": { "description": "Assets list object, de-duped images and asset light objects collection.", "schema": { "$ref": "#/definitions/Api.Models.Integration.AssetList" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/asset/available": { "get": { "tags": [ "asset" ], "summary": "Gets the available assets descriptors.", "description": "Gets the available assets descriptors.", "operationId": "getAvailableAssets", "parameters": [], "responses": { "200": { "description": "IEnumerable<AssetDescriptor>.", "schema": { "items": { "$ref": "#/definitions/Core.Models.Integrations.Assets.AssetDescriptor" }, "type": "array" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/asset/test": { "post": { "tags": [ "asset" ], "summary": "Tests the specified asset.", "description": "Tests the specified asset.", "operationId": "test", "parameters": [ { "name": "asset", "description": "The asset.", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Core.Models.Integrations.Assets.Asset" } } ], "responses": { "200": { "description": "AssetTestResult.", "schema": { "$ref": "#/definitions/Core.Models.Integrations.Assets.AssetTestResult" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/asset-descriptor/{id}": { "delete": { "tags": [ "asset" ], "summary": "Delete Asset Descriptor By ID", "description": "Delete Asset Descriptor By ID", "operationId": "deleteAssetDescriptor", "parameters": [ { "name": "id", "description": "Asset DescriptorID", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "", "schema": { "type": "object" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/content/export/download": { "post": { "tags": [ "content" ], "summary": "Exports Swimlane solution content package.", "description": "Exports Swimlane solution content package.", "operationId": "contentExport", "parameters": [ { "name": "exportDownloadRequest", "description": "Export request. That includes entrypoint\n ids and the entrypoint type. Also specifies the name for package.", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Api.Models.Content.ExportDownloadRequest" } } ], "responses": { "200": { "description": "Swimlane solution package. (Zip archive).", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.FileResult" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/content/export/try": { "post": { "tags": [ "content" ], "summary": "Performs export dry run. Running collection and validation of entities.", "description": "If any errors or issues are encountered, the problem will contain an associated error code. Possible codes are:\n \n 0: An unexpected error has occurred.\n 1000: Could not load application file in package\n 1001: Could not load applet file in package\n 1002: Could not load asset file in package\n 1003: Could not load dashboard file in package\n 1004: Could not load export transformation file in package\n 1005: Could not load package descriptor file in package\n 1006: Could not load available action descriptor file in package\n 1007: Could not load report file in package\n 1008: Could not load task file in package\n 1009: Could not load workflow file in package\n 1010: Could not load workspace file in package\n 1011: Could not load correlation file in package\n 1012: Could not load orchestration task file in package\n 1013: Could not load playbook file in package\n 1014: Could not load DO asset file in package\n 1015: Could not load sensor file in package\n 1016: Could not load ingestion rule file in package\n 1017: Could not load connector file in package\n 2000: An error was encountered while saving an application\n 2001: An error was encountered while saving an applet\n 2002: An error was encountered while saving an asset\n 2003: An error was encountered while saving a dashboard\n 2004: An error was encountered while saving an export transformation\n 2005: An error was encountered while saving a plugin\n 2006: An error was encountered while saving a report\n 2007: An error was encountered while saving a task\n 2008: An error was encountered while saving a workflow\n 2009: An error was encountered while saving a workspace\n 2010: An error was encountered while saving a correlation\n 2011: An error was encountered while saving an orchestration task\n 2012: An error was encountered while saving a playbook\n 2013: An error was encountered while saving a DO asset\n 2014: An error was encountered while saving a sensor\n 2015: An error was encountered while saving an ingestion rule\n 2016: An error was encountered while saving a connector\n 100: A value was unexpectedly null or empty. (Obsolete)\n 101: A file was missing from the ssp. (Obsolete)\n 102: A file in the ssp was unexpectedly empty. (Obsolete)\n 3000: The SSP is missing a bundle file\n 3001: The SSP is missing a result file\n 3002: The SSP is missing a mapping file\n 3003: The SSP is missing an application file\n 3004: The SSP is missing an applet bundle file\n 3005: The SSP is missing an asset file\n 3006: The SSP is missing a dashboard file\n 3007: The SSP is missing an export transformation file\n 3008: The SSP is missing a package descriptor file\n 3009: The SSP is missing an available action descriptor file\n 3010: The SSP is missing a report file\n 3011: The SSP is missing a task file\n 3012: The SSP is missing a workflow file\n 3013: The SSP is missing a workspace file\n 3014: The SSP is missing a correlation file\n 3015: The SSP is missing an orchestration task file\n 3016: The SSP is missing a playbook file\n 3017: The SSP is missing a DO asset file\n 3018: The SSP is missing a sensor file\n 3019: The SSP is missing an ingestion rule file\n 3020: The SSP is missing a connector file\n 103: The requested entity is not in the system. (Obsolete)\n 4000: No application matching the provided ID exists\n 4001: No applet matching the provided ID exists\n 4002: No task matching the provided ID exists\n 4003: No package descriptor matching the provided ID exists\n 4004: No Dynamic Orchestration asset matching the provided ID exists\n 4005: No Playbook matching the provided ID exists\n 4006: No sensor matching the provided ID exists\n 4007: No orchestration task matching the provided ID exists\n 4008: No ingestion rule matching the provided ID exists\n 4009: No referenced application matching the provided ID exists\n 4010: No referenced applet matching the provided ID exists\n 4011: No connector matching the provided name exists\n 200: An entity with this UID is already present in the system. (Obsolete)\n 5000: An application with this UID is already present in the system.\n 5001: An applet with this UID is already present in the system.\n 5002: An asset with this UID is already present in the system.\n 5003: A dashboard with this UID is already present in the system.\n 5004: An export transformation with this UID is already present in the system.\n 5005: A report with this UID is already present in the system.\n 5006: A task with this UID is already present in the system.\n 5007: A workflow with this UID is already present in the system.\n 5008: A workspace with this UID is already present in the system.\n 5009: An ingestion rule with this UID is already present in the system.\n 5010: An orchestration task with this UID is already present in the system.\n 5011: A playbook with this UID is already present in the system.\n 5012: A DO asset with this UID is already present in the system.\n 5013: A sensor with this UID is already present in the system.\n 201: An entity with this acronym is already present in the system. (Obsolete)\n 6000: An application with this acronym is already present in the system.\n 6001: An applet with this acronym is already present in the system.\n 202: An entity with this name is already present in the system. (Obsolete)\n 7000: An application with this name is already present in the system.\n 7001: An applet with this name is already present in the system.\n 7002: An asset with this name is already present in the system.\n 8000: A workflow task reference was left undefined\n 8001: A layout task reference was left undefined\n 8002: An output's email asset reference was left undefined\n 8003: An output's task reference was left undefined\n 8004: An output's parent reference was left undefined\n 8005: A trigger's email asset reference was left undefined\n 8006: An action's plugin reference was left undefined\n 8007: An action's asset reference was left undefined\n 8008: A package descriptor's name was left undefined\n 8009: A packages descriptor's file ID was left undefined\n 8010: A reference field ID in an application was left undefined\n 8011: A reference field ID in an applet was left undefined\n 8012: A reference field in an application has an invalid type\n 8013: A reference field in an applet has an invalid type\n 8014: A layout orchestration task reference was left undefined\n 8015: A orchestration node was left undefined\n 300: A secure credential has been removed during export. (Obsolete)\n 9000: A secure credential has been removed from an asset during export.\n 9001: A key store reference has been removed from a task during export.\n 9002: A secure credential has been removed from a Dynamic Orchestration asset during export.\n 9003: A secure credential has been removed from a Dynamic Orchestration sensor during export.\n 9004: A secure credential has been removed from a Playbook during export. (Obsolete)\n 302: Entries from a user/group field have been removed during export. (Obsolete)\n 10000: The notification recipients have been removed from an action.\n 10001: An action's user/group single-select field has been cleared.\n 10002: An action's user/group multi-select field has been cleared.\n 10003: A condition's user/group single-select field has been cleared.\n 10004: A condition's user/group multi-select field has been cleared.\n 10005: An application's user/group field has been cleared.\n 10006: An applet's user/group field has been cleared.\n 11000: Mapping file could not be deserialized.\n 11001: Relationship file could not be deserialized.\n 12000: An application has failed its validation\n 12001: An applet has failed its validation\n 12002: An task has failed its validation\n 12003: An application's workflow has failed its validation\n 12004: An applet's workflow has failed its validation\n 12005: A task output has multiple parent IDs, it should only have one\n 13000: A task's asset has been modified.\n 13001: An orchestration tasks's asset has been modified.\n 13002: An orchestration webhook url has been modified.\n 400: The system has an older version of a plugin installed. Upgrade the plugin and try again.\n 401: The system has a newer version of a plugin installed. The older version cannot be imported.\n 500: The system has swimlane version incompatible with the one specified in the plugin.\n 501: The system does not have the DO feature flag enabled, but this SSP requires it.\n 301: A report filter has been removed during export.\n 14000: The Python version is not supported.\n 15000: A playbook was disabled during export.\n 15001: A sensor was disabled during export.\n 17001: Could not fetch connector version information from swimlane marketplace.\n 17002: Could not fetch connector from swimlane marketplace.", "operationId": "contentExportTry", "parameters": [ { "name": "exportDownloadRequest", "description": "Export dry run request. That includes entrypoint\n ids and the entrypoint type to prepare export.", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Api.Models.Content.ExportRequest" } } ], "responses": { "200": { "description": "Returns dry run results including errors and issues encountered.", "schema": { "$ref": "#/definitions/Swimlane.Platform.Content.Model.ContentActionResult" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/content/import": { "post": { "tags": [ "content" ], "summary": "Imports Swimlane solution content package.", "description": "If any errors or issues are encountered, the problem will contain an associated error code. Possible codes are:\n \n 0: An unexpected error has occurred.\n 1000: Could not load application file in package\n 1001: Could not load applet file in package\n 1002: Could not load asset file in package\n 1003: Could not load dashboard file in package\n 1004: Could not load export transformation file in package\n 1005: Could not load package descriptor file in package\n 1006: Could not load available action descriptor file in package\n 1007: Could not load report file in package\n 1008: Could not load task file in package\n 1009: Could not load workflow file in package\n 1010: Could not load workspace file in package\n 1011: Could not load correlation file in package\n 1012: Could not load orchestration task file in package\n 1013: Could not load playbook file in package\n 1014: Could not load DO asset file in package\n 1015: Could not load sensor file in package\n 1016: Could not load ingestion rule file in package\n 1017: Could not load connector file in package\n 2000: An error was encountered while saving an application\n 2001: An error was encountered while saving an applet\n 2002: An error was encountered while saving an asset\n 2003: An error was encountered while saving a dashboard\n 2004: An error was encountered while saving an export transformation\n 2005: An error was encountered while saving a plugin\n 2006: An error was encountered while saving a report\n 2007: An error was encountered while saving a task\n 2008: An error was encountered while saving a workflow\n 2009: An error was encountered while saving a workspace\n 2010: An error was encountered while saving a correlation\n 2011: An error was encountered while saving an orchestration task\n 2012: An error was encountered while saving a playbook\n 2013: An error was encountered while saving a DO asset\n 2014: An error was encountered while saving a sensor\n 2015: An error was encountered while saving an ingestion rule\n 2016: An error was encountered while saving a connector\n 100: A value was unexpectedly null or empty. (Obsolete)\n 101: A file was missing from the ssp. (Obsolete)\n 102: A file in the ssp was unexpectedly empty. (Obsolete)\n 3000: The SSP is missing a bundle file\n 3001: The SSP is missing a result file\n 3002: The SSP is missing a mapping file\n 3003: The SSP is missing an application file\n 3004: The SSP is missing an applet bundle file\n 3005: The SSP is missing an asset file\n 3006: The SSP is missing a dashboard file\n 3007: The SSP is missing an export transformation file\n 3008: The SSP is missing a package descriptor file\n 3009: The SSP is missing an available action descriptor file\n 3010: The SSP is missing a report file\n 3011: The SSP is missing a task file\n 3012: The SSP is missing a workflow file\n 3013: The SSP is missing a workspace file\n 3014: The SSP is missing a correlation file\n 3015: The SSP is missing an orchestration task file\n 3016: The SSP is missing a playbook file\n 3017: The SSP is missing a DO asset file\n 3018: The SSP is missing a sensor file\n 3019: The SSP is missing an ingestion rule file\n 3020: The SSP is missing a connector file\n 103: The requested entity is not in the system. (Obsolete)\n 4000: No application matching the provided ID exists\n 4001: No applet matching the provided ID exists\n 4002: No task matching the provided ID exists\n 4003: No package descriptor matching the provided ID exists\n 4004: No Dynamic Orchestration asset matching the provided ID exists\n 4005: No Playbook matching the provided ID exists\n 4006: No sensor matching the provided ID exists\n 4007: No orchestration task matching the provided ID exists\n 4008: No ingestion rule matching the provided ID exists\n 4009: No referenced application matching the provided ID exists\n 4010: No referenced applet matching the provided ID exists\n 4011: No connector matching the provided name exists\n 200: An entity with this UID is already present in the system. (Obsolete)\n 5000: An application with this UID is already present in the system.\n 5001: An applet with this UID is already present in the system.\n 5002: An asset with this UID is already present in the system.\n 5003: A dashboard with this UID is already present in the system.\n 5004: An export transformation with this UID is already present in the system.\n 5005: A report with this UID is already present in the system.\n 5006: A task with this UID is already present in the system.\n 5007: A workflow with this UID is already present in the system.\n 5008: A workspace with this UID is already present in the system.\n 5009: A correlation with this UID is already present in the system.\n 5010: An orchestration task with this UID is already present in the system.\n 5011: A playbook with this UID is already present in the system.\n 5012: A DO asset with this UID is already present in the system.\n 5013: A sensor with this UID is already present in the system.\n 5014: An ingestion rule with this UID is already present in the system.\n 201: An entity with this acronym is already present in the system. (Obsolete)\n 6000: An application with this acronym is already present in the system.\n 6001: An applet with this acronym is already present in the system.\n 202: An entity with this name is already present in the system. (Obsolete)\n 7000: An application with this name is already present in the system.\n 7001: An applet with this name is already present in the system.\n 7002: An asset with this name is already present in the system.\n 8000: A workflow task reference was left undefined\n 8001: A layout task reference was left undefined\n 8002: An output's email asset reference was left undefined\n 8003: An output's task reference was left undefined\n 8004: An output's parent reference was left undefined\n 8005: A trigger's email asset reference was left undefined\n 8006: An action's plugin reference was left undefined\n 8007: An action's asset reference was left undefined\n 8008: A package descriptor's name was left undefined\n 8009: A packages descriptor's file ID was left undefined\n 8010: A reference field ID in an application was left undefined\n 8011: A reference field ID in an applet was left undefined\n 8012: A reference field in an application has an invalid type\n 8013: A reference field in an applet has an invalid type\n 8014: A layout orchestration task reference was left undefined\n 8015: A orchestration node was left undefined\n 300: A secure credential has been removed during export. (Obsolete)\n 9000: A secure credential has been removed from an asset during export.\n 9001: A key store reference has been removed from a task during export.\n 9002: A secure credential has been removed from a Dynamic Orchestration asset during export.\n 9003: A secure credential has been removed from a Dynamic Orchestration sensor during export.\n 9004: A secure credential has been removed from a Playbook during export. (Obsolete)\n 302: Entries from a user/group field have been removed during export. (Obsolete)\n 10000: The notification recipients have been removed from an action.\n 10001: An action's user/group single-select field has been cleared.\n 10002: An action's user/group multi-select field has been cleared.\n 10003: A condition's user/group single-select field has been cleared.\n 10004: A condition's user/group multi-select field has been cleared.\n 10005: An application's user/group field has been cleared.\n 10006: An applet's user/group field has been cleared.\n 11000: Mapping file could not be deserialized.\n 11001: Relationship file could not be deserialized.\n 12000: An application has failed its validation\n 12001: An applet has failed its validation\n 12002: An task has failed its validation\n 12003: An application's workflow has failed its validation\n 12004: An applet's workflow has failed its validation\n 12005: A task output has multiple parent IDs, it should only have one\n 13000: A task's asset has been modified.\n 13001: An orchestration tasks's asset has been modified.\n 13002: An orchestration webhook url has been modified.\n 400: The system has an older version of a plugin installed. Upgrade the plugin and try again.\n 401: The system has a newer version of a plugin installed. The older version cannot be imported.\n 500: The system has swimlane version incompatible with the one specified in the plugin.\n 501: The system does not have the DO feature flag enabled, but this SSP requires it.\n 301: A report filter has been removed during export.\n 14000: The Python version is not supported.\n 15000: A playbook was disabled during export.\n 15001: A sensor was disabled during export.\n 16000: A relationship between entities is missing.\n 16001: A workflow entity is missing.\n 16002: A default report entity is missing.\n 16003: An application entity is missing.\n 16004: A playbook entity is missing.\n 17001: Could not fetch connector version information from swimlane marketplace.\n 17002: Could not fetch connector from swimlane marketplace.", "operationId": "contentImport", "consumes": [ "multipart/form-data" ], "parameters": [ { "name": "file", "description": "Swimlane solution content package, ssp.", "in": "formData", "required": true, "type": "file" }, { "name": "entityIds", "description": "IDs of the entities in the SSP which should be imported.", "in": "formData", "required": true, "collectionFormat": "csv", "type": "array", "items": { "type": "string" } }, { "name": "runInBackground", "description": "Determines if import process should run as a background task. Defaults to true.", "in": "formData", "required": false, "type": "boolean" }, { "name": "overwrite", "description": "Determines if import process overwrites existing entities. Defaults to false.", "in": "formData", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "A tracking ID which can be used to retrieve the status and results of the import process.", "schema": { "type": "string" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/content/import/try": { "post": { "tags": [ "content" ], "summary": "Performs an import dry run.", "description": "Performs an import dry run.", "operationId": "contentImportTry", "consumes": [ "multipart/form-data" ], "parameters": [ { "name": "file", "description": "Swimlane solution content package, ssp.", "in": "formData", "required": true, "type": "file" } ], "responses": { "200": { "description": "A tracking ID which can be used to retrieve the status and results of the import process.", "schema": { "type": "string" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/content/import/{trackingId}/status": { "get": { "tags": [ "content" ], "summary": "Retrieves the status and results (if available) of a content exchange import.", "description": "Retrieves the status and results (if available) of a content exchange import.", "operationId": "contentImportStatus", "parameters": [ { "name": "trackingId", "description": "Tracking ID of the import process.", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/Core.Models.Content.ContentExchangeResult" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/credentials": { "get": { "tags": [ "credentials" ], "summary": "Gets the credentials.", "description": "Gets the credentials.", "operationId": "getCredentials", "parameters": [], "responses": { "200": { "description": "Dictionary of credential names with masked values.", "schema": { "additionalProperties": { "type": "string" }, "type": "object" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false }, "put": { "tags": [ "credentials" ], "summary": "Updates the credentials.", "description": "Updates the credentials.", "operationId": "updateCredentials", "parameters": [ { "name": "entity", "description": "The entity.", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Core.Models.Base.NameValue" } } ], "responses": { "200": { "description": "IActionResult.", "schema": { "type": "object" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false }, "post": { "tags": [ "credentials" ], "summary": "Creates new credentials.", "description": "Creates new credentials.", "operationId": "createCredentials", "parameters": [ { "name": "nameValue", "description": "The credential key value pair.", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Core.Models.Base.NameValue" } } ], "responses": { "200": { "description": "Unencrypted credentials back.", "schema": { "type": "object" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/credentials/{name}": { "get": { "tags": [ "credentials" ], "summary": "Gets the credential by name.", "description": "Gets the credential by name.", "operationId": "getCredential", "parameters": [ { "name": "name", "description": "The name.", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "Name value pair (value is masked)", "schema": { "$ref": "#/definitions/Core.Models.Base.NameValue" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false }, "put": { "tags": [ "credentials" ], "summary": "Updates the credentials.", "description": "Updates the credentials.", "operationId": "updateCredentials2", "parameters": [ { "name": "entity", "description": "The entity.", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Core.Models.Base.NameValue" } }, { "name": "name", "description": "The name.", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "IActionResult.", "schema": { "type": "object" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false }, "delete": { "tags": [ "credentials" ], "summary": "Deletes the credentials.", "description": "Deletes the credentials.", "operationId": "deleteCredentials", "parameters": [ { "name": "name", "description": "The name.", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "IActionResult.", "schema": { "type": "object" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/dashboard/workspace/{id}": { "get": { "tags": [ "dashboard" ], "summary": "Gets dashboards containing the identified workspace.", "description": "Gets dashboards containing the identified workspace.", "operationId": "dashboardWorkspaceId", "parameters": [ { "name": "id", "description": "The workspace identifier.", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "IEnumerable<Dashboard>.", "schema": { "items": { "$ref": "#/definitions/Core.Models.Workspaces.Dashboard" }, "type": "array" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/dashboard/status/workspace/{id}": { "get": { "tags": [ "dashboard" ], "summary": "Gets a map of dashboard ids with their status i.e. enabled or disabled if they have any schedules.\n If the report does not have schedules will not be added to the map.", "description": "Gets a map of dashboard ids with their status i.e. enabled or disabled if they have any schedules.\n If the report does not have schedules will not be added to the map.", "operationId": "getScheduledDashboardStatusMapAsync", "parameters": [ { "name": "id", "description": "The workspace id.", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "The Dictionary with the report ids and their status calculated.", "schema": { "additionalProperties": { "type": "string" }, "type": "object" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/dashboard/{id}": { "get": { "tags": [ "dashboard" ], "summary": "Gets the specified dashboard.", "description": "Gets the specified dashboard.", "operationId": "getDashboard", "parameters": [ { "name": "id", "description": "The identifier.", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "Dashboard.", "schema": { "$ref": "#/definitions/Core.Models.Workspaces.Dashboard" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false }, "put": { "tags": [ "dashboard" ], "summary": "Updates the specified dashboard.", "description": "Updates the specified dashboard.", "operationId": "putDashboard", "parameters": [ { "name": "model", "description": "The dashboard.", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Core.Models.Workspaces.Dashboard" } }, { "name": "id", "description": "The dashboard ID", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "The saved dashboard.", "schema": { "$ref": "#/definitions/Core.Models.Workspaces.Dashboard" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false }, "delete": { "tags": [ "dashboard" ], "summary": "Deletes the specified dashboard.", "description": "Deletes the specified dashboard.", "operationId": "deleteDashboard", "parameters": [ { "name": "id", "description": "The identifier.", "in": "path", "required": true, "type": "string" } ], "responses": { "204": { "description": "IActionResult", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.NoContentResult" } }, "404": { "description": "IActionResult", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.NotFoundObjectResult" } }, "200": { "description": "IActionResult", "schema": { "type": "object" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/dashboard": { "get": { "tags": [ "dashboard" ], "summary": "Gets all dashboards in application.", "description": "Gets all dashboards in application.", "operationId": "getDashboards", "parameters": [], "responses": { "200": { "description": "Dashboard collection", "schema": { "items": { "$ref": "#/definitions/Core.Models.Workspaces.Dashboard" }, "type": "array" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false }, "put": { "tags": [ "dashboard" ], "summary": "Updates the specified dashboard.", "description": "Updates the specified dashboard.", "operationId": "putDashboardOld", "parameters": [ { "name": "model", "description": "The dashboard.", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Core.Models.Workspaces.Dashboard" } } ], "responses": { "200": { "description": "The saved dashboard.", "schema": { "$ref": "#/definitions/Core.Models.Workspaces.Dashboard" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false }, "post": { "tags": [ "dashboard" ], "summary": "Inserts/Creates the dashboard.", "description": "Inserts/Creates the dashboard.", "operationId": "postDashboard", "parameters": [ { "name": "model", "description": "The dashboard", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Core.Models.Workspaces.Dashboard" } } ], "responses": { "200": { "description": "The saved dashboard", "schema": { "$ref": "#/definitions/Core.Models.Workspaces.Dashboard" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/data-import/upload": { "post": { "tags": [ "dataImport" ], "summary": "Uploads the file to database.", "description": "Uploads the file to database.", "operationId": "upload", "parameters": [ { "name": "file", "description": "The file.", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Http.IFormFile" } } ], "responses": { "200": { "description": "object.", "schema": { "type": "object" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/data-import/run": { "post": { "tags": [ "dataImport" ], "summary": "Runs the submitted data import.", "description": "Runs the submitted data import.", "operationId": "run", "parameters": [ { "name": "model", "description": "The model.", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Api.Models.DataImport.FileImport" } } ], "responses": { "204": { "description": "System.String.", "schema": { "type": "string" } }, "200": { "description": "System.String.", "schema": { "type": "string" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/app/{appId}/transformations": { "get": { "tags": [ "exportTransformation" ], "summary": "Gets all saved export transformations for an application.", "description": "Gets all saved export transformations for an application.", "operationId": "getExportTransformations", "parameters": [ { "name": "appId", "description": "The application identifier", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "The export transformation definitions", "schema": { "items": { "$ref": "#/definitions/Core.Models.Application.ExportTransformation" }, "type": "array" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false }, "put": { "tags": [ "exportTransformation" ], "summary": "Updates an export transformation", "description": "Updates an export transformation", "operationId": "putExportTransformationOld", "parameters": [ { "name": "transformation", "description": "The export transformation to update.", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Core.Models.Application.ExportTransformation" } }, { "name": "appId", "description": "The application identifier", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "ExportTransformation.", "schema": { "$ref": "#/definitions/Core.Models.Application.ExportTransformation" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false }, "post": { "tags": [ "exportTransformation" ], "summary": "Saves an export transformation", "description": "Saves an export transformation", "operationId": "postExportTransformation", "parameters": [ { "name": "transformation", "description": "The export transformation model to save.", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Core.Models.Application.ExportTransformation" } }, { "name": "appId", "description": "The application identifier", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "ExportTransformation.", "schema": { "$ref": "#/definitions/Core.Models.Application.ExportTransformation" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/app/{appId}/transformations/{transformationId}": { "get": { "tags": [ "exportTransformation" ], "summary": "Gets a saved export transformation.", "description": "Gets a saved export transformation.", "operationId": "getExportTransformation", "parameters": [ { "name": "appId", "description": "The application identifier", "in": "path", "required": true, "type": "string" }, { "name": "transformationId", "description": "The export transformation identifier", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "The export transformation definition", "schema": { "$ref": "#/definitions/Core.Models.Application.ExportTransformation" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false }, "put": { "tags": [ "exportTransformation" ], "summary": "Updates an export transformation", "description": "Updates an export transformation", "operationId": "putExportTransformation", "parameters": [ { "name": "transformation", "description": "The export transformation to update.", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Core.Models.Application.ExportTransformation" } }, { "name": "appId", "description": "The application identifier", "in": "path", "required": true, "type": "string" }, { "name": "transformationId", "description": "The export transformation identifier", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "ExportTransformation.", "schema": { "$ref": "#/definitions/Core.Models.Application.ExportTransformation" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false }, "delete": { "tags": [ "exportTransformation" ], "summary": "Deletes an export transformation.", "description": "Deletes an export transformation.", "operationId": "deleteExportTransformation", "parameters": [ { "name": "appId", "description": "The application identifier", "in": "path", "required": true, "type": "string" }, { "name": "transformationId", "description": "The id of the transformation to delete.", "in": "path", "required": true, "type": "string" } ], "responses": { "204": { "description": "NoContentResult.", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.NoContentResult" } }, "404": { "description": "NoContentResult.", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.NotFoundObjectResult" } }, "200": { "description": "NoContentResult.", "schema": { "type": "object" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/app/{id}/fields": { "post": { "tags": [ "application" ], "summary": "Add one or more fields to the specified application", "description": "Add one or more fields to the specified application", "operationId": "createApplicationFields", "parameters": [ { "name": "id", "description": "The id of the application to add the fields to", "in": "path", "required": true, "type": "string" }, { "name": "command", "description": "The fields to add to the application", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Core.Commands.Fields.AddFieldsToApplicationCommand" } } ], "responses": { "200": { "description": "Task<IEnumerable<Field>>.", "schema": { "items": { "$ref": "#/definitions/Core.Models.Fields.Field" }, "type": "array" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/applet/{id}/fields": { "post": { "tags": [ "applet" ], "summary": "Add one or more fields to the specified applet", "description": "Add one or more fields to the specified applet", "operationId": "createAppletFields", "parameters": [ { "name": "id", "description": "The id of the applet to add the fields to", "in": "path", "required": true, "type": "string" }, { "name": "command", "description": "The fields to add to the applet", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Core.Commands.Fields.AddFieldsToAppletCommand" } } ], "responses": { "200": { "description": "Task<IEnumerable<Field>>.", "schema": { "items": { "$ref": "#/definitions/Core.Models.Fields.Field" }, "type": "array" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/app/fields/descriptor/mapping": { "get": { "tags": [ "application" ], "summary": "Gets the mappings for descriptor types.", "description": "Gets the mappings for descriptor types.", "operationId": "getMappingsForDescriptorTypes", "parameters": [], "responses": { "200": { "description": "", "schema": { "additionalProperties": { "items": { "$ref": "#/definitions/Api.Models.Application.FieldTypeModel" }, "type": "array" }, "type": "object" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/app/formula-validate": { "post": { "tags": [ "formula" ], "summary": "Validate formulas.", "description": "Superceeds ValidateFormula", "operationId": "postAppFormulaValidate", "parameters": [ { "name": "model", "description": "The calculation model.", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Api.Models.Application.CalculationViewModel" } } ], "responses": { "200": { "description": "Http response codes.", "schema": { "type": "object" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/groups/{id}": { "get": { "tags": [ "groups" ], "summary": "Gets the specified group.", "description": "Gets the specified group.", "operationId": "getGroup", "parameters": [ { "name": "id", "description": "The identifier.", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "The GroupService", "schema": { "$ref": "#/definitions/Core.Models.Groups.Group" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false }, "put": { "tags": [ "groups" ], "summary": "Updates the specified group.", "description": "Updates the specified group.", "operationId": "putGroup", "parameters": [ { "name": "id", "description": "The identifier.", "in": "path", "required": true, "type": "string" }, { "name": "group", "description": "The group to update.", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Core.Models.Groups.Group" } } ], "responses": { "200": { "description": "Saved GroupService.", "schema": { "$ref": "#/definitions/Core.Models.Groups.Group" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false }, "delete": { "tags": [ "groups" ], "summary": "Deletes the specified group.", "description": "Deletes the specified group.", "operationId": "deleteGroup", "parameters": [ { "name": "id", "description": "The identifier.", "in": "path", "required": true, "type": "string" } ], "responses": { "204": { "description": "IActionResult", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.NoContentResult" } }, "404": { "description": "IActionResult", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.NotFoundObjectResult" } }, "200": { "description": "IActionResult", "schema": { "type": "object" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/groups": { "get": { "tags": [ "groups" ], "summary": "Gets an amount of groups based on the paged search criteria.", "description": "Gets an amount of groups based on the paged search criteria.", "operationId": "getGroups", "parameters": [ { "name": "size", "description": "The number of documents to gather after skip..", "in": "query", "required": false, "type": "integer" }, { "name": "pageNumber", "description": "Page number to skip.", "in": "query", "required": false, "type": "integer" }, { "name": "sortFieldName", "description": "The group field name to be sorted.", "in": "query", "required": false, "type": "string" }, { "name": "sortType", "description": "The direction of the sorting.", "in": "query", "required": false, "type": "string" }, { "name": "searchFieldName", "description": "The field name where the search will be executed.", "in": "query", "required": false, "type": "string" }, { "name": "searchValue", "description": "The search value to look into the search field name.", "in": "query", "required": false, "type": "string" } ], "responses": { "200": { "description": "PagedResponse<Group>.", "schema": { "$ref": "#/definitions/Api.Models.PagedResponse%3cCore.Models.Groups.Group%3e" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false }, "post": { "tags": [ "groups" ], "summary": "Inserts/Creates the specified group.", "description": "Inserts/Creates the specified group.", "operationId": "postGroup", "parameters": [ { "name": "group", "description": "The group.", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Core.Models.Groups.Group" } } ], "responses": { "200": { "description": "Saved Group.", "schema": { "$ref": "#/definitions/Core.Models.Groups.Group" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/groups/lookup": { "get": { "tags": [ "groups" ], "summary": "Gets all groups for whose name starts with query.", "description": "Gets all groups for whose name starts with query.", "operationId": "lookup", "parameters": [ { "name": "name", "description": "The name.", "in": "query", "required": true, "type": "string" }, { "name": "appId", "description": "The application identifier.", "in": "query", "required": false, "type": "string" }, { "name": "appletId", "description": "The applet identifier.", "in": "query", "required": false, "type": "string" }, { "name": "fieldId", "description": "The field identifier.", "in": "query", "required": false, "type": "string" }, { "name": "dashboardId", "description": "The dashboard identifier.", "in": "query", "required": false, "type": "string" }, { "name": "recordId", "description": "The record identifier.", "in": "query", "required": false, "type": "string" }, { "name": "reportId", "description": "The report identifier.", "in": "query", "required": false, "type": "string" } ], "responses": { "200": { "description": "GroupService collection.", "schema": { "items": { "$ref": "#/definitions/Core.Models.Groups.Group" }, "type": "array" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/health/ping": { "get": { "tags": [ "health" ], "summary": "A basic ping endpoint for clients to use to test connectivity to the Swimlane API.", "description": "A basic ping endpoint for clients to use to test connectivity to the Swimlane API.", "operationId": "getPing", "parameters": [], "responses": { "200": { "description": "", "schema": { "type": "object" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/health/wait/{duration}": { "get": { "tags": [ "health" ], "summary": "A basic ping endpoint for clients to use to test connectivity to the Swimlane API.", "description": "A basic ping endpoint for clients to use to test connectivity to the Swimlane API.", "operationId": "waitFor", "parameters": [ { "name": "duration", "description": "", "in": "path", "required": true, "type": "integer" } ], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.OkResult" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/health/tasksstatus": { "get": { "tags": [ "health" ], "summary": "Gets the tasks status.", "description": "Gets the tasks status.", "operationId": "getTasksStatus", "parameters": [], "responses": { "200": { "description": "Dictionary<System.String, Dictionary<System.String, System.Int32>>.", "schema": { "additionalProperties": { "additionalProperties": { "type": "integer" }, "type": "object" }, "type": "object" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/health/ldap": { "get": { "tags": [ "health" ], "summary": "Runs the directory test.", "description": "Runs the directory test.", "operationId": "runDirectoryTest", "parameters": [], "responses": { "200": { "description": "true if XXXX, false otherwise.", "schema": { "type": "boolean" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/health/": { "get": { "tags": [ "health" ], "summary": "Runs the health test.", "description": "Runs the health test.", "operationId": "runHealthTest", "parameters": [], "responses": { "200": { "description": "HealthTestResult.", "schema": { "$ref": "#/definitions/Api.Controllers.HealthController%2bHealthTestResult" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/health/probe": { "get": { "tags": [ "health" ], "summary": "Returns success response only when all necessary components are online, to indicate API is ready to accept the traffic.", "description": "Returns success response only when all necessary components are online, to indicate API is ready to accept the traffic.", "operationId": "probeApiHealth", "parameters": [], "responses": { "200": { "description": "200 if mongodb, directory services, hangfire and postgres are online, 400 otherwise.", "schema": { "type": "string" } }, "400": { "description": "200 if mongodb, directory services, hangfire and postgres are online, 400 otherwise.", "schema": { "type": "string" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/health/mongodb": { "get": { "tags": [ "health" ], "summary": "Runs the mongo database test.", "description": "Runs the mongo database test.", "operationId": "runMongoDbTest", "parameters": [], "responses": { "200": { "description": "true if XXXX, false otherwise.", "schema": { "type": "boolean" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/health/hangfire": { "get": { "tags": [ "health" ], "summary": "A basic endpoint for checking the health state of Swimalne web server.", "description": "A basic endpoint for checking the health state of Swimalne web server.", "operationId": "runHangfireHealthTest", "parameters": [], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.IActionResult" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/health/hangfire/statistics": { "get": { "tags": [ "health" ], "summary": "Returns Hangfire Jobs Statistics", "description": "Returns Hangfire Jobs Statistics", "operationId": "getHangFireStatistics", "parameters": [], "responses": { "200": { "description": "Returns the hangfire Job Statistics", "schema": { "$ref": "#/definitions/Api.Models.Health.HangfireJobStats" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/health/postgresdb": { "get": { "tags": [ "health" ], "summary": "Runs the postgres database test.", "description": "Runs the postgres database test.", "operationId": "runPostgresDbTest", "parameters": [], "responses": { "200": { "description": "", "schema": { "type": "boolean" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/icon/{id}": { "get": { "tags": [ "icon" ], "summary": "Gets the icon by id.", "description": "Gets the icon by id.", "operationId": "getIcon", "parameters": [ { "name": "id", "description": "The identifier.", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "Task<IconImageModel>.", "schema": { "$ref": "#/definitions/Api.Models.Icons.IconImageModel" } }, "404": { "description": "Task<IconImageModel>.", "schema": { "type": "string" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/icon": { "get": { "tags": [ "icon" ], "summary": "Gets the icons ordered by name. Note only thumbnail is included in results, not the full icon.", "description": "Gets the icons ordered by name. Note only thumbnail is included in results, not the full icon.", "operationId": "getIcons", "parameters": [ { "name": "page", "description": "The page to return.", "in": "query", "required": false, "type": "integer" }, { "name": "size", "description": "The number of icons to return.", "in": "query", "required": false, "type": "integer" } ], "responses": { "200": { "description": "Task<PagedResponse<IconModel>>.", "schema": { "$ref": "#/definitions/Api.Models.PagedResponse%3cApi.Models.Icons.IconModel%3e" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/logging/recent": { "post": { "tags": [ "logging" ], "summary": "Finds the recent logs.", "description": "Finds the recent logs.", "operationId": "logsFindRecent", "parameters": [ { "name": "request", "description": "", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Core.Models.Log.LogSearchBase" } } ], "responses": { "200": { "description": "Log entries collection.", "schema": { "items": { "$ref": "#/definitions/Core.Infrastructure.Logging.Layout.FullDebugLayout%2bLogData" }, "type": "array" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/logging/offset": { "post": { "tags": [ "logging" ], "summary": "Finds logs by the provided offset.", "description": "Finds logs by the provided offset.", "operationId": "logsFindOffset", "parameters": [ { "name": "request", "description": "A request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Core.Models.Log.LogSearchOffset" } } ], "responses": { "200": { "description": "Log entries collection.", "schema": { "items": { "$ref": "#/definitions/Core.Infrastructure.Logging.Layout.FullDebugLayout%2bLogData" }, "type": "array" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/logging/date": { "post": { "tags": [ "logging" ], "summary": "Finds logs before, after and equals the provided date.", "description": "Finds logs before, after and equals the provided date.", "operationId": "logsFindDate", "parameters": [ { "name": "request", "description": "A ", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Core.Models.Log.LogSearchDate" } } ], "responses": { "200": { "description": "Log entries collection.", "schema": { "items": { "$ref": "#/definitions/Core.Infrastructure.Logging.Layout.FullDebugLayout%2bLogData" }, "type": "array" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/logging/job/{jobId}": { "get": { "tags": [ "logging" ], "summary": "Gets the job information.", "description": "Gets the job information.", "operationId": "getJobInfo", "parameters": [ { "name": "jobId", "description": "The job identifier.", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "IEnumerable<JobInfo>.", "schema": { "items": { "$ref": "#/definitions/Core.Models.Jobs.JobInfo" }, "type": "array" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/logging/bulk": { "post": { "tags": [ "logging" ], "summary": "Find bulk logs by the provided criteria", "description": "Find bulk logs by the provided criteria", "operationId": "logsSearchBulk", "parameters": [ { "name": "request", "description": "A ", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Core.Models.Log.LogSearchBulk" } } ], "responses": { "200": { "description": "Log entries collection along with total number of logs for the filter", "schema": { "$ref": "#/definitions/Core.Models.Log.BulkLogs" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/otp/enroll": { "post": { "tags": [ "oneTimePassword" ], "summary": "Enrolls the current logged in user in 2FA / OTP", "description": "Enrolls the current logged in user in 2FA / OTP", "operationId": "enroll", "parameters": [ { "name": "request", "description": "The request.", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Core.Requests.OneTimePassword.Commands.EnrollOneTimePasswordCommand" } } ], "responses": { "200": { "description": "200 with OTP secret and key uri if successful, 400 if not", "schema": { "$ref": "#/definitions/Core.Requests.OneTimePassword.Commands.OneTimePasswordSecret" } }, "400": { "description": "200 with OTP secret and key uri if successful, 400 if not", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.ContentResult" } }, "401": { "description": "200 with OTP secret and key uri if successful, 400 if not", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.UnauthorizedResult" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/otp/secret/verify": { "post": { "tags": [ "oneTimePassword" ], "summary": "Verify that the secret has been correctly configured within the user's 2FA / OTP application of choice", "description": "Verify that the secret has been correctly configured within the user's 2FA / OTP application of choice", "operationId": "verifySecret", "parameters": [ { "name": "request", "description": "The one time password / 2FA request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Core.Requests.OneTimePassword.Commands.VerifyOneTimePasswordSecretCommand" } } ], "responses": { "200": { "description": "Whether (or not) the secret has been verified", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.OkObjectResult" } }, "204": { "description": "Whether (or not) the secret has been verified", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.NoContentResult" } }, "400": { "description": "Whether (or not) the secret has been verified", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.ContentResult" } }, "401": { "description": "Whether (or not) the secret has been verified", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.UnauthorizedResult" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/otp/opt-out": { "post": { "tags": [ "oneTimePassword" ], "summary": "Opts the user out of 2FA / OTP (if not enforced)", "description": "Opts the user out of 2FA / OTP (if not enforced)", "operationId": "optOut", "parameters": [ { "name": "request", "description": "The user's current account password", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Core.Requests.OneTimePassword.Commands.OptOutOfOneTimePasswordCommand" } } ], "responses": { "204": { "description": "The result", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.NoContentResult" } }, "400": { "description": "The result", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.ContentResult" } }, "200": { "description": "The result", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.IActionResult" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/otp/exempt": { "post": { "tags": [ "oneTimePassword" ], "summary": "Exempts the user from 2FA / OTP when globally enforced, requires admin\n permissions", "description": "Exempts the user from 2FA / OTP when globally enforced, requires admin\n permissions", "operationId": "exemptUserFromOtp", "parameters": [ { "name": "request", "description": "The exempt request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Core.Requests.OneTimePassword.Commands.ExemptUserFromOneTimePasswordCommand" } } ], "responses": { "204": { "description": "204 if the request succeeds, 400 or 403 otherwise", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.NoContentResult" } }, "400": { "description": "204 if the request succeeds, 400 or 403 otherwise", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.ContentResult" } }, "403": { "description": "204 if the request succeeds, 400 or 403 otherwise", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.NoContentResult" } }, "200": { "description": "204 if the request succeeds, 400 or 403 otherwise", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.IActionResult" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/otp/reset": { "post": { "tags": [ "oneTimePassword" ], "summary": "Resets OTP for a user and flags them for re-enrollment on next login, requires admin\n permissions", "description": "Resets OTP for a user and flags them for re-enrollment on next login, requires admin\n permissions", "operationId": "resetOtp", "parameters": [ { "name": "request", "description": "The reset request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Core.Requests.OneTimePassword.Commands.ResetOneTimePasswordCommand" } } ], "responses": { "204": { "description": "204 if the request succeeds, 400 or 403 otherwise", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.NoContentResult" } }, "400": { "description": "204 if the request succeeds, 400 or 403 otherwise", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.ContentResult" } }, "403": { "description": "204 if the request succeeds, 400 or 403 otherwise", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.NoContentResult" } }, "200": { "description": "204 if the request succeeds, 400 or 403 otherwise", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.IActionResult" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/pip/packages/all": { "get": { "tags": [ "pipPackage" ], "summary": "Gets all globally installed packages that were installed via Swimlane", "description": "Gets all globally installed packages that were installed via Swimlane", "operationId": "getAllInstalledPipPackages", "parameters": [], "responses": { "200": { "description": "The list of packages that were globally installed via Swimlane", "schema": { "items": { "$ref": "#/definitions/Core.Models.Python.PipPackage" }, "type": "array" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/pip/packages/{pythonVersion}": { "get": { "tags": [ "pipPackage" ], "summary": "Gets all globally installed packages that were installed via Swimlane by Python version", "description": "Gets all globally installed packages that were installed via Swimlane by Python version", "operationId": "getInstalledPipPackages", "parameters": [ { "name": "pythonVersion", "description": "", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "The list of packages that were globally installed via Swimlane", "schema": { "items": { "$ref": "#/definitions/Core.Models.Python.PipPackage" }, "type": "array" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/pip/packages/": { "post": { "tags": [ "pipPackage" ], "summary": "Globally installs the Python package with the given name and optional version number", "description": "Globally installs the Python package with the given name and optional version number", "operationId": "installPipPackage", "parameters": [ { "name": "package", "description": "The Python package to globally install", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Core.Requests.PipPackages.InstallPackageCommand" } } ], "responses": { "200": { "description": "200 if the Python package exists, 400 otherwise", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.OkResult" } }, "400": { "description": "200 if the Python package exists, 400 otherwise", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.ContentResult" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/pip/packages/offline": { "post": { "tags": [ "pipPackage" ], "summary": "Globally installs the Python package with the given name and optional version number using whl for offline installs", "description": "Globally installs the Python package with the given name and optional version number using whl for offline installs", "operationId": "installPipPackageOffline", "consumes": [ "multipart/form-data" ], "parameters": [ { "name": "pythonVersion", "description": "The python version with which to install this whl.", "in": "formData", "required": true, "type": "string", "enum": [ "Python2_7", "Python3_6", "Python3_7", "Python3", "Python3_12" ] }, { "name": "wheel", "description": "The wheel of the python package to install.", "in": "formData", "required": true, "type": "file" } ], "responses": { "200": { "description": "200 if the Python package exists, 400 otherwise", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.OkResult" } }, "400": { "description": "200 if the Python package exists, 400 otherwise", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.ContentResult" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/pip/packages/{packageName}/{pythonVersion}": { "delete": { "tags": [ "pipPackage" ], "summary": "Uninstalls a Python package that was globally installed via Swimlane", "description": "Uninstalls a Python package that was globally installed via Swimlane", "operationId": "uninstallPipPackage", "parameters": [ { "name": "packageName", "description": "The name of the Python package to uninstall", "in": "path", "required": true, "type": "string" }, { "name": "pythonVersion", "description": "", "in": "path", "required": true, "type": "string" } ], "responses": { "204": { "description": "204 if the package is installed, 404 otherwise", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.NoContentResult" } }, "404": { "description": "204 if the package is installed, 404 otherwise", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.ContentResult" } }, "200": { "description": "204 if the package is installed, 404 otherwise", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.ActionResult" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/app/{appId}/record/{id}/calc": { "post": { "tags": [ "record" ], "summary": "Calculate values for all fields.", "description": "Calculate values for all fields.", "operationId": "calculateAppAppIdRecordId", "parameters": [ { "name": "appId", "description": "The application identifier.", "in": "path", "required": true, "type": "string" }, { "name": "id", "description": "The record identifier.", "in": "path", "required": true, "type": "string" }, { "name": "record", "description": "The record.", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Core.Models.Record.Record" } } ], "responses": { "200": { "description": "Updated record with new field values.", "schema": { "$ref": "#/definitions/Core.Models.Record.Record" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/app/{appId}/record/{id}/calc/{fieldId}": { "post": { "tags": [ "record" ], "summary": "Calculate field value.", "description": "Result can be string, date or number.", "operationId": "calculateAppAppIdRecordIdFieldId", "parameters": [ { "name": "appId", "description": "The application identifier.", "in": "path", "required": true, "type": "string" }, { "name": "id", "description": "The record identifier", "in": "path", "required": true, "type": "string" }, { "name": "fieldId", "description": "The field identifier.", "in": "path", "required": true, "type": "string" }, { "name": "record", "description": "The record.", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Core.Models.Record.Record" } } ], "responses": { "200": { "description": "Calculation result.", "schema": { "type": "object" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/app/{appId}/record": { "get": { "tags": [ "record" ], "summary": "Gets the base record for an application.", "description": "Gets the base record for an application.", "operationId": "getAppAppIdRecord", "parameters": [ { "name": "appId", "description": "The application identifier.", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "Record.", "schema": { "$ref": "#/definitions/Core.Models.Record.Record" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false }, "put": { "tags": [ "record" ], "summary": "Updates the specified record.", "description": "Updates the specified record.", "operationId": "putAppAppIdRecord", "parameters": [ { "name": "appId", "description": "The application identifier", "in": "path", "required": true, "type": "string" }, { "name": "model", "description": "The model.", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Core.Models.Record.Record" } } ], "responses": { "200": { "description": "Record.", "schema": { "$ref": "#/definitions/Core.Models.Record.Record" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false }, "post": { "tags": [ "record" ], "summary": "Insert/Create the record.", "description": "The bare minimum you need to send\n is (assuming application id is 5667113fd273a205bc747cf0):\n ```\n {\n \"applicationId\": \"5667113fd273a205bc747cf0\",\n \"values\": {\n \"$type\": \"System.Collections.Generic.Dictionary`2[[System.String, mscorlib],[System.Object, mscorlib]], mscorlib\",\n \"56674c5cc6c7dea0aeab4aed\": \"A new value\"\n }\n ```", "operationId": "postAppAppIdRecord", "parameters": [ { "name": "appId", "description": "The application identifier", "in": "path", "required": true, "type": "string" }, { "name": "model", "description": "The record.", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Core.Models.Record.Record" } } ], "responses": { "200": { "description": "Saved record.", "schema": { "$ref": "#/definitions/Core.Models.Record.Record" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false }, "delete": { "tags": [ "record" ], "summary": "Deletes all records for identified application.", "description": "Deletes all records for identified application.", "operationId": "deleteAppAppIdRecord", "parameters": [ { "name": "appId", "description": "The application identifier.", "in": "path", "required": true, "type": "string" } ], "responses": { "204": { "description": "NoContentResult.", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.NoContentResult" } }, "400": { "description": "NoContentResult.", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.BadRequestObjectResult" } }, "404": { "description": "NoContentResult.", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.NotFoundObjectResult" } }, "200": { "description": "NoContentResult.", "schema": { "type": "object" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/app/{appId}/record/{id}": { "get": { "tags": [ "record" ], "summary": "Gets the application application identifier record identifier.", "description": "Gets the application application identifier record identifier.", "operationId": "getAppAppIdRecordId", "parameters": [ { "name": "appId", "description": "The application identifier.", "in": "path", "required": true, "type": "string" }, { "name": "id", "description": "The identifier.", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "Record.", "schema": { "$ref": "#/definitions/Core.Models.Record.Record" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false }, "put": { "tags": [ "record" ], "summary": "Updates the specified record.", "description": "Updates the specified record.", "operationId": "putAppAppIdRecordId", "parameters": [ { "name": "appId", "description": "The application identifier", "in": "path", "required": true, "type": "string" }, { "name": "id", "description": "The record identifier", "in": "path", "required": true, "type": "string" }, { "name": "model", "description": "The model.", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Core.Models.Record.Record" } } ], "responses": { "200": { "description": "Record.", "schema": { "$ref": "#/definitions/Core.Models.Record.Record" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false }, "delete": { "tags": [ "record" ], "summary": "Deletes the specified record.", "description": "Deletes the specified record.", "operationId": "deleteAppAppIdRecordId", "parameters": [ { "name": "appId", "description": "The application identifier", "in": "path", "required": true, "type": "string" }, { "name": "id", "description": "The identifier.", "in": "path", "required": true, "type": "string" } ], "responses": { "204": { "description": "IActionResult.", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.NoContentResult" } }, "404": { "description": "IActionResult.", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.NotFoundObjectResult" } }, "200": { "description": "IActionResult.", "schema": { "type": "object" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false }, "patch": { "tags": [ "record" ], "summary": "Updates the record values", "description": "Updates the record values", "operationId": "patchAppAppIdRecordId", "parameters": [ { "name": "appId", "description": "The application identifier", "in": "path", "required": true, "type": "string" }, { "name": "id", "description": "The record identifier", "in": "path", "required": true, "type": "string" }, { "name": "record", "description": "The model.", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Core.Models.Record.Record" } } ], "responses": { "200": { "description": "Record.", "schema": { "$ref": "#/definitions/Core.Models.Record.Record" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/app/{appId}/record/tracking/{trackingId}": { "get": { "tags": [ "record" ], "summary": "Gets a record by tracking Id for an application", "description": "Gets a record by tracking Id for an application", "operationId": "getRecordAppIdTrackingId", "parameters": [ { "name": "appId", "description": "The application identifier.", "in": "path", "required": true, "type": "string" }, { "name": "trackingId", "description": "The tracking Id for the record requested.", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "Record.", "schema": { "$ref": "#/definitions/Core.Models.Record.Record" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/app/{appId}/record/{id}/references": { "post": { "tags": [ "record" ], "summary": "Gets the referenced records by fields if specified.", "description": "Gets the referenced records by fields if specified.", "operationId": "getAppRecordReferences", "parameters": [ { "name": "appId", "description": "The application identifier", "in": "path", "required": true, "type": "string" }, { "name": "id", "description": "The record id.", "in": "path", "required": true, "type": "string" }, { "name": "model", "description": "The record reference model containing a list of field and record ids.", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Api.Models.Record.RecordReferencesModel" } } ], "responses": { "200": { "description": "IEnumerable<ReferencedRecord>.", "schema": { "items": { "$ref": "#/definitions/Core.Models.Record.ReferencedRecord" }, "type": "array" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/app/{appId}/record/{id}/correlations": { "get": { "tags": [ "record" ], "operationId": "getCorrelatedChildRecords", "parameters": [ { "name": "appId", "description": "", "in": "path", "required": true, "type": "string" }, { "name": "id", "description": "", "in": "path", "required": true, "type": "string" }, { "name": "fieldIds", "description": "", "in": "query", "required": true, "collectionFormat": "csv", "type": "array", "items": { "type": "string" } } ], "responses": { "200": { "description": "", "schema": { "items": { "$ref": "#/definitions/Core.Models.Record.ReferencedRecord" }, "type": "array" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/app/{appId}/record/validate": { "post": { "tags": [ "record" ], "summary": "Insert/Create the record.", "description": "Insert/Create the record.", "operationId": "postAppAppIdRecordValidate", "parameters": [ { "name": "appId", "description": "The application identifier", "in": "path", "required": true, "type": "string" }, { "name": "record", "description": "The record.", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Core.Models.Record.Record" } } ], "responses": { "200": { "description": "Saved record.", "schema": { "$ref": "#/definitions/Core.Models.Base.DatabaseResult" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/app/{appId}/record/batch": { "put": { "tags": [ "record" ], "summary": "Update records in batch mode.", "description": "Updates records based on sent ids or query (filters) with new Values provided.\n Field identification in values can be id, name or key.", "operationId": "bulkUpdate", "parameters": [ { "name": "appId", "description": "Application id, for records needed to be removed.", "in": "path", "required": true, "type": "string" }, { "name": "batchRequest", "description": "Definition of the scope of records and new values.\n applicationId is ignored in favor of appId from route.\n Must provide either recordIds or filters.\n modifications are mandatory.", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Core.Models.Record.Batch.BatchRequest" } } ], "responses": { "202": { "description": "Accepted with JobId of a task.", "schema": { "type": "string" } }, "200": { "description": "Accepted with JobId of a task.", "schema": { "type": "object" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false }, "post": { "tags": [ "record" ], "operationId": "postAppAppIdRecordBatch", "parameters": [ { "name": "appId", "description": "", "in": "path", "required": true, "type": "string" }, { "name": "records", "description": "", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/Core.Models.Record.Record" }, "type": "array" } } ], "responses": { "200": { "description": "", "schema": { "items": { "type": "string" }, "type": "array" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false }, "delete": { "tags": [ "record" ], "summary": "Delete records in batch mode.", "description": "Delete records based on sent ids or query (filters).", "operationId": "batchDelete", "parameters": [ { "name": "appId", "description": "Application id, for records needed to be removed.", "in": "path", "required": true, "type": "string" }, { "name": "batchRequest", "description": "Definition of the scope of records.\n applicationId is ignored in favor of appId from route.\n Must provide either recordIds or filters.\n modifications are not used and should be ommited.", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Core.Models.Record.Batch.BatchRequest" } } ], "responses": { "202": { "description": "Accepted with JobId of a task.", "schema": { "type": "string" } }, "200": { "description": "Accepted with JobId of a task.", "schema": { "type": "object" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/app/{appId}/record/{id}/restrict": { "put": { "tags": [ "record" ], "operationId": "restrictRecord", "parameters": [ { "name": "appId", "description": "", "in": "path", "required": true, "type": "string" }, { "name": "id", "description": "", "in": "path", "required": true, "type": "string" }, { "name": "allowed", "description": "", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/Core.Models.Utilities.UserGroupSelection" }, "type": "array" } } ], "responses": { "204": { "description": "", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.NoContentResult" } }, "200": { "description": "", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.NoContentResult" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/app/{appId}/record/{recordId}/add-references": { "post": { "tags": [ "record" ], "summary": "Add references to an existing record.", "description": "Add references to an existing record.", "operationId": "postAppAppIdRecordIdReference", "parameters": [ { "name": "appId", "description": "The referencing application identifer", "in": "path", "required": true, "type": "string" }, { "name": "recordId", "description": "The referencing record identifer", "in": "path", "required": true, "type": "string" }, { "name": "model", "description": "The payload containing a fieldId and targetRecordIds properties.", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Api.Models.Record.AddReferenceModel" } } ], "responses": { "200": { "description": "NoContentResult.", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.NoContentResult" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/app/{appId}/record/{recordId}/{fieldId}/comment": { "post": { "tags": [ "record" ], "summary": "Add a comment to a existing record.", "description": "Add a comment to a existing record.", "operationId": "postAppAppIdRecordIdComment", "parameters": [ { "name": "appId", "description": "The application identifier", "in": "path", "required": true, "type": "string" }, { "name": "recordId", "description": "The record identifier", "in": "path", "required": true, "type": "string" }, { "name": "fieldId", "description": "The field identifier", "in": "path", "required": true, "type": "string" }, { "name": "model", "description": "The comment model", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Core.Models.Record.Comments" } } ], "responses": { "204": { "description": "NoContentResult.", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.NoContentResult" } }, "200": { "description": "NoContentResult.", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.NoContentResult" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/app/{appId}/record/{recordId}/{fieldId}/comment/{index}": { "put": { "tags": [ "record" ], "summary": "Update a comment from an existing record.", "description": "Update a comment from an existing record.", "operationId": "putAppAppIdRecordIdComment", "parameters": [ { "name": "appId", "description": "The application identifier", "in": "path", "required": true, "type": "string" }, { "name": "recordId", "description": "The record identifier", "in": "path", "required": true, "type": "string" }, { "name": "fieldId", "description": "The field identifier", "in": "path", "required": true, "type": "string" }, { "name": "message", "description": "The comment message", "in": "body", "required": true, "schema": { "type": "string" } }, { "name": "index", "description": "The index of the comment to be updated", "in": "path", "required": true, "type": "integer" } ], "responses": { "204": { "description": "NoContentResult.", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.NoContentResult" } }, "200": { "description": "NoContentResult.", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.NoContentResult" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/app/{appId}/record/{recordId}/lock": { "post": { "tags": [ "record" ], "summary": "Locks the specified record", "description": "Locks the specified record", "operationId": "lockRecord", "parameters": [ { "name": "appId", "description": "The application identifier", "in": "path", "required": true, "type": "string" }, { "name": "recordId", "description": "The record identifier", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "IActionResult.", "schema": { "type": "object" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/app/{appId}/record/{recordId}/unlock": { "post": { "tags": [ "record" ], "summary": "Un-Locks the specified record", "description": "Un-Locks the specified record", "operationId": "unLockRecord", "parameters": [ { "name": "appId", "description": "The application identifier", "in": "path", "required": true, "type": "string" }, { "name": "recordId", "description": "The record identifier", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "IActionResult.", "schema": { "type": "object" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/app/{appId}/record/{id}/unique/{fieldId}": { "post": { "tags": [ "record" ], "summary": "Validates the field has unique values across the records.", "description": "Validates the field has unique values across the records.", "operationId": "validateFieldUniqueValues", "parameters": [ { "name": "appId", "description": "The application identifier.", "in": "path", "required": true, "type": "string" }, { "name": "fieldId", "description": "The field identifier.", "in": "path", "required": true, "type": "string" }, { "name": "id", "description": "The record identifier.", "in": "path", "required": true, "type": "string" }, { "name": "model", "description": "The model?", "in": "body", "required": true, "schema": { "type": "object" } } ], "responses": { "200": { "description": "The validation result.", "schema": { "$ref": "#/definitions/Core.Models.Record.UniqueValidationResult" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/app/{appId}/record/{id}/history": { "get": { "tags": [ "record" ], "summary": "Gets the revision history for specified record.", "description": "Gets the revision history for specified record.", "operationId": "getAppAppIdRecordIdHistory", "parameters": [ { "name": "appId", "description": "The application identifier", "in": "path", "required": true, "type": "string" }, { "name": "id", "description": "The identifier.", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "The revisons collection.", "schema": { "items": { "$ref": "#/definitions/Core.Models.History.Revision" }, "type": "array" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/app/{appId}/record/{id}/history/{revision}": { "get": { "tags": [ "record" ], "summary": "Gets the specified revision of the record.", "description": "Gets the specified revision of the record.", "operationId": "getAppAppIdRecordIdHistoryRevision", "parameters": [ { "name": "appId", "description": "The application identifier", "in": "path", "required": true, "type": "string" }, { "name": "id", "description": "The record identifier.", "in": "path", "required": true, "type": "string" }, { "name": "revision", "description": "The revision number.", "in": "path", "required": true, "type": "number" } ], "responses": { "200": { "description": "The Revision", "schema": { "$ref": "#/definitions/Core.Models.History.Revision" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/app/{appId}/record/{id}/history/{revision}/diff": { "get": { "tags": [ "record" ], "summary": "Gets the diff between revision of the record and the current record.", "description": "Gets the diff between revision of the record and the current record.", "operationId": "getAppAppIdRecordIdHistorySinceRevision", "parameters": [ { "name": "appId", "description": "The application identifier", "in": "path", "required": true, "type": "string" }, { "name": "id", "description": "The record identifier.", "in": "path", "required": true, "type": "string" }, { "name": "revision", "description": "The revision number.", "in": "path", "required": true, "type": "number" } ], "responses": { "200": { "description": "The Revision", "schema": { "$ref": "#/definitions/Core.Models.History.RecordHistory" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/app/{appId}/record/{id}/export/{formatId}": { "get": { "tags": [ "record" ], "summary": "Generates a formatted export of a record.", "description": "Generates a formatted export of a record.", "operationId": "getExport", "parameters": [ { "name": "appId", "description": "The application identifier", "in": "path", "required": true, "type": "string" }, { "name": "id", "description": "The record identifier of the record to export", "in": "path", "required": true, "type": "string" }, { "name": "formatId", "description": "The format identifier of the lay", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "The exported record in the specified format", "schema": { "type": "object" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/app/{appId}/record/underEdit": { "get": { "tags": [ "record" ], "summary": "Gets the number of the records currently being edited for specified application.", "description": "Gets the number of the records currently being edited for specified application.", "operationId": "getRecordsUnderEdit", "parameters": [ { "name": "appId", "description": "The application identifier.", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "The number records currently being edited, that belong to this application", "schema": { "type": "integer" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/app/{appId}/record/correlation/reassign": { "post": { "tags": [ "record" ], "summary": "Reassigns or unassigns the correlation for records.", "description": "Reassigns or unassigns the correlation for records.", "operationId": "reAssignCorrelation", "parameters": [ { "name": "appId", "description": "The application id.", "in": "path", "required": true, "type": "string" }, { "name": "correlationReassignRequest", "description": "The correlation reassign request model.", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Core.Models.Record.CorrelationReassignRequest" } } ], "responses": { "200": { "description": "IActionResult", "schema": { "items": { "$ref": "#/definitions/Core.Models.Base.DatabaseResult" }, "type": "array" } }, "400": { "description": "IActionResult", "schema": { "items": { "$ref": "#/definitions/Core.Models.Base.DatabaseResult" }, "type": "array" } }, "404": { "description": "IActionResult", "schema": { "type": "string" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/reports/{id}": { "get": { "tags": [ "reports" ], "summary": "Gets the specified report.", "description": "Gets the specified report.", "operationId": "getReport", "parameters": [ { "name": "id", "description": "The identifier.", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "Report.", "schema": { "$ref": "#/definitions/Core.Models.Search.Report" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false }, "put": { "tags": [ "reports" ], "summary": "Updates the specified report.", "description": "Updates the specified report.", "operationId": "putReportAsync", "parameters": [ { "name": "id", "description": "The report identifier", "in": "path", "required": true, "type": "string" }, { "name": "model", "description": "The report.", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Core.Models.Search.Report" } } ], "responses": { "200": { "description": "Saved Report.", "schema": { "$ref": "#/definitions/Core.Models.Search.Report" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false }, "delete": { "tags": [ "reports" ], "summary": "Deletes the specified report.", "description": "Deletes the specified report.", "operationId": "deleteReportAsync", "parameters": [ { "name": "id", "description": "The identifier.", "in": "path", "required": true, "type": "string" } ], "responses": { "204": { "description": "NoContentResult.", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.NoContentResult" } }, "200": { "description": "NoContentResult.", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.NoContentResult" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/reports/app/{appId}": { "get": { "tags": [ "reports" ], "summary": "Gets the reports for specific application.", "description": "Gets the reports for specific application.", "operationId": "getReportsAppAppId", "parameters": [ { "name": "appId", "description": "The application identifier.", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "IEnumerable<Report>.", "schema": { "items": { "$ref": "#/definitions/Core.Models.Search.Report" }, "type": "array" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false }, "delete": { "tags": [ "reports" ], "summary": "Delete reports by application.", "description": "Delete reports by application.", "operationId": "deleteByApplicationAsync", "parameters": [ { "name": "appId", "description": "The application identifier.", "in": "path", "required": true, "type": "string" } ], "responses": { "204": { "description": "NoContentResult.", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.NoContentResult" } }, "200": { "description": "NoContentResult.", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.NoContentResult" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/reports": { "get": { "tags": [ "reports" ], "summary": "Gets all reports.", "description": "Gets all reports.", "operationId": "getReports", "parameters": [], "responses": { "200": { "description": "IEnumerable<Report>.", "schema": { "items": { "$ref": "#/definitions/Core.Models.Search.Report" }, "type": "array" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false }, "post": { "tags": [ "reports" ], "summary": "Inserts/Creates the specified report.", "description": "Inserts/Creates the specified report.", "operationId": "postReportAsync", "parameters": [ { "name": "model", "description": "The report.", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Core.Models.Search.Report" } } ], "responses": { "200": { "description": "Saved Report.", "schema": { "$ref": "#/definitions/Core.Models.Search.Report" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/reports/app/{id}/default": { "get": { "tags": [ "reports" ], "summary": "Gets the default report for the application.", "description": "Gets the default report for the application.", "operationId": "getReportsAppIdDefault", "parameters": [ { "name": "id", "description": "The application identifier.", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "The Report", "schema": { "$ref": "#/definitions/Core.Models.Search.Report" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/reports/workspace/{id}": { "get": { "tags": [ "reports" ], "summary": "Gets the reports in the workspace.", "description": "Gets the reports in the workspace.", "operationId": "getReportsWorkspaceId", "parameters": [ { "name": "id", "description": "The workspace identifier.", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "The Report collection.", "schema": { "items": { "$ref": "#/definitions/Core.Models.Search.Report" }, "type": "array" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/reports/": { "put": { "tags": [ "reports" ], "summary": "Updates the specified report.", "description": "Updates the specified report.", "operationId": "putReportOldAsync", "parameters": [ { "name": "model", "description": "The report.", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Core.Models.Search.Report" } } ], "responses": { "200": { "description": "Saved Report.", "schema": { "$ref": "#/definitions/Core.Models.Search.Report" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/reports/status/workspace/{id}": { "get": { "tags": [ "reports" ], "summary": "Gets a Dictionary with the report ids with a status enabled or disabled if has schedules reports, if the report does not have schedules will not be added to the dictionary.", "description": "Gets a Dictionary with the report ids with a status enabled or disabled if has schedules reports, if the report does not have schedules will not be added to the dictionary.", "operationId": "getReportsWithScheduledReportsStatusByWorkspace", "parameters": [ { "name": "id", "description": "", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "The Dictionary with the report ids and their status calculated.", "schema": { "additionalProperties": { "type": "string" }, "type": "object" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/roles/{id}": { "get": { "tags": [ "roles" ], "summary": "Gets the specified role.", "description": "Gets the specified role.", "operationId": "getRole", "parameters": [ { "name": "id", "description": "The role identifier.", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "The role.", "schema": { "$ref": "#/definitions/Core.Models.Roles.Role" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false }, "put": { "tags": [ "roles" ], "summary": "Updates the specified role.", "description": "Updates the specified role.", "operationId": "putRole", "parameters": [ { "name": "id", "description": "The role identifier.", "in": "path", "required": true, "type": "string" }, { "name": "model", "description": "The role.", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Core.Models.Roles.Role" } } ], "responses": { "200": { "description": "Saved role", "schema": { "$ref": "#/definitions/Core.Models.Roles.Role" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false }, "delete": { "tags": [ "roles" ], "summary": "Deletes the specified role.", "description": "Deletes the specified role.", "operationId": "deleteRole", "parameters": [ { "name": "id", "description": "The role identifier.", "in": "path", "required": true, "type": "string" } ], "responses": { "204": { "description": "IActionResult.", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.NoContentResult" } }, "404": { "description": "IActionResult.", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.NotFoundObjectResult" } }, "200": { "description": "IActionResult.", "schema": { "type": "object" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/roles/": { "get": { "tags": [ "roles" ], "summary": "Gets an amount of roles based on the paged search criteria.", "description": "Gets an amount of roles based on the paged search criteria.", "operationId": "getRoles", "parameters": [ { "name": "size", "description": "The number of documents to gather after skip..", "in": "query", "required": false, "type": "integer" }, { "name": "pageNumber", "description": "Page number to skip.", "in": "query", "required": false, "type": "integer" }, { "name": "sortFieldName", "description": "The roles field name to be sorted.", "in": "query", "required": false, "type": "string" }, { "name": "sortType", "description": "The direction of the sorting.", "in": "query", "required": false, "type": "string" }, { "name": "searchFieldName", "description": "The field name where the search will be executed.", "in": "query", "required": false, "type": "string" }, { "name": "searchValue", "description": "The search value to look into the search field name.", "in": "query", "required": false, "type": "string" } ], "responses": { "200": { "description": "PagedResponse<Role>.", "schema": { "$ref": "#/definitions/Api.Models.PagedResponse%3cCore.Models.Roles.Role%3e" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false }, "post": { "tags": [ "roles" ], "summary": "Inserts/Creates the role.", "description": "Inserts/Creates the role.", "operationId": "postRole", "parameters": [ { "name": "model", "description": "The role.", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Core.Models.Roles.Role" } } ], "responses": { "200": { "description": "Saved role", "schema": { "$ref": "#/definitions/Core.Models.Roles.Role" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/roles/light": { "get": { "tags": [ "roles" ], "summary": "Gets the light models of the roles.", "description": "Gets the light models of the roles.", "operationId": "getRolesLight", "parameters": [], "responses": { "200": { "description": "The RoleView model", "schema": { "items": { "$ref": "#/definitions/Core.Models.Base.Entity" }, "type": "array" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/saml/enabled": { "get": { "tags": [ "saml" ], "summary": "Gets a SAML AuthnRequest", "description": "Required so the UI can determine if SAML is enabled before the user has logged in.", "operationId": "getSamlEnabled", "parameters": [], "responses": { "200": { "description": "True if", "schema": { "type": "boolean" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/scheduled/dashboard": { "get": { "tags": [ "scheduledDashboard" ], "summary": "Gets all schedule dashboards", "description": "Gets all schedule dashboards", "operationId": "getScheduledDashboardsAsync", "parameters": [], "responses": { "200": { "description": "IEnumerable<Dashboard>", "schema": { "items": { "$ref": "#/definitions/Api.Models.Report.ScheduledViewModel" }, "type": "array" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false }, "post": { "tags": [ "scheduledDashboard" ], "summary": "Inserts/Creates the specified scheduled dashboard", "description": "Inserts/Creates the specified scheduled dashboard", "operationId": "postScheduledDashboardAsync", "parameters": [ { "name": "viewModel", "description": "The scheduled viewModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Api.Models.Report.ScheduledViewModel" } } ], "responses": { "200": { "description": "Saved Scheduled Dashboard", "schema": { "$ref": "#/definitions/Api.Models.Report.ScheduledViewModel" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/scheduled/dashboard/{dashboardId}": { "get": { "tags": [ "scheduledDashboard" ], "summary": "Gets scheduled dashboards by dashboard id", "description": "Gets scheduled dashboards by dashboard id", "operationId": "getScheduledDashboardsByIdAsync", "parameters": [ { "name": "dashboardId", "description": "The dashboard identifier", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "IEnumerable<Scheduled Dashboard>", "schema": { "items": { "$ref": "#/definitions/Api.Models.Report.ScheduledViewModel" }, "type": "array" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false }, "put": { "tags": [ "scheduledDashboard" ], "summary": "Updates the specified scheduled dashboard", "description": "Updates the specified scheduled dashboard", "operationId": "putScheduledDashboardAsync", "parameters": [ { "name": "dashboardId", "description": "The scheduled dashboard identifier", "in": "path", "required": true, "type": "string" }, { "name": "viewModel", "description": "The scheduled viewModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Api.Models.Report.ScheduledViewModel" } } ], "responses": { "200": { "description": "Saved Scheduled Dashboard", "schema": { "$ref": "#/definitions/Api.Models.Report.ScheduledViewModel" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false }, "delete": { "tags": [ "scheduledDashboard" ], "summary": "Deletes the specified scheduled dashboard", "description": "Deletes the specified scheduled dashboard", "operationId": "deleteScheduledDashboardAsync", "parameters": [ { "name": "dashboardId", "description": "The scheduled dashboard identifier", "in": "path", "required": true, "type": "string" } ], "responses": { "204": { "description": "IActionResult", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.NoContentResult" } }, "400": { "description": "IActionResult", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.BadRequestObjectResult" } }, "404": { "description": "IActionResult", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.NotFoundObjectResult" } }, "200": { "description": "IActionResult", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.IActionResult" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/scheduled/reports": { "get": { "tags": [ "scheduledReport" ], "summary": "Gets all schedule reports", "description": "Gets all schedule reports", "operationId": "getScheduledReportsAsync", "parameters": [], "responses": { "200": { "description": "IEnumerable<Report>", "schema": { "items": { "$ref": "#/definitions/Api.Models.Report.ScheduledViewModel" }, "type": "array" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/scheduled/report/{reportId}": { "get": { "tags": [ "scheduledReport" ], "summary": "Gets schedule reports by report id", "description": "Gets schedule reports by report id", "operationId": "getScheduledReportsByIdAsync", "parameters": [ { "name": "reportId", "description": "", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "IEnumerable<Scheduled Report>", "schema": { "items": { "$ref": "#/definitions/Api.Models.Report.ScheduledViewModel" }, "type": "array" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/scheduled/{scheduledId}": { "get": { "tags": [ "scheduledReport" ], "summary": "Gets scheduled report by id", "description": "Gets scheduled report by id", "operationId": "getSchedulesByIdAsync", "parameters": [ { "name": "scheduledId", "description": "", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "Scheduled Report", "schema": { "$ref": "#/definitions/Api.Models.Report.ScheduledViewModel" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false }, "put": { "tags": [ "scheduledReport" ], "summary": "Updates the specified scheduled report", "description": "Updates the specified scheduled report", "operationId": "putScheduledReportAsync", "parameters": [ { "name": "scheduledId", "description": "The scheduled report identifier", "in": "path", "required": true, "type": "string" }, { "name": "viewModel", "description": "The scheduled viewModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Api.Models.Report.ScheduledViewModel" } } ], "responses": { "200": { "description": "Saved Scheduled Report", "schema": { "$ref": "#/definitions/Api.Models.Report.ScheduledViewModel" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false }, "delete": { "tags": [ "scheduledReport" ], "summary": "Deletes the specified scheduled report", "description": "Deletes the specified scheduled report", "operationId": "deleteScheduledReportAsync", "parameters": [ { "name": "scheduledId", "description": "The scheduled report identifier", "in": "path", "required": true, "type": "string" } ], "responses": { "204": { "description": "NoContentResult", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.NoContentResult" } }, "400": { "description": "NoContentResult", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.BadRequestObjectResult" } }, "404": { "description": "NoContentResult", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.NotFoundObjectResult" } }, "200": { "description": "NoContentResult", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.IActionResult" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/scheduled": { "post": { "tags": [ "scheduledReport" ], "summary": "Inserts/Creates the specified scheduled report", "description": "Inserts/Creates the specified scheduled report", "operationId": "postScheduledReportAsync", "parameters": [ { "name": "viewModel", "description": "The scheduled viewModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Api.Models.Report.ScheduledViewModel" } } ], "responses": { "200": { "description": "Saved Scheduled Report", "schema": { "$ref": "#/definitions/Api.Models.Report.ScheduledViewModel" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/search/stats": { "post": { "tags": [ "search" ], "summary": "Gets statistics for defined on report.", "description": "Gets statistics for defined on report.", "operationId": "getSearchStats", "parameters": [ { "name": "report", "description": "The report.", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Core.Models.Search.StatsReport" } } ], "responses": { "200": { "description": "Object collection.", "schema": { "items": {}, "type": "array" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/search/keyword": { "get": { "tags": [ "search" ], "summary": "Gets the search result.", "description": "Gets the search result.", "operationId": "getKeywordSearch", "parameters": [ { "name": "keywords", "description": "The keywords to search.", "in": "query", "required": true, "type": "string" }, { "name": "page", "description": "The page to return.", "in": "query", "required": false, "type": "integer" }, { "name": "size", "description": "The number of results to return.", "in": "query", "required": false, "type": "integer" } ], "responses": { "200": { "description": "GroupedSearchResults", "schema": { "$ref": "#/definitions/Core.Requests.Search.Queries.SearchReportKeywordResult" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false }, "post": { "tags": [ "search" ], "summary": "Gets the search result.", "description": "Gets the search result.", "operationId": "postKeywordSearch", "parameters": [ { "name": "report", "description": "The report to query.", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Core.Models.Search.Report" } }, { "name": "page", "description": "The page to return.", "in": "query", "required": false, "type": "integer" }, { "name": "size", "description": "The number of results to return.", "in": "query", "required": false, "type": "integer" } ], "responses": { "200": { "description": "GroupedSearchResults", "schema": { "$ref": "#/definitions/Core.Requests.Search.Queries.SearchReportKeywordResult" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/search/": { "post": { "tags": [ "search" ], "summary": "Gets the search result.", "description": "Gets the search result.", "operationId": "search", "parameters": [ { "name": "report", "description": "The report.", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Core.Models.Search.Report" } } ], "responses": { "200": { "description": "GroupedSearchResults", "schema": { "$ref": "#/definitions/Api.Models.Search.GroupedSearchResults" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/search/export/{id}": { "get": { "tags": [ "search" ], "summary": "Exports the specified identifier.", "description": "Exports the specified identifier.", "operationId": "export", "parameters": [ { "name": "id", "description": "The identifier.", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "Task<FileResult>.", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.FileResult" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/search/export": { "post": { "tags": [ "search" ], "summary": "Exports the report.", "description": "Exports the report.", "operationId": "exportReport", "parameters": [ { "name": "report", "description": "The report.", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Core.Models.Search.Report" } } ], "responses": { "200": { "description": "Task<FileResult>.", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.FileResult" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/settings/features": { "get": { "tags": [ "settings" ], "summary": "Gets all the externally visible feature flags", "description": "Gets all the externally visible feature flags", "operationId": "getUserFeatures", "parameters": [], "responses": { "200": { "description": "List of feature flags", "schema": { "items": { "$ref": "#/definitions/Core.Models.FeatureFlags.FeatureFlag" }, "type": "array" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/settings/features/enabled": { "get": { "tags": [ "settings" ], "summary": "Gets all of the externally visible feature flags", "description": "Gets all of the externally visible feature flags", "operationId": "getEnabledFeatures", "parameters": [], "responses": { "200": { "description": "List of feature flags", "schema": { "items": { "$ref": "#/definitions/Core.Models.FeatureFlags.FeatureFlag" }, "type": "array" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/settings/features/{id}": { "post": { "tags": [ "settings" ], "summary": "Enables or disables a feature flag", "description": "Enables or disables a feature flag", "operationId": "toggleFeature", "parameters": [ { "name": "id", "description": "", "in": "path", "required": true, "type": "string" }, { "name": "toggleFeatureRequest", "description": "", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Api.Models.Settings.ToggleFeatureRequestModel" } } ], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/Core.Models.FeatureFlags.FeatureFlag" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/settings/timezones/": { "get": { "tags": [ "settings" ], "summary": "Get all available system time zones.", "description": "Get all available system time zones.", "operationId": "getAllTimeZones", "parameters": [], "responses": { "200": { "description": "List of available time zones.", "schema": { "items": { "type": "string" }, "type": "array" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/settings/ldap/validategroups": { "post": { "tags": [ "settings" ], "summary": "Checks that the Active Directory groups are valid.", "description": "Admin only.", "operationId": "validateActiveDirectoryGroups", "parameters": [ { "name": "viewModel", "description": "A view model with a Domain property to test against and a Group property with a list of groups to validate", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Api.Models.Settings.ValidateGroupViewModel" } } ], "responses": { "200": { "description": "A Successful property with a value of true if all groups are valid. The Reason property lists the invalid groups if any.", "schema": { "$ref": "#/definitions/Api.Models.Settings.ConnectionTestResult" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/settings/ldap/defaultsettings": { "get": { "tags": [ "settings" ], "summary": "Gets the default directory settings.", "description": "Gets the default directory settings.", "operationId": "getDefaultDirectorySettings", "parameters": [ { "name": "type", "description": "The type.", "in": "query", "required": true, "type": "string", "enum": [ "OpenLdap", "ActiveDirectory" ] } ], "responses": { "200": { "description": "DirectorySettings.", "schema": { "$ref": "#/definitions/Core.Models.Settings.DirectorySettings" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/settings/": { "get": { "tags": [ "settings" ], "summary": "Gets the global settings.", "description": "Gets the global settings.", "operationId": "getSettings", "parameters": [], "responses": { "200": { "description": "Global settings", "schema": { "$ref": "#/definitions/Core.Models.Settings.GlobalSettings" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false }, "put": { "tags": [ "settings" ], "summary": "Updates global settings.", "description": "Updates global settings.", "operationId": "putSettings", "parameters": [ { "name": "model", "description": "The global settings.", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Core.Models.Settings.GlobalSettings" } } ], "responses": { "200": { "description": "Saved global settings.", "schema": { "$ref": "#/definitions/Core.Models.Settings.GlobalSettings" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/settings/schedule": { "get": { "tags": [ "settings" ], "summary": "Gets the scheduled report settings.", "description": "Gets the scheduled report settings.", "operationId": "getScheduledReportSettingsAsync", "parameters": [], "responses": { "200": { "description": "Scheduled report settings.", "schema": { "$ref": "#/definitions/Core.Models.Settings.ScheduledReportSettings" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/settings/mailsettings/test": { "get": { "tags": [ "settings" ], "summary": "ValidateMailSettings", "description": "ValidateMailSettings", "operationId": "validateMailSettings", "parameters": [], "responses": { "200": { "description": "", "schema": { "type": "boolean" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/settings/version": { "get": { "tags": [ "settings" ], "summary": "Gets the API version.", "description": "Gets the API version.", "operationId": "getAPIVersion", "parameters": [], "responses": { "200": { "description": "System.String.", "schema": { "type": "string" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/settings/python3-version": { "get": { "tags": [ "settings" ], "summary": "Gets the Python 3 version.", "description": "Gets the Python 3 version.", "operationId": "getPython3Version", "parameters": [], "responses": { "200": { "description": "System.String.", "schema": { "type": "string" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/settings/login-banner": { "get": { "tags": [ "settings" ], "summary": "Gets the login banner.", "description": "Gets the login banner.", "operationId": "getLoginBanner", "parameters": [], "responses": { "200": { "description": "Login banner text.", "schema": { "type": "object" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/settings/upgrade-status": { "get": { "tags": [ "settings" ], "summary": "Checks whether the application is in the process of upgrading.", "description": "Checks whether the application is in the process of upgrading.", "operationId": "getUpgradeStatus", "parameters": [], "responses": { "200": { "description": "Upgrade status of the application", "schema": { "type": "boolean" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/settings/password-complexity": { "get": { "tags": [ "settings" ], "summary": "Gets the minimum password complexity level.", "description": "Gets the minimum password complexity level.", "operationId": "getMinPasswordComplexity", "parameters": [], "responses": { "200": { "description": "Minimum password complexity level", "schema": { "type": "object" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/settings/install": { "post": { "tags": [ "settings" ], "summary": "Installs the settings from the seed.", "description": "Installs the settings from the seed.", "operationId": "install", "parameters": [ { "name": "seedDataCommand", "description": "The seed data model for initial settings", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Core.Requests.Settings.Commands.InitializeSwimlaneCommand" } } ], "responses": { "204": { "description": "Task<NoContentResult>.", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.NoContentResult" } }, "200": { "description": "Task<NoContentResult>.", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.NoContentResult" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/settings/ldap/sync": { "post": { "tags": [ "settings" ], "summary": "Synchronizes the active directory. Admin.", "description": "Admin only.", "operationId": "syncActiveDirectory", "parameters": [], "responses": { "200": { "description": "BasicResult to be able to return if there is an error without the full stack trace or not and his status.", "schema": { "$ref": "#/definitions/Core.Models.Utilities.BasicResult" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/settings/license/upload": { "post": { "tags": [ "settings" ], "summary": "Uploads the license.", "description": "Uploads the license.", "operationId": "uploadLicense", "parameters": [ { "name": "file", "description": "The file.", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Http.IFormFile" } } ], "responses": { "200": { "description": "Task<FileResult>.", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.FileResult" } }, "400": { "description": "Task<FileResult>.", "schema": { "$ref": "#/definitions/Api.Infrastructure.ActionResults.ErrorCodeResult" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/settings/agent": { "get": { "tags": [ "settings" ], "summary": "Gets the remote agent configuration", "description": "Gets the remote agent configuration", "operationId": "getRemoteAgentConfiguration", "parameters": [], "responses": { "200": { "description": "The remote agent configuration", "schema": { "$ref": "#/definitions/Core.Models.Configuration.AgentConfiguration" } }, "403": { "description": "The remote agent configuration", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.ForbidResult" } }, "404": { "description": "The remote agent configuration", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.ObjectResult" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/settings/ManageHangfireStartUpJobs": { "post": { "tags": [ "settings" ], "summary": "Enables/Disables Directory Service and/or EMail recurring job", "description": "Enables/Disables Directory Service and/or EMail recurring job", "operationId": "manageHangfireStartUpJobsAsync", "parameters": [ { "name": "hangfireStartUpJobs", "description": "", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Core.Models.Settings.HangfireStartUpJobs" } } ], "responses": { "204": { "description": "Task<NoContentResult>.", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.NoContentResult" } }, "400": { "description": "Task<NoContentResult>.", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.BadRequestResult" } }, "200": { "description": "Task<NoContentResult>.", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.NoContentResult" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/sharing/": { "post": { "tags": [ "sharing" ], "summary": "Sends the message.", "description": "Sends the message.", "operationId": "sharePage", "parameters": [ { "name": "message", "description": "The message.", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Core.Models.Sharing.SharingMessage" } } ], "responses": { "204": { "description": "NoContentResult.", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.NoContentResult" } }, "200": { "description": "NoContentResult.", "schema": { "type": "object" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/sharing/scheduled/report": { "post": { "tags": [ "sharing" ], "summary": "Sends the scheduled report", "description": "Sends the scheduled report", "operationId": "sendScheduledReport", "parameters": [ { "name": "viewModel", "description": "The scheduled viewModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Api.Models.Report.ScheduledViewModel" } } ], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.NoContentResult" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/sharing/scheduled/dashboard": { "post": { "tags": [ "sharing" ], "summary": "Sends the scheduled dashboard", "description": "Sends the scheduled dashboard", "operationId": "sendScheduledDashboard", "parameters": [ { "name": "viewModel", "description": "The scheduled viewModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Api.Models.Report.ScheduledViewModel" } } ], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.NoContentResult" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/sharing/scheduled/report/export/csv": { "post": { "tags": [ "sharing" ], "summary": "Exports scheduled reports csv files and returns them into a compressed file", "description": "Exports scheduled reports csv files and returns them into a compressed file", "operationId": "downloadReportCsvAsync", "produces": [ "application/octet-stream" ], "parameters": [ { "name": "viewModel", "description": "The scheduled viewModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Api.Models.Report.ScheduledViewModel" } } ], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.IActionResult" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/sharing/scheduled/report/export/pdf": { "post": { "tags": [ "sharing" ], "summary": "Create and returns a PDF with the reports", "description": "Create and returns a PDF with the reports", "operationId": "downloadReportPdfAsync", "produces": [ "application/octet-stream" ], "parameters": [ { "name": "viewModel", "description": "The scheduled viewModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Api.Models.Report.ScheduledViewModel" } } ], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.FileResult" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/sharing/scheduled/download/pdf": { "post": { "tags": [ "sharing" ], "summary": "Generates and returns a PDF with the reports", "description": "Generates and returns a PDF with the reports", "operationId": "downloadReportFromHtmlToPdf", "produces": [ "application/octet-stream" ], "parameters": [ { "name": "viewModel", "description": "The scheduled viewModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Api.Models.Report.ScheduledDownloadViewModel" } } ], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.FileResult" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/sharing/scheduled/dashboard/export/pdf": { "post": { "tags": [ "sharing" ], "summary": "Create and returns a PDF with the dashboard", "description": "Create and returns a PDF with the dashboard", "operationId": "downloadDashboardPdfAsync", "produces": [ "application/octet-stream" ], "parameters": [ { "name": "viewModel", "description": "The scheduled viewModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Api.Models.Report.ScheduledViewModel" } } ], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.FileResult" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/task/actions": { "get": { "tags": [ "task" ], "summary": "Gets the available actions.", "description": "Gets the available actions.", "operationId": "getAvailableActions", "parameters": [], "responses": { "200": { "description": "IEnumerable<AvailableActionDescriptor>.", "schema": { "items": { "$ref": "#/definitions/Core.Models.Integrations.Actions.AvailableActionDescriptor" }, "type": "array" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/task/running": { "get": { "tags": [ "task" ], "summary": "Returns list of hangfire jobs that are currently in running state.", "description": "Returns list of hangfire jobs that are currently in running state.", "operationId": "getAllProcessingTasks", "parameters": [ { "name": "taskId", "description": "The taskId to fetch the task from processingTasks..", "in": "query", "required": false, "type": "string" } ], "responses": { "200": { "description": "", "schema": { "items": { "additionalProperties": {}, "type": "object" }, "type": "array" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/task/action/{id}/new": { "get": { "tags": [ "task" ], "summary": "Creates the default task for an action descriptor.", "description": "Creates the default task for an action descriptor.", "operationId": "createDefaultTask", "parameters": [ { "name": "id", "description": "The action identifier.", "in": "path", "required": true, "type": "string" } ], "responses": { "404": { "description": "Default task template.", "schema": { "type": "string" } }, "200": { "description": "Default task template.", "schema": { "$ref": "#/definitions/Core.Models.Integrations.Task" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/task/action/{id}/fork": { "get": { "tags": [ "task" ], "summary": "Creates the forked task for an action descriptor.", "description": "Creates the forked task for an action descriptor.", "operationId": "createDefaultTaskFork", "parameters": [ { "name": "id", "description": "The action identifier.", "in": "path", "required": true, "type": "string" } ], "responses": { "404": { "description": "Forked task template.", "schema": { "type": "string" } }, "200": { "description": "Forked task template.", "schema": { "$ref": "#/definitions/Core.Models.Integrations.Task" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/task/options": { "get": { "tags": [ "task" ], "summary": "Gets the options.", "description": "Gets the options.", "operationId": "getOptions", "parameters": [], "responses": { "200": { "description": "TaskOptionModel.", "schema": { "$ref": "#/definitions/Api.Models.Integration.TaskOptionModel" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/task/light": { "get": { "tags": [ "task" ], "summary": "Gets the tasks (light model).", "description": "Gets the tasks (light model).", "operationId": "getLightTasks", "parameters": [], "responses": { "200": { "description": "IEnumerable<object>.", "schema": { "items": {}, "type": "array" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/task/light/{parentId}": { "get": { "tags": [ "task" ], "summary": "Gets the tasks (light model).", "description": "Gets the tasks (light model).", "operationId": "getLightTasksParentId", "parameters": [ { "name": "parentId", "description": "The application or applet identifier.", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "IEnumerable<object>.", "schema": { "items": {}, "type": "array" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/task/list": { "get": { "tags": [ "task" ], "summary": "Gets the tasks list with de-duped images for them.", "description": "Gets the tasks list with de-duped images for them.", "operationId": "getTasksList", "parameters": [], "responses": { "200": { "description": "Task list object with a tasks list and dictionary of de-duped images.", "schema": { "$ref": "#/definitions/Api.Models.Integration.TaskList" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/task/list/{parentId}": { "get": { "tags": [ "task" ], "summary": "Gets the tasks list with de-duped images for them.", "description": "Gets the tasks list with de-duped images for them.", "operationId": "getTasksListByParent", "parameters": [ { "name": "parentId", "description": "The application or applet identifier.", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "Task list object with a tasks list and dictionary of de-duped images.", "schema": { "$ref": "#/definitions/Api.Models.Integration.TaskList" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/task": { "get": { "tags": [ "task" ], "summary": "Gets the tasks by application or applet.", "description": "Gets the tasks by application or applet.", "operationId": "getTasksByParent", "parameters": [ { "name": "parentId", "description": "The application or applet identifier.", "in": "query", "required": true, "type": "string" } ], "responses": { "200": { "description": "IEnumerable<Task>.", "schema": { "items": { "$ref": "#/definitions/Core.Models.Integrations.Task" }, "type": "array" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false }, "post": { "tags": [ "task" ], "summary": "Posts the task.", "description": "Posts the task.", "operationId": "postTask", "parameters": [ { "name": "value", "description": "The value.", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Core.Models.Integrations.Task" } } ], "responses": { "200": { "description": "Task.", "schema": { "$ref": "#/definitions/Core.Models.Integrations.Task" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/task/common": { "get": { "tags": [ "task" ], "summary": "Gets all common tasks.", "description": "Gets all common tasks.", "operationId": "getCommonTasks", "parameters": [], "responses": { "200": { "description": "", "schema": { "items": { "$ref": "#/definitions/Core.Models.Integrations.Task" }, "type": "array" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/task/{id}": { "get": { "tags": [ "task" ], "summary": "Gets the task with specified identifier.", "description": "Gets the task with specified identifier.", "operationId": "getTask", "parameters": [ { "name": "id", "description": "The identifier.", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "JsonResult.", "schema": { "$ref": "#/definitions/Core.Models.Integrations.Task" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false }, "put": { "tags": [ "task" ], "summary": "Puts the task.", "description": "Puts the task.", "operationId": "putTask", "parameters": [ { "name": "id", "description": "The identifier.", "in": "path", "required": true, "type": "string" }, { "name": "task", "description": "The task.", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Core.Models.Integrations.Task" } } ], "responses": { "200": { "description": "Task.", "schema": { "$ref": "#/definitions/Core.Models.Integrations.Task" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false }, "delete": { "tags": [ "task" ], "summary": "Deletes the task.", "description": "Deletes the task.", "operationId": "deleteTask", "parameters": [ { "name": "id", "description": "The identifier.", "in": "path", "required": true, "type": "string" } ], "responses": { "204": { "description": "NoContentResult.", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.NoContentResult" } }, "200": { "description": "NoContentResult.", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.NoContentResult" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/task/fork": { "post": { "tags": [ "task" ], "summary": "Forks the specified task.", "description": "Forks the specified task.", "operationId": "fork", "parameters": [ { "name": "task", "description": "The task.", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Core.Models.Integrations.Task" } } ], "responses": { "200": { "description": "Task.", "schema": { "$ref": "#/definitions/Core.Models.Integrations.Task" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/task/execute/record": { "post": { "tags": [ "task" ], "summary": "Executes the record.", "description": "Executes the record.", "operationId": "executeRecord", "parameters": [ { "name": "model", "description": "The model.", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Api.Models.Integration.TaskExecuteModel" } } ], "responses": { "200": { "description": "System.String.", "schema": { "type": "string" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/task/test/output": { "post": { "tags": [ "task" ], "summary": "Tests the output.", "description": "Tests the output.", "operationId": "testOutput", "parameters": [ { "name": "mapping", "description": "The mapping.", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Core.Models.Integrations.Descriptors.Mapping" } } ], "responses": { "200": { "description": "object.", "schema": { "type": "object" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/task/export/{id}": { "get": { "tags": [ "task" ], "summary": "Exports the task.", "description": "Exports the task.", "operationId": "exportTask", "parameters": [ { "name": "id", "description": "The identifier.", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "FileContentResult.", "schema": { "type": "object" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/task/upload-script": { "post": { "tags": [ "task" ], "summary": "Uploads the script.", "description": "Uploads the script.", "operationId": "uploadScript", "parameters": [ { "name": "form", "description": "The form. Fields:\n appId: Application id.\n appletId: Applet id.\n taskName: The name of the task.\n scriptType: Either python or powershell\n File type fields (any name): The content of the script.", "in": "query", "required": true, "collectionFormat": "csv", "type": "array", "items": {} } ], "responses": { "200": { "description": "Task or null if failed", "schema": { "$ref": "#/definitions/Core.Models.Integrations.Task" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/task/upload-task": { "post": { "tags": [ "task" ], "summary": "Uploads the task.", "description": "Uploads the task.", "operationId": "uploadTask", "parameters": [ { "name": "form", "description": "The form.", "in": "query", "required": true, "collectionFormat": "csv", "type": "array", "items": {} } ], "responses": { "200": { "description": "The uploaded task", "schema": { "$ref": "#/definitions/Core.Models.Integrations.Task" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/task/upload": { "post": { "tags": [ "task" ], "summary": "Upload task to Swimlane.", "description": "Upload task to Swimlane.", "operationId": "taskUpload", "consumes": [ "multipart/form-data" ], "parameters": [ { "name": "appId", "description": "The application identifier. Will overwrite the one in file.", "in": "formData", "required": true, "type": "string" }, { "name": "appletId", "description": "The applet identifier. Will overwrite the one in file.", "in": "formData", "required": true, "type": "string" }, { "name": "taskName", "description": "New task name. Will overwrite the one in file.", "in": "formData", "required": true, "type": "string" }, { "name": "files", "description": "Task file.", "in": "formData", "required": true, "type": "file" } ], "responses": { "200": { "description": "Created task from Swimlane.", "schema": { "$ref": "#/definitions/Core.Models.Integrations.Task" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/task/upload-appId": { "post": { "tags": [ "task" ], "summary": "Upload task to Swimlane by app Id.", "description": "Upload task to Swimlane by app Id.", "operationId": "taskUploadByAppId", "consumes": [ "multipart/form-data" ], "parameters": [ { "name": "appId", "description": "The application identifier. Will overwrite the one in file.", "in": "formData", "required": true, "type": "string" }, { "name": "taskName", "description": "New task name. Will overwrite the one in file.", "in": "formData", "required": true, "type": "string" }, { "name": "files", "description": "Task file.", "in": "formData", "required": true, "type": "file" } ], "responses": { "200": { "description": "Created task from Swimlane.", "schema": { "$ref": "#/definitions/Core.Models.Integrations.Task" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/task/upload-appletId": { "post": { "tags": [ "task" ], "summary": "Upload task to Swimlane by applet Id.", "description": "Upload task to Swimlane by applet Id.", "operationId": "taskUploadByAppletId", "consumes": [ "multipart/form-data" ], "parameters": [ { "name": "appletId", "description": "The applet identifier. Will overwrite the one in file.", "in": "formData", "required": true, "type": "string" }, { "name": "taskName", "description": "New task name. Will overwrite the one in file.", "in": "formData", "required": true, "type": "string" }, { "name": "files", "description": "Task file.", "in": "formData", "required": true, "type": "file" } ], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/Core.Models.Integrations.Task" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/task/{jobId}/cancel": { "post": { "tags": [ "task" ], "summary": "Cancels the task.", "description": "Cancels the task.", "operationId": "cancel", "parameters": [ { "name": "jobId", "description": "The job identifier.", "in": "path", "required": true, "type": "string" } ], "responses": { "204": { "description": "NoContentResult.", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.NoContentResult" } }, "200": { "description": "NoContentResult.", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.NoContentResult" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/task/enable": { "post": { "tags": [ "task" ], "summary": "Bulk enable tasks", "description": "Bulk enable tasks", "operationId": "enableTasks", "parameters": [ { "name": "tasks", "description": "Collection of task IDs", "in": "body", "required": true, "schema": { "items": { "type": "string" }, "type": "array" } } ], "responses": { "200": { "description": "Collection of IDs of tasks enabled.", "schema": { "items": { "$ref": "#/definitions/Core.Models.Integrations.Task" }, "type": "array" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/task/hangfire/{jobId}/requeue": { "get": { "tags": [ "task" ], "summary": "", "description": "", "operationId": "requeueHangfireJob", "parameters": [ { "name": "jobId", "description": "", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "", "schema": { "type": "object" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/task/action-descriptor/{id}": { "delete": { "tags": [ "task" ], "summary": "Deletes the Available Action Descriptor By ID", "description": "Deletes the Available Action Descriptor By ID", "operationId": "deleteAvailableActionDescriptor", "parameters": [ { "name": "id", "description": "Available Action Descriptor ID", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "", "schema": { "type": "object" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/task/packages/{packageName}/{version}": { "delete": { "tags": [ "taskPackage" ], "summary": "Deletes the package.", "description": "Deletes the package.", "operationId": "deletePackage", "parameters": [ { "name": "packageName", "description": "Name of the package.", "in": "path", "required": true, "type": "string" }, { "name": "version", "description": "Version of the package.", "in": "path", "required": true, "type": "string" } ], "responses": { "204": { "description": "Task<IActionResult>.", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.NoContentResult" } }, "404": { "description": "Task<IActionResult>.", "schema": { "type": "string" } }, "200": { "description": "Task<IActionResult>.", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.IActionResult" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/task/packages/{packageName}/{version}/{pythonVersion}": { "delete": { "tags": [ "taskPackage" ], "summary": "Deletes the package.", "description": "Deletes the package.", "operationId": "deletePackage2", "parameters": [ { "name": "packageName", "description": "Name of the package.", "in": "path", "required": true, "type": "string" }, { "name": "version", "description": "Version of the package.", "in": "path", "required": true, "type": "string" }, { "name": "pythonVersion", "description": "", "in": "path", "required": true, "type": "string" } ], "responses": { "204": { "description": "Task<IActionResult>.", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.NoContentResult" } }, "404": { "description": "Task<IActionResult>.", "schema": { "type": "string" } }, "200": { "description": "Task<IActionResult>.", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.IActionResult" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/task/packages": { "get": { "tags": [ "taskPackage" ], "summary": "Gets the packages.", "description": "Gets the packages.", "operationId": "getPackages", "parameters": [], "responses": { "200": { "description": "IEnumerable<System.Object>.", "schema": { "items": { "$ref": "#/definitions/Api.Models.Integration.PackageDescriptorLight" }, "type": "array" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/task/packages/{packageName}": { "get": { "tags": [ "taskPackage" ], "summary": "Gets the package with assets and actions.", "description": "Gets the package with assets and actions.", "operationId": "getPackage", "parameters": [ { "name": "packageName", "description": "", "in": "path", "required": true, "type": "string" } ], "responses": { "404": { "description": "Extended package object.", "schema": { "type": "string" } }, "200": { "description": "Extended package object.", "schema": { "$ref": "#/definitions/Api.Models.Integration.PackageDescriptorExtended" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/task/packages/{packageName}/{version}/usage": { "get": { "tags": [ "taskPackage" ], "summary": "Retrieves the task and asset usage of the bundle specified.\n Useful for confirming deletion of bundles.", "description": "Retrieves the task and asset usage of the bundle specified.\n Useful for confirming deletion of bundles.", "operationId": "packageUsage", "parameters": [ { "name": "packageName", "description": "Name of the package.", "in": "path", "required": true, "type": "string" }, { "name": "version", "description": "Version of the package.", "in": "path", "required": true, "type": "string" } ], "responses": { "404": { "description": "Task<JsonResult>.", "schema": { "type": "string" } }, "200": { "description": "Task<JsonResult>.", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.IActionResult" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/task/packages/{packageName}/{version}/usage/{pythonVersion}": { "get": { "tags": [ "taskPackage" ], "summary": "Retrieves the task and asset usage of the bundle specified.\n Useful for confirming deletion of bundles.", "description": "Retrieves the task and asset usage of the bundle specified.\n Useful for confirming deletion of bundles.", "operationId": "packageUsage2", "parameters": [ { "name": "packageName", "description": "Name of the package.", "in": "path", "required": true, "type": "string" }, { "name": "version", "description": "Version of the package.", "in": "path", "required": true, "type": "string" }, { "name": "pythonVersion", "description": "", "in": "path", "required": true, "type": "string" } ], "responses": { "404": { "description": "Task<JsonResult>.", "schema": { "type": "string" } }, "200": { "description": "Task<JsonResult>.", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.IActionResult" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/task/packages/upload": { "post": { "tags": [ "taskPackage" ], "summary": "Uploads the package and validates if it requires upgrade.", "description": "Inserts if no issues found. Returns issues to let user decide.", "operationId": "packageUploadIfPossible", "consumes": [ "multipart/form-data" ], "parameters": [ { "name": "file", "description": "The file.", "in": "formData", "required": true, "type": "file" } ], "responses": { "200": { "description": "Package definition.", "schema": { "$ref": "#/definitions/Core.Models.Integrations.Actions.PackageDescriptor" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/task/packages/upgrade": { "post": { "tags": [ "taskPackage" ], "summary": "Uploads the package and forces upgrade.", "description": "Uploads the package and forces upgrade.", "operationId": "packageUpload", "consumes": [ "multipart/form-data" ], "parameters": [ { "name": "file", "description": "The file.", "in": "formData", "required": true, "type": "file" } ], "responses": { "200": { "description": "Package definition.", "schema": { "$ref": "#/definitions/Core.Models.Integrations.Actions.PackageDescriptor" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/task/packages/upload/ssp": { "post": { "tags": [ "taskPackage" ], "summary": "Uploads the package from an SSP and validates if it requires upgrade.", "description": "Inserts if no issues found. Returns issues to let user decide.", "operationId": "packageUploadIfPossibleSsp", "consumes": [ "multipart/form-data" ], "parameters": [ { "name": "file", "description": "The file.", "in": "formData", "required": true, "type": "file" }, { "name": "pluginId", "description": "The id of the desired plugin.", "in": "query", "required": true, "type": "string" }, { "name": "pluginName", "description": "The Name of the desired plugin.", "in": "query", "required": true, "type": "string" } ], "responses": { "200": { "description": "Package definition.", "schema": { "$ref": "#/definitions/Core.Models.Integrations.Actions.PackageDescriptor" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/task/packages/upgrade/ssp": { "post": { "tags": [ "taskPackage" ], "summary": "Uploads the package from an SSP and forces upgrade.", "description": "Uploads the package from an SSP and forces upgrade.", "operationId": "packageUploadSsp", "consumes": [ "multipart/form-data" ], "parameters": [ { "name": "file", "description": "The file.", "in": "formData", "required": true, "type": "file" }, { "name": "pluginId", "description": "The id of the desired plugin.", "in": "query", "required": true, "type": "string" }, { "name": "pluginName", "description": "Name of Plugin", "in": "query", "required": true, "type": "string" } ], "responses": { "200": { "description": "Package definition.", "schema": { "$ref": "#/definitions/Core.Models.Integrations.Actions.PackageDescriptor" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/turbineMigration/UpgradeToTurbine": { "get": { "tags": [ "turbineMigration" ], "summary": "Validate whether to upgrade to Turbine", "description": "Validate whether to upgrade to Turbine", "operationId": "upgradeToTurbine", "parameters": [], "responses": { "200": { "description": "Task<OkObjectResult>.", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.NoContentResult" } }, "400": { "description": "Task<OkObjectResult>.", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.BadRequestResult" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/turbineMigration/InstallTurbineOnSwimlane": { "post": { "tags": [ "turbineMigration" ], "summary": "Installs the settings from the Turbine.", "description": "Installs the settings from the Turbine.", "operationId": "installTurbineOnSwimlane", "parameters": [ { "name": "turbineAdminUser", "description": "The data model for Turbine Admin user", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Core.Models.Settings.TurbineAdminUser" } } ], "responses": { "204": { "description": "Task<NoContentResult>.", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.NoContentResult" } }, "400": { "description": "Task<NoContentResult>.", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.BadRequestResult" } }, "200": { "description": "Task<NoContentResult>.", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.NoContentResult" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/turbineMigration/PruneSwimlaneCollections": { "delete": { "tags": [ "turbineMigration" ], "summary": "Installs the settings from the Turbine.", "description": "Installs the settings from the Turbine.", "operationId": "pruneSwimlaneCollections", "parameters": [], "responses": { "204": { "description": "Task<NoContentResult>.", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.NoContentResult" } }, "400": { "description": "Task<NoContentResult>.", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.BadRequestResult" } }, "200": { "description": "Task<NoContentResult>.", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.NoContentResult" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/usage/app/{appId}": { "get": { "tags": [ "usage" ], "summary": "Retrieves all filter usage tasks by a specific application identifier.", "description": "Retrieves all filter usage tasks by a specific application identifier.", "operationId": "all", "parameters": [ { "name": "appId", "description": "The application identifier.", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "List<UsageTask>.", "schema": { "items": { "$ref": "#/definitions/Core.Models.Usage.UsageTask" }, "type": "array" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/usage/app/common": { "get": { "tags": [ "usage" ], "summary": "Retrieves all common usage tasks.", "description": "Retrieves all common usage tasks.", "operationId": "allCommon", "parameters": [], "responses": { "200": { "description": "List<UsageTask>.", "schema": { "items": { "$ref": "#/definitions/Core.Models.Usage.UsageTask" }, "type": "array" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/usage/update": { "put": { "tags": [ "usage" ], "summary": "Updates or inserts all usage tasks.", "description": "Updates or inserts all usage tasks.", "operationId": "update", "parameters": [ { "name": "tasks", "description": "The tasks.", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/Core.Models.Usage.UsageTask" }, "type": "array" } } ], "responses": { "204": { "description": "NoContentResult.", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.NoContentResult" } }, "200": { "description": "NoContentResult.", "schema": { "type": "object" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/usage/stats": { "post": { "tags": [ "usage" ], "operationId": "stats", "parameters": [ { "name": "filters", "description": "", "in": "body", "required": true, "schema": { "additionalProperties": { "items": { "type": "string" }, "type": "array" }, "type": "object" } } ], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/Core.Models.Usage.GlobalUsage" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/user/authorize": { "get": { "tags": [ "user" ], "summary": "Returns user with permissions.", "description": "Returns user with permissions.", "operationId": "authorize", "parameters": [], "responses": { "200": { "description": "Task<IActionResult>.", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.IActionResult" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/user/avatar/{id}": { "get": { "tags": [ "user" ], "summary": "Avatars the specified identifier.", "description": "Avatars the specified identifier.", "operationId": "avatar", "parameters": [ { "name": "id", "description": "The identifier.", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "ActionResult.", "schema": { "type": "object" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false }, "post": { "tags": [ "user" ], "summary": "Uploads the avatar image.", "description": "Uploads the avatar image.", "operationId": "uploadAvatar", "parameters": [ { "name": "id", "description": "The user id", "in": "path", "required": true, "type": "string" }, { "name": "avatar", "description": "The avatar upload model containing an id property and the file.", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Api.Models.Users.AvatarViewModel" } } ], "responses": { "204": { "description": "NoContentResult.", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.NoContentResult" } }, "403": { "description": "NoContentResult.", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.ForbidResult" } }, "200": { "description": "NoContentResult.", "schema": { "type": "object" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/user": { "get": { "tags": [ "user" ], "summary": "Gets an amount of application users based on the paged search criteria.", "description": "Gets an amount of application users based on the paged search criteria.", "operationId": "getUsers", "parameters": [ { "name": "size", "description": "The number of documents to gather after skip..", "in": "query", "required": false, "type": "integer" }, { "name": "pageNumber", "description": "Page number to skip.", "in": "query", "required": false, "type": "integer" }, { "name": "sortFieldName", "description": "The application user field name to be sorted.", "in": "query", "required": false, "type": "string" }, { "name": "sortType", "description": "The direction of the sorting.", "in": "query", "required": false, "type": "string" }, { "name": "searchFieldName", "description": "The field name where the search will be executed.", "in": "query", "required": false, "type": "string" }, { "name": "searchValue", "description": "The search value to look into the search field name.", "in": "query", "required": false, "type": "string" } ], "responses": { "200": { "description": "PagedResponse<ApplicationUser>.", "schema": { "$ref": "#/definitions/Api.Models.PagedResponse%3cCore.Models.Identity.ApplicationUser%3e" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false }, "post": { "tags": [ "user" ], "summary": "Insert/Creates the specified user.", "description": "Insert/Creates the specified user.", "operationId": "create", "parameters": [ { "name": "model", "description": "The user.", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Api.Models.Identity.RegisterViewModel" } } ], "responses": { "200": { "description": "Saved user.", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.IActionResult" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/user/{id}": { "get": { "tags": [ "user" ], "summary": "Gets the specified user.", "description": "Gets the specified user.", "operationId": "getUser", "parameters": [ { "name": "id", "description": "The user identifier.", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "The user.", "schema": { "$ref": "#/definitions/Core.Models.Identity.ApplicationUser" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false }, "put": { "tags": [ "user" ], "summary": "Updates the specified user.", "description": "Updates the specified user.", "operationId": "updateUser", "parameters": [ { "name": "id", "description": "The user identifier.", "in": "path", "required": true, "type": "string" }, { "name": "applicationUser", "description": ".", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Core.Models.Identity.ApplicationUser" } } ], "responses": { "200": { "description": "Action result", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.IActionResult" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false }, "delete": { "tags": [ "user" ], "summary": "Removes the specified user.", "description": "Removes the specified user.", "operationId": "removeUser", "parameters": [ { "name": "id", "description": "The user identifier.", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "StatusCodeResult.", "schema": { "type": "object" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/user/{id}/permissions": { "get": { "tags": [ "user" ], "summary": "Gets the specified user.", "description": "Gets the specified user.", "operationId": "getPermissions", "parameters": [ { "name": "id", "description": "The user identifier.", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "The user.", "schema": { "additionalProperties": { "$ref": "#/definitions/Core.Models.Security.Authorization" }, "type": "object" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/user/{id}/light": { "get": { "tags": [ "user" ], "summary": "Gets the specified user as light model.", "description": "Gets the specified user as light model.", "operationId": "getUserIdLight", "parameters": [ { "name": "id", "description": "The user identifier.", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "The user light model.", "schema": { "$ref": "#/definitions/Core.Models.Identity.ApplicationUserLight" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/user/light": { "get": { "tags": [ "user" ], "summary": "Gets all users as light model.", "description": "Gets all users as light model.", "operationId": "getUserLight", "parameters": [], "responses": { "200": { "description": "All user light model.", "schema": { "items": { "$ref": "#/definitions/Core.Models.Identity.ApplicationUserLight" }, "type": "array" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/user/search": { "get": { "tags": [ "user" ], "summary": "Returns users whose display name matches the query.", "description": "Returns users whose display name matches the query.", "operationId": "searchUsers", "parameters": [ { "name": "query", "description": "The text to search user display names for", "in": "query", "required": true, "type": "string" }, { "name": "appId", "description": "The application identifier of the application where the user/group field being searched is located", "in": "query", "required": false, "type": "string" }, { "name": "appletId", "description": "The applet identifier of the applet where the user/group field being searched is located", "in": "query", "required": false, "type": "string" }, { "name": "fieldId", "description": "The field identifier of the user/group field being searched", "in": "query", "required": false, "type": "string" }, { "name": "dashboardId", "description": "The field identifier of the user/group field being searched", "in": "query", "required": false, "type": "string" }, { "name": "reportId", "description": "The field identifier of the user/group field being searched", "in": "query", "required": false, "type": "string" }, { "name": "recordId", "description": "The field identifier of the user/group field being searched", "in": "query", "required": false, "type": "string" } ], "responses": { "200": { "description": "List of users that match the search query and field constraints. The search is preformed within the constraints defined\n on the specified user/group field, so some users may be filtered out.", "schema": { "items": { "$ref": "#/definitions/Core.Models.Identity.ApplicationUser" }, "type": "array" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/user/token": { "post": { "tags": [ "user" ], "summary": "Log in the user and return an authentication token.", "description": "Log in the user and return an authentication token.", "operationId": "token", "parameters": [ { "name": "model", "description": "The login model including userName and password.", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Api.Models.Identity.LoginViewModel" } } ], "responses": { "200": { "description": "Task<System.String>.", "schema": { "type": "string" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/user/login": { "post": { "tags": [ "user" ], "summary": "Log in the user.", "description": "Log in the user.", "operationId": "login", "parameters": [ { "name": "model", "description": "The login model including userName and password.", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Api.Models.Identity.LoginViewModel" } } ], "responses": { "200": { "description": "Task<IActionResult>.", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.IActionResult" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/user/refresh": { "get": { "tags": [ "user" ], "summary": "Generates a new access token with the help of refresh token.", "description": "Generates a new access token with the help of refresh token.", "operationId": "refreshToken", "parameters": [], "responses": { "200": { "description": "", "schema": { "type": "object" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/user/logout": { "post": { "tags": [ "user" ], "summary": "Logouts this instance.", "description": "Logouts this instance.", "operationId": "logout", "parameters": [], "responses": { "204": { "description": "Task<NoContentResult>.", "schema": { "$ref": "#/definitions/System.Threading.Tasks.Task%3cMicrosoft.AspNetCore.Mvc.NoContentResult%3e" } }, "200": { "description": "Task<NoContentResult>.", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.NoContentResult" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/user/password/reset": { "post": { "tags": [ "user" ], "summary": "Resets the password.", "description": "Resets the password.", "operationId": "resetPassword", "parameters": [ { "name": "model", "description": "The model.", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Api.Models.Identity.SetPasswordViewModel" } } ], "responses": { "200": { "description": "Task<IActionResult>.", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.IActionResult" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/user/password/set": { "post": { "tags": [ "user" ], "summary": "Sets the password.", "description": "Sets the password.", "operationId": "setPassword", "parameters": [ { "name": "model", "description": "The model.", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Api.Models.Identity.SetPasswordViewModel" } } ], "responses": { "200": { "description": "Task<IActionResult>.", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.IActionResult" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/user/password/test": { "post": { "tags": [ "user" ], "summary": "Tests a password and returns zxcvbn results, including the strength score.", "description": "Tests a password and returns zxcvbn results, including the strength score.", "operationId": "passwordTest", "parameters": [ { "name": "passwordViewModel", "description": "An object containing a password property containing the password to test", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Api.Models.Users.PasswordTestViewModel" } } ], "responses": { "200": { "description": "The zxcvbn password test result", "schema": { "$ref": "#/definitions/Api.Models.Users.PasswordTestResult" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/usergroup/lookup": { "get": { "tags": [ "user" ], "summary": "Returns both groups and users whose name starts with supplied string.", "description": "Returns both groups and users whose name starts with supplied string.", "operationId": "userGroupLookup", "parameters": [ { "name": "name", "description": "Partial name (starting characters).", "in": "query", "required": true, "type": "string" } ], "responses": { "200": { "description": "Collection of users and groups as Id,Name,Disabled and EntityType object.", "schema": { "items": { "$ref": "#/definitions/Core.Models.Base.Entity" }, "type": "array" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/user/lookup": { "get": { "tags": [ "user" ], "summary": "Returns users whose username matches starting string.", "description": "Returns users whose username matches starting string.", "operationId": "userLookup", "parameters": [ { "name": "name", "description": "Partial name (starting characters).", "in": "query", "required": true, "type": "string" } ], "responses": { "200": { "description": "Collection of users as Id,Name,Disabled object.", "schema": { "items": { "$ref": "#/definitions/Core.Models.Base.Entity" }, "type": "array" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/workflow/": { "get": { "tags": [ "workflow" ], "summary": "Gets all workflows.", "description": "Gets all workflows.", "operationId": "getWorkflows", "parameters": [], "responses": { "200": { "description": "IEnumerable<Workflow>.", "schema": { "items": { "$ref": "#/definitions/Core.Models.Workflow.Workflow" }, "type": "array" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false }, "post": { "tags": [ "workflow" ], "summary": "Creates a new workflow.", "description": "Creates a new workflow.", "operationId": "postWorkflow", "parameters": [ { "name": "model", "description": "The workflow.", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Core.Models.Workflow.Workflow" } } ], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/Core.Models.Workflow.Workflow" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false }, "delete": { "tags": [ "workflow" ], "summary": "Deletes the specified workflow.", "description": "Deletes the specified workflow.", "operationId": "deleteWorkflow", "parameters": [ { "name": "id", "description": "The workflow identifier.", "in": "query", "required": true, "type": "string" } ], "responses": { "204": { "description": "IActionResult", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.NoContentResult" } }, "404": { "description": "IActionResult", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.NotFoundObjectResult" } }, "200": { "description": "IActionResult", "schema": { "type": "object" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/workflow/{id}": { "get": { "tags": [ "workflow" ], "summary": "Gets the specified workflow.", "description": "Gets the specified workflow.", "operationId": "getWorkflow", "parameters": [ { "name": "id", "description": "The identifier.", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "Workflow.", "schema": { "$ref": "#/definitions/Core.Models.Workflow.Workflow" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false }, "put": { "tags": [ "workflow" ], "summary": "Updates workflow.", "description": "Updates workflow.", "operationId": "putWorkflow", "parameters": [ { "name": "id", "description": "The identifier.", "in": "path", "required": true, "type": "string" }, { "name": "model", "description": "The workflow.", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Core.Models.Workflow.Workflow" } } ], "responses": { "200": { "description": "Saved workflow.", "schema": { "$ref": "#/definitions/Core.Models.Workflow.Workflow" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/workflow/{workflowId}/version/{version}": { "get": { "tags": [ "workflow" ], "summary": "Gets the specified workflow.", "description": "Gets the specified workflow.", "operationId": "getWorkflowByVersion", "parameters": [ { "name": "workflowId", "description": "The WorkflowId.", "in": "path", "required": true, "type": "string" }, { "name": "version", "description": "version", "in": "path", "required": true, "type": "integer" } ], "responses": { "200": { "description": "Workflow.", "schema": { "$ref": "#/definitions/Core.Models.Workflow.Workflow" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/workflow/notify": { "post": { "tags": [ "workflow" ], "summary": "Sends the notification.", "description": "Sends the notification.", "operationId": "sendNotification", "parameters": [ { "name": "model", "description": "The notification.", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Core.Models.Workflow.Notification" } } ], "responses": { "204": { "description": "NoContentResult.", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.NoContentResult" } }, "200": { "description": "NoContentResult.", "schema": { "type": "object" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/workflow/record/runs/{recordId}": { "get": { "tags": [ "workflow" ], "summary": "Retrieves the workflow runs for the specified record id", "description": "Retrieves the workflow runs for the specified record id", "operationId": "getRunsByRecord", "parameters": [ { "name": "recordId", "description": "The record id", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "The workflow runs for the record", "schema": { "items": { "$ref": "#/definitions/Core.Models.Workflow.WorkflowRun" }, "type": "array" } }, "404": { "description": "The workflow runs for the record", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.NotFoundResult" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/workflow/run/{workflowRunId}/sequence/{sequence}": { "get": { "tags": [ "workflow" ], "summary": "Retrieves the run and executions for the specified workflow run id and sequence", "description": "Retrieves the run and executions for the specified workflow run id and sequence", "operationId": "getRunBySequence", "parameters": [ { "name": "workflowRunId", "description": "", "in": "path", "required": true, "type": "string" }, { "name": "sequence", "description": "", "in": "path", "required": true, "type": "integer" } ], "responses": { "200": { "description": "The workflow run and executions", "schema": { "$ref": "#/definitions/Api.Models.Record.WorkflowRunDetails" } }, "404": { "description": "The workflow run and executions", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.NotFoundResult" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/workflow/run/record/{recordId}": { "post": { "tags": [ "workflow" ], "summary": "Gets the workflow runs by record identifier.", "description": "Gets the workflow runs by record identifier.", "operationId": "getWorkflowRunsByRecordId", "parameters": [ { "name": "recordId", "description": "The model.", "in": "path", "required": true, "type": "string" }, { "name": "model", "description": "The model.", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Api.Models.Workflow.WorkflowRequestModel" } } ], "responses": { "200": { "description": "", "schema": { "items": { "$ref": "#/definitions/Api.Models.Record.WorkflowRunDetails" }, "type": "array" } }, "204": { "description": "", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.NoContentResult" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/workspaces/": { "get": { "tags": [ "workspace" ], "summary": "Gets all workspaces.", "description": "Gets all workspaces.", "operationId": "getWorkspaces", "parameters": [], "responses": { "200": { "description": "The workspace collection.", "schema": { "items": { "$ref": "#/definitions/Core.Models.Workspaces.Workspace" }, "type": "array" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false }, "post": { "tags": [ "workspace" ], "summary": "Inserts/Creates the specified workspace.", "description": "Inserts/Creates the specified workspace.", "operationId": "postWorkspace", "parameters": [ { "name": "model", "description": "The workspace.", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Core.Models.Workspaces.Workspace" } } ], "responses": { "200": { "description": "Saved workspace.", "schema": { "$ref": "#/definitions/Core.Models.Workspaces.Workspace" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/workspaces/nav": { "get": { "tags": [ "workspace" ], "summary": "Gets the workspace navigation.", "description": "Gets the workspace navigation.", "operationId": "getWorkspaceNavigation", "parameters": [], "responses": { "200": { "description": "Object list", "schema": { "items": {}, "type": "array" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/workspaces/{id}": { "get": { "tags": [ "workspace" ], "summary": "Gets the specified workspace.", "description": "Gets the specified workspace.", "operationId": "getWorkspace", "parameters": [ { "name": "id", "description": "The workspace identifier.", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "The workspace", "schema": { "$ref": "#/definitions/Core.Models.Workspaces.Workspace" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false }, "put": { "tags": [ "workspace" ], "summary": "Updates the specified workspace.", "description": "Updates the specified workspace.", "operationId": "putWorkspaceId", "parameters": [ { "name": "id", "description": "The workspace identifier.", "in": "path", "required": true, "type": "string" }, { "name": "model", "description": "The workspace.", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Core.Models.Workspaces.Workspace" } } ], "responses": { "200": { "description": "Saved workspace.", "schema": { "$ref": "#/definitions/Core.Models.Workspaces.Workspace" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false }, "delete": { "tags": [ "workspace" ], "summary": "Deletes the specified workspace.", "description": "Deletes the specified workspace.", "operationId": "deleteWorkspace", "parameters": [ { "name": "id", "description": "The workspace identifier.", "in": "path", "required": true, "type": "string" } ], "responses": { "204": { "description": "IActionResult.", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.NoContentResult" } }, "404": { "description": "IActionResult.", "schema": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.NotFoundObjectResult" } }, "200": { "description": "IActionResult.", "schema": { "type": "object" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } }, "/workspaces/app/{id}": { "get": { "tags": [ "workspace" ], "summary": "Gets workspaces for application.", "description": "Gets workspaces for application.", "operationId": "getWorkspacesAppId", "parameters": [ { "name": "id", "description": "Application id.", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "Workspace collection.", "schema": { "items": { "$ref": "#/definitions/Core.Models.Workspaces.Workspace" }, "type": "array" } }, "default": { "description": "Unexpected Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "deprecated": false } } }, "definitions": { "Api.Infrastructure.Filters.ErrorCodeResponse": { "properties": { "errorCode": { "enum": [ "None", "PasswordExpired", "DuplicateUserName", "InvalidUserNameOrPassword", "ConfirmPasswordDoesNotMatch", "PasswordDoesNotMeetComplexityRequirements", "PasswordResetRequired", "NewPasswordCannotMatchCurrent", "InvalidUser", "DuplicateEmail", "NonAdminUser", "PasswordDoesNotMeetMinLengthRequirements", "InvalidMinPasswordLength", "DuplicateGroupName", "DuplicateRoleName", "DuplicateFieldName", "FieldNameEmpty", "InvalidApplicationExportFile", "ApplicationNotFound", "InvalidCalculation", "DuplicateApplicationName", "DuplicateAppletName", "DuplicateAppletAcronym", "DuplicateApplicationAcronym", "AppletNotFound", "SettingsInvalid", "SectionNameTooLong", "DuplicateFieldValue", "InvalidDateField", "RecordNotFound", "FieldNotFound", "RecordLocked", "CannotGeneratePdfPreview", "MaxAttachmentSize", "CannotParseField", "AttachmentDownloadError", "UnauthorizedUserError", "UnsupportedAttachmentType", "UnsupportedImageType", "UnsupportedCorrelationUnassignment", "UnsupportedCorrelationAssignment", "RecordCorrelationReassignmentFailed", "RecordIdentifierNullOrEmpty", "RecordPatchValuesNotProvided", "RecordSizeLimitExceeded", "BadStatsGroup", "BadFilter", "BadSort", "AppLimitExceeded", "UserLimitExceeded", "NewServerInstall", "UnableToConnectToActiveDirectory", "UnableToRetrieveStoredValue", "UnableToConnectToMongoDb", "UnableToConnectToSmtp", "SwimlaneAlreadyInitialized", "ModelValidationError", "UpgradeInProcess", "RequiredFieldMissing", "UnableToRetrieveEncryptionKey", "PathNotFound", "WrongType", "ModificationError", "DatabaseError", "NetworkError", "InvalidOnThisOS", "DeserializationError", "ContractRequiresError", "ContractEnsuresError", "InvalidNumericInput", "InvalidSessionTimeout", "InvalidInputTemplateString", "GenericAssertError", "MissingRequiredMailSettings", "ConnectionDataNotProvided", "RegexNotDefined", "AssetNotFound", "BadThreatIntelConnector", "NoThreatIntel", "ThreatIntelTypeNotSupportedByThisProvider", "DuplicateTaskName", "TaskNotFound", "PythonVersionNotSupported", "TaskMigrated", "PackageAlreadyInstalled", "PackageNotFound", "PackageInstallError", "InvalidSupportedSwimlaneVersion", "PackageUploadError", "PackageUpgradeError", "ImproperMappingFileError", "PackageContentError", "UserAlreadyHasAccessToken", "AccessTokenNotFound", "UserAlreadyEnrolledInOneTimePassword", "UserNotEnrolledInOneTimePassword", "OneTimePasswordNotAvailable", "OneTimePasswordRecentlyUsed", "OneTimePasswordUseIsNotEnforced", "SamlNotEnabled", "SamlUserNotFound", "SamlInternalError", "SamlUserValidationError", "InvalidSamlResponse", "WorkflowLocked", "FeatureFlagNotModifiable", "DuplicateAssetName", "IngestionRuleInvalid", "DuplicateIngestionRuleName", "DuplicateOrchestrationTaskName", "OrchestrationTaskDisabled", "ApplicationNullOrEmpty", "PlaybookNullOrEmpty", "PlaybookNotFound", "PlaybookNotEnabled", "HangfireError", "ReportNotFound", "ReportProcessFailed", "DuplicateDefaultReport", "DefaultReportDelete", "CardsNotContained", "WidgetsNotSupported", "DashboardNotFound", "InvalidDashboardAutoRefreshTime", "ContentExchangeError", "CommentsListNotFound", "CommentNotFound", "CommentNotOwned", "TurbineAlreadyInitialized", "InvalidLogRetentionInDays", "MultipleTargetIdsNotAllowed" ], "type": "string" }, "argument": { "type": "string" }, "innerException": { "additionalProperties": { "type": "string" }, "type": "object" } }, "type": "object" }, "Core.Models.Utilities.UserGroupSelection": { "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "Core.Models.Auth.AccessToken": { "properties": { "createdBy": { "$ref": "#/definitions/Core.Models.Utilities.UserGroupSelection" }, "createdOn": { "type": "string" }, "lastUsedOn": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "disabled": { "type": "boolean" } }, "type": "object" }, "Microsoft.AspNetCore.Mvc.NoContentResult": { "properties": { "statusCode": { "type": "integer" } }, "type": "object" }, "Microsoft.AspNetCore.Mvc.IActionResult": { "type": "object" }, "Core.Models.Base.DatabaseResult": { "properties": { "id": { "type": "string" }, "errorCodes": { "enum": [ "None", "PasswordExpired", "DuplicateUserName", "InvalidUserNameOrPassword", "ConfirmPasswordDoesNotMatch", "PasswordDoesNotMeetComplexityRequirements", "PasswordResetRequired", "NewPasswordCannotMatchCurrent", "InvalidUser", "DuplicateEmail", "NonAdminUser", "PasswordDoesNotMeetMinLengthRequirements", "InvalidMinPasswordLength", "DuplicateGroupName", "DuplicateRoleName", "DuplicateFieldName", "FieldNameEmpty", "InvalidApplicationExportFile", "ApplicationNotFound", "InvalidCalculation", "DuplicateApplicationName", "DuplicateAppletName", "DuplicateAppletAcronym", "DuplicateApplicationAcronym", "AppletNotFound", "SettingsInvalid", "SectionNameTooLong", "DuplicateFieldValue", "InvalidDateField", "RecordNotFound", "FieldNotFound", "RecordLocked", "CannotGeneratePdfPreview", "MaxAttachmentSize", "CannotParseField", "AttachmentDownloadError", "UnauthorizedUserError", "UnsupportedAttachmentType", "UnsupportedImageType", "UnsupportedCorrelationUnassignment", "UnsupportedCorrelationAssignment", "RecordCorrelationReassignmentFailed", "RecordIdentifierNullOrEmpty", "RecordPatchValuesNotProvided", "RecordSizeLimitExceeded", "BadStatsGroup", "BadFilter", "BadSort", "AppLimitExceeded", "UserLimitExceeded", "NewServerInstall", "UnableToConnectToActiveDirectory", "UnableToRetrieveStoredValue", "UnableToConnectToMongoDb", "UnableToConnectToSmtp", "SwimlaneAlreadyInitialized", "ModelValidationError", "UpgradeInProcess", "RequiredFieldMissing", "UnableToRetrieveEncryptionKey", "PathNotFound", "WrongType", "ModificationError", "DatabaseError", "NetworkError", "InvalidOnThisOS", "DeserializationError", "ContractRequiresError", "ContractEnsuresError", "InvalidNumericInput", "InvalidSessionTimeout", "InvalidInputTemplateString", "GenericAssertError", "MissingRequiredMailSettings", "ConnectionDataNotProvided", "RegexNotDefined", "AssetNotFound", "BadThreatIntelConnector", "NoThreatIntel", "ThreatIntelTypeNotSupportedByThisProvider", "DuplicateTaskName", "TaskNotFound", "PythonVersionNotSupported", "TaskMigrated", "PackageAlreadyInstalled", "PackageNotFound", "PackageInstallError", "InvalidSupportedSwimlaneVersion", "PackageUploadError", "PackageUpgradeError", "ImproperMappingFileError", "PackageContentError", "UserAlreadyHasAccessToken", "AccessTokenNotFound", "UserAlreadyEnrolledInOneTimePassword", "UserNotEnrolledInOneTimePassword", "OneTimePasswordNotAvailable", "OneTimePasswordRecentlyUsed", "OneTimePasswordUseIsNotEnforced", "SamlNotEnabled", "SamlUserNotFound", "SamlInternalError", "SamlUserValidationError", "InvalidSamlResponse", "WorkflowLocked", "FeatureFlagNotModifiable", "DuplicateAssetName", "IngestionRuleInvalid", "DuplicateIngestionRuleName", "DuplicateOrchestrationTaskName", "OrchestrationTaskDisabled", "ApplicationNullOrEmpty", "PlaybookNullOrEmpty", "PlaybookNotFound", "PlaybookNotEnabled", "HangfireError", "ReportNotFound", "ReportProcessFailed", "DuplicateDefaultReport", "DefaultReportDelete", "CardsNotContained", "WidgetsNotSupported", "DashboardNotFound", "InvalidDashboardAutoRefreshTime", "ContentExchangeError", "CommentsListNotFound", "CommentNotFound", "CommentNotOwned", "TurbineAlreadyInitialized", "InvalidLogRetentionInDays", "MultipleTargetIdsNotAllowed" ], "type": "string" }, "errors": { "items": { "type": "string" }, "type": "array" }, "succeeded": { "type": "boolean" }, "error": { "type": "string" }, "deletedCount": { "type": "integer" }, "nonDeletedDocumentIds": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "Microsoft.AspNetCore.Mvc.StatusCodeResult": { "properties": { "statusCode": { "type": "integer" } }, "type": "object" }, "Microsoft.AspNetCore.Mvc.Formatters.IOutputFormatter": { "type": "object" }, "Microsoft.AspNetCore.Mvc.NotFoundObjectResult": { "properties": { "value": {}, "formatters": { "items": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.Formatters.IOutputFormatter" }, "type": "array" }, "contentTypes": { "items": { "type": "string" }, "type": "array" }, "declaredType": { "type": "string" }, "statusCode": { "type": "integer" } }, "type": "object" }, "Core.Models.Layouts.Layout": { "properties": { "id": { "type": "string" }, "parentId": { "type": "string" }, "row": { "type": "integer" }, "col": { "type": "integer" }, "sizex": { "type": "number" }, "sizey": { "type": "number" }, "layoutType": { "enum": [ "None", "Field", "Section", "HtmlObject", "Tab", "Integration", "Tabs", "Widget", "OrchestrationTask" ], "type": "string" } }, "type": "object" }, "Core.Models.Fields.Field": { "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "key": { "type": "string" }, "sourceAppletFieldId": { "type": "string" }, "sourceAppletId": { "type": "string" }, "fieldType": { "enum": [ "None", "Text", "Numeric", "ValuesList", "Date", "UserGroup", "Attachment", "Tracking", "Reference", "Comments", "History", "List" ], "type": "string" }, "required": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "supportsMultipleOutputMappings": { "type": "boolean" } }, "type": "object" }, "Core.Models.Security.Authorization": { "properties": { "type": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "access": { "enum": [ "None", "Create", "Read", "Update", "Delete", "Admin", "Execute", "CreateInstance", "ReadInstance", "UpdateInstance", "DeleteInstance", "BulkCreateInstance", "Export", "Lock", "Restrict", "RestrictHistory", "Share" ], "type": "string" }, "fields": { "additionalProperties": { "enum": [ "None", "Create", "Read", "Update", "Delete", "Admin", "Execute", "CreateInstance", "ReadInstance", "UpdateInstance", "DeleteInstance", "BulkCreateInstance", "Export", "Lock", "Restrict", "RestrictHistory", "Share" ], "type": "string" }, "type": "object" } }, "type": "object" }, "Core.Models.Workflow.Condition": { "properties": { "id": { "type": "string" }, "conditionType": { "enum": [ "Contains", "Excludes", "Equals", "DoesNotEqual", "LessThan", "LessThanOrEqual", "GreaterThan", "GreaterThanOrEqual", "DefaultActions", "Regex", "HasValue", "DoesNotHaveValue", "HasBeenModified" ], "type": "string" }, "fieldId": { "type": "string" }, "referencedApplicationFieldId": { "type": "string" }, "referenceFieldConjunction": { "enum": [ "And", "Or" ], "type": "string" }, "value": {}, "isCaseSensitive": { "type": "boolean" } }, "type": "object" }, "Core.Models.Workflow.Actions.Action": { "properties": { "sourceAppletId": { "type": "string" }, "parentId": { "type": "string" }, "actionType": { "enum": [ "ShowHide", "SetValue", "ReadOnly", "Required", "CreateNewRecord", "Notification", "Integration", "FilterValues", "FormattedExport", "ToggleTimeTracking" ], "type": "string" }, "allowMultipleExecutions": { "type": "boolean" }, "id": { "type": "string" }, "name": { "type": "string" }, "disabled": { "type": "boolean" } }, "type": "object" }, "Core.Models.Workflow.Repeat": { "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "parentId": { "type": "string" }, "fieldId": { "type": "string" }, "referencedApplicationFieldId": { "type": "string" }, "actions": { "items": { "$ref": "#/definitions/Core.Models.Workflow.Actions.Action" }, "type": "array" }, "disabled": { "type": "boolean" }, "filterType": { "enum": [ "None", "Equals", "DoesNotEqual", "LessThan", "LessThanOrEqual", "GreaterThan", "GreaterThanOrEqual", "Regex" ], "type": "string" }, "filterValue": {} }, "type": "object" }, "Core.Models.Workflow.Stage": { "properties": { "id": { "type": "string" }, "sourceAppletId": { "type": "string" }, "name": { "type": "string" }, "disabled": { "type": "boolean" }, "parentId": { "type": "string" }, "conditionType": { "enum": [ "Contains", "Excludes", "Equals", "DoesNotEqual", "LessThan", "LessThanOrEqual", "GreaterThan", "GreaterThanOrEqual", "DefaultActions", "Regex", "HasValue", "DoesNotHaveValue", "HasBeenModified" ], "type": "string" }, "evalType": { "enum": [ "And", "Or" ], "type": "string" }, "conditions": { "items": { "$ref": "#/definitions/Core.Models.Workflow.Condition" }, "type": "array" }, "actions": { "items": { "$ref": "#/definitions/Core.Models.Workflow.Actions.Action" }, "type": "array" }, "repeats": { "items": { "$ref": "#/definitions/Core.Models.Workflow.Repeat" }, "type": "array" }, "stages": { "items": { "$ref": "#/definitions/Core.Models.Workflow.Stage" }, "type": "array" } }, "type": "object" }, "Core.Models.Workflow.WorkflowLock": { "properties": { "applicationId": { "type": "string" }, "workflowId": { "type": "string" }, "lockedDate": { "type": "string" }, "lockingUser": { "$ref": "#/definitions/Core.Models.Utilities.UserGroupSelection" }, "lockExpiration": { "type": "string" }, "isExpired": { "type": "boolean" }, "id": { "type": "string" }, "name": { "type": "string" }, "disabled": { "type": "boolean" } }, "type": "object" }, "Core.Models.Workflow.Workflow": { "properties": { "applicationId": { "type": "string" }, "stages": { "items": { "$ref": "#/definitions/Core.Models.Workflow.Stage" }, "type": "array" }, "permissions": { "additionalProperties": { "$ref": "#/definitions/Core.Models.Security.Authorization" }, "type": "object" }, "workflowLock": { "$ref": "#/definitions/Core.Models.Workflow.WorkflowLock" }, "createdDate": { "type": "string" }, "modifiedDate": { "type": "string" }, "modifiedByUser": { "$ref": "#/definitions/Core.Models.Utilities.UserGroupSelection" }, "createdByUser": { "$ref": "#/definitions/Core.Models.Utilities.UserGroupSelection" }, "uid": { "type": "string" }, "version": { "type": "integer" }, "id": { "type": "string" }, "name": { "type": "string" }, "disabled": { "type": "boolean" } }, "type": "object" }, "Core.Models.Applet.Applet": { "properties": { "description": { "type": "string" }, "acronym": { "type": "string" }, "iconImage64": { "type": "string" }, "layout": { "items": { "$ref": "#/definitions/Core.Models.Layouts.Layout" }, "type": "array" }, "fields": { "items": { "$ref": "#/definitions/Core.Models.Fields.Field" }, "type": "array" }, "permissions": { "additionalProperties": { "$ref": "#/definitions/Core.Models.Security.Authorization" }, "type": "object" }, "workflow": { "$ref": "#/definitions/Core.Models.Workflow.Workflow" }, "createdDate": { "type": "string" }, "modifiedDate": { "type": "string" }, "createdByUser": { "$ref": "#/definitions/Core.Models.Utilities.UserGroupSelection" }, "modifiedByUser": { "$ref": "#/definitions/Core.Models.Utilities.UserGroupSelection" }, "enableRecordDataRetention": { "type": "boolean" }, "recordDataRetentionInDays": { "type": "integer" }, "recordDataRetentionBatchSize": { "type": "integer" }, "enableRecordHistoryDataRetention": { "type": "boolean" }, "retainParentAlertCorrelationRecords": { "type": "boolean" }, "recordHistoryDataRetentionInDays": { "type": "integer" }, "uid": { "type": "string" }, "version": { "type": "integer" }, "id": { "type": "string" }, "name": { "type": "string" }, "disabled": { "type": "boolean" } }, "type": "object" }, "Core.Models.History.Revision": { "properties": { "revisionNumber": { "type": "number" }, "status": { "enum": [ "Current", "Historical", "Deleted" ], "type": "string" }, "userId": { "$ref": "#/definitions/Core.Models.Utilities.UserGroupSelection" }, "modifiedDate": { "type": "string" }, "version": {} }, "type": "object" }, "Core.Models.Base.EntityModification": { "properties": { "field": { "type": "string" }, "value": {}, "type": { "enum": [ "None", "Create", "Delete", "Append", "Subtract" ], "type": "string" } }, "type": "object" }, "Core.Commands.Applets.CopyAppletCommand": { "properties": { "modifications": { "items": { "$ref": "#/definitions/Core.Models.Base.EntityModification" }, "type": "array" }, "id": { "type": "string" } }, "type": "object" }, "Microsoft.Extensions.Primitives.StringSegment": { "properties": { "buffer": { "type": "string" }, "offset": { "type": "integer" }, "length": { "type": "integer" }, "value": { "type": "string" }, "hasValue": { "type": "boolean" } }, "type": "object" }, "Microsoft.Net.Http.Headers.EntityTagHeaderValue": { "properties": { "tag": { "$ref": "#/definitions/Microsoft.Extensions.Primitives.StringSegment" }, "isWeak": { "type": "boolean" } }, "type": "object" }, "Microsoft.AspNetCore.Mvc.FileResult": { "properties": { "contentType": { "type": "string" }, "fileDownloadName": { "type": "string" }, "lastModified": { "type": "string" }, "entityTag": { "$ref": "#/definitions/Microsoft.Net.Http.Headers.EntityTagHeaderValue" }, "enableRangeProcessing": { "type": "boolean" } }, "type": "object" }, "Microsoft.AspNetCore.Mvc.ContentResult": { "properties": { "content": { "type": "string" }, "contentType": { "type": "string" }, "statusCode": { "type": "integer" } }, "type": "object" }, "Core.Models.Applet.AppletExportImport": { "properties": { "swimlaneVersion": { "type": "string" }, "applet": { "$ref": "#/definitions/Core.Models.Applet.Applet" } }, "type": "object" }, "Api.Models.Applet.AppletImportModel": { "properties": { "modifications": { "items": { "$ref": "#/definitions/Core.Models.Base.EntityModification" }, "type": "array" }, "manifest": { "$ref": "#/definitions/Core.Models.Applet.AppletExportImport" } }, "type": "object" }, "Core.Models.Application.ApplicationViewModel": { "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "acronym": { "type": "string" }, "description": { "type": "string" }, "createdDate": { "type": "string" }, "createdByUser": { "$ref": "#/definitions/Core.Models.Utilities.UserGroupSelection" }, "modifiedDate": { "type": "string" }, "modifiedByUser": { "$ref": "#/definitions/Core.Models.Utilities.UserGroupSelection" } }, "type": "object" }, "Core.Models.Application.Application": { "properties": { "description": { "type": "string" }, "acronym": { "type": "string" }, "trackingFieldId": { "type": "string" }, "layout": { "items": { "$ref": "#/definitions/Core.Models.Layouts.Layout" }, "type": "array" }, "fields": { "items": { "$ref": "#/definitions/Core.Models.Fields.Field" }, "type": "array" }, "maxTrackingId": { "type": "number" }, "workspaces": { "items": { "type": "string" }, "type": "array" }, "createWorkspace": { "type": "boolean" }, "createdDate": { "type": "string" }, "createdByUser": { "$ref": "#/definitions/Core.Models.Utilities.UserGroupSelection" }, "modifiedDate": { "type": "string" }, "modifiedByUser": { "$ref": "#/definitions/Core.Models.Utilities.UserGroupSelection" }, "timeSpentFieldId": { "type": "string" }, "timeTrackingEnabled": { "type": "boolean" }, "enableRecordDataRetention": { "type": "boolean" }, "recordDataRetentionInDays": { "type": "integer" }, "recordDataRetentionBatchSize": { "type": "integer" }, "retainParentAlertCorrelationRecords": { "type": "boolean" }, "enableRecordHistoryDataRetention": { "type": "boolean" }, "recordHistoryDataRetentionInDays": { "type": "integer" }, "permissions": { "additionalProperties": { "$ref": "#/definitions/Core.Models.Security.Authorization" }, "type": "object" }, "uid": { "type": "string" }, "version": { "type": "integer" }, "id": { "type": "string" }, "name": { "type": "string" }, "disabled": { "type": "boolean" } }, "type": "object" }, "Core.Requests.Applications.Commands.CopyApplicationCommand": { "properties": { "modifications": { "items": { "$ref": "#/definitions/Core.Models.Base.EntityModification" }, "type": "array" }, "id": { "type": "string" } }, "type": "object" }, "Core.Models.Search.GroupBy": { "properties": { "fieldId": { "type": "string" }, "groupByType": { "enum": [ "GroupBy", "GroupByHour", "GroupByDay", "GroupByWeek", "GroupByMonth", "GroupByQuarter", "GroupByYear", "GroupByNull" ], "type": "string" } }, "type": "object" }, "Core.Models.Search.Aggregate": { "properties": { "fieldId": { "type": "string" }, "aggregateType": { "enum": [ "Average", "Count", "Sum", "Min", "Max" ], "type": "string" } }, "type": "object" }, "Core.Models.Search.Filter": { "properties": { "fieldId": { "type": "string" }, "filterType": { "enum": [ "Contains", "Excludes", "Equals", "DoesNotEqual", "LessThan", "LessThanOrEqual", "GreaterThan", "GreaterThanOrEqual", "Previous", "Current", "Next", "Exists", "Hour", "DayOfWeek" ], "type": "string" }, "dateFilterType": { "enum": [ "Minute", "Hour", "Day", "Week", "Month", "Quarter", "Year", "AllTime" ], "type": "string" }, "filterOperationType": { "enum": [ "And", "Or" ], "type": "string" }, "filters": { "items": { "$ref": "#/definitions/Core.Models.Search.Filter" }, "type": "array" }, "value": {}, "drillin": { "type": "boolean" } }, "type": "object" }, "Core.Models.Search.ChartSortOption": { "properties": { "name": {} }, "type": "object" }, "Core.Models.Search.ChartSort": { "properties": { "directionD0": { "enum": [ "LabelAscending", "LabelDescending", "Custom", "ValueAscending", "ValueDescending" ], "type": "string" }, "entriesD0": { "items": { "$ref": "#/definitions/Core.Models.Search.ChartSortOption" }, "type": "array" }, "directionD1": { "enum": [ "LabelAscending", "LabelDescending", "Custom", "ValueAscending", "ValueDescending" ], "type": "string" }, "entriesD1": { "items": { "$ref": "#/definitions/Core.Models.Search.ChartSortOption" }, "type": "array" } }, "type": "object" }, "Core.Models.Base.NameValue": { "properties": { "name": { "type": "string" }, "value": { "type": "string" }, "linkedId": { "type": "string" }, "isInternal": { "type": "boolean" } }, "type": "object" }, "Core.Models.Search.ChartOptions": { "properties": { "colorScheme": { "type": "string" }, "showLegend": { "type": "boolean" }, "legendPosition": { "enum": [ "Top", "Left", "Right", "Bottom", "None", "Advanced" ], "type": "string" }, "chartType": { "enum": [ "VerticalBar", "HorizontalBar", "Line", "Scatter", "Bubble", "Pie", "Heat", "Gauge", "Number", "Map", "Area", "AdvancedPie", "LinearGauge", "Widget", "Polar" ], "type": "string" }, "chartSubType": { "enum": [ "Doughnut", "Stacked", "FullStacked", "Step", "Spline", "PieGrid", "Usa", "World" ], "type": "string" }, "label": { "type": "string" }, "showLabels": { "type": "boolean" }, "showXAxis": { "type": "boolean" }, "showXAxisLabel": { "type": "boolean" }, "xAxisLabelText": { "type": "string" }, "showYAxis": { "type": "boolean" }, "showYAxisLabel": { "type": "boolean" }, "yAxisLabelText": { "type": "string" }, "gradient": { "type": "boolean" }, "zoom": { "type": "boolean" }, "autoScale": { "type": "boolean" }, "explodeSlices": { "type": "boolean" }, "transparentBackground": { "type": "boolean" }, "sort": { "$ref": "#/definitions/Core.Models.Search.ChartSort" }, "colorMap": { "items": { "$ref": "#/definitions/Core.Models.Base.NameValue" }, "type": "array" }, "showOtherGroup": { "type": "boolean" }, "curveType": { "type": "string" }, "showAxis": { "type": "boolean" }, "min": { "type": "number" }, "max": { "type": "number" }, "minRadius": { "type": "integer" }, "maxRadius": { "type": "integer" }, "units": { "type": "string" }, "bigSegments": { "type": "integer" }, "smallSegments": { "type": "integer" }, "angleSpan": { "type": "integer" }, "startAngle": { "type": "integer" }, "value": { "type": "number" }, "code": { "type": "string" }, "wrapTicks": { "type": "boolean" }, "maxXAxisTickLength": { "type": "integer" }, "maxYAxisTickLength": { "type": "integer" } }, "type": "object" }, "Core.Models.Search.Report": { "properties": { "groupBys": { "items": { "$ref": "#/definitions/Core.Models.Search.GroupBy" }, "type": "array" }, "aggregates": { "items": { "$ref": "#/definitions/Core.Models.Search.Aggregate" }, "type": "array" }, "applicationIds": { "items": { "type": "string" }, "type": "array" }, "keywords": { "type": "string" }, "columns": { "items": { "type": "string" }, "type": "array" }, "sorts": { "additionalProperties": { "enum": [ "Ascending", "Descending" ], "type": "string" }, "type": "object" }, "filters": { "items": { "$ref": "#/definitions/Core.Models.Search.Filter" }, "type": "array" }, "countByApplicationFacet": { "type": "boolean" }, "pageSize": { "type": "integer" }, "offset": { "type": "integer" }, "defaultSearchReport": { "type": "boolean" }, "allowed": { "items": { "$ref": "#/definitions/Core.Models.Utilities.UserGroupSelection" }, "type": "array" }, "permissions": { "additionalProperties": { "$ref": "#/definitions/Core.Models.Security.Authorization" }, "type": "object" }, "createdDate": { "type": "string" }, "modifiedDate": { "type": "string" }, "createdByUser": { "$ref": "#/definitions/Core.Models.Utilities.UserGroupSelection" }, "modifiedByUser": { "$ref": "#/definitions/Core.Models.Utilities.UserGroupSelection" }, "chartOptions": { "$ref": "#/definitions/Core.Models.Search.ChartOptions" }, "statsDrillin": { "type": "boolean" }, "filterType": { "type": "string" }, "autoRefreshMilliseconds": { "type": "integer" }, "uid": { "type": "string" }, "version": { "type": "integer" }, "id": { "type": "string" }, "name": { "type": "string" }, "disabled": { "type": "boolean" } }, "type": "object" }, "Core.Models.Search.StatsReport": { "properties": { "groupBys": { "items": { "$ref": "#/definitions/Core.Models.Search.GroupBy" }, "type": "array" }, "aggregates": { "items": { "$ref": "#/definitions/Core.Models.Search.Aggregate" }, "type": "array" }, "applicationIds": { "items": { "type": "string" }, "type": "array" }, "keywords": { "type": "string" }, "columns": { "items": { "type": "string" }, "type": "array" }, "sorts": { "additionalProperties": { "enum": [ "Ascending", "Descending" ], "type": "string" }, "type": "object" }, "filters": { "items": { "$ref": "#/definitions/Core.Models.Search.Filter" }, "type": "array" }, "countByApplicationFacet": { "type": "boolean" }, "pageSize": { "type": "integer" }, "offset": { "type": "integer" }, "defaultSearchReport": { "type": "boolean" }, "allowed": { "items": { "$ref": "#/definitions/Core.Models.Utilities.UserGroupSelection" }, "type": "array" }, "permissions": { "additionalProperties": { "$ref": "#/definitions/Core.Models.Security.Authorization" }, "type": "object" }, "createdDate": { "type": "string" }, "modifiedDate": { "type": "string" }, "createdByUser": { "$ref": "#/definitions/Core.Models.Utilities.UserGroupSelection" }, "modifiedByUser": { "$ref": "#/definitions/Core.Models.Utilities.UserGroupSelection" }, "chartOptions": { "$ref": "#/definitions/Core.Models.Search.ChartOptions" }, "statsDrillin": { "type": "boolean" }, "filterType": { "type": "string" }, "autoRefreshMilliseconds": { "type": "integer" }, "uid": { "type": "string" }, "version": { "type": "integer" }, "id": { "type": "string" }, "name": { "type": "string" }, "disabled": { "type": "boolean" } }, "type": "object" }, "Core.Models.Workspaces.Workspace": { "properties": { "description": { "type": "string" }, "createdDate": { "type": "string" }, "createdByUser": { "$ref": "#/definitions/Core.Models.Utilities.UserGroupSelection" }, "modifiedDate": { "type": "string" }, "modifiedByUser": { "$ref": "#/definitions/Core.Models.Utilities.UserGroupSelection" }, "dashboards": { "items": { "type": "string" }, "type": "array" }, "applications": { "items": { "type": "string" }, "type": "array" }, "permissions": { "additionalProperties": { "$ref": "#/definitions/Core.Models.Security.Authorization" }, "type": "object" }, "uid": { "type": "string" }, "version": { "type": "integer" }, "id": { "type": "string" }, "name": { "type": "string" }, "disabled": { "type": "boolean" } }, "type": "object" }, "Core.Models.Workspaces.Card": { "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "autoRefreshMilliseconds": { "type": "integer" }, "cardType": { "enum": [ "Report", "Html", "UsageStatistic" ], "type": "string" }, "row": { "type": "integer" }, "col": { "type": "integer" }, "sizeX": { "type": "integer" }, "sizeY": { "type": "integer" } }, "type": "object" }, "Core.Models.Workspaces.Dashboard": { "properties": { "description": { "type": "string" }, "workspaces": { "items": { "type": "string" }, "type": "array" }, "items": { "items": { "$ref": "#/definitions/Core.Models.Workspaces.Card" }, "type": "array" }, "timelineEnabled": { "type": "boolean" }, "timelineFilters": { "additionalProperties": { "type": "string" }, "type": "object" }, "minTimelineDate": { "type": "string" }, "maxTimelineDate": { "type": "string" }, "createdByUser": { "$ref": "#/definitions/Core.Models.Utilities.UserGroupSelection" }, "modifiedByUser": { "$ref": "#/definitions/Core.Models.Utilities.UserGroupSelection" }, "createdDate": { "type": "string" }, "modifiedDate": { "type": "string" }, "permissions": { "additionalProperties": { "$ref": "#/definitions/Core.Models.Security.Authorization" }, "type": "object" }, "allowed": { "items": { "$ref": "#/definitions/Core.Models.Utilities.UserGroupSelection" }, "type": "array" }, "uid": { "type": "string" }, "version": { "type": "integer" }, "id": { "type": "string" }, "name": { "type": "string" }, "disabled": { "type": "boolean" } }, "type": "object" }, "Core.Models.Application.ExportTransformation": { "properties": { "applicationId": { "type": "string" }, "format": { "type": "string" }, "createdByUser": { "$ref": "#/definitions/Core.Models.Utilities.UserGroupSelection" }, "modifiedByUser": { "$ref": "#/definitions/Core.Models.Utilities.UserGroupSelection" }, "createdDate": { "type": "string" }, "modifiedDate": { "type": "string" }, "uid": { "type": "string" }, "version": { "type": "integer" }, "id": { "type": "string" }, "name": { "type": "string" }, "disabled": { "type": "boolean" } }, "type": "object" }, "Core.Models.Application.ExportImportModel": { "properties": { "swimlaneVersion": { "type": "string" }, "application": { "$ref": "#/definitions/Core.Models.Application.Application" }, "reports": { "items": { "$ref": "#/definitions/Core.Models.Search.Report" }, "type": "array" }, "statsReports": { "items": { "$ref": "#/definitions/Core.Models.Search.StatsReport" }, "type": "array" }, "workspaces": { "items": { "$ref": "#/definitions/Core.Models.Workspaces.Workspace" }, "type": "array" }, "dashboards": { "items": { "$ref": "#/definitions/Core.Models.Workspaces.Dashboard" }, "type": "array" }, "workflows": { "items": { "$ref": "#/definitions/Core.Models.Workflow.Workflow" }, "type": "array" }, "exportTransformations": { "items": { "$ref": "#/definitions/Core.Models.Application.ExportTransformation" }, "type": "array" } }, "type": "object" }, "Core.Requests.Applications.Commands.ImportApplicationCommand": { "properties": { "modifications": { "items": { "$ref": "#/definitions/Core.Models.Base.EntityModification" }, "type": "array" }, "manifest": { "$ref": "#/definitions/Core.Models.Application.ExportImportModel" } }, "type": "object" }, "Microsoft.AspNetCore.Mvc.JsonResult": { "properties": { "contentType": { "type": "string" }, "serializerSettings": {}, "statusCode": { "type": "integer" }, "value": {} }, "type": "object" }, "Core.Services.ApplicationImportResult": { "properties": { "application": { "$ref": "#/definitions/Core.Models.Application.Application" }, "errors": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "Core.Models.Application.SwimlaneCorrelationInfo": { "properties": { "correlationFields": { "additionalProperties": { "enum": [ "Domain", "URL", "Email", "Filename", "FileAttachment", "IPv4Private", "IPv4Public", "IPv6Private", "IPv6Public", "MD5", "SHA1", "SHA256", "Ssdeep", "RawText", "Unknown" ], "type": "string" }, "type": "object" }, "correlationFilterFields": { "additionalProperties": { "enum": [ "Domain", "URL", "Email", "Filename", "FileAttachment", "IPv4Private", "IPv4Public", "IPv6Private", "IPv6Public", "MD5", "SHA1", "SHA256", "Ssdeep", "RawText", "Unknown" ], "type": "string" }, "type": "object" }, "optionalPlaybookId": { "type": "string" }, "fields": { "additionalProperties": { "enum": [ "None", "Ip", "Levenshtein", "Equal", "Tlsh", "ExactMatch" ], "type": "string" }, "type": "object" }, "filterFields": { "additionalProperties": { "enum": [ "None", "Ip", "Levenshtein", "Equal", "Tlsh", "ExactMatch" ], "type": "string" }, "type": "object" }, "correlationName": { "type": "string" }, "daysIncluded": { "type": "integer" }, "textConfidence": { "type": "integer" }, "minCorrelationKeys": { "type": "integer" } }, "type": "object" }, "Core.Models.Application.CorrelationConfigurationEntity": { "properties": { "applicationId": { "type": "string" }, "referenceFieldId": { "type": "string" }, "correlationInfo": { "$ref": "#/definitions/Core.Models.Application.SwimlaneCorrelationInfo" }, "uid": { "type": "string" }, "version": { "type": "integer" }, "id": { "type": "string" }, "name": { "type": "string" }, "disabled": { "type": "boolean" } }, "type": "object" }, "Core.Models.Integrations.Descriptors.Descriptor": { "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "example": { "type": "string" }, "type": { "enum": [ "Text", "Textarea", "Code", "Password", "List", "Number", "Boolean", "Iso8601", "Json", "Epoch", "EpochMs", "Date", "Email", "Url", "Telephone", "Ip", "Time", "Attachment", "NumericList", "Category" ], "type": "string" }, "required": { "type": "boolean" }, "default": {} }, "type": "object" }, "Core.Models.Integrations.Upgrade.ParameterIssue": { "properties": { "type": { "enum": [ "RequiredParameterNotMapped", "ParameterMissing", "ParametersAreDifferentType" ], "type": "string" }, "name": { "type": "string" }, "haveBreakingIssues": { "type": "boolean" } }, "type": "object" }, "Core.Models.Integrations.Upgrade.OutputIssue": { "properties": { "inputParameterIssues": { "items": { "$ref": "#/definitions/Core.Models.Integrations.Upgrade.ParameterIssue" }, "type": "array" }, "outputParameterIssues": { "items": { "$ref": "#/definitions/Core.Models.Integrations.Upgrade.ParameterIssue" }, "type": "array" }, "haveBreakingIssues": { "type": "boolean" } }, "type": "object" }, "Core.Models.Integrations.Upgrade.TaskIssue": { "properties": { "haveBreakingIssues": { "type": "boolean" }, "outputIssues": { "items": { "$ref": "#/definitions/Core.Models.Integrations.Upgrade.OutputIssue" }, "type": "array" }, "taskName": { "type": "string" }, "taskId": { "type": "string" }, "inputMappingIssues": { "items": { "$ref": "#/definitions/Core.Models.Integrations.Upgrade.ParameterIssue" }, "type": "array" } }, "type": "object" }, "Core.Models.Integrations.Upgrade.AssetIssue": { "properties": { "assetName": { "type": "string" }, "assetId": { "type": "string" }, "parameterIssues": { "items": { "$ref": "#/definitions/Core.Models.Integrations.Upgrade.ParameterIssue" }, "type": "array" }, "affectedTasks": { "items": { "$ref": "#/definitions/Core.Models.Integrations.Upgrade.TaskIssue" }, "type": "array" }, "haveBreakingIssues": { "type": "boolean" } }, "type": "object" }, "Core.Models.Integrations.Upgrade.AssetDescriptorIssue": { "properties": { "matched": { "enum": [ "Match", "New", "Old" ], "type": "string" }, "inputParameterIssues": { "items": { "$ref": "#/definitions/Core.Models.Integrations.Upgrade.ParameterIssue" }, "type": "array" }, "assetsAffected": { "items": { "$ref": "#/definitions/Core.Models.Integrations.Upgrade.AssetIssue" }, "type": "array" }, "existingAssetDescriptor": { "$ref": "#/definitions/Core.Models.Integrations.Assets.AssetDescriptor" }, "haveBreakingIssues": { "type": "boolean" } }, "type": "object" }, "Core.Models.Integrations.Descriptors.NameDescriptor": { "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "outputType": { "enum": [ "Text", "Textarea", "Code", "Password", "List", "Number", "Boolean", "Iso8601", "Json", "Epoch", "EpochMs", "Date", "Email", "Url", "Telephone", "Ip", "Time", "Attachment", "NumericList", "Category" ], "type": "string" }, "type": { "type": "integer" }, "disableEdit": { "type": "boolean" }, "isSystem": { "type": "boolean" } }, "type": "object" }, "Core.Models.Integrations.Actions.LicenseDescriptor": { "properties": { "package": { "type": "string" }, "license": { "type": "string" } }, "type": "object" }, "Core.Models.Integrations.Actions.AvailableActionDescriptor": { "properties": { "description": { "type": "string" }, "actionId": { "type": "string" }, "actionType": { "type": "string" }, "family": { "type": "string" }, "base64Image": { "type": "string" }, "readonly": { "type": "boolean" }, "assetDependencyType": { "type": "string" }, "assetDependencyVersion": { "type": "string" }, "pythonDependencies": { "additionalProperties": { "type": "string" }, "type": "object" }, "pythonVersion": { "enum": [ "Python2_7", "Python3_6", "Python3_7", "Python3", "Python3_12" ], "type": "string" }, "pythonVersionLabel": { "type": "string" }, "deprecationBanner": { "type": "boolean" }, "availableOutputVariables": { "additionalProperties": { "$ref": "#/definitions/Core.Models.Integrations.Descriptors.NameDescriptor" }, "type": "object" }, "availableOutputTypes": { "items": { "type": "string" }, "type": "array" }, "inputParameters": { "additionalProperties": { "$ref": "#/definitions/Core.Models.Integrations.Descriptors.Descriptor" }, "type": "object" }, "script": { "type": "string" }, "scriptFile": { "type": "string" }, "version": { "type": "string" }, "licenses": { "items": { "$ref": "#/definitions/Core.Models.Integrations.Actions.LicenseDescriptor" }, "type": "array" }, "packageDescriptor": { "$ref": "#/definitions/Core.Models.Integrations.Actions.PackageDescriptor" }, "imageId": { "type": "string" }, "meta": { "additionalProperties": {}, "type": "object" }, "outputs": { "type": "string" }, "createdDate": { "type": "string" }, "modifiedDate": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "disabled": { "type": "boolean" } }, "type": "object" }, "Core.Models.Integrations.Upgrade.AvailableActionDescriptorIssue": { "properties": { "matched": { "enum": [ "Match", "New", "Old" ], "type": "string" }, "inputParameterIssues": { "items": { "$ref": "#/definitions/Core.Models.Integrations.Upgrade.ParameterIssue" }, "type": "array" }, "affectedTasks": { "items": { "$ref": "#/definitions/Core.Models.Integrations.Upgrade.TaskIssue" }, "type": "array" }, "existingAvailableActionDescriptor": { "$ref": "#/definitions/Core.Models.Integrations.Actions.AvailableActionDescriptor" }, "availableOutputVariableIssues": { "items": { "$ref": "#/definitions/Core.Models.Integrations.Upgrade.ParameterIssue" }, "type": "array" }, "haveBreakingIssues": { "type": "boolean" } }, "type": "object" }, "Core.Models.Integrations.Upgrade.PackageIssue": { "properties": { "uploadStatus": { "enum": [ "None", "Inserted", "NeedUpgrade", "Present", "Upgraded", "InvalidOnThisOs", "PythonVersionNotSupported" ], "type": "string" }, "issueMessage": { "type": "string" }, "assetDescriptorIssue": { "items": { "$ref": "#/definitions/Core.Models.Integrations.Upgrade.AssetDescriptorIssue" }, "type": "array" }, "availableActionDescriptorIssues": { "items": { "$ref": "#/definitions/Core.Models.Integrations.Upgrade.AvailableActionDescriptorIssue" }, "type": "array" }, "existingPackageDescriptor": { "$ref": "#/definitions/Core.Models.Integrations.Actions.PackageDescriptor" }, "haveBreakingIssues": { "type": "boolean" } }, "type": "object" }, "Core.Models.Integrations.Actions.PackageDescriptor": { "properties": { "name": { "type": "string" }, "base64Image": { "type": "string" }, "description": { "type": "string" }, "author": { "type": "string" }, "versionHash": { "type": "string" }, "author_email": { "type": "string" }, "version": { "type": "string" }, "supported_swimlane_version": { "type": "string" }, "pythonVersion": { "type": "string" }, "python_version": { "type": "string" }, "url": { "type": "string" }, "installRequires": { "items": { "type": "string" }, "type": "array" }, "packages": { "items": { "type": "string" }, "type": "array" }, "bundleHash": { "type": "string" }, "fileId": { "type": "string" }, "isEmailBundle": { "type": "boolean" }, "packageIssue": { "$ref": "#/definitions/Core.Models.Integrations.Upgrade.PackageIssue" }, "vendor": { "type": "string" }, "product": { "type": "string" }, "family": { "type": "string" }, "readme": { "type": "string" }, "changeLog": { "type": "string" }, "createdDate": { "type": "string" }, "modifiedDate": { "type": "string" }, "id": { "type": "string" }, "disabled": { "type": "boolean" } }, "type": "object" }, "Core.Models.Integrations.Assets.AssetDescriptor": { "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "base64Image": { "type": "string" }, "family": { "type": "string" }, "version": { "type": "string" }, "description": { "type": "string" }, "testScript": { "type": "string" }, "testScriptFile": { "type": "string" }, "pythonVersion": { "enum": [ "Python2_7", "Python3_6", "Python3_7", "Python3", "Python3_12" ], "type": "string" }, "inputParameters": { "additionalProperties": { "$ref": "#/definitions/Core.Models.Integrations.Descriptors.Descriptor" }, "type": "object" }, "packageDescriptor": { "$ref": "#/definitions/Core.Models.Integrations.Actions.PackageDescriptor" }, "imageId": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "disabled": { "type": "boolean" } }, "type": "object" }, "Core.Models.Integrations.Assets.Asset": { "properties": { "description": { "type": "string" }, "type": { "type": "string" }, "pythonVersion": { "enum": [ "Python2_7", "Python3_6", "Python3_7", "Python3", "Python3_12" ], "type": "string" }, "parameters": { "additionalProperties": {}, "type": "object" }, "descriptor": { "$ref": "#/definitions/Core.Models.Integrations.Assets.AssetDescriptor" }, "valid": { "type": "boolean" }, "uid": { "type": "string" }, "version": { "type": "integer" }, "id": { "type": "string" }, "name": { "type": "string" }, "disabled": { "type": "boolean" } }, "type": "object" }, "Api.Models.Integration.AssetLight": { "properties": { "valid": { "type": "boolean" }, "assetDescriptorVersion": { "type": "string" }, "pythonVersion": { "type": "string" }, "assetDescriptorProduct": { "type": "string" }, "assetDescriptorVendor": { "type": "string" }, "assetDescriptorImageId": { "type": "string" }, "assetDescriptorDescription": { "type": "string" }, "assetDescriptorName": { "type": "string" }, "type": { "type": "string" }, "disabled": { "type": "boolean" }, "description": { "type": "string" }, "name": { "type": "string" }, "id": { "type": "string" } }, "type": "object" }, "Api.Models.Integration.AssetList": { "properties": { "images": { "additionalProperties": { "type": "string" }, "type": "object" }, "assets": { "items": { "$ref": "#/definitions/Api.Models.Integration.AssetLight" }, "type": "array" } }, "type": "object" }, "Core.Models.Integrations.Assets.AssetTestResult": { "properties": { "successful": { "type": "boolean" }, "errorMessage": { "type": "string" } }, "type": "object" }, "Api.Models.Content.ExportDownloadRequest": { "properties": { "exportName": { "type": "string" }, "entryPointIds": { "items": { "type": "string" }, "type": "array" }, "entryPointType": { "enum": [ "None", "Application", "Applet", "Playbook", "Workspace", "Dashboard" ], "type": "string" }, "globalEntryPoints": { "additionalProperties": { "enum": [ "None", "Application", "Applet", "Playbook", "Workspace", "Dashboard" ], "type": "string" }, "type": "object" }, "exportSelectedEntities": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "Api.Models.Content.ExportRequest": { "properties": { "entryPointIds": { "items": { "type": "string" }, "type": "array" }, "entryPointType": { "enum": [ "None", "Application", "Applet", "Playbook", "Workspace", "Dashboard" ], "type": "string" }, "globalEntryPoints": { "additionalProperties": { "enum": [ "None", "Application", "Applet", "Playbook", "Workspace", "Dashboard" ], "type": "string" }, "type": "object" }, "exportSelectedEntities": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "Swimlane.Platform.Content.Model.Problem": { "properties": { "errorCode": { "type": "integer" }, "message": { "type": "string" }, "parentId": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "Core.Models.Content.DescriptorResult": { "properties": { "description": { "type": "string" }, "version": { "type": "string" }, "imageMd5": { "type": "string" }, "availableActionDescriptorName": { "type": "string" } }, "type": "object" }, "Core.Models.Content.ResponseEntity": { "properties": { "acronym": { "type": "string" }, "applicationId": { "type": "string" }, "valid": { "type": "boolean" }, "descriptor": { "$ref": "#/definitions/Core.Models.Content.DescriptorResult" }, "uid": { "type": "string" }, "version": { "type": "integer" }, "id": { "type": "string" }, "name": { "type": "string" }, "disabled": { "type": "boolean" } }, "type": "object" }, "Core.Models.Content.Relationship.IRelationshipGraph": { "type": "object" }, "Swimlane.Platform.Content.Model.ContentActionResult": { "properties": { "errors": { "additionalProperties": { "items": { "$ref": "#/definitions/Swimlane.Platform.Content.Model.Problem" }, "type": "array" }, "type": "object" }, "entities": { "additionalProperties": { "items": { "$ref": "#/definitions/Core.Models.Content.ResponseEntity" }, "type": "array" }, "type": "object" }, "state": { "enum": [ "Incomplete", "Success", "Failure" ], "type": "string" }, "issues": { "additionalProperties": { "items": { "$ref": "#/definitions/Swimlane.Platform.Content.Model.Problem" }, "type": "array" }, "type": "object" }, "images": { "additionalProperties": { "type": "string" }, "type": "object" }, "swimlaneVersion": { "type": "string" }, "relationshipGraph": { "$ref": "#/definitions/Core.Models.Content.Relationship.IRelationshipGraph" } }, "type": "object" }, "Core.Models.Base.TrackedEntity": { "properties": { "uid": { "type": "string" }, "version": { "type": "integer" }, "id": { "type": "string" }, "name": { "type": "string" }, "disabled": { "type": "boolean" } }, "type": "object" }, "Core.Models.Content.ContentExchangeProblem": { "properties": { "errorCode": { "type": "integer" }, "message": { "type": "string" }, "parentId": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "Core.Models.Content.ContentExchangeResult": { "properties": { "entities": { "additionalProperties": { "items": { "$ref": "#/definitions/Core.Models.Base.TrackedEntity" }, "type": "array" }, "type": "object" }, "issues": { "additionalProperties": { "items": { "$ref": "#/definitions/Core.Models.Content.ContentExchangeProblem" }, "type": "array" }, "type": "object" }, "errors": { "additionalProperties": { "items": { "$ref": "#/definitions/Core.Models.Content.ContentExchangeProblem" }, "type": "array" }, "type": "object" }, "createdDate": { "type": "string" }, "modifiedDate": { "type": "string" }, "createdByUser": { "$ref": "#/definitions/Core.Models.Utilities.UserGroupSelection" }, "modifiedByUser": { "$ref": "#/definitions/Core.Models.Utilities.UserGroupSelection" }, "state": { "enum": [ "Incomplete", "Success", "Failure" ], "type": "string" }, "images": { "additionalProperties": { "type": "string" }, "type": "object" }, "swimlaneVersion": { "type": "string" }, "relationshipGraph": { "$ref": "#/definitions/Core.Models.Content.Relationship.IRelationshipGraph" }, "id": { "type": "string" }, "name": { "type": "string" }, "disabled": { "type": "boolean" } }, "type": "object" }, "Microsoft.AspNetCore.Http.IFormFile": { "properties": { "contentType": { "type": "string" }, "contentDisposition": { "type": "string" }, "headers": { "additionalProperties": { "items": { "type": "string" }, "type": "array" }, "type": "object" }, "length": { "type": "integer" }, "name": { "type": "string" }, "fileName": { "type": "string" } }, "type": "object" }, "Api.Models.DataImport.FileImportColumn": { "properties": { "header": { "type": "string" }, "fieldId": { "type": "string" }, "addMissing": { "type": "boolean" }, "hasHeaders": { "type": "boolean" }, "dataFormat": { "type": "string" }, "userFormat": { "type": "string" }, "customDataFormat": { "type": "string" } }, "type": "object" }, "Api.Models.DataImport.FileImport": { "properties": { "fileId": { "type": "string" }, "applicationId": { "type": "string" }, "columns": { "items": { "$ref": "#/definitions/Api.Models.DataImport.FileImportColumn" }, "type": "array" }, "createType": { "enum": [ "InsertOnly", "Replace", "Update" ], "type": "string" }, "errorHandlingType": { "enum": [ "SetEmptyColumn", "SkipRow", "CancelImport" ], "type": "string" }, "keyFieldId": { "type": "string" }, "hasHeaders": { "type": "boolean" } }, "type": "object" }, "Core.Commands.Fields.AddFieldsToApplicationCommand": { "properties": { "applicationId": { "type": "string" }, "fields": { "items": { "$ref": "#/definitions/Core.Models.Fields.Field" }, "type": "array" }, "createLayout": { "enum": [ "None", "AddToHidden", "AddToLayout", "AddToNewSection" ], "type": "string" }, "sectionName": { "type": "string" } }, "type": "object" }, "Core.Commands.Fields.AddFieldsToAppletCommand": { "properties": { "appletId": { "type": "string" }, "fields": { "items": { "$ref": "#/definitions/Core.Models.Fields.Field" }, "type": "array" }, "createLayout": { "enum": [ "None", "AddToHidden", "AddToLayout", "AddToNewSection" ], "type": "string" }, "sectionName": { "type": "string" } }, "type": "object" }, "Api.Models.Application.FieldTypeModel": { "properties": { "fieldType": { "enum": [ "None", "Text", "Numeric", "ValuesList", "Date", "UserGroup", "Attachment", "Tracking", "Reference", "Comments", "History", "List" ], "type": "string" }, "fieldSubType": { "type": "string" } }, "type": "object" }, "Api.Models.Application.CalculationViewModel": { "properties": { "formula": { "type": "string" }, "application": { "$ref": "#/definitions/Core.Models.Application.Application" } }, "type": "object" }, "Core.Models.Base.Entity": { "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "disabled": { "type": "boolean" } }, "type": "object" }, "Core.Models.Groups.Group": { "properties": { "description": { "type": "string" }, "users": { "items": { "$ref": "#/definitions/Core.Models.Base.Entity" }, "type": "array" }, "groups": { "items": { "$ref": "#/definitions/Core.Models.Base.Entity" }, "type": "array" }, "roles": { "items": { "$ref": "#/definitions/Core.Models.Base.Entity" }, "type": "array" }, "activeDirectoryGuids": { "items": { "type": "string" }, "type": "array" }, "createdDate": { "type": "string" }, "modifiedDate": { "type": "string" }, "createdByUser": { "$ref": "#/definitions/Core.Models.Utilities.UserGroupSelection" }, "modifiedByUser": { "$ref": "#/definitions/Core.Models.Utilities.UserGroupSelection" }, "id": { "type": "string" }, "name": { "type": "string" }, "disabled": { "type": "boolean" } }, "type": "object" }, "Api.Models.PagedResponse": { "properties": { "totalCount": { "type": "integer" }, "items": { "items": { "$ref": "#/definitions/Core.Models.Groups.Group" }, "type": "array" } }, "type": "object" }, "Microsoft.AspNetCore.Mvc.OkResult": { "properties": { "statusCode": { "type": "integer" } }, "type": "object" }, "Api.Controllers.HealthController+HealthTestResult": { "properties": { "mongoDbCheck": { "type": "boolean" }, "directoryConectedCheck": { "type": "boolean" }, "apiCheck": { "type": "boolean" }, "apiPoolCheck": { "type": "boolean" }, "taskCheck": { "type": "boolean" }, "tasksStatus": { "additionalProperties": { "additionalProperties": { "type": "integer" }, "type": "object" }, "type": "object" }, "errors": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "Api.Models.Health.HangfireJobStats": { "properties": { "enqueued": { "type": "integer" }, "scheduled": { "type": "integer" }, "processing": { "type": "integer" }, "succeeded": { "type": "integer" }, "failed": { "type": "integer" }, "deleted": { "type": "integer" } }, "type": "object" }, "Api.Models.Icons.IconImageModel": { "properties": { "image64": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "thumbnail64": { "type": "string" } }, "type": "object" }, "Api.Models.Icons.IconModel": { "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "thumbnail64": { "type": "string" } }, "type": "object" }, "Api.Models.PagedResponse": { "properties": { "totalCount": { "type": "integer" }, "items": { "items": { "$ref": "#/definitions/Api.Models.Icons.IconModel" }, "type": "array" } }, "type": "object" }, "Core.Models.Log.LogSearchBase": { "properties": { "level": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "Core.Infrastructure.Logging.Layout.FullDebugLayout+LogData": { "properties": { "level": { "type": "string" }, "message": { "type": "string" }, "timeStamp": { "type": "string" }, "hostName": { "type": "string" }, "userName": { "type": "string" }, "methodName": { "type": "string" }, "exceptionMessage": { "type": "string" }, "exceptionMethod": { "type": "string" }, "exceptionType": { "type": "string" }, "exceptionStackTrace": { "type": "string" }, "exceptionWithInner": { "type": "string" }, "ipAddress": { "type": "string" }, "id": { "type": "string" } }, "type": "object" }, "Core.Models.Log.LogSearchOffset": { "properties": { "offset": { "type": "string" }, "queryFilter": { "enum": [ "Contains", "Excludes", "Equals", "DoesNotEqual", "LessThan", "LessThanOrEqual", "GreaterThan", "GreaterThanOrEqual", "Previous", "Current", "Next", "Exists", "Hour", "DayOfWeek" ], "type": "string" }, "querySort": { "enum": [ "Ascending", "Descending" ], "type": "string" }, "level": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "Core.Models.Log.LogSearchDate": { "properties": { "date": { "type": "string" }, "level": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "Core.Models.Notifications.RecordMessage": { "properties": { "message": { "type": "string" }, "recordId": { "type": "string" }, "trackingId": { "type": "string" }, "exception": { "type": "string" } }, "type": "object" }, "Core.Models.Notifications.BulkModifyFinishedNotification": { "properties": { "applicationId": { "type": "string" }, "bulkModificationType": { "enum": [ "None", "Delete", "Update" ], "type": "string" }, "errors": { "items": { "$ref": "#/definitions/Core.Models.Notifications.RecordMessage" }, "type": "array" }, "totalRecordsSkipped": { "type": "integer" }, "totalRecordsUpdated": { "type": "integer" }, "warnings": { "items": { "$ref": "#/definitions/Core.Models.Notifications.RecordMessage" }, "type": "array" }, "notificationType": { "enum": [ "Record", "Console", "Lock" ], "type": "string" }, "jobId": {}, "taskName": {}, "status": { "type": "string" }, "output": { "type": "string" }, "recordId": { "type": "string" }, "fromWorkflow": { "type": "boolean" }, "userName": { "type": "string" }, "dateTime": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "disabled": { "type": "boolean" } }, "type": "object" }, "Core.Models.Jobs.JobInfo": { "properties": { "task": { "type": "string" }, "job": { "type": "string" }, "status": { "enum": [ "None", "Created", "InProgress", "Completed", "Failed", "Started" ], "type": "string" }, "message": { "type": "string" }, "details": { "$ref": "#/definitions/Core.Models.Notifications.BulkModifyFinishedNotification" }, "createdDate": { "type": "string" }, "modifiedDate": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "disabled": { "type": "boolean" } }, "type": "object" }, "Core.Models.Log.LogSearchBulk": { "properties": { "pageNumber": { "type": "integer" }, "limit": { "type": "integer" }, "from": { "type": "string" }, "to": { "type": "string" }, "relativeTime": { "type": "string" }, "searchValue": { "type": "string" }, "level": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "Core.Models.Log.BulkLogs": { "properties": { "logs": { "items": { "$ref": "#/definitions/Core.Infrastructure.Logging.Layout.FullDebugLayout%2bLogData" }, "type": "array" }, "totalLogs": { "type": "integer" }, "pagesCount": { "type": "integer" }, "from": { "type": "string" }, "to": { "type": "string" }, "level": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "Core.Requests.OneTimePassword.Commands.EnrollOneTimePasswordCommand": { "properties": { "userName": { "type": "string" }, "password": { "type": "string" } }, "type": "object" }, "Core.Requests.OneTimePassword.Commands.OneTimePasswordSecret": { "properties": { "secret": { "type": "string" }, "keyUri": { "type": "string" } }, "type": "object" }, "Microsoft.AspNetCore.Mvc.UnauthorizedResult": { "properties": { "statusCode": { "type": "integer" } }, "type": "object" }, "Core.Requests.OneTimePassword.Commands.VerifyOneTimePasswordSecretCommand": { "properties": { "userName": { "type": "string" }, "password": { "type": "string" }, "oneTimePassword": { "type": "string" } }, "type": "object" }, "Microsoft.AspNetCore.Mvc.OkObjectResult": { "properties": { "value": {}, "formatters": { "items": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.Formatters.IOutputFormatter" }, "type": "array" }, "contentTypes": { "items": { "type": "string" }, "type": "array" }, "declaredType": { "type": "string" }, "statusCode": { "type": "integer" } }, "type": "object" }, "Core.Requests.OneTimePassword.Commands.OptOutOfOneTimePasswordCommand": { "properties": { "password": { "type": "string" } }, "type": "object" }, "Core.Requests.OneTimePassword.Commands.ExemptUserFromOneTimePasswordCommand": { "properties": { "userName": { "type": "string" } }, "type": "object" }, "Core.Requests.OneTimePassword.Commands.ResetOneTimePasswordCommand": { "properties": { "userName": { "type": "string" } }, "type": "object" }, "Core.Models.Python.PipPackage": { "properties": { "version": { "type": "string" }, "summary": { "type": "string" }, "homePage": { "type": "string" }, "author": { "type": "string" }, "authorEmail": { "type": "string" }, "license": { "type": "string" }, "requires": { "items": { "type": "string" }, "type": "array" }, "pythonVersion": { "enum": [ "Python2_7", "Python3_6", "Python3_7", "Python3", "Python3_12" ], "type": "string" }, "pythonVersionLabel": { "type": "string" }, "fileId": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "disabled": { "type": "boolean" } }, "type": "object" }, "Core.Requests.PipPackages.InstallPackageCommand": { "required": [ "name" ], "properties": { "name": { "type": "string" }, "version": { "type": "string" }, "pythonVersion": { "enum": [ "Python2_7", "Python3_6", "Python3_7", "Python3", "Python3_12" ], "type": "string" } }, "type": "object" }, "Microsoft.AspNetCore.Mvc.ActionResult": { "type": "object" }, "Core.Models.Record.VisualizationData": { "properties": { "dateFound": { "type": "string" }, "assetId": { "type": "string" }, "count": { "type": "integer" } }, "type": "object" }, "Core.Models.Record.CoeditRecord": { "properties": { "editors": { "items": { "$ref": "#/definitions/Core.Models.Utilities.UserGroupSelection" }, "type": "array" }, "recordId": { "type": "string" }, "applicationId": { "type": "string" }, "values": { "additionalProperties": {}, "type": "object" }, "createdDate": { "type": "string" }, "modifiedDate": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "disabled": { "type": "boolean" } }, "type": "object" }, "Core.Models.Record.Comments": { "properties": { "message": { "type": "string" }, "createdDate": { "type": "string" }, "createdByUser": { "$ref": "#/definitions/Core.Models.Utilities.UserGroupSelection" }, "modifiedByUser": { "$ref": "#/definitions/Core.Models.Utilities.UserGroupSelection" }, "modifiedDate": { "type": "string" }, "isRichText": { "type": "boolean" } }, "type": "object" }, "Core.Models.Base.ExecutionMetadata": { "properties": { "started": { "type": "string" }, "finished": { "type": "string" }, "originator": { "$ref": "#/definitions/Core.Models.Utilities.UserGroupSelection" } }, "type": "object" }, "Core.Models.Workflow.WorkflowRun": { "properties": { "workflowRunId": { "type": "string" }, "workflowId": { "type": "string" }, "applicationId": { "type": "string" }, "recordId": { "type": "string" }, "executionMetadata": { "$ref": "#/definitions/Core.Models.Base.ExecutionMetadata" }, "sequence": { "type": "integer" }, "workflowVersion": { "type": "integer" }, "success": { "type": "boolean" }, "lastFailedActionId": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "disabled": { "type": "boolean" } }, "type": "object" }, "Core.Models.Record.Record": { "properties": { "name": { "type": "string" }, "allowed": { "items": { "$ref": "#/definitions/Core.Models.Utilities.UserGroupSelection" }, "type": "array" }, "trackingId": { "type": "number" }, "trackingFull": { "type": "string" }, "applicationId": { "type": "string" }, "referencedRecordIds": { "items": { "type": "string" }, "type": "array" }, "referencedByIds": { "items": { "type": "string" }, "type": "array" }, "referenceTrackingMap": { "additionalProperties": { "type": "string" }, "type": "object" }, "matches": { "items": { "type": "string" }, "type": "array" }, "isNew": { "type": "boolean" }, "values": { "additionalProperties": {}, "type": "object" }, "repeatFieldCurrentValues": { "additionalProperties": {}, "type": "object" }, "valuesDocument": { "additionalProperties": {}, "type": "object" }, "actionsExecuted": { "additionalProperties": {}, "type": "object" }, "visualizations": { "additionalProperties": { "items": { "$ref": "#/definitions/Core.Models.Record.VisualizationData" }, "type": "array" }, "type": "object" }, "applicationRevision": { "type": "number" }, "coeditSession": { "$ref": "#/definitions/Core.Models.Record.CoeditRecord" }, "locked": { "type": "boolean" }, "lockingUser": { "$ref": "#/definitions/Core.Models.Utilities.UserGroupSelection" }, "lockedDate": { "type": "string" }, "lockingJob": { "type": "string" }, "comments": { "additionalProperties": { "items": { "$ref": "#/definitions/Core.Models.Record.Comments" }, "type": "array" }, "type": "object" }, "createdDate": { "type": "string" }, "modifiedDate": { "type": "string" }, "createdByUser": { "$ref": "#/definitions/Core.Models.Utilities.UserGroupSelection" }, "modifiedByUser": { "$ref": "#/definitions/Core.Models.Utilities.UserGroupSelection" }, "sessionTimeSpent": { "type": "integer" }, "totalTimeSpent": { "type": "integer" }, "timeTrackingEnabled": { "type": "boolean" }, "hangfireJobId": { "type": "string" }, "isHangfireCreatedAndUnpersisted": { "type": "boolean" }, "infiniteLoopFlag": { "type": "boolean" }, "latestWorkflowRun": { "items": { "$ref": "#/definitions/Core.Models.Workflow.WorkflowRun" }, "type": "array" }, "lockTimestamp": { "type": "string" }, "isStoredExternally": { "type": "boolean" }, "largeTextFieldHashes": { "additionalProperties": { "type": "string" }, "type": "object" }, "id": { "type": "string" }, "disabled": { "type": "boolean" } }, "type": "object" }, "Microsoft.AspNetCore.Mvc.BadRequestObjectResult": { "properties": { "value": {}, "formatters": { "items": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.Formatters.IOutputFormatter" }, "type": "array" }, "contentTypes": { "items": { "type": "string" }, "type": "array" }, "declaredType": { "type": "string" }, "statusCode": { "type": "integer" } }, "type": "object" }, "Api.Models.Record.RecordReferencesModel": { "properties": { "recordIds": { "items": { "type": "string" }, "type": "array" }, "fieldIds": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "Core.Models.Record.ReferencedRecord": { "properties": { "recordId": { "type": "string" }, "values": { "additionalProperties": {}, "type": "object" }, "applicationId": { "type": "string" }, "allowed": { "items": { "$ref": "#/definitions/Core.Models.Utilities.UserGroupSelection" }, "type": "array" } }, "type": "object" }, "Api.Models.Record.AddReferenceModel": { "properties": { "fieldId": { "type": "string" }, "targetRecordIds": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "Core.Models.Record.UniqueValidationResult": { "properties": { "unique": { "type": "boolean" } }, "type": "object" }, "Core.Utilities.Extensions.Change": { "properties": { "old": {}, "new": {} }, "type": "object" }, "Core.Models.History.RecordHistory+RecordDifferential": { "properties": { "valuesChange": { "additionalProperties": { "$ref": "#/definitions/Core.Utilities.Extensions.Change" }, "type": "object" }, "newComments": { "additionalProperties": { "items": { "$ref": "#/definitions/Core.Models.Record.Comments" }, "type": "array" }, "type": "object" } }, "type": "object" }, "Core.Models.History.RecordHistory": { "properties": { "differential": { "$ref": "#/definitions/Core.Models.History.RecordHistory%2bRecordDifferential" }, "fromRevisionNumber": { "type": "number" }, "referenceId": { "type": "string" }, "referenceCollection": { "type": "string" }, "revisionNumber": { "type": "number" }, "status": { "enum": [ "Current", "Historical", "Deleted" ], "type": "string" }, "userId": { "$ref": "#/definitions/Core.Models.Utilities.UserGroupSelection" }, "modifiedDate": { "type": "string" }, "version": {}, "id": { "type": "string" }, "name": { "type": "string" }, "disabled": { "type": "boolean" } }, "type": "object" }, "Core.Models.Record.CorrelationReassignRequest": { "properties": { "applicationId": { "type": "string" }, "recordIds": { "items": { "type": "string" }, "type": "array" }, "parentRecordId": { "type": "string" } }, "type": "object" }, "Core.Models.Record.Batch.Locator": { "properties": { "value": { "type": "string" }, "type": { "enum": [ "None", "Id", "Name", "Key" ], "type": "string" } }, "type": "object" }, "Core.Models.Record.Batch.Modification": { "properties": { "fieldId": { "$ref": "#/definitions/Core.Models.Record.Batch.Locator" }, "value": {}, "type": { "enum": [ "None", "Create", "Delete", "Append", "Subtract" ], "type": "string" } }, "type": "object" }, "Core.Models.Record.Batch.BatchRequest": { "properties": { "applicationId": { "type": "string" }, "changeAll": { "type": "boolean" }, "filters": { "items": { "$ref": "#/definitions/Core.Models.Search.Filter" }, "type": "array" }, "keywords": { "type": "string" }, "recordIds": { "items": { "type": "string" }, "type": "array" }, "cutOffDate": { "type": "string" }, "modifications": { "items": { "$ref": "#/definitions/Core.Models.Record.Batch.Modification" }, "type": "array" } }, "type": "object" }, "Core.Models.Roles.Role": { "properties": { "description": { "type": "string" }, "permissions": { "additionalProperties": { "$ref": "#/definitions/Core.Models.Security.Authorization" }, "type": "object" }, "createdDate": { "type": "string" }, "modifiedDate": { "type": "string" }, "createdByUser": { "$ref": "#/definitions/Core.Models.Utilities.UserGroupSelection" }, "modifiedByUser": { "$ref": "#/definitions/Core.Models.Utilities.UserGroupSelection" }, "groups": { "items": { "$ref": "#/definitions/Core.Models.Base.Entity" }, "type": "array" }, "roles": { "items": { "$ref": "#/definitions/Core.Models.Base.Entity" }, "type": "array" }, "users": { "items": { "$ref": "#/definitions/Core.Models.Base.Entity" }, "type": "array" }, "id": { "type": "string" }, "name": { "type": "string" }, "disabled": { "type": "boolean" } }, "type": "object" }, "Api.Models.PagedResponse": { "properties": { "totalCount": { "type": "integer" }, "items": { "items": { "$ref": "#/definitions/Core.Models.Roles.Role" }, "type": "array" } }, "type": "object" }, "Core.Models.Utilities.ItemUserGroupSelection": { "properties": { "itemType": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "Core.Models.Scheduled.ScheduledDashboardCard": { "properties": { "cardId": { "type": "string" }, "row": { "type": "integer" }, "col": { "type": "integer" }, "sizeX": { "type": "integer" }, "sizeY": { "type": "integer" }, "recipients": { "items": { "$ref": "#/definitions/Core.Models.Utilities.ItemUserGroupSelection" }, "type": "array" }, "notes": { "type": "string" }, "includeLink": { "type": "boolean" }, "cronExpression": { "type": "string" }, "runOneTime": { "type": "string" }, "layout": { "enum": [ "Portrait", "Landscape" ], "type": "string" }, "header": { "type": "string" }, "footer": { "type": "string" }, "createdDate": { "type": "string" }, "createdByUser": { "$ref": "#/definitions/Core.Models.Utilities.UserGroupSelection" }, "modifiedDate": { "type": "string" }, "modifiedByUser": { "$ref": "#/definitions/Core.Models.Utilities.UserGroupSelection" }, "currentUserId": { "type": "string" }, "link": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "disabled": { "type": "boolean" } }, "type": "object" }, "Api.Models.Report.ScheduledViewModel": { "properties": { "applicationId": { "type": "string" }, "notes": { "type": "string" }, "recipients": { "items": { "$ref": "#/definitions/Core.Models.Utilities.ItemUserGroupSelection" }, "type": "array" }, "includeLink": { "type": "boolean" }, "includeCsv": { "type": "boolean" }, "includeTable": { "type": "boolean" }, "scheduleType": { "enum": [ "Recurring", "OneTime" ], "type": "string" }, "cronExpression": { "type": "string" }, "scheduleTime": { "type": "string" }, "layout": { "enum": [ "Portrait", "Landscape" ], "type": "string" }, "reportId": { "type": "string" }, "dashboardId": { "type": "string" }, "scheduleReportType": { "enum": [ "Report", "Dashboard" ], "type": "string" }, "createdDate": { "type": "string" }, "createdByUser": { "$ref": "#/definitions/Core.Models.Utilities.UserGroupSelection" }, "modifiedByUser": { "$ref": "#/definitions/Core.Models.Utilities.UserGroupSelection" }, "modifiedDate": { "type": "string" }, "dashboardCards": { "items": { "$ref": "#/definitions/Core.Models.Scheduled.ScheduledDashboardCard" }, "type": "array" }, "header": { "type": "string" }, "footer": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "disabled": { "type": "boolean" } }, "type": "object" }, "Core.Requests.Search.Queries.SearchReportKeywordResult": { "properties": { "records": { "items": { "$ref": "#/definitions/Core.Models.Record.Record" }, "type": "array" } }, "type": "object" }, "Api.Models.Search.GroupedSearchResults": { "properties": { "results": { "additionalProperties": { "items": { "$ref": "#/definitions/Core.Models.Record.Record" }, "type": "array" }, "type": "object" }, "count": { "type": "integer" }, "offset": { "type": "integer" }, "limit": { "type": "integer" }, "isCountLimited": { "type": "boolean" } }, "type": "object" }, "Core.Models.FeatureFlags.FeatureFlag": { "properties": { "description": { "type": "string" }, "groupName": { "type": "string" }, "shortName": { "type": "string" }, "system": { "type": "boolean" }, "id": { "type": "string" }, "name": { "type": "string" }, "disabled": { "type": "boolean" } }, "type": "object" }, "Api.Models.Settings.ToggleFeatureRequestModel": { "properties": { "disabled": { "type": "boolean" } }, "type": "object" }, "Api.Models.Settings.ValidateGroupViewModel": { "properties": { "domain": { "type": "string" }, "groups": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "Api.Models.Settings.ConnectionTestResult": { "properties": { "successful": { "type": "boolean" }, "reason": { "type": "string" } }, "type": "object" }, "Core.Models.Settings.DirectoryServerSettings": { "required": [ "type", "userName", "password", "domain" ], "properties": { "type": { "enum": [ "OpenLdap", "ActiveDirectory" ], "type": "string" }, "server": { "type": "string" }, "userName": { "type": "string" }, "password": { "type": "string" }, "passwordBytes": { "type": "string" }, "domain": { "type": "string" }, "ssl": { "type": "boolean" }, "tls": { "type": "boolean" }, "allowInvalidCertificates": { "type": "boolean" }, "authorizationType": { "enum": [ "Negotiate", "Basic" ], "type": "string" }, "protocolVersion": { "type": "integer" }, "valid": { "type": "boolean" } }, "type": "object" }, "Core.Models.Settings.DirectoryUserSettings": { "required": [ "objectClass", "uniqueId", "accountNameField" ], "properties": { "objectClass": { "type": "string" }, "uniqueId": { "type": "string" }, "accountNameField": { "type": "string" }, "memberOfField": { "type": "string" }, "mapping": { "additionalProperties": { "type": "string" }, "type": "object" }, "memberOfFieldTarget": { "type": "string" }, "userLocation": { "type": "string" } }, "type": "object" }, "Core.Models.Settings.DirectoryGroupSettings": { "required": [ "objectClass" ], "properties": { "objectClass": { "type": "string" }, "userMembershipField": { "type": "string" }, "groupLocation": { "type": "string" }, "userMembershipFieldTarget": { "type": "string" } }, "type": "object" }, "Core.Models.Settings.DirectorySettings": { "required": [ "enabled", "groups", "serverSettings", "userSettings", "groupSettings", "membership" ], "properties": { "enabled": { "type": "boolean" }, "groups": { "items": { "type": "string" }, "type": "array" }, "serverSettings": { "$ref": "#/definitions/Core.Models.Settings.DirectoryServerSettings" }, "userSettings": { "$ref": "#/definitions/Core.Models.Settings.DirectoryUserSettings" }, "groupSettings": { "$ref": "#/definitions/Core.Models.Settings.DirectoryGroupSettings" }, "membership": { "enum": [ "ByGroupField", "ByUserField" ], "type": "string" }, "valid": { "type": "boolean" } }, "type": "object" }, "Core.Models.Settings.MailSettings": { "properties": { "authenticationType": { "enum": [ "None", "Basic", "OAuth2" ], "type": "string" }, "propsChanged": { "type": "boolean" }, "outgoingMailHost": { "type": "string" }, "outgoingMailPort": { "type": "integer" }, "outgoingMailEnableSSL": { "type": "boolean" }, "outgoingMailFrom": { "type": "string" }, "outgoingMailLogin": { "type": "string" }, "outgoingMailPassword": { "type": "string" }, "outgoingMailPasswordBytes": { "type": "string" }, "outgoingMailDisableCertificateValidation": { "type": "boolean" }, "outgoingClientId": { "type": "string" }, "outgoingTenantId": { "type": "string" }, "outgoingClientSecret": { "type": "string" }, "outgoingClientSecretBytes": { "type": "string" }, "outgoingHttpProxy": { "type": "string" }, "outgoingHttpProxyBytes": { "type": "string" }, "incomingMailHost": { "type": "string" }, "incomingMailPort": { "type": "integer" }, "incomingMailEnableSSL": { "type": "boolean" }, "incomingMailFrom": { "type": "string" }, "incomingMailLogin": { "type": "string" }, "incomingMailPassword": { "type": "string" }, "incomingMailPasswordBytes": { "type": "string" }, "incomingMailTimeQueue": { "type": "integer" }, "mailHeader": { "type": "string" }, "mailFooter": { "type": "string" }, "emailCheckFrequencyMinutes": { "type": "integer" } }, "type": "object" }, "Core.Models.Settings.ScheduledReportSettings": { "properties": { "header": { "type": "string" }, "footer": { "type": "string" }, "layout": { "enum": [ "Portrait", "Landscape" ], "type": "string" } }, "type": "object" }, "Core.Models.Settings.SecurityParameters": { "properties": { "sessionTimeout": { "type": "number" }, "sessionTimeoutType": { "enum": [ "Minutes", "Hours" ], "type": "string" }, "passwordExpiration": { "type": "number" }, "passwordExpirationType": { "enum": [ "None", "Days" ], "type": "string" }, "minPasswordComplexityScore": { "maximum": 4.0, "exclusiveMaximum": false, "minimum": 0.0, "exclusiveMinimum": false, "type": "integer" }, "minPasswordLength": { "type": "integer" }, "httpProxy": { "type": "string" }, "httpProxyBytes": { "type": "string" }, "httpsProxy": { "type": "string" }, "httpsProxyBytes": { "type": "string" }, "maxFailedLogInAttempts": { "type": "integer" }, "securityNotificationEmail": { "type": "string" } }, "type": "object" }, "Core.Models.Settings.OrchestrationSettings": { "properties": { "webhookCleanupInterval": { "type": "number" }, "orchestrationTaskCleanupInterval": { "type": "number" }, "ingestionRuleCleanupInterval": { "type": "number" }, "webhookCleanupIntervalType": { "enum": [ "Minutes", "Hours" ], "type": "string" }, "orchestrationTaskCleanupIntervalType": { "enum": [ "Minutes", "Hours" ], "type": "string" }, "ingestionRuleCleanupIntervalType": { "enum": [ "Minutes", "Hours" ], "type": "string" } }, "type": "object" }, "Core.Models.Settings.MarketplaceSettings": { "properties": { "url": { "type": "string" } }, "type": "object" }, "Core.Models.Settings.HangfireStartUpJobs": { "properties": { "disableDirectoryServerJob": { "type": "boolean" }, "disableEmailJob": { "type": "boolean" }, "disableHangfireCleanupJob": { "type": "boolean" }, "hangfireCleanupJobIntervalHours": { "type": "integer" }, "expireUserConnectionsJobIntervalMinutes": { "type": "integer" }, "expireUserConnectionsAfterInMinutes": { "type": "integer" } }, "type": "object" }, "Core.Models.Settings.License": { "properties": { "file": { "type": "string" }, "licenseType": { "enum": [ "Trial", "Standard" ], "type": "string" }, "expiration": { "type": "string" }, "licensedTo": { "type": "string" }, "licensedToEmail": { "type": "string" }, "applicationLimit": { "type": "number" }, "userLimit": { "type": "number" }, "valid": { "type": "boolean" } }, "type": "object" }, "Core.Models.Settings.FeatureSettings": { "properties": { "enableCertificateAuthentication": { "type": "boolean" }, "enableOtpAuthenticationEnforcement": { "type": "boolean" } }, "type": "object" }, "Core.Models.Settings.SamlSettings": { "properties": { "enabled": { "type": "boolean" }, "nameIdContent": { "enum": [ "EmailAddress", "Username" ], "type": "string" }, "idpSsoUrl": { "type": "string" }, "isForceSSOEnabled": { "type": "boolean" }, "idpCertificate": { "type": "string" }, "verifyIdpSignature": { "type": "boolean" }, "applicationServiceProviderId": { "type": "string" }, "identityProviderId": { "type": "string" }, "preserveWhitespaceInSamlResponse": { "type": "boolean" }, "enableSAMLAutoProvisioning": { "type": "boolean" }, "signRequest": { "type": "boolean" }, "sourceCertificate": { "type": "string" } }, "type": "object" }, "Core.Models.Settings.UsageMetricsSettings": { "properties": { "manualTimeExpenditure": { "type": "number" }, "manualTimeCost": { "type": "number" } }, "type": "object" }, "Core.Models.Settings.GlobalSettings": { "properties": { "hasOutgoingMailSettingsConfigured": { "type": "boolean" }, "databaseEncryptionKeys": { "additionalProperties": { "type": "string" }, "type": "object" }, "directory": { "$ref": "#/definitions/Core.Models.Settings.DirectorySettings" }, "mailSettings": { "$ref": "#/definitions/Core.Models.Settings.MailSettings" }, "scheduledReportSettings": { "$ref": "#/definitions/Core.Models.Settings.ScheduledReportSettings" }, "securityParameters": { "$ref": "#/definitions/Core.Models.Settings.SecurityParameters" }, "orchestrationSettings": { "$ref": "#/definitions/Core.Models.Settings.OrchestrationSettings" }, "marketplaceSettings": { "$ref": "#/definitions/Core.Models.Settings.MarketplaceSettings" }, "loginBanner": { "type": "string" }, "systemTimeZoneId": { "type": "string" }, "workflowRunTtlType": { "enum": [ "Days", "Weeks", "Months" ], "type": "string" }, "workflowRunTtl": { "type": "integer" }, "hangfireBackgroundStartupJobs": { "$ref": "#/definitions/Core.Models.Settings.HangfireStartUpJobs" }, "license": { "$ref": "#/definitions/Core.Models.Settings.License" }, "apiVersion": { "type": "string" }, "swimlaneUrl": { "type": "string" }, "logRetentionInDays": { "type": "integer" }, "isLogDataRetentionEnabled": { "type": "boolean" }, "updateInProgress": { "type": "boolean" }, "featureSettings": { "$ref": "#/definitions/Core.Models.Settings.FeatureSettings" }, "lockedRecordCleanupIntervalMinutes": { "type": "integer" }, "orphanedSwimlaneEntitiesCleanupIntervalMinutes": { "type": "integer" }, "recordHistoryTtlType": { "enum": [ "Days", "Weeks", "Months" ], "type": "string" }, "recordHistoryTtl": { "type": "integer" }, "samlSettings": { "$ref": "#/definitions/Core.Models.Settings.SamlSettings" }, "usageMetricsSettings": { "$ref": "#/definitions/Core.Models.Settings.UsageMetricsSettings" }, "isTurbineInitialized": { "type": "boolean" }, "id": { "type": "string" }, "name": { "type": "string" }, "disabled": { "type": "boolean" } }, "type": "object" }, "Core.Requests.Settings.Commands.InitializeSwimlaneCommand": { "properties": { "adminUserName": { "type": "string" }, "password": { "type": "string" }, "adminEmail": { "type": "string" }, "license": { "$ref": "#/definitions/Core.Models.Settings.License" }, "swimlaneUrl": { "type": "string" }, "systemTimeZoneId": { "type": "string" } }, "type": "object" }, "Core.Models.Utilities.BasicResult": { "properties": { "success": { "type": "boolean" }, "resultMessages": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "Api.Infrastructure.ActionResults.ErrorCodeResult": { "type": "object" }, "Core.Models.Configuration.AgentConfiguration": { "properties": { "rabbitMQConnectionString": { "type": "string" } }, "type": "object" }, "Microsoft.AspNetCore.Authentication.AuthenticationProperties": { "properties": { "items": { "additionalProperties": { "type": "string" }, "type": "object" }, "parameters": { "additionalProperties": {}, "type": "object" }, "isPersistent": { "type": "boolean" }, "redirectUri": { "type": "string" }, "issuedUtc": { "type": "string" }, "expiresUtc": { "type": "string" }, "allowRefresh": { "type": "boolean" } }, "type": "object" }, "Microsoft.AspNetCore.Mvc.ForbidResult": { "properties": { "authenticationSchemes": { "items": { "type": "string" }, "type": "array" }, "properties": { "$ref": "#/definitions/Microsoft.AspNetCore.Authentication.AuthenticationProperties" } }, "type": "object" }, "Microsoft.AspNetCore.Mvc.ObjectResult": { "properties": { "value": {}, "formatters": { "items": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.Formatters.IOutputFormatter" }, "type": "array" }, "contentTypes": { "items": { "type": "string" }, "type": "array" }, "declaredType": { "type": "string" }, "statusCode": { "type": "integer" } }, "type": "object" }, "Microsoft.AspNetCore.Mvc.BadRequestResult": { "properties": { "statusCode": { "type": "integer" } }, "type": "object" }, "Core.Models.Sharing.SharingMessage": { "properties": { "to": { "items": { "type": "string" }, "type": "array" }, "subject": { "type": "string" }, "message": { "type": "string" } }, "type": "object" }, "Core.Models.Scheduled.ScheduledReport": { "properties": { "applicationId": { "type": "string" }, "reportId": { "type": "string" }, "scheduleReportType": { "enum": [ "Report", "Dashboard" ], "type": "string" }, "includeTable": { "type": "boolean" }, "includeCsv": { "type": "boolean" }, "recipients": { "items": { "$ref": "#/definitions/Core.Models.Utilities.ItemUserGroupSelection" }, "type": "array" }, "notes": { "type": "string" }, "includeLink": { "type": "boolean" }, "cronExpression": { "type": "string" }, "runOneTime": { "type": "string" }, "layout": { "enum": [ "Portrait", "Landscape" ], "type": "string" }, "header": { "type": "string" }, "footer": { "type": "string" }, "createdDate": { "type": "string" }, "createdByUser": { "$ref": "#/definitions/Core.Models.Utilities.UserGroupSelection" }, "modifiedDate": { "type": "string" }, "modifiedByUser": { "$ref": "#/definitions/Core.Models.Utilities.UserGroupSelection" }, "currentUserId": { "type": "string" }, "link": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "disabled": { "type": "boolean" } }, "type": "object" }, "Api.Models.Report.ScheduledDownloadViewModel": { "properties": { "name": { "type": "string" }, "html": { "type": "string" }, "layout": { "enum": [ "Portrait", "Landscape" ], "type": "string" }, "report": { "$ref": "#/definitions/Core.Models.Search.Report" }, "application": { "$ref": "#/definitions/Core.Models.Application.Application" }, "data": {}, "schedule": { "$ref": "#/definitions/Core.Models.Scheduled.ScheduledReport" }, "tableData": { "$ref": "#/definitions/Api.Models.Search.GroupedSearchResults" } }, "type": "object" }, "Core.Models.Integrations.Actions.Action": { "properties": { "readonly": { "type": "boolean" }, "type": { "type": "string" }, "descriptor": { "$ref": "#/definitions/Core.Models.Integrations.Actions.AvailableActionDescriptor" } }, "type": "object" }, "Core.Models.Integrations.Descriptors.Mapping": { "properties": { "type": { "type": "string" }, "parserType": { "type": "string" }, "expression": { "type": "string" }, "key": { "type": "string" }, "value": {}, "useOldValue": { "type": "boolean" }, "subValue": {}, "example": {}, "addMissing": { "type": "boolean" }, "unixEpochUnit": { "type": "string" }, "enableDeletionOnNull": { "type": "boolean" }, "dataFormat": { "type": "string" }, "customDataFormat": { "type": "string" }, "userFormat": { "type": "string" }, "listModificationType": { "enum": [ "None", "Create", "Delete", "Append", "Subtract" ], "type": "string" } }, "type": "object" }, "Core.Models.Integrations.Outputs.Output": { "properties": { "type": { "type": "string" } }, "type": "object" }, "Core.Models.Integrations.Triggers.Trigger": { "properties": { "conditions": { "items": {}, "type": "array" }, "type": { "type": "string" }, "availableMappings": { "items": { "type": "string" }, "type": "array" }, "hasRecord": { "type": "boolean" } }, "type": "object" }, "Core.Models.Integrations.Task": { "properties": { "description": { "type": "string" }, "applicationId": { "type": "string" }, "appletId": { "type": "string" }, "action": { "$ref": "#/definitions/Core.Models.Integrations.Actions.Action" }, "inputMapping": { "items": { "$ref": "#/definitions/Core.Models.Integrations.Descriptors.Mapping" }, "type": "array" }, "isSystemTask": { "type": "boolean" }, "outputs": { "items": { "$ref": "#/definitions/Core.Models.Integrations.Outputs.Output" }, "type": "array" }, "triggers": { "items": { "$ref": "#/definitions/Core.Models.Integrations.Triggers.Trigger" }, "type": "array" }, "createdByUser": { "$ref": "#/definitions/Core.Models.Utilities.UserGroupSelection" }, "modifiedByUser": { "$ref": "#/definitions/Core.Models.Utilities.UserGroupSelection" }, "createdDate": { "type": "string" }, "modifiedDate": { "type": "string" }, "valid": { "type": "boolean" }, "uid": { "type": "string" }, "version": { "type": "integer" }, "id": { "type": "string" }, "name": { "type": "string" }, "disabled": { "type": "boolean" } }, "type": "object" }, "Api.Models.Integration.TriggerDescriptor": { "properties": { "type": { "type": "string" }, "availableMappings": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "Core.Models.Integrations.Parsers.Parser": { "properties": { "description": { "type": "string" }, "family": { "type": "string" }, "type": { "enum": [ "None", "Regex", "Python", "Delimiter" ], "type": "string" }, "version": { "type": "string" }, "src": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "disabled": { "type": "boolean" } }, "type": "object" }, "Api.Models.Integration.TaskOptionModel": { "properties": { "triggers": { "items": { "$ref": "#/definitions/Api.Models.Integration.TriggerDescriptor" }, "type": "array" }, "parsers": { "items": { "$ref": "#/definitions/Core.Models.Integrations.Parsers.Parser" }, "type": "array" } }, "type": "object" }, "Api.Models.Integration.TaskLight": { "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "disabled": { "type": "boolean" }, "applicationId": { "type": "string" }, "appletId": { "type": "string" }, "actionType": { "type": "string" }, "actionDescription": { "type": "string" }, "actionDescriptorImageId": { "type": "string" }, "actionDescriptorName": { "type": "string" }, "actionDescriptorVendor": { "type": "string" }, "actionDescriptorProduct": { "type": "string" }, "actionDescriptorVersion": { "type": "string" }, "migrated": { "type": "boolean" }, "deprecated": { "type": "boolean" }, "pythonVersion": { "enum": [ "Python2_7", "Python3_6", "Python3_7", "Python3", "Python3_12" ], "type": "string" }, "valid": { "type": "boolean" } }, "type": "object" }, "Api.Models.Integration.TaskList": { "properties": { "images": { "additionalProperties": { "type": "string" }, "type": "object" }, "tasks": { "items": { "$ref": "#/definitions/Api.Models.Integration.TaskLight" }, "type": "array" } }, "type": "object" }, "Api.Models.Integration.TaskExecuteModel": { "properties": { "taskId": { "type": "string" }, "record": { "$ref": "#/definitions/Core.Models.Record.Record" }, "sessionInputs": { "additionalProperties": {}, "type": "object" } }, "type": "object" }, "Api.Models.Integration.PackageDescriptorLight": { "properties": { "id": { "type": "string" }, "base64Image": { "type": "string" }, "vendor": { "type": "string" }, "product": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "version": { "type": "string" }, "author": { "type": "string" }, "pythonVersion": { "type": "string" }, "readme": { "type": "string" }, "changeLog": { "type": "string" }, "family": { "type": "string" }, "modifiedDate": { "type": "string" }, "createdDate": { "type": "string" } }, "type": "object" }, "Api.Models.Integration.PackageDescriptorExtended": { "properties": { "family": { "type": "string" }, "modifiedDate": { "type": "string" }, "createdDate": { "type": "string" }, "assetDescriptors": { "items": { "$ref": "#/definitions/Core.Models.Integrations.Assets.AssetDescriptor" }, "type": "array" }, "availableActionDescriptors": { "items": { "$ref": "#/definitions/Core.Models.Integrations.Actions.AvailableActionDescriptor" }, "type": "array" }, "name": { "type": "string" }, "base64Image": { "type": "string" }, "description": { "type": "string" }, "author": { "type": "string" }, "versionHash": { "type": "string" }, "authorEmail": { "type": "string" }, "version": { "type": "string" }, "supportedSwimlaneVersion": { "type": "string" }, "pythonVersion": { "type": "string" }, "url": { "type": "string" }, "installRequires": { "items": { "type": "string" }, "type": "array" }, "packages": { "items": { "type": "string" }, "type": "array" }, "bundleHash": { "type": "string" }, "fileId": { "type": "string" }, "isEmailBundle": { "type": "boolean" }, "vendor": { "type": "string" }, "product": { "type": "string" }, "readme": { "type": "string" }, "changeLog": { "type": "string" }, "id": { "type": "string" }, "disabled": { "type": "boolean" } }, "type": "object" }, "Core.Models.Settings.TurbineAdminUser": { "properties": { "adminUserName": { "type": "string" }, "password": { "type": "string" }, "adminEmail": { "type": "string" } }, "type": "object" }, "Core.Models.Usage.UsageTask": { "required": [ "name", "taskId", "type" ], "properties": { "name": { "type": "string" }, "taskId": { "type": "string" }, "type": { "enum": [ "Integration", "Workflow" ], "type": "string" }, "applicationId": { "type": "string" }, "cost": { "type": "number" }, "manualTimeExpenditure": { "type": "number" }, "manualTimeCost": { "type": "number" }, "executionCount": { "type": "integer" }, "totalExecutionDuration": { "type": "number" }, "fastestExecutionTime": { "type": "number" }, "longestExecutionTime": { "type": "number" }, "averageExecutionTime": { "type": "number" }, "averageTimeSavings": { "type": "number" }, "totalTimeSavings": { "type": "number" }, "averageCostSavings": { "type": "number" }, "totalCostSavings": { "type": "number" }, "usageTaskSeries": { "additionalProperties": { "type": "number" }, "type": "object" }, "id": { "type": "string" }, "disabled": { "type": "boolean" } }, "type": "object" }, "Core.Models.Usage.ApplicationUsage": { "properties": { "applicationId": { "type": "string" }, "totalExecutionsRan": { "type": "integer" }, "totalRecords": { "type": "integer" }, "averageTimeSavings": { "type": "number" }, "totalExecutionDuration": { "type": "number" }, "totalTimeSavings": { "type": "number" }, "averageCostSavings": { "type": "number" }, "totalCostSavings": { "type": "number" }, "usageTasks": { "items": { "$ref": "#/definitions/Core.Models.Usage.UsageTask" }, "type": "array" }, "applicationUsageSeries": { "additionalProperties": {}, "type": "object" }, "timeSeries": { "additionalProperties": { "additionalProperties": { "type": "number" }, "type": "object" }, "type": "object" } }, "type": "object" }, "Core.Models.Usage.GlobalUsage": { "properties": { "averageTimeSavings": { "type": "number" }, "averageCostSavings": { "type": "number" }, "totalTimeSavings": { "type": "number" }, "globalCostSavings": { "type": "number" }, "totalRecords": { "type": "integer" }, "totalExecutionsRan": { "type": "integer" }, "applicationUsage": { "items": { "$ref": "#/definitions/Core.Models.Usage.ApplicationUsage" }, "type": "array" }, "timeSeries": { "items": { "additionalProperties": {}, "type": "object" }, "type": "array" } }, "type": "object" }, "Api.Models.Identity.RegisterViewModel": { "required": [ "email" ], "properties": { "userName": { "type": "string" }, "notify": { "type": "boolean" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "middleInitial": { "type": "string" }, "displayName": { "type": "string" }, "password": { "type": "string" }, "confirmPassword": { "type": "string" }, "email": { "type": "string" }, "groups": { "items": { "$ref": "#/definitions/Core.Models.Base.Entity" }, "type": "array" }, "roles": { "items": { "$ref": "#/definitions/Core.Models.Base.Entity" }, "type": "array" }, "isForceSSOExempted": { "type": "boolean" } }, "type": "object" }, "Core.Models.Identity.ApplicationUser": { "properties": { "favorites": { "additionalProperties": { "items": { "type": "string" }, "type": "array" }, "type": "object" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "middleInitial": { "type": "string" }, "displayName": { "type": "string" }, "lastLogin": { "type": "string" }, "activeDirectoryGuid": { "type": "string" }, "domain": { "type": "string" }, "active": { "type": "boolean" }, "name": { "type": "string" }, "avatar": { "type": "string" }, "lastPasswordChangedDate": { "type": "string" }, "passwordResetRequired": { "type": "boolean" }, "defaultWorkspaceId": { "type": "string" }, "defaultDashboardId": { "type": "string" }, "sessionTimeout": { "type": "number" }, "sourceIp": { "type": "string" }, "sessionTimeoutType": { "enum": [ "Minutes", "Hours" ], "type": "string" }, "isForceSSOExempted": { "type": "boolean" }, "users": { "items": { "$ref": "#/definitions/Core.Models.Base.Entity" }, "type": "array" }, "groups": { "items": { "$ref": "#/definitions/Core.Models.Base.Entity" }, "type": "array" }, "roles": { "items": { "$ref": "#/definitions/Core.Models.Base.Entity" }, "type": "array" }, "primaryGroup": { "$ref": "#/definitions/Core.Models.Utilities.UserGroupSelection" }, "email": { "type": "string" }, "createdDate": { "type": "string" }, "modifiedDate": { "type": "string" }, "createdByUser": { "$ref": "#/definitions/Core.Models.Utilities.UserGroupSelection" }, "modifiedByUser": { "$ref": "#/definitions/Core.Models.Utilities.UserGroupSelection" }, "userName": { "type": "string" }, "phoneNumber": { "type": "string" }, "passwordComplexityScore": { "type": "integer" }, "isSystemUser": { "type": "boolean" }, "timeZoneId": { "type": "string" }, "isOTPVerified": { "type": "boolean" }, "isOtpUser": { "type": "boolean" }, "isOtpEnforced": { "type": "boolean" }, "isOtpExempted": { "type": "boolean" }, "isLdapUser": { "type": "boolean" }, "isLocked": { "type": "boolean" }, "currentFailedLogInAttempts": { "type": "integer" }, "lastFailedLogInAttemptAt": { "type": "string" }, "id": { "type": "string" }, "disabled": { "type": "boolean" } }, "type": "object" }, "Api.Models.PagedResponse": { "properties": { "totalCount": { "type": "integer" }, "items": { "items": { "$ref": "#/definitions/Core.Models.Identity.ApplicationUser" }, "type": "array" } }, "type": "object" }, "Core.Models.Identity.ApplicationUserLight": { "properties": { "displayName": { "type": "string" }, "avatar": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "disabled": { "type": "boolean" } }, "type": "object" }, "Api.Models.Identity.LoginViewModel": { "required": [ "userName", "password" ], "properties": { "userName": { "type": "string" }, "password": { "type": "string" }, "domain": { "type": "string" } }, "type": "object" }, "System.AggregateException": { "type": "object" }, "System.Threading.Tasks.Task": { "properties": { "result": { "$ref": "#/definitions/Microsoft.AspNetCore.Mvc.NoContentResult" }, "id": { "type": "integer" }, "exception": { "$ref": "#/definitions/System.AggregateException" }, "status": { "enum": [ "Created", "WaitingForActivation", "WaitingToRun", "Running", "WaitingForChildrenToComplete", "RanToCompletion", "Canceled", "Faulted" ], "type": "string" }, "isCanceled": { "type": "boolean" }, "isCompleted": { "type": "boolean" }, "isCompletedSuccessfully": { "type": "boolean" }, "creationOptions": { "enum": [ "None", "PreferFairness", "LongRunning", "AttachedToParent", "DenyChildAttach", "HideScheduler", "RunContinuationsAsynchronously" ], "type": "string" }, "asyncState": {}, "isFaulted": { "type": "boolean" } }, "type": "object" }, "Api.Models.Identity.SetPasswordViewModel": { "required": [ "userId", "password" ], "properties": { "userName": { "type": "string" }, "userId": { "type": "string" }, "password": { "maxLength": 100, "minLength": 6, "type": "string" }, "confirmPassword": { "type": "string" }, "oldPassword": { "type": "string" }, "notify": { "type": "boolean" } }, "type": "object" }, "Api.Models.Users.PasswordTestViewModel": { "properties": { "password": { "type": "string" } }, "type": "object" }, "Api.Models.Users.PasswordTestResult": { "properties": { "entropy": { "type": "number" }, "calcTime": { "type": "integer" }, "crackTime": { "type": "number" }, "crackTimeDisplay": { "type": "string" }, "score": { "type": "integer" }, "suggestions": { "items": { "enum": [ "Default", "AddAnotherWordOrTwo", "UseLongerKeyboardPattern", "AvoidRepeatedWordsAndChars", "AvoidSequences", "AvoidYearsAssociatedYou", "AvoidDatesYearsAssociatedYou", "CapsDontHelp", "AllCapsEasy", "ReversedWordEasy", "PredictableSubstitutionsEasy", "Empty" ], "type": "string" }, "type": "array" }, "warning": { "type": "string" } }, "type": "object" }, "Api.Models.Users.AvatarViewModel": { "properties": { "id": { "type": "string" }, "file": { "$ref": "#/definitions/Microsoft.AspNetCore.Http.IFormFile" } }, "type": "object" }, "Core.Models.Workflow.Notification": { "properties": { "applicationId": { "type": "string" }, "recordId": { "type": "string" }, "actionIds": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "Microsoft.AspNetCore.Mvc.NotFoundResult": { "properties": { "statusCode": { "type": "integer" } }, "type": "object" }, "Core.Models.Workflow.ActionExecutionSource": { "properties": { "type": { "enum": [ "Workflow", "Continuation", "Api" ], "type": "string" }, "actionType": { "type": "integer" }, "name": { "type": "string" }, "id": { "type": "string" } }, "type": "object" }, "Core.Utilities.Extensions.DeserializableChange": { "properties": { "old": {}, "new": {} }, "type": "object" }, "Core.Models.Workflow.ActionExecution": { "properties": { "workflowRunSequence": { "type": "integer" }, "workflowRunId": { "type": "string" }, "recordId": { "type": "string" }, "jobId": { "type": "string" }, "source": { "$ref": "#/definitions/Core.Models.Workflow.ActionExecutionSource" }, "executionMetadata": { "$ref": "#/definitions/Core.Models.Base.ExecutionMetadata" }, "success": { "type": "boolean" }, "message": { "type": "string" }, "differential": { "additionalProperties": { "$ref": "#/definitions/Core.Utilities.Extensions.DeserializableChange" }, "type": "object" }, "actionOutputs": { "additionalProperties": {}, "type": "object" }, "id": { "type": "string" }, "name": { "type": "string" }, "disabled": { "type": "boolean" } }, "type": "object" }, "Api.Models.Record.WorkflowRunDetails": { "properties": { "run": { "$ref": "#/definitions/Core.Models.Workflow.WorkflowRun" }, "executions": { "items": { "$ref": "#/definitions/Core.Models.Workflow.ActionExecution" }, "type": "array" } }, "type": "object" }, "Api.Models.Workflow.WorkflowRequestModel": { "properties": { "workflowRunId": { "type": "string" }, "sequence": { "type": "integer" }, "size": { "type": "integer" }, "queryFilter": { "enum": [ "Contains", "Excludes", "Equals", "DoesNotEqual", "LessThan", "LessThanOrEqual", "GreaterThan", "GreaterThanOrEqual", "Previous", "Current", "Next", "Exists", "Hour", "DayOfWeek" ], "type": "string" } }, "type": "object" }, "ErrorModel": { "description": "Default Error Object", "required": [ "message", "code" ], "properties": { "message": { "type": "string" }, "code": { "maximum": 600.0, "minimum": 100.0, "type": "integer" } }, "type": "object" } }, "securityDefinitions": { "jwt_token": { "type": "apiKey", "name": "Authorization", "in": "header" }, "access_token": { "type": "apiKey", "name": "Private-Token", "in": "header" } }, "security": [ { "jwt_token": [] }, { "access_token": [] } ] }