{ "swagger": "2.0", "info": { "description": "The XNAT REST API (XAPI) functions provide access to XNAT internal functions for remote clients.", "version": "1.10.0", "title": "XNAT REST API", "termsOfService": "http://www.xnat.org/download", "contact": { "name": "XNAT", "url": "http://www.xnat.org", "email": "info@xnat.org" }, "license": { "name": "Simplified 2-Clause BSD", "url": "https://opensource.org/licenses/BSD-2-Clause" } }, "host": "localhost", "basePath": "/1100/xapi", "tags": [ { "name": "command-configuration-rest-api", "description": "Command Configuration Rest Api" }, { "name": "command-event-mapping-rest-api", "description": "Command Event Mapping Rest Api" }, { "name": "command-rest-api", "description": "Command Rest Api" }, { "name": "command-visibility-rest-api", "description": "Command Visibility Rest Api" }, { "name": "container-rest-api", "description": "Container Rest Api" }, { "name": "docker-rest-api", "description": "Docker Rest Api" }, { "name": "launch-rest-api", "description": "Launch Rest Api" }, { "name": "orchestration-rest-api", "description": "Orchestration Rest Api" }, { "name": "queue-settings-rest-api", "description": "Queue Settings Rest Api" }, { "name": "workflow-monitor-api", "description": "Workflow Monitor Api" } ], "paths": { "/command/{id}/visibility/{visibility}": { "post": { "tags": [ "command-visibility-rest-api" ], "summary": "Modify Command visibility", "operationId": "setVisibilityUsingPOST", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "name": "id", "in": "path", "description": "id", "required": true, "type": "integer", "format": "int64" }, { "name": "visibility", "in": "path", "description": "visibility", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK" }, "201": { "description": "Created" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/commandeventmapping": { "get": { "tags": [ "command-event-mapping-rest-api" ], "summary": "Get all Command-Event Mappings", "operationId": "getMappingsUsingGET", "produces": [ "*/*" ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/CommandEventMapping" } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false }, "post": { "tags": [ "command-event-mapping-rest-api" ], "summary": "Create a Command-Event Mapping", "description": "Use the event service to trigger commands based on events", "operationId": "createUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "commandEventMapping", "description": "commandEventMapping", "required": true, "schema": { "$ref": "#/definitions/CommandEventMapping" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CommandEventMapping" } }, "201": { "description": "Created" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": true } }, "/commandeventmapping/{id}": { "get": { "tags": [ "command-event-mapping-rest-api" ], "summary": "Get a Command-Event-Mapping", "operationId": "retrieveUsingGET", "produces": [ "*/*" ], "parameters": [ { "name": "id", "in": "path", "description": "id", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CommandEventMapping" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false }, "delete": { "tags": [ "command-event-mapping-rest-api" ], "summary": "Delete a Command-Event Mapping", "operationId": "deleteUsingDELETE", "produces": [ "*/*" ], "parameters": [ { "name": "id", "in": "path", "description": "id", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } }, "204": { "description": "No Content" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "deprecated": false } }, "/commandeventmapping/{id}/convert": { "post": { "tags": [ "command-event-mapping-rest-api" ], "summary": "Convert a Command-Event Automation item to an Event Service Subscription", "operationId": "convertUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "name": "id", "in": "path", "description": "id", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "OK" }, "201": { "description": "Created" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/commandeventmapping/{id}/disable": { "put": { "tags": [ "command-event-mapping-rest-api" ], "summary": "Disable a Command-Event Mapping", "description": "Use the event service to trigger commands based on events", "operationId": "disableUsingPUT", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "name": "id", "in": "path", "description": "id", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "OK" }, "201": { "description": "Created" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": true } }, "/commandeventmapping/{id}/enable": { "put": { "tags": [ "command-event-mapping-rest-api" ], "summary": "Enable a Command-Event Mapping", "description": "Use the event service to trigger commands based on events", "operationId": "enableUsingPUT", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "name": "id", "in": "path", "description": "id", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "OK" }, "201": { "description": "Created" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": true } }, "/commands": { "get": { "tags": [ "command-rest-api" ], "summary": "Get Commands by criteria", "operationId": "getCommandsUsingGET_1", "produces": [ "*/*" ], "parameters": [ { "name": "image", "in": "query", "description": "image", "required": false, "type": "string" }, { "name": "name", "in": "query", "description": "name", "required": false, "type": "string" }, { "name": "restrictToEnabledForSite", "in": "query", "description": "restrictToEnabledForSite", "required": false, "type": "boolean" }, { "name": "version", "in": "query", "description": "version", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/Command" } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false }, "post": { "tags": [ "command-rest-api" ], "summary": "Create a Command", "operationId": "createCommandUsingPOST", "consumes": [ "application/json" ], "produces": [ "application/json;charset=UTF-8" ], "parameters": [ { "in": "body", "name": "command", "description": "command", "required": true, "schema": { "$ref": "#/definitions/CommandCreation" } }, { "name": "image", "in": "query", "description": "image", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "integer", "format": "int64" } }, "201": { "description": "Created" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/commands/available": { "get": { "tags": [ "command-rest-api" ], "summary": "Get Commands available in given project context and XSIType", "operationId": "availableCommandsUsingGET", "produces": [ "*/*" ], "parameters": [ { "name": "project", "in": "query", "description": "project", "required": true, "type": "string" }, { "name": "xsiType", "in": "query", "description": "xsiType", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/CommandSummaryForContext" } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/commands/available/site": { "get": { "tags": [ "command-rest-api" ], "summary": "Get Commands sitewide with given XSIType", "operationId": "siteLevelAvailableCommandsUsingGET", "produces": [ "*/*" ], "parameters": [ { "name": "projects", "in": "query", "description": "projects", "required": false, "type": "string" }, { "name": "xsiType", "in": "query", "description": "xsiType", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/CommandSummaryForContext" } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/commands/{commandId}/wrappers/{wrapperId}": { "post": { "tags": [ "command-rest-api" ], "summary": "Update a Command Wrapper", "operationId": "updateWrapperUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "name": "commandId", "in": "path", "description": "commandId", "required": true, "type": "integer", "format": "int64" }, { "in": "body", "name": "commandWrapper", "description": "commandWrapper", "required": true, "schema": { "$ref": "#/definitions/CommandWrapper" } }, { "name": "wrapperId", "in": "path", "description": "wrapperId", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "OK" }, "201": { "description": "Created" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/commands/{commandId}/wrappers/{wrapperName}/bulklaunch": { "get": { "tags": [ "launch-rest-api" ], "summary": "Get Bulk Launch UI for wrapper", "description": "DOES NOT WORK PROPERLY IN SWAGGER UI", "operationId": "getBulkLaunchUiUsingGET", "produces": [ "*/*" ], "parameters": [ { "name": "commandId", "in": "path", "description": "commandId", "required": true, "type": "integer", "format": "int64" }, { "name": "rootElement", "in": "query", "description": "rootElement", "required": true, "type": "string" }, { "name": "sampleTarget", "in": "query", "description": "sampleTarget", "required": true, "type": "string" }, { "name": "wrapperName", "in": "path", "description": "wrapperName", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/LaunchUi" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false }, "post": { "tags": [ "launch-rest-api" ], "summary": "Resolve a command from the variable values in the request body, and launch it", "description": "Replaced by /commands/{commandId}/wrappers/{wrapperName}/root/{rootElement}/bulklaunch including xsiType as rootElement parameter.", "operationId": "bulklaunch2UsingPOST", "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "allRequestParams", "description": "allRequestParams", "required": true, "schema": { "type": "object", "additionalProperties": { "type": "string" } } }, { "name": "commandId", "in": "path", "description": "commandId", "required": true, "type": "integer", "format": "int64" }, { "name": "wrapperName", "in": "path", "description": "wrapperName", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/BulkLaunchReport" } }, "201": { "description": "Created" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": true } }, "/commands/{commandId}/wrappers/{wrapperName}/config": { "get": { "tags": [ "command-configuration-rest-api" ], "summary": "Get (site)", "operationId": "getConfigurationUsingGET", "produces": [ "*/*" ], "parameters": [ { "name": "commandId", "in": "path", "description": "commandId", "required": true, "type": "integer", "format": "int64" }, { "name": "wrapperName", "in": "path", "description": "wrapperName", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CommandConfiguration" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false }, "post": { "tags": [ "command-configuration-rest-api" ], "summary": "Configure (site)", "operationId": "createConfigurationUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "commandConfiguration", "description": "commandConfiguration", "required": true, "schema": { "$ref": "#/definitions/CommandConfiguration" } }, { "name": "commandId", "in": "path", "description": "commandId", "required": true, "type": "integer", "format": "int64" }, { "name": "enable", "in": "query", "description": "enable", "required": false, "type": "boolean", "default": true }, { "name": "reason", "in": "query", "description": "reason", "required": false, "type": "string" }, { "name": "wrapperName", "in": "path", "description": "wrapperName", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK" }, "201": { "description": "Created" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false }, "delete": { "tags": [ "command-configuration-rest-api" ], "summary": "Delete (site)", "operationId": "deleteConfigurationUsingDELETE", "produces": [ "*/*" ], "parameters": [ { "name": "commandId", "in": "path", "description": "commandId", "required": true, "type": "integer", "format": "int64" }, { "name": "wrapperName", "in": "path", "description": "wrapperName", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK" }, "204": { "description": "No Content" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "deprecated": false } }, "/commands/{commandId}/wrappers/{wrapperName}/disabled": { "put": { "tags": [ "command-configuration-rest-api" ], "summary": "Disable (site)", "operationId": "disableConfigurationUsingPUT", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "name": "commandId", "in": "path", "description": "commandId", "required": true, "type": "integer", "format": "int64" }, { "name": "reason", "in": "query", "description": "reason", "required": false, "type": "string" }, { "name": "wrapperName", "in": "path", "description": "wrapperName", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK" }, "201": { "description": "Created" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/commands/{commandId}/wrappers/{wrapperName}/enabled": { "get": { "tags": [ "command-configuration-rest-api" ], "summary": "Is Enabled (site)", "operationId": "isConfigurationEnabledUsingGET", "produces": [ "*/*" ], "parameters": [ { "name": "commandId", "in": "path", "description": "commandId", "required": true, "type": "integer", "format": "int64" }, { "name": "wrapperName", "in": "path", "description": "wrapperName", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "boolean" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false }, "put": { "tags": [ "command-configuration-rest-api" ], "summary": "Enable (site)", "operationId": "enableConfigurationUsingPUT", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "name": "commandId", "in": "path", "description": "commandId", "required": true, "type": "integer", "format": "int64" }, { "name": "reason", "in": "query", "description": "reason", "required": false, "type": "string" }, { "name": "wrapperName", "in": "path", "description": "wrapperName", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK" }, "201": { "description": "Created" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/commands/{commandId}/wrappers/{wrapperName}/launch": { "get": { "tags": [ "launch-rest-api" ], "summary": "Get Launch UI for wrapper", "description": "DOES NOT WORK PROPERLY IN SWAGGER UI", "operationId": "getLaunchUiUsingGET", "produces": [ "*/*" ], "parameters": [ { "name": "allRequestParams", "in": "query", "description": "allRequestParams", "required": true, "items": { "type": "object", "additionalProperties": { "type": "string" } } }, { "name": "commandId", "in": "path", "description": "commandId", "required": true, "type": "integer", "format": "int64" }, { "name": "wrapperName", "in": "path", "description": "wrapperName", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/LaunchUi" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false }, "post": { "tags": [ "launch-rest-api" ], "summary": "Resolve a command from the variable values in the query params, and launch it", "description": "Replaced by /commands/{commandId}/wrappers/{wrapperName}/root/{rootElement}/launch including xsiType as rootElement parameter.", "operationId": "launchCommandWQueryParams2UsingPOST", "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "*/*" ], "parameters": [ { "name": "allRequestParams", "in": "query", "description": "allRequestParams", "required": true, "items": { "type": "object", "additionalProperties": { "type": "string" } } }, { "name": "commandId", "in": "path", "description": "commandId", "required": true, "type": "integer", "format": "int64" }, { "name": "wrapperName", "in": "path", "description": "wrapperName", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/LaunchReport" } }, "201": { "description": "Created" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": true } }, "/commands/{commandId}/wrappers/{wrapperName}/root/{rootElement}/bulklaunch": { "post": { "tags": [ "launch-rest-api" ], "summary": "Resolve a command from the variable values in the request body, and launch it", "operationId": "bulkLaunchUsingPOST", "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "allRequestParams", "description": "allRequestParams", "required": true, "schema": { "type": "object", "additionalProperties": { "type": "string" } } }, { "name": "commandId", "in": "path", "description": "commandId", "required": true, "type": "integer", "format": "int64" }, { "name": "rootElement", "in": "path", "description": "rootElement", "required": true, "type": "string" }, { "name": "wrapperName", "in": "path", "description": "wrapperName", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/BulkLaunchReport" } }, "201": { "description": "Created" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/commands/{commandId}/wrappers/{wrapperName}/root/{rootElement}/launch": { "post": { "tags": [ "launch-rest-api" ], "summary": "Resolve a command from the variable values in the request body, and launch it", "operationId": "launchCommandWJsonBodyUsingPOST", "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "allRequestParams", "description": "allRequestParams", "required": true, "schema": { "type": "object", "additionalProperties": { "type": "string" } } }, { "name": "commandId", "in": "path", "description": "commandId", "required": true, "type": "integer", "format": "int64" }, { "name": "rootElement", "in": "path", "description": "rootElement", "required": true, "type": "string" }, { "name": "wrapperName", "in": "path", "description": "wrapperName", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/LaunchReport" } }, "201": { "description": "Created" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/commands/{id}": { "get": { "tags": [ "command-rest-api" ], "summary": "Get a Command by ID", "operationId": "retrieveCommandUsingGET", "produces": [ "*/*" ], "parameters": [ { "name": "id", "in": "path", "description": "id", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Command" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false }, "post": { "tags": [ "command-rest-api" ], "summary": "Update a Command", "operationId": "updateCommandUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "command", "description": "command", "required": true, "schema": { "$ref": "#/definitions/Command" } }, { "name": "id", "in": "path", "description": "id", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "OK" }, "201": { "description": "Created" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false }, "delete": { "tags": [ "command-rest-api" ], "summary": "Delete a Command", "operationId": "deleteUsingDELETE_1", "produces": [ "*/*" ], "parameters": [ { "name": "id", "in": "path", "description": "id", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "OK" }, "204": { "description": "No Content" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "deprecated": false } }, "/commands/{id}/wrappers": { "post": { "tags": [ "command-rest-api" ], "summary": "Create a Command Wrapper", "operationId": "createWrapperUsingPOST", "consumes": [ "application/json" ], "produces": [ "application/json;charset=UTF-8" ], "parameters": [ { "in": "body", "name": "commandWrapperCreation", "description": "commandWrapperCreation", "required": true, "schema": { "$ref": "#/definitions/CommandWrapperCreation" } }, { "name": "id", "in": "path", "description": "id", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "OK", "schema": { "type": "integer", "format": "int64" } }, "201": { "description": "Created" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/container/name/{name}": { "get": { "tags": [ "container-rest-api" ], "summary": "Get Containers by database name", "operationId": "getByNameUsingGET", "produces": [ "*/*" ], "parameters": [ { "name": "name", "in": "path", "description": "name", "required": true, "type": "string" }, { "name": "nonfinalized", "in": "query", "description": "nonfinalized", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Container" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/containers": { "get": { "tags": [ "container-rest-api" ], "summary": "Get all Containers", "operationId": "getAllUsingGET_2", "produces": [ "*/*" ], "parameters": [ { "name": "nonfinalized", "in": "query", "description": "nonfinalized", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/Container" } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false }, "post": { "tags": [ "container-rest-api" ], "summary": "Get paginated containers per request", "operationId": "getPaginatedUsingPOST", "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "parameters": [ { "in": "body", "name": "containerPaginatedRequest", "description": "containerPaginatedRequest", "required": true, "schema": { "$ref": "#/definitions/ContainerPaginatedRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/Container" } } }, "201": { "description": "Created" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/containers/version": { "get": { "tags": [ "container-rest-api" ], "summary": "Check XNAT Version compatibility.", "operationId": "versionCheckUsingGET", "produces": [ "*/*" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PluginVersionCheck" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/containers/{containerId}/logSince/{file}": { "get": { "tags": [ "container-rest-api" ], "summary": "Get Container logs", "description": "Return either stdout or stderr logs", "operationId": "pollLogUsingGET", "produces": [ "*/*" ], "parameters": [ { "name": "containerId", "in": "path", "description": "containerId", "required": true, "type": "string" }, { "name": "file", "in": "path", "description": "file", "required": false, "type": "string", "enum": [ "stdout", "stderr" ] }, { "name": "since", "in": "query", "description": "since", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ContainerLogPollResponse" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/containers/{containerId}/logs": { "get": { "tags": [ "container-rest-api" ], "summary": "Get Container logs", "description": "Return stdout and stderr logs as a zip", "operationId": "getLogsUsingGET", "produces": [ "*/*" ], "parameters": [ { "name": "containerId", "in": "path", "description": "containerId", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/containers/{containerId}/logs/{file}": { "get": { "tags": [ "container-rest-api" ], "summary": "Get Container logs", "description": "Return either stdout or stderr logs", "operationId": "getLogUsingGET", "produces": [ "*/*" ], "parameters": [ { "name": "containerId", "in": "path", "description": "containerId", "required": true, "type": "string" }, { "name": "file", "in": "path", "description": "file", "required": false, "type": "string", "enum": [ "stdout", "stderr" ] } ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/containers/{id}": { "get": { "tags": [ "container-rest-api" ], "summary": "Get Containers by database ID", "operationId": "getUsingGET_2", "produces": [ "*/*" ], "parameters": [ { "name": "id", "in": "path", "description": "id", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Container" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false }, "delete": { "tags": [ "container-rest-api" ], "summary": "Get Container by container server ID", "operationId": "deleteUsingDELETE_4", "produces": [ "*/*" ], "parameters": [ { "name": "id", "in": "path", "description": "id", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK" }, "204": { "description": "No Content" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "deprecated": false } }, "/containers/{id}/finalize": { "post": { "tags": [ "container-rest-api" ], "summary": "Finalize Container", "operationId": "finalizeUsingPOST", "consumes": [ "application/json" ], "produces": [ "application/json;charset=UTF-8" ], "parameters": [ { "name": "id", "in": "path", "description": "id", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK" }, "201": { "description": "Created" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/containers/{id}/kill": { "post": { "tags": [ "container-rest-api" ], "summary": "Kill Container", "operationId": "killUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "name": "id", "in": "path", "description": "id", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } }, "201": { "description": "Created" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/docker/hubs": { "get": { "tags": [ "docker-rest-api" ], "summary": "Get Docker Hubs", "operationId": "getHubsUsingGET", "produces": [ "*/*" ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/DockerHubWithPing" } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false }, "post": { "tags": [ "docker-rest-api" ], "summary": "Create new Docker Hub", "operationId": "createHubUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "name": "default", "in": "query", "description": "default", "required": false, "type": "boolean", "default": false }, { "in": "body", "name": "hub", "description": "hub", "required": true, "schema": { "$ref": "#/definitions/DockerHub" } }, { "name": "reason", "in": "query", "description": "reason", "required": false, "type": "string", "default": "User request" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/DockerHubWithPing" } }, "201": { "description": "Created" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/docker/hubs/{id}": { "get": { "tags": [ "docker-rest-api" ], "summary": "Get Docker Hub by ID", "operationId": "getHubUsingGET", "produces": [ "*/*" ], "parameters": [ { "name": "id", "in": "path", "description": "id", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/DockerHubWithPing" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false }, "post": { "tags": [ "docker-rest-api" ], "summary": "Update Docker Hub by ID", "operationId": "updateHubUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "name": "default", "in": "query", "description": "default", "required": false, "type": "boolean", "default": false }, { "in": "body", "name": "hub", "description": "hub", "required": false, "schema": { "$ref": "#/definitions/DockerHub" } }, { "name": "id", "in": "path", "description": "id", "required": true, "type": "integer", "format": "int64" }, { "name": "reason", "in": "query", "description": "reason", "required": false, "type": "string", "default": "User request" } ], "responses": { "200": { "description": "OK" }, "201": { "description": "Created" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false }, "delete": { "tags": [ "docker-rest-api" ], "summary": "Delete Docker Hub by ID", "operationId": "deleteHubUsingDELETE", "produces": [ "*/*" ], "parameters": [ { "name": "id", "in": "path", "description": "id", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "OK" }, "204": { "description": "No Content" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "deprecated": false } }, "/docker/hubs/{id}/ping": { "get": { "tags": [ "docker-rest-api" ], "summary": "Ping Docker Hub by ID", "description": "Returns status, \"OK\" response, and message on success.", "operationId": "pingHubUsingGET", "produces": [ "*/*" ], "parameters": [ { "name": "id", "in": "path", "description": "id", "required": true, "type": "integer", "format": "int64" }, { "name": "password", "in": "query", "description": "password", "required": false, "type": "string" }, { "name": "username", "in": "query", "description": "username", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/DockerHubStatus" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/docker/hubs/{id}/pull": { "post": { "tags": [ "docker-rest-api" ], "summary": "Pull image from Docker Hub by ID", "operationId": "pullImageFromHubUsingPOST_1", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "name": "id", "in": "path", "description": "id", "required": true, "type": "integer", "format": "int64" }, { "name": "image", "in": "query", "description": "image", "required": true, "type": "string" }, { "name": "save-commands", "in": "query", "description": "save-commands", "required": false, "type": "boolean", "default": true } ], "responses": { "200": { "description": "OK" }, "201": { "description": "Created" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/docker/hubs/{name}": { "get": { "tags": [ "docker-rest-api" ], "summary": "Get Docker Hub by Name", "operationId": "getHubUsingGET_1", "produces": [ "*/*" ], "parameters": [ { "name": "name", "in": "path", "description": "name", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/DockerHubWithPing" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false }, "delete": { "tags": [ "docker-rest-api" ], "summary": "Delete Docker Hub by Name", "operationId": "deleteHubUsingDELETE_1", "produces": [ "*/*" ], "parameters": [ { "name": "name", "in": "path", "description": "name", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK" }, "204": { "description": "No Content" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "deprecated": false } }, "/docker/hubs/{name}/ping": { "get": { "tags": [ "docker-rest-api" ], "summary": "Ping Docker Hub by Name", "description": "Returns status, \"OK\" response, and message on success.", "operationId": "pingHubUsingGET_1", "produces": [ "*/*" ], "parameters": [ { "name": "name", "in": "path", "description": "name", "required": true, "type": "string" }, { "name": "password", "in": "query", "description": "password", "required": false, "type": "string" }, { "name": "username", "in": "query", "description": "username", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/DockerHubStatus" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/docker/hubs/{name}/pull": { "post": { "tags": [ "docker-rest-api" ], "summary": "Pull image from Docker Hub by Name", "operationId": "pullImageFromHubUsingPOST_2", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "name": "image", "in": "query", "description": "image", "required": true, "type": "string" }, { "name": "name", "in": "path", "description": "name", "required": true, "type": "string" }, { "name": "save-commands", "in": "query", "description": "save-commands", "required": false, "type": "boolean", "default": true } ], "responses": { "200": { "description": "OK" }, "201": { "description": "Created" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/docker/image-summaries": { "get": { "tags": [ "docker-rest-api" ], "summary": "Get summary list of images and commands.", "operationId": "getImageSummariesUsingGET", "produces": [ "application/json;charset=UTF-8" ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/DockerImageAndCommandSummary" } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/docker/images": { "get": { "tags": [ "docker-rest-api" ], "summary": "Get list of images.", "description": "Returns a list of all Docker images on the Docker server.", "operationId": "getImagesUsingGET", "produces": [ "application/json;charset=UTF-8" ], "parameters": [ { "name": "installed", "in": "query", "description": "installed", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "A list of images on the server", "schema": { "type": "array", "items": { "$ref": "#/definitions/DockerImage" } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "424": { "description": "Admin must set up Docker server." }, "500": { "description": "Unexpected error" } }, "deprecated": false } }, "/docker/images/save": { "post": { "tags": [ "docker-rest-api" ], "summary": "Save Commands from labels", "description": "Read labels from Docker image. If any labels contain key org.nrg.commands, parse value as list of Commands.", "operationId": "saveFromLabelsUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "name": "image", "in": "query", "description": "image", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/Command" } } }, "201": { "description": "Created" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/docker/images/{id}": { "get": { "tags": [ "docker-rest-api" ], "summary": "Get Docker image", "description": "Retrieve information about a Docker image from the docker server", "operationId": "getImageUsingGET", "produces": [ "application/json;charset=UTF-8" ], "parameters": [ { "name": "id", "in": "path", "description": "id", "required": true, "type": "string" } ], "responses": { "200": { "description": "Found the image", "schema": { "$ref": "#/definitions/DockerImage" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "No docker image with given id on the server" }, "424": { "description": "Admin must set up Docker server." }, "500": { "description": "Unexpected error" } }, "deprecated": false }, "delete": { "tags": [ "docker-rest-api" ], "summary": "Delete Docker image", "description": "Remove information about a Docker image", "operationId": "deleteImageUsingDELETE", "produces": [ "*/*" ], "parameters": [ { "name": "force", "in": "query", "description": "force", "required": false, "type": "boolean", "default": false }, { "name": "id", "in": "path", "description": "id", "required": true, "type": "string" } ], "responses": { "200": { "description": "Image was removed" }, "204": { "description": "No Content" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "No docker image with given id on docker server" }, "424": { "description": "Admin must set up Docker server." }, "500": { "description": "Unexpected error" } }, "deprecated": false } }, "/docker/pull": { "post": { "tags": [ "docker-rest-api" ], "summary": "Pull image from default Docker Hub", "operationId": "pullImageFromDefaultHubUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "name": "image", "in": "query", "description": "image", "required": true, "type": "string" }, { "name": "save-commands", "in": "query", "description": "save-commands", "required": false, "type": "boolean", "default": true } ], "responses": { "200": { "description": "OK" }, "201": { "description": "Created" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/docker/server": { "get": { "tags": [ "docker-rest-api" ], "summary": "Docker server", "description": "Returns Docker server configuration values", "operationId": "getServerUsingGET", "produces": [ "application/json;charset=UTF-8" ], "responses": { "200": { "description": "The Docker server configuration", "schema": { "$ref": "#/definitions/DockerServer" } }, "400": { "description": "The server has not been configured" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Unexpected error" } }, "deprecated": false }, "post": { "tags": [ "docker-rest-api" ], "summary": "Set Docker server configuration", "description": "Save new Docker server configuration values", "operationId": "setServerUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "dockerServer", "description": "dockerServer", "required": true, "schema": { "$ref": "#/definitions/DockerServer" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/DockerServerWithPing" } }, "201": { "description": "The Docker server configuration was saved", "schema": { "$ref": "#/definitions/DockerServerWithPing" } }, "400": { "description": "Configuration was invalid" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Unexpected error" } }, "deprecated": false } }, "/docker/server/ping": { "get": { "tags": [ "docker-rest-api" ], "summary": "Ping docker server.", "description": "Returns \"OK\" on success.", "operationId": "pingServerUsingGET", "produces": [ "*/*" ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/jms_queues": { "get": { "tags": [ "queue-settings-rest-api" ], "summary": "Returns a map of queue settings.", "operationId": "getQueueSettingsUsingGET", "produces": [ "application/json" ], "responses": { "200": { "description": "Queue settings successfully retrieved.", "schema": { "type": "object" } }, "401": { "description": "Must be authenticated to access the XNAT REST API." }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Unexpected error" } }, "deprecated": false }, "post": { "tags": [ "queue-settings-rest-api" ], "summary": "Sets a map of queue settings.", "operationId": "setQueueSettingsUsingPOST", "consumes": [ "application/json", "application/x-www-form-urlencoded" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "properties", "description": "The map of queue settings properties to be set.", "required": true, "schema": { "type": "object", "additionalProperties": { "type": "string" } } } ], "responses": { "200": { "description": "Queue settings successfully set." }, "201": { "description": "Created" }, "400": { "description": "Invalid input." }, "401": { "description": "Must be authenticated to access the XNAT REST API." }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Unexpected error" } }, "deprecated": false } }, "/orchestration": { "get": { "tags": [ "orchestration-rest-api" ], "summary": "Get orchestrations", "operationId": "getOrchestrationsUsingGET_1", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/Orchestration" } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false }, "post": { "tags": [ "orchestration-rest-api" ], "summary": "Create or update orchestration", "operationId": "setupOrchestrationUsingPOST", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "orchestration", "description": "orchestration", "required": true, "schema": { "$ref": "#/definitions/Orchestration" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Orchestration" } }, "201": { "description": "Created" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/orchestration/project/{project}": { "get": { "tags": [ "orchestration-rest-api" ], "summary": "Get orchestrations", "operationId": "getOrchestrationsUsingGET", "produces": [ "application/json" ], "parameters": [ { "name": "project", "in": "path", "description": "project", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OrchestrationProject" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false }, "put": { "tags": [ "orchestration-rest-api" ], "summary": "Set orchestration on project", "operationId": "setProjectOrchestrationUsingPUT", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "name": "orchestrationId", "in": "query", "description": "orchestrationId", "required": true, "type": "integer", "format": "int64" }, { "name": "project", "in": "path", "description": "project", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK" }, "201": { "description": "Created" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false }, "delete": { "tags": [ "orchestration-rest-api" ], "summary": "Remove orchestration from project", "operationId": "setProjectOrchestrationUsingDELETE", "produces": [ "*/*" ], "parameters": [ { "name": "project", "in": "path", "description": "project", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK" }, "204": { "description": "No Content" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "deprecated": false } }, "/orchestration/{id}": { "delete": { "tags": [ "orchestration-rest-api" ], "summary": "Delete orchestration", "operationId": "deleteOrchestrationUsingDELETE", "produces": [ "*/*" ], "parameters": [ { "name": "id", "in": "path", "description": "id", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "OK" }, "204": { "description": "No Content" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "deprecated": false } }, "/orchestration/{id}/enabled/{enabled}": { "put": { "tags": [ "orchestration-rest-api" ], "summary": "Enable or disable orchestration", "operationId": "enableOrDisableOrchestrationUsingPUT", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "name": "enabled", "in": "path", "description": "enabled", "required": true, "type": "boolean" }, { "name": "id", "in": "path", "description": "id", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "OK" }, "201": { "description": "Created" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/projects/{project}/commands/available": { "get": { "tags": [ "command-rest-api" ], "summary": "Get Commands available in given project context and XSIType", "operationId": "availableCommands2UsingGET", "produces": [ "*/*" ], "parameters": [ { "name": "project", "in": "path", "description": "project", "required": true, "type": "string" }, { "name": "xsiType", "in": "query", "description": "xsiType", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/CommandSummaryForContext" } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/projects/{project}/commands/{commandId}/wrappers/{wrapperName}/bulklaunch": { "get": { "tags": [ "launch-rest-api" ], "summary": "Get Bulk Launch UI for wrapper", "description": "DOES NOT WORK PROPERLY IN SWAGGER UI", "operationId": "getBulkLaunchUiUsingGET_1", "produces": [ "*/*" ], "parameters": [ { "name": "commandId", "in": "path", "description": "commandId", "required": true, "type": "integer", "format": "int64" }, { "name": "project", "in": "path", "description": "project", "required": true, "type": "string" }, { "name": "rootElement", "in": "query", "description": "rootElement", "required": true, "type": "string" }, { "name": "sampleTarget", "in": "query", "description": "sampleTarget", "required": true, "type": "string" }, { "name": "wrapperName", "in": "path", "description": "wrapperName", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/LaunchUi" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false }, "post": { "tags": [ "launch-rest-api" ], "summary": "Resolve a command from the variable values in the request body, and launch it", "description": "Replaced by /projects/{project}/commands/{commandId}/wrappers/{wrapperName}/root/{rootElement}/bulklaunch including xsiType as rootElement parameter.", "operationId": "bulklaunch2UsingPOST_1", "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "allRequestParams", "description": "allRequestParams", "required": true, "schema": { "type": "object", "additionalProperties": { "type": "string" } } }, { "name": "commandId", "in": "path", "description": "commandId", "required": true, "type": "integer", "format": "int64" }, { "name": "project", "in": "path", "description": "project", "required": true, "type": "string" }, { "name": "wrapperName", "in": "path", "description": "wrapperName", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/BulkLaunchReport" } }, "201": { "description": "Created" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": true } }, "/projects/{project}/commands/{commandId}/wrappers/{wrapperName}/config": { "get": { "tags": [ "command-configuration-rest-api" ], "summary": "Get (project)", "operationId": "getConfigurationUsingGET_1", "produces": [ "*/*" ], "parameters": [ { "name": "commandId", "in": "path", "description": "commandId", "required": true, "type": "integer", "format": "int64" }, { "name": "project", "in": "path", "description": "project", "required": true, "type": "string" }, { "name": "wrapperName", "in": "path", "description": "wrapperName", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CommandConfiguration" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false }, "post": { "tags": [ "command-configuration-rest-api" ], "summary": "Configure (project)", "operationId": "createConfigurationUsingPOST_1", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "commandConfiguration", "description": "commandConfiguration", "required": true, "schema": { "$ref": "#/definitions/CommandConfiguration" } }, { "name": "commandId", "in": "path", "description": "commandId", "required": true, "type": "integer", "format": "int64" }, { "name": "enable", "in": "query", "description": "enable", "required": false, "type": "boolean", "default": true }, { "name": "project", "in": "path", "description": "project", "required": true, "type": "string" }, { "name": "reason", "in": "query", "description": "reason", "required": false, "type": "string" }, { "name": "wrapperName", "in": "path", "description": "wrapperName", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK" }, "201": { "description": "Created" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false }, "delete": { "tags": [ "command-configuration-rest-api" ], "summary": "Delete (project)", "operationId": "deleteConfigurationUsingDELETE_1", "produces": [ "*/*" ], "parameters": [ { "name": "commandId", "in": "path", "description": "commandId", "required": true, "type": "integer", "format": "int64" }, { "name": "project", "in": "path", "description": "project", "required": true, "type": "string" }, { "name": "wrapperName", "in": "path", "description": "wrapperName", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK" }, "204": { "description": "No Content" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "deprecated": false } }, "/projects/{project}/commands/{commandId}/wrappers/{wrapperName}/disabled": { "put": { "tags": [ "command-configuration-rest-api" ], "summary": "Disable (project)", "operationId": "disableConfigurationUsingPUT_1", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "name": "commandId", "in": "path", "description": "commandId", "required": true, "type": "integer", "format": "int64" }, { "name": "project", "in": "path", "description": "project", "required": true, "type": "string" }, { "name": "reason", "in": "query", "description": "reason", "required": false, "type": "string" }, { "name": "wrapperName", "in": "path", "description": "wrapperName", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK" }, "201": { "description": "Created" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/projects/{project}/commands/{commandId}/wrappers/{wrapperName}/enabled": { "get": { "tags": [ "command-configuration-rest-api" ], "summary": "Is Enabled (project)", "operationId": "isConfigurationEnabledUsingGET_1", "produces": [ "*/*" ], "parameters": [ { "name": "commandId", "in": "path", "description": "commandId", "required": true, "type": "integer", "format": "int64" }, { "name": "project", "in": "path", "description": "project", "required": true, "type": "string" }, { "name": "wrapperName", "in": "path", "description": "wrapperName", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ProjectEnabledReport" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false }, "put": { "tags": [ "command-configuration-rest-api" ], "summary": "Enable (project)", "operationId": "enableConfigurationUsingPUT_1", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "name": "commandId", "in": "path", "description": "commandId", "required": true, "type": "integer", "format": "int64" }, { "name": "project", "in": "path", "description": "project", "required": true, "type": "string" }, { "name": "reason", "in": "query", "description": "reason", "required": false, "type": "string" }, { "name": "wrapperName", "in": "path", "description": "wrapperName", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK" }, "201": { "description": "Created" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/projects/{project}/commands/{commandId}/wrappers/{wrapperName}/launch": { "get": { "tags": [ "launch-rest-api" ], "summary": "Get Launch UI for wrapper", "description": "DOES NOT WORK PROPERLY IN SWAGGER UI", "operationId": "getLaunchUiUsingGET_1", "produces": [ "*/*" ], "parameters": [ { "name": "allRequestParams", "in": "query", "description": "allRequestParams", "required": true, "items": { "type": "object", "additionalProperties": { "type": "string" } } }, { "name": "commandId", "in": "path", "description": "commandId", "required": true, "type": "integer", "format": "int64" }, { "name": "project", "in": "path", "description": "project", "required": true, "type": "string" }, { "name": "wrapperName", "in": "path", "description": "wrapperName", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/LaunchUi" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false }, "post": { "tags": [ "launch-rest-api" ], "summary": "Resolve a command from the variable values in the request body, and launch it", "description": "Replaced by /projects/{project}/commands/{commandId}/wrappers/{wrapperName}/root/{rootElement}/launch including xsiType as rootElement parameter.", "operationId": "launchCommandWJsonBody2UsingPOST", "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "allRequestParams", "description": "allRequestParams", "required": true, "schema": { "type": "object", "additionalProperties": { "type": "string" } } }, { "name": "commandId", "in": "path", "description": "commandId", "required": true, "type": "integer", "format": "int64" }, { "name": "project", "in": "path", "description": "project", "required": true, "type": "string" }, { "name": "wrapperName", "in": "path", "description": "wrapperName", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/LaunchReport" } }, "201": { "description": "Created" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": true } }, "/projects/{project}/commands/{commandId}/wrappers/{wrapperName}/root/{rootElement}/bulklaunch": { "post": { "tags": [ "launch-rest-api" ], "summary": "Resolve a command from the variable values in the request body, and launch it", "operationId": "bulkLaunchUsingPOST_1", "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "allRequestParams", "description": "allRequestParams", "required": true, "schema": { "type": "object", "additionalProperties": { "type": "string" } } }, { "name": "commandId", "in": "path", "description": "commandId", "required": true, "type": "integer", "format": "int64" }, { "name": "project", "in": "path", "description": "project", "required": true, "type": "string" }, { "name": "rootElement", "in": "path", "description": "rootElement", "required": true, "type": "string" }, { "name": "wrapperName", "in": "path", "description": "wrapperName", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/BulkLaunchReport" } }, "201": { "description": "Created" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/projects/{project}/commands/{commandId}/wrappers/{wrapperName}/root/{rootElement}/launch": { "post": { "tags": [ "launch-rest-api" ], "summary": "Resolve a command from the variable values in the query params, and launch it", "description": "DOES NOT WORK PROPERLY IN SWAGGER UI", "operationId": "launchCommandWQueryParamsUsingPOST", "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "*/*" ], "parameters": [ { "name": "allRequestParams", "in": "query", "description": "allRequestParams", "required": true, "items": { "type": "object", "additionalProperties": { "type": "string" } } }, { "name": "commandId", "in": "path", "description": "commandId", "required": true, "type": "integer", "format": "int64" }, { "name": "project", "in": "path", "description": "project", "required": true, "type": "string" }, { "name": "rootElement", "in": "path", "description": "rootElement", "required": true, "type": "string" }, { "name": "wrapperName", "in": "path", "description": "wrapperName", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/LaunchReport" } }, "201": { "description": "Created" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/projects/{project}/containers": { "get": { "tags": [ "container-rest-api" ], "summary": "Get all Containers by project", "operationId": "getAllUsingGET_3", "produces": [ "*/*" ], "parameters": [ { "name": "nonfinalized", "in": "query", "description": "nonfinalized", "required": false, "type": "boolean" }, { "name": "project", "in": "path", "description": "project", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/Container" } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/projects/{project}/containers/name/{name}": { "get": { "tags": [ "container-rest-api" ], "summary": "Get Containers by name", "operationId": "getByNameUsingGET_1", "produces": [ "*/*" ], "parameters": [ { "name": "name", "in": "path", "description": "name", "required": true, "type": "string" }, { "name": "nonfinalized", "in": "query", "description": "nonfinalized", "required": false, "type": "boolean" }, { "name": "project", "in": "path", "description": "project", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Container" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/projects/{project}/containers/{id}/kill": { "post": { "tags": [ "container-rest-api" ], "summary": "Kill Container", "operationId": "killUsingPOST_1", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "name": "id", "in": "path", "description": "id", "required": true, "type": "string" }, { "name": "project", "in": "path", "description": "project", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } }, "201": { "description": "Created" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/projects/{project}/wrapper/{wrapperId}/launch": { "post": { "tags": [ "launch-rest-api" ], "summary": "Resolve a command from the variable values in the query params, and launch it", "description": "Replaced by /projects/{project}/wrapper/{wrapperId}/root/{rootElement}/launch including xsiType as rootElement parameter.", "operationId": "launchCommandWQueryParams2UsingPOST_1", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "name": "allRequestParams", "in": "query", "description": "allRequestParams", "required": true, "items": { "type": "object", "additionalProperties": { "type": "string" } } }, { "name": "project", "in": "path", "description": "project", "required": true, "type": "string" }, { "name": "wrapperId", "in": "path", "description": "wrapperId", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/LaunchReport" } }, "201": { "description": "Created" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": true } }, "/projects/{project}/wrapper/{wrapperId}/root/{rootElement}/launch": { "post": { "tags": [ "launch-rest-api" ], "summary": "Resolve a command from the variable values in the query params, and launch it", "description": "DOES NOT WORK PROPERLY IN SWAGGER UI", "operationId": "launchCommandWQueryParamsUsingPOST_1", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "name": "allRequestParams", "in": "query", "description": "allRequestParams", "required": true, "items": { "type": "object", "additionalProperties": { "type": "string" } } }, { "name": "project", "in": "path", "description": "project", "required": true, "type": "string" }, { "name": "rootElement", "in": "path", "description": "rootElement", "required": true, "type": "string" }, { "name": "wrapperId", "in": "path", "description": "wrapperId", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/LaunchReport" } }, "201": { "description": "Created" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/projects/{project}/wrappers/{wrapperId}/bulklaunch": { "get": { "tags": [ "launch-rest-api" ], "summary": "Get Bulk Launch UI for wrapper", "description": "DOES NOT WORK PROPERLY IN SWAGGER UI", "operationId": "getBulkLaunchUiUsingGET_2", "produces": [ "*/*" ], "parameters": [ { "name": "project", "in": "path", "description": "project", "required": true, "type": "string" }, { "name": "rootElement", "in": "query", "description": "rootElement", "required": true, "type": "string" }, { "name": "sampleTarget", "in": "query", "description": "sampleTarget", "required": true, "type": "string" }, { "name": "wrapperId", "in": "path", "description": "wrapperId", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/LaunchUi" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false }, "post": { "tags": [ "launch-rest-api" ], "summary": "Resolve a command from the variable values in the request body, and launch it", "description": "Replaced by /projects/{project}/wrappers/{wrapperId}/root/{rootElement}/bulklaunch including xsiType as rootElement parameter.", "operationId": "bulklaunch2UsingPOST_2", "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "allRequestParams", "description": "allRequestParams", "required": true, "schema": { "type": "object", "additionalProperties": { "type": "string" } } }, { "name": "project", "in": "path", "description": "project", "required": true, "type": "string" }, { "name": "wrapperId", "in": "path", "description": "wrapperId", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/BulkLaunchReport" } }, "201": { "description": "Created" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": true } }, "/projects/{project}/wrappers/{wrapperId}/config": { "get": { "tags": [ "command-configuration-rest-api" ], "summary": "Get (project)", "operationId": "getConfigurationUsingGET_2", "produces": [ "*/*" ], "parameters": [ { "name": "project", "in": "path", "description": "project", "required": true, "type": "string" }, { "name": "wrapperId", "in": "path", "description": "wrapperId", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CommandConfiguration" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false }, "post": { "tags": [ "command-configuration-rest-api" ], "summary": "Configure (project)", "operationId": "createConfigurationUsingPOST_2", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "commandConfiguration", "description": "commandConfiguration", "required": true, "schema": { "$ref": "#/definitions/CommandConfiguration" } }, { "name": "enable", "in": "query", "description": "enable", "required": false, "type": "boolean", "default": true }, { "name": "project", "in": "path", "description": "project", "required": true, "type": "string" }, { "name": "reason", "in": "query", "description": "reason", "required": false, "type": "string" }, { "name": "wrapperId", "in": "path", "description": "wrapperId", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "OK" }, "201": { "description": "Created" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false }, "delete": { "tags": [ "command-configuration-rest-api" ], "summary": "Delete (project)", "operationId": "deleteConfigurationUsingDELETE_2", "produces": [ "*/*" ], "parameters": [ { "name": "project", "in": "path", "description": "project", "required": true, "type": "string" }, { "name": "wrapperId", "in": "path", "description": "wrapperId", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "OK" }, "204": { "description": "No Content" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "deprecated": false } }, "/projects/{project}/wrappers/{wrapperId}/disabled": { "put": { "tags": [ "command-configuration-rest-api" ], "summary": "Disable (project)", "operationId": "disableConfigurationUsingPUT_2", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "name": "project", "in": "path", "description": "project", "required": true, "type": "string" }, { "name": "reason", "in": "query", "description": "reason", "required": false, "type": "string" }, { "name": "wrapperId", "in": "path", "description": "wrapperId", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "OK" }, "201": { "description": "Created" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/projects/{project}/wrappers/{wrapperId}/enabled": { "get": { "tags": [ "command-configuration-rest-api" ], "summary": "Is Enabled (project)", "operationId": "isConfigurationEnabledUsingGET_2", "produces": [ "*/*" ], "parameters": [ { "name": "project", "in": "path", "description": "project", "required": true, "type": "string" }, { "name": "wrapperId", "in": "path", "description": "wrapperId", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ProjectEnabledReport" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false }, "put": { "tags": [ "command-configuration-rest-api" ], "summary": "Enable (project)", "operationId": "enableConfigurationUsingPUT_2", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "name": "project", "in": "path", "description": "project", "required": true, "type": "string" }, { "name": "reason", "in": "query", "description": "reason", "required": false, "type": "string" }, { "name": "wrapperId", "in": "path", "description": "wrapperId", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "OK" }, "201": { "description": "Created" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/projects/{project}/wrappers/{wrapperId}/launch": { "get": { "tags": [ "launch-rest-api" ], "summary": "Get Launch UI for wrapper", "description": "DOES NOT WORK PROPERLY IN SWAGGER UI", "operationId": "getLaunchUiUsingGET_2", "produces": [ "*/*" ], "parameters": [ { "name": "allRequestParams", "in": "query", "description": "allRequestParams", "required": true, "items": { "type": "object", "additionalProperties": { "type": "string" } } }, { "name": "project", "in": "path", "description": "project", "required": true, "type": "string" }, { "name": "wrapperId", "in": "path", "description": "wrapperId", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/LaunchUi" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false }, "post": { "tags": [ "launch-rest-api" ], "summary": "Resolve a command from the variable values in the request body, and launch it", "description": "Replaced by /projects/{project}/wrappers/{wrapperId}/root/{rootElement}/launch including xsiType as rootElement parameter.", "operationId": "launchCommandWJsonBody2UsingPOST_1", "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "allRequestParams", "description": "allRequestParams", "required": true, "schema": { "type": "object", "additionalProperties": { "type": "string" } } }, { "name": "project", "in": "path", "description": "project", "required": true, "type": "string" }, { "name": "wrapperId", "in": "path", "description": "wrapperId", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/LaunchReport" } }, "201": { "description": "Created" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": true } }, "/projects/{project}/wrappers/{wrapperId}/root/{rootElement}/bulklaunch": { "post": { "tags": [ "launch-rest-api" ], "summary": "Resolve a command from the variable values in the request body, and launch it", "operationId": "bulkLaunchUsingPOST_2", "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "allRequestParams", "description": "allRequestParams", "required": true, "schema": { "type": "object", "additionalProperties": { "type": "string" } } }, { "name": "project", "in": "path", "description": "project", "required": true, "type": "string" }, { "name": "rootElement", "in": "path", "description": "rootElement", "required": true, "type": "string" }, { "name": "wrapperId", "in": "path", "description": "wrapperId", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/BulkLaunchReport" } }, "201": { "description": "Created" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/projects/{project}/wrappers/{wrapperId}/root/{rootElement}/launch": { "post": { "tags": [ "launch-rest-api" ], "summary": "Resolve a command from the variable values in the request body, and launch it", "operationId": "launchCommandWJsonBodyUsingPOST_1", "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "allRequestParams", "description": "allRequestParams", "required": true, "schema": { "type": "object", "additionalProperties": { "type": "string" } } }, { "name": "project", "in": "path", "description": "project", "required": true, "type": "string" }, { "name": "rootElement", "in": "path", "description": "rootElement", "required": true, "type": "string" }, { "name": "wrapperId", "in": "path", "description": "wrapperId", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/LaunchReport" } }, "201": { "description": "Created" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/workflows": { "post": { "tags": [ "workflow-monitor-api" ], "summary": "Returns a map of workflow models.", "operationId": "getWorkflowsUsingPOST", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "workflowPaginatedRequest", "description": "workflowPaginatedRequest", "required": true, "schema": { "$ref": "#/definitions/WorkflowPaginatedRequest" } } ], "responses": { "200": { "description": "Workflows successfully retrieved.", "schema": { "type": "array", "items": { "$ref": "#/definitions/Workflow" } } }, "201": { "description": "Created" }, "400": { "description": "Invalid request." }, "401": { "description": "Must be authenticated to access the XNAT REST API." }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Unexpected error" } }, "deprecated": false } }, "/workflows/{containerName}/killactive": { "post": { "tags": [ "workflow-monitor-api" ], "summary": "Kill all running *containerName* container processes for a list of sessions IDs.", "operationId": "killActiveUsingPOST", "consumes": [ "application/json", "application/x-www-form-urlencoded" ], "produces": [ "application/json" ], "parameters": [ { "name": "containerName", "in": "path", "description": "containerName", "required": true, "type": "string" }, { "name": "elements[]", "in": "formData", "description": "elements[]", "required": true, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" } ], "responses": { "200": { "description": "Containers successfully terminated.", "schema": { "type": "string" } }, "201": { "description": "Created" }, "401": { "description": "Must be authenticated to access the XNAT REST API." }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Unexpected error" } }, "deprecated": false } }, "/workflows/{wfid}": { "get": { "tags": [ "workflow-monitor-api" ], "summary": "Returns workflow model.", "operationId": "getWorkflowStatusUsingGET", "produces": [ "application/json" ], "parameters": [ { "name": "wfid", "in": "path", "description": "wfid", "required": true, "type": "string" } ], "responses": { "200": { "description": "Workflow successfully retrieved.", "schema": { "$ref": "#/definitions/Workflow" } }, "401": { "description": "Must be authenticated to access the XNAT REST API." }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Unexpected error" } }, "deprecated": false } }, "/workflows/{wfid}/build_dir": { "get": { "tags": [ "workflow-monitor-api" ], "summary": "Returns json representation of build directory.", "operationId": "getBuildDirJsonUsingGET", "produces": [ "application/json" ], "parameters": [ { "name": "wfid", "in": "path", "description": "wfid", "required": true, "type": "string" } ], "responses": { "200": { "description": "Build directory contents successfully retrieved.", "schema": { "type": "string" } }, "401": { "description": "Must be authenticated to access the XNAT REST API." }, "403": { "description": "User account does not have access to requested data." }, "404": { "description": "Not Found" }, "422": { "description": "Not a pipeline or container or no build directory." }, "500": { "description": "Unexpected error" } }, "deprecated": false } }, "/workflows/{wfid}/build_dir_contd": { "get": { "tags": [ "workflow-monitor-api" ], "summary": "Returns json representation of build directory, continued from path.", "operationId": "getBuildDirJsonContinuedUsingGET", "produces": [ "application/json" ], "parameters": [ { "name": "inputPath", "in": "query", "description": "inputPath", "required": true, "type": "string" }, { "name": "wfid", "in": "path", "description": "wfid", "required": true, "type": "string" } ], "responses": { "200": { "description": "Build directory contents successfully retrieved.", "schema": { "type": "string" } }, "401": { "description": "Must be authenticated to access the XNAT REST API." }, "403": { "description": "User account does not have access to requested data." }, "404": { "description": "Not Found" }, "422": { "description": "Not a pipeline or container or no build directory." }, "500": { "description": "Unexpected error" } }, "deprecated": false } }, "/workflows/{wfid}/get_file": { "get": { "tags": [ "workflow-monitor-api" ], "summary": "Returns requested file.", "operationId": "getBuildDirFileUsingGET", "produces": [ "application/octet-stream" ], "parameters": [ { "name": "path", "in": "query", "description": "path", "required": true, "type": "string" }, { "name": "wfid", "in": "path", "description": "wfid", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FileSystemResource" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/workflows/{wfid}/get_zip": { "post": { "tags": [ "workflow-monitor-api" ], "summary": "Returns requested files.", "operationId": "getBuildDirZipUsingPOST", "consumes": [ "application/json", "application/x-www-form-urlencoded" ], "produces": [ "application/octet-stream" ], "parameters": [ { "name": "inputPaths", "in": "formData", "description": "inputPaths", "required": true, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" }, { "name": "wfid", "in": "path", "description": "wfid", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/StreamingResponseBody" } }, "201": { "description": "Created" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/workflows/{workflowId}/kill": { "post": { "tags": [ "workflow-monitor-api" ], "summary": "Kill Process", "operationId": "killUsingPOST_2", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "name": "workflowId", "in": "path", "description": "workflowId", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } }, "201": { "description": "Created" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/workflows/{workflowid}/container": { "get": { "tags": [ "workflow-monitor-api" ], "summary": "Gets the container/service ID from a workflow", "operationId": "getContainerOrServiceIdUsingGET", "produces": [ "text/plain" ], "parameters": [ { "name": "workflowid", "in": "path", "description": "workflowid", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Unexpected error" } }, "deprecated": false } }, "/wrappers/{wrapperId}": { "delete": { "tags": [ "command-rest-api" ], "summary": "Delete a Command Wrapper", "operationId": "deleteWrapperUsingDELETE", "produces": [ "*/*" ], "parameters": [ { "name": "wrapperId", "in": "path", "description": "wrapperId", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "OK" }, "204": { "description": "No Content" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "deprecated": false } }, "/wrappers/{wrapperId}/bulklaunch": { "get": { "tags": [ "launch-rest-api" ], "summary": "Get Bulk Launch UI for wrapper", "description": "DOES NOT WORK PROPERLY IN SWAGGER UI", "operationId": "getBulkLaunchUiUsingGET_3", "produces": [ "*/*" ], "parameters": [ { "name": "rootElement", "in": "query", "description": "rootElement", "required": true, "type": "string" }, { "name": "sampleTarget", "in": "query", "description": "sampleTarget", "required": true, "type": "string" }, { "name": "wrapperId", "in": "path", "description": "wrapperId", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/LaunchUi" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false }, "post": { "tags": [ "launch-rest-api" ], "summary": "Resolve a command from the variable values in the request body, and launch it", "description": "Replaced by /wrappers/{wrapperId}/root/{rootElement}/bulklaunch including xsiType as rootElement parameter.", "operationId": "bulklaunch2UsingPOST_3", "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "allRequestParams", "description": "allRequestParams", "required": true, "schema": { "type": "object", "additionalProperties": { "type": "string" } } }, { "name": "wrapperId", "in": "path", "description": "wrapperId", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/BulkLaunchReport" } }, "201": { "description": "Created" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": true } }, "/wrappers/{wrapperId}/config": { "get": { "tags": [ "command-configuration-rest-api" ], "summary": "Get (site)", "operationId": "getConfigurationUsingGET_3", "produces": [ "*/*" ], "parameters": [ { "name": "wrapperId", "in": "path", "description": "wrapperId", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CommandConfiguration" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false }, "post": { "tags": [ "command-configuration-rest-api" ], "summary": "Configure (site)", "operationId": "createConfigurationUsingPOST_3", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "commandConfiguration", "description": "commandConfiguration", "required": true, "schema": { "$ref": "#/definitions/CommandConfiguration" } }, { "name": "enable", "in": "query", "description": "enable", "required": false, "type": "boolean", "default": true }, { "name": "reason", "in": "query", "description": "reason", "required": false, "type": "string" }, { "name": "wrapperId", "in": "path", "description": "wrapperId", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "OK" }, "201": { "description": "Created" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false }, "delete": { "tags": [ "command-configuration-rest-api" ], "summary": "Delete (site)", "operationId": "deleteConfigurationUsingDELETE_3", "produces": [ "*/*" ], "parameters": [ { "name": "wrapperId", "in": "path", "description": "wrapperId", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "OK" }, "204": { "description": "No Content" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "deprecated": false } }, "/wrappers/{wrapperId}/disabled": { "put": { "tags": [ "command-configuration-rest-api" ], "summary": "Disable (site)", "operationId": "disableConfigurationUsingPUT_3", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "name": "reason", "in": "query", "description": "reason", "required": false, "type": "string" }, { "name": "wrapperId", "in": "path", "description": "wrapperId", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "OK" }, "201": { "description": "Created" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/wrappers/{wrapperId}/enabled": { "get": { "tags": [ "command-configuration-rest-api" ], "summary": "Is Enabled (site)", "operationId": "isConfigurationEnabledUsingGET_3", "produces": [ "*/*" ], "parameters": [ { "name": "wrapperId", "in": "path", "description": "wrapperId", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "OK", "schema": { "type": "boolean" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false }, "put": { "tags": [ "command-configuration-rest-api" ], "summary": "Enable (site)", "operationId": "enableConfigurationUsingPUT_3", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "name": "reason", "in": "query", "description": "reason", "required": false, "type": "string" }, { "name": "wrapperId", "in": "path", "description": "wrapperId", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "OK" }, "201": { "description": "Created" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/wrappers/{wrapperId}/launch": { "get": { "tags": [ "launch-rest-api" ], "summary": "Get Launch UI for wrapper", "description": "DOES NOT WORK PROPERLY IN SWAGGER UI", "operationId": "getLaunchUiUsingGET_3", "produces": [ "*/*" ], "parameters": [ { "name": "allRequestParams", "in": "query", "description": "allRequestParams", "required": true, "items": { "type": "object", "additionalProperties": { "type": "string" } } }, { "name": "wrapperId", "in": "path", "description": "wrapperId", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/LaunchUi" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false }, "post": { "tags": [ "launch-rest-api" ], "summary": "Resolve a command from the variable values in the query params, and launch it", "description": "Deprecated API - Prefer /wrappers/{wrapperId}/root/{rootElement}/launch including xsiType as rootElement parameter.", "operationId": "launchCommandWQueryParams2UsingPOST_2", "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "*/*" ], "parameters": [ { "name": "allRequestParams", "in": "query", "description": "allRequestParams", "required": true, "items": { "type": "object", "additionalProperties": { "type": "string" } } }, { "name": "wrapperId", "in": "path", "description": "wrapperId", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/LaunchReport" } }, "201": { "description": "Created" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": true } }, "/wrappers/{wrapperId}/projects": { "get": { "tags": [ "command-configuration-rest-api" ], "summary": "Get a list of all projects which have enabled a particular wrapper", "operationId": "getProjectsEnabledFordWrapperUsingGET", "produces": [ "application/json;charset=UTF-8" ], "parameters": [ { "name": "wrapperId", "in": "path", "description": "wrapperId", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "type": "string" } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/wrappers/{wrapperId}/root/{rootElement}/bulklaunch": { "post": { "tags": [ "launch-rest-api" ], "summary": "Resolve a command from the variable values in the request body, and launch it", "operationId": "bulkLaunchUsingPOST_3", "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "allRequestParams", "description": "allRequestParams", "required": true, "schema": { "type": "object", "additionalProperties": { "type": "string" } } }, { "name": "rootElement", "in": "path", "description": "rootElement", "required": true, "type": "string" }, { "name": "wrapperId", "in": "path", "description": "wrapperId", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/BulkLaunchReport" } }, "201": { "description": "Created" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/wrappers/{wrapperId}/root/{rootElement}/launch": { "post": { "tags": [ "launch-rest-api" ], "summary": "Resolve a command from the variable values in the query params, and launch it", "description": "DOES NOT WORK PROPERLY IN SWAGGER UI", "operationId": "launchCommandWQueryParamsUsingPOST_2", "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "*/*" ], "parameters": [ { "name": "allRequestParams", "in": "query", "description": "allRequestParams", "required": true, "items": { "type": "object", "additionalProperties": { "type": "string" } } }, { "name": "rootElement", "in": "path", "description": "rootElement", "required": true, "type": "string" }, { "name": "wrapperId", "in": "path", "description": "wrapperId", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/LaunchReport" } }, "201": { "description": "Created" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } } }, "definitions": { "Action": { "type": "object", "properties": { "action-key": { "type": "string" }, "attributes": { "type": "object", "additionalProperties": { "$ref": "#/definitions/ActionAttributeConfiguration" } }, "description": { "type": "string" }, "display-name": { "type": "string" } }, "title": "Action" }, "ActionAttributeConfiguration": { "type": "object", "properties": { "default-value": { "type": "string" }, "description": { "type": "string" }, "required": { "type": "boolean" }, "restrict-to-list": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/definitions/AttributeContextValue" } } }, "type": { "type": "string" }, "user-settable": { "type": "boolean" } }, "title": "ActionAttributeConfiguration" }, "Administration": { "type": "object", "properties": { "duration": { "type": "string" }, "endTime": { "type": "string" }, "flowRate": { "type": "string" }, "startTime": { "type": "string" }, "totalDose": { "type": "string" }, "volume": { "type": "string" } }, "title": "Administration" }, "AppenderHierarchy": { "type": "object", "properties": { "loggers": { "type": "object", "additionalProperties": { "type": "string" } }, "name": { "type": "string" }, "path": { "type": "string" } }, "title": "AppenderHierarchy" }, "ArchiveProcessorInstance": { "type": "object", "properties": { "created": { "type": "string", "format": "date-time" }, "disabled": { "type": "string", "format": "date-time" }, "enabled": { "type": "boolean" }, "id": { "type": "integer", "format": "int64" }, "label": { "type": "string" }, "location": { "type": "string" }, "parameters": { "type": "object", "additionalProperties": { "type": "string" } }, "priority": { "type": "integer", "format": "int32" }, "processorClass": { "type": "string" }, "projectIdsList": { "type": "array", "items": { "type": "string" } }, "scope": { "type": "string" }, "scpBlacklist": { "type": "array", "items": { "type": "string" } }, "scpWhitelist": { "type": "array", "items": { "type": "string" } }, "timestamp": { "type": "string", "format": "date-time" } }, "title": "ArchiveProcessorInstance" }, "ArchiveProcessorInstanceSummary": { "type": "object", "properties": { "label": { "type": "string" }, "location": { "type": "string" }, "priority": { "type": "integer", "format": "int32" }, "processorClass": { "type": "string" } }, "title": "ArchiveProcessorInstanceSummary" }, "AttributeContextValue": { "type": "object", "properties": { "label": { "type": "string" }, "type": { "type": "string" }, "value": { "type": "string" } }, "title": "AttributeContextValue" }, "BulkLaunchReport": { "type": "object", "properties": { "bulk-launch-id": { "type": "string" }, "failures": { "type": "array", "items": { "$ref": "#/definitions/Failure" } }, "pipeline-name": { "type": "string" }, "successes": { "type": "array", "items": { "$ref": "#/definitions/Success" } } }, "title": "BulkLaunchReport" }, "CacheEntryEventFilter«object,object»": { "type": "object", "title": "CacheEntryEventFilter«object,object»" }, "CacheEntryListenerConfiguration«object,object»": { "type": "object", "properties": { "cacheEntryEventFilterFactory": { "$ref": "#/definitions/Factory«CacheEntryEventFilter«object,object»»" }, "cacheEntryListenerFactory": { "$ref": "#/definitions/Factory«CacheEntryListener«object,object»»" }, "oldValueRequired": { "type": "boolean" }, "synchronous": { "type": "boolean" } }, "title": "CacheEntryListenerConfiguration«object,object»" }, "CacheEntryListener«object,object»": { "type": "object", "title": "CacheEntryListener«object,object»" }, "CacheLoader«object,object»": { "type": "object", "title": "CacheLoader«object,object»" }, "CacheWriter«object,object»": { "type": "object", "title": "CacheWriter«object,object»" }, "CatCatalogBean": { "type": "object", "properties": { "allFields": { "type": "array", "items": { "type": "object" } }, "catCatalogId": { "type": "integer", "format": "int32" }, "description": { "type": "string" }, "entries_entry": { "type": "array", "items": { "$ref": "#/definitions/CatEntryI" } }, "fullSchemaElementName": { "type": "string" }, "headerString": { "type": "string" }, "id": { "type": "string" }, "metafields_metafield": { "type": "array", "items": { "$ref": "#/definitions/CatCatalogMetafieldI" } }, "name": { "type": "string" }, "schemaElementName": { "type": "string" }, "sets_entryset": { "type": "array", "items": { "$ref": "#/definitions/CatCatalogI" } }, "tags_tag": { "type": "array", "items": { "$ref": "#/definitions/CatCatalogTagI" } }, "xsitype": { "type": "string" } }, "title": "CatCatalogBean" }, "CatCatalogI": { "type": "object", "properties": { "catCatalogId": { "type": "integer", "format": "int32" }, "description": { "type": "string" }, "entries_entry": { "type": "array", "items": { "$ref": "#/definitions/CatEntryI" } }, "id": { "type": "string" }, "metafields_metafield": { "type": "array", "items": { "$ref": "#/definitions/CatCatalogMetafieldI" } }, "name": { "type": "string" }, "sets_entryset": { "type": "array", "items": { "$ref": "#/definitions/CatCatalogI" } }, "tags_tag": { "type": "array", "items": { "$ref": "#/definitions/CatCatalogTagI" } }, "xsitype": { "type": "string" } }, "title": "CatCatalogI" }, "CatCatalogMetafieldI": { "type": "object", "properties": { "catCatalogMetafieldId": { "type": "integer", "format": "int32" }, "metafield": { "type": "string" }, "name": { "type": "string" }, "xsitype": { "type": "string" } }, "title": "CatCatalogMetafieldI" }, "CatCatalogTagI": { "type": "object", "properties": { "catCatalogTagId": { "type": "integer", "format": "int32" }, "tag": { "type": "string" }, "xsitype": { "type": "string" } }, "title": "CatCatalogTagI" }, "CatEntryI": { "type": "object", "properties": { "cachepath": { "type": "string" }, "catEntryId": { "type": "integer", "format": "int32" }, "content": { "type": "string" }, "createdby": { "type": "string" }, "createdeventid": { "type": "integer", "format": "int32" }, "createdtime": { "type": "object" }, "description": { "type": "string" }, "digest": { "type": "string" }, "format": { "type": "string" }, "id": { "type": "string" }, "metafields_metafield": { "type": "array", "items": { "$ref": "#/definitions/CatEntryMetafieldI" } }, "modifiedby": { "type": "string" }, "modifiedeventid": { "type": "integer", "format": "int32" }, "modifiedtime": { "type": "object" }, "name": { "type": "string" }, "tags_tag": { "type": "array", "items": { "$ref": "#/definitions/CatEntryTagI" } }, "uri": { "type": "string" }, "xsitype": { "type": "string" } }, "title": "CatEntryI" }, "CatEntryMetafieldI": { "type": "object", "properties": { "catEntryMetafieldId": { "type": "integer", "format": "int32" }, "metafield": { "type": "string" }, "name": { "type": "string" }, "xsitype": { "type": "string" } }, "title": "CatEntryMetafieldI" }, "CatEntryTagI": { "type": "object", "properties": { "catEntryTagId": { "type": "integer", "format": "int32" }, "tag": { "type": "string" }, "xsitype": { "type": "string" } }, "title": "CatEntryTagI" }, "CollatedLegacyCustomVariable": { "type": "object", "properties": { "dataType": { "type": "string" }, "description": { "type": "string" }, "fieldDefinitionGroupId": { "type": "integer", "format": "int32" }, "id": { "type": "string" }, "projectIds": { "type": "array", "items": { "type": "string" } }, "project_specific": { "type": "integer", "format": "int32" }, "shareable": { "type": "integer", "format": "int32" } }, "title": "CollatedLegacyCustomVariable" }, "Command": { "type": "object", "properties": { "auto-remove": { "type": "boolean" }, "command-line": { "type": "string" }, "command-metadata": { "$ref": "#/definitions/JsonNode" }, "container-labels": { "type": "object", "additionalProperties": { "type": "string" } }, "container-name": { "type": "string" }, "description": { "type": "string" }, "environment-variables": { "type": "object", "additionalProperties": { "type": "string" } }, "generic-resources": { "type": "object", "additionalProperties": { "type": "string" } }, "gpus": { "type": "string" }, "hash": { "type": "string" }, "id": { "type": "integer", "format": "int64" }, "image": { "type": "string" }, "index": { "type": "string" }, "info-url": { "type": "string" }, "inputs": { "type": "array", "items": { "$ref": "#/definitions/CommandInput" } }, "ipc-mode": { "type": "string" }, "label": { "type": "string" }, "limit-cpu": { "type": "number", "format": "double" }, "limit-memory": { "type": "integer", "format": "int64" }, "mounts": { "type": "array", "items": { "$ref": "#/definitions/CommandMount" } }, "name": { "type": "string" }, "network": { "type": "string" }, "outputs": { "type": "array", "items": { "$ref": "#/definitions/CommandOutput" } }, "override-entrypoint": { "type": "boolean" }, "ports": { "type": "object", "additionalProperties": { "type": "string" } }, "reserve-memory": { "type": "integer", "format": "int64" }, "runtime": { "type": "string" }, "schema-version": { "type": "string" }, "secrets": { "type": "array", "items": { "$ref": "#/definitions/Secret" } }, "shm-size": { "type": "integer", "format": "int64" }, "type": { "type": "string" }, "ulimits": { "type": "object", "additionalProperties": { "type": "string" } }, "version": { "type": "string" }, "visibility": { "type": "string" }, "working-directory": { "type": "string" }, "xnat": { "type": "array", "items": { "$ref": "#/definitions/CommandWrapper" } } }, "title": "Command" }, "CommandConfiguration": { "type": "object", "properties": { "inputs": { "type": "object", "additionalProperties": { "$ref": "#/definitions/CommandInputConfiguration" } }, "outputs": { "type": "object", "additionalProperties": { "$ref": "#/definitions/CommandOutputConfiguration" } } }, "title": "CommandConfiguration" }, "CommandCreation": { "type": "object", "title": "CommandCreation" }, "CommandEventMapping": { "type": "object", "properties": { "command-id": { "type": "integer", "format": "int64" }, "created": { "type": "string", "format": "date-time" }, "disabled": { "type": "string", "format": "date-time" }, "enabled": { "type": "boolean" }, "event-type": { "type": "string" }, "id": { "type": "integer", "format": "int64" }, "project": { "type": "string" }, "subscription-user-name": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" }, "xnat-command-wrapper": { "type": "string" } }, "title": "CommandEventMapping" }, "CommandInput": { "type": "object", "properties": { "command-line-flag": { "type": "string" }, "command-line-separator": { "type": "string" }, "default-value": { "type": "string" }, "description": { "type": "string" }, "false-value": { "type": "string" }, "label": { "type": "string" }, "matcher": { "type": "string" }, "multiple-delimiter": { "type": "string" }, "name": { "type": "string" }, "replacement-key": { "type": "string" }, "required": { "type": "boolean" }, "select-values": { "type": "array", "items": { "type": "string" } }, "sensitive": { "type": "boolean" }, "true-value": { "type": "string" }, "type": { "type": "string" } }, "title": "CommandInput" }, "CommandInputConfiguration": { "type": "object", "properties": { "description": { "type": "string" }, "type": { "type": "string" }, "default-value": { "type": "string" }, "matcher": { "type": "string" }, "user-settable": { "type": "boolean" }, "advanced": { "type": "boolean" }, "required": { "type": "boolean" } }, "title": "CommandInputConfiguration" }, "CommandMount": { "type": "object", "properties": { "name": { "type": "string" }, "path": { "type": "string" }, "writable": { "type": "boolean" } }, "title": "CommandMount" }, "CommandOutput": { "type": "object", "properties": { "description": { "type": "string" }, "glob": { "type": "string" }, "mount": { "type": "string" }, "name": { "type": "string" }, "path": { "type": "string" }, "required": { "type": "boolean" } }, "title": "CommandOutput" }, "CommandOutputConfiguration": { "type": "object", "properties": { "type": { "type": "string" }, "label": { "type": "string" } }, "title": "CommandOutputConfiguration" }, "CommandSummaryForContext": { "type": "object", "properties": { "command-description": { "type": "string" }, "command-id": { "type": "integer", "format": "int64" }, "command-label": { "type": "string" }, "command-name": { "type": "string" }, "enabled": { "type": "boolean" }, "image-name": { "type": "string" }, "image-type": { "type": "string" }, "root-element-name": { "type": "string" }, "wrapper-contexts": { "type": "array", "items": { "type": "string" } }, "wrapper-description": { "type": "string" }, "wrapper-id": { "type": "integer", "format": "int64" }, "wrapper-label": { "type": "string" }, "wrapper-name": { "type": "string" } }, "title": "CommandSummaryForContext" }, "CommandWrapper": { "type": "object", "properties": { "contexts": { "type": "array", "items": { "type": "string" } }, "derived-inputs": { "type": "array", "items": { "$ref": "#/definitions/CommandWrapperDerivedInput" } }, "description": { "type": "string" }, "external-inputs": { "type": "array", "items": { "$ref": "#/definitions/CommandWrapperExternalInput" } }, "id": { "type": "integer", "format": "int64" }, "label": { "type": "string" }, "name": { "type": "string" }, "output-handlers": { "type": "array", "items": { "$ref": "#/definitions/CommandWrapperOutput" } } }, "title": "CommandWrapper" }, "CommandWrapperCreation": { "type": "object", "properties": { "name": { "type": "string" }, "label": { "type": "string" }, "description": { "type": "string" }, "contexts": { "type": "array", "items": { "type": "string" } }, "external-inputs": { "type": "array", "items": { "$ref": "#/definitions/CommandWrapperExternalInput" } }, "derived-inputs": { "type": "array", "items": { "$ref": "#/definitions/CommandWrapperDerivedInput" } }, "output-handlers": { "type": "array", "items": { "$ref": "#/definitions/CommandWrapperOutputCreation" } } }, "title": "CommandWrapperCreation" }, "CommandWrapperDerivedInput": { "type": "object", "properties": { "default-value": { "type": "string" }, "derived-from-wrapper-input": { "type": "string" }, "derived-from-xnat-object-property": { "type": "string" }, "description": { "type": "string" }, "label": { "type": "string" }, "load-children": { "type": "boolean" }, "matcher": { "type": "string" }, "multiple": { "type": "boolean" }, "name": { "type": "string" }, "parser": { "type": "string" }, "provides-files-for-command-mount": { "type": "string" }, "provides-value-for-command-input": { "type": "string" }, "replacement-key": { "type": "string" }, "required": { "type": "boolean" }, "sensitive": { "type": "boolean" }, "type": { "type": "string" }, "user-settable": { "type": "boolean" }, "via-setup-command": { "type": "string" } }, "title": "CommandWrapperDerivedInput" }, "CommandWrapperExternalInput": { "type": "object", "properties": { "default-value": { "type": "string" }, "description": { "type": "string" }, "label": { "type": "string" }, "load-children": { "type": "boolean" }, "matcher": { "type": "string" }, "name": { "type": "string" }, "provides-files-for-command-mount": { "type": "string" }, "provides-value-for-command-input": { "type": "string" }, "replacement-key": { "type": "string" }, "required": { "type": "boolean" }, "sensitive": { "type": "boolean" }, "type": { "type": "string" }, "user-settable": { "type": "boolean" }, "via-setup-command": { "type": "string" } }, "title": "CommandWrapperExternalInput" }, "CommandWrapperOutput": { "type": "object", "properties": { "accepts-command-output": { "type": "string" }, "as-a-child-of": { "type": "string" }, "content": { "type": "string" }, "description": { "type": "string" }, "format": { "type": "string" }, "label": { "type": "string" }, "name": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "type": { "type": "string" }, "via-wrapup-command": { "type": "string" }, "xsi-type": { "type": "string" } }, "title": "CommandWrapperOutput" }, "CommandWrapperOutputCreation": { "type": "object", "properties": { "name": { "type": "string" }, "accepts-command-output": { "type": "string" }, "as-a-child-of": { "type": "string" }, "as-a-child-of-wrapper-input": { "type": "string" }, "via-wrapup-command": { "type": "string" }, "type": { "type": "string" }, "xsi-type": { "type": "string" }, "label": { "type": "string" }, "format": { "type": "string" }, "description": { "type": "string" }, "content": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } } }, "title": "CommandWrapperOutputCreation" }, "CompleteConfiguration": { "type": "object", "properties": { "cacheEntryListenerConfigurations": { "$ref": "#/definitions/Iterable«CacheEntryListenerConfiguration«object,object»»" }, "cacheLoaderFactory": { "$ref": "#/definitions/Factory«CacheLoader«object,object»»" }, "cacheWriterFactory": { "$ref": "#/definitions/Factory«CacheWriter«object,object»»" }, "expiryPolicyFactory": { "$ref": "#/definitions/Factory«ExpiryPolicy»" }, "managementEnabled": { "type": "boolean" }, "readThrough": { "type": "boolean" }, "statisticsEnabled": { "type": "boolean" }, "storeByValue": { "type": "boolean" }, "writeThrough": { "type": "boolean" } }, "title": "CompleteConfiguration" }, "CompleteConfiguration«object,object»": { "type": "object", "properties": { "cacheEntryListenerConfigurations": { "$ref": "#/definitions/Iterable«CacheEntryListenerConfiguration«object,object»»" }, "cacheLoaderFactory": { "$ref": "#/definitions/Factory«CacheLoader«object,object»»" }, "cacheWriterFactory": { "$ref": "#/definitions/Factory«CacheWriter«object,object»»" }, "expiryPolicyFactory": { "$ref": "#/definitions/Factory«ExpiryPolicy»" }, "managementEnabled": { "type": "boolean" }, "readThrough": { "type": "boolean" }, "statisticsEnabled": { "type": "boolean" }, "storeByValue": { "type": "boolean" }, "writeThrough": { "type": "boolean" } }, "title": "CompleteConfiguration«object,object»" }, "ComputeEnvironment": { "type": "object", "properties": { "name": { "type": "string" }, "image": { "type": "string" }, "command": { "type": "string" }, "environmentVariables": { "type": "array", "items": { "$ref": "#/definitions/EnvironmentVariable" } }, "mounts": { "type": "array", "items": { "$ref": "#/definitions/Mount" } } }, "title": "ComputeEnvironment" }, "ComputeEnvironmentConfig": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "configTypes": { "type": "array", "items": { "type": "string", "enum": [ "JUPYTERHUB", "CONTAINER_SERVICE", "GENERAL" ] } }, "computeEnvironment": { "$ref": "#/definitions/ComputeEnvironment" }, "scopes": { "type": "object", "additionalProperties": { "$ref": "#/definitions/ComputeEnvironmentScope" } }, "hardwareOptions": { "$ref": "#/definitions/ComputeEnvironmentHardwareOptions" } }, "title": "ComputeEnvironmentConfig" }, "ComputeEnvironmentHardwareOptions": { "type": "object", "properties": { "allowAllHardware": { "type": "boolean" }, "hardwareConfigs": { "type": "array", "items": { "$ref": "#/definitions/HardwareConfig" } } }, "title": "ComputeEnvironmentHardwareOptions" }, "ComputeEnvironmentScope": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "ids": { "type": "array", "items": { "type": "string" } }, "scope": { "type": "string", "enum": [ "Site", "Project", "Subject", "Experiment", "User", "DataType" ] } }, "title": "ComputeEnvironmentScope" }, "Constraint": { "type": "object", "properties": { "key": { "type": "string" }, "operator": { "type": "string", "enum": [ "IN", "NOT_IN" ] }, "values": { "type": "array", "items": { "type": "string" } } }, "title": "Constraint" }, "ConstraintConfig": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "constraint": { "$ref": "#/definitions/Constraint" }, "scopes": { "type": "object", "additionalProperties": { "$ref": "#/definitions/ConstraintScope" } } }, "title": "ConstraintConfig" }, "ConstraintScope": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "ids": { "type": "array", "items": { "type": "string" } }, "scope": { "type": "string", "enum": [ "Site", "Project", "Subject", "Experiment", "User", "DataType" ] } }, "title": "ConstraintScope" }, "Container": { "type": "object", "properties": { "auto-remove": { "type": "boolean" }, "backend": { "type": "string", "enum": [ "docker", "swarm", "kubernetes" ] }, "command-id": { "type": "integer", "format": "int64" }, "command-line": { "type": "string" }, "container-id": { "type": "string" }, "container-labels": { "type": "object", "additionalProperties": { "type": "string" } }, "container-name": { "type": "string" }, "docker-image": { "type": "string" }, "env": { "type": "object", "additionalProperties": { "type": "string" } }, "generic-resources": { "type": "object", "additionalProperties": { "type": "string" } }, "gpus": { "type": "string" }, "history": { "type": "array", "items": { "$ref": "#/definitions/ContainerHistory" } }, "id": { "type": "integer", "format": "int64" }, "inputs": { "type": "array", "items": { "$ref": "#/definitions/ContainerInput" } }, "ipc-mode": { "type": "string" }, "limit-cpu": { "type": "number", "format": "double" }, "limit-memory": { "type": "integer", "format": "int64" }, "log-paths": { "type": "array", "items": { "type": "string" } }, "mounts": { "type": "array", "items": { "$ref": "#/definitions/ContainerMount" } }, "network": { "type": "string" }, "node-id": { "type": "string" }, "outputs": { "type": "array", "items": { "$ref": "#/definitions/ContainerOutput" } }, "override-entrypoint": { "type": "boolean" }, "parent-source-object-name": { "type": "string" }, "ports": { "type": "object", "additionalProperties": { "type": "string" } }, "project": { "type": "string" }, "reserve-memory": { "type": "integer", "format": "int64" }, "runtime": { "type": "string" }, "secrets": { "type": "array", "items": { "$ref": "#/definitions/ResolvedSecret" } }, "service-id": { "type": "string" }, "shm-size": { "type": "integer", "format": "int64" }, "status": { "type": "string" }, "status-time": { "type": "string", "format": "date-time" }, "subtype": { "type": "string" }, "swarm": { "type": "boolean" }, "swarm-constraints": { "type": "array", "items": { "type": "string" } }, "task-id": { "type": "string" }, "ulimits": { "type": "object", "additionalProperties": { "type": "string" } }, "user-id": { "type": "string" }, "workflow-id": { "type": "string" }, "working-directory": { "type": "string" }, "wrapper-id": { "type": "integer", "format": "int64" } }, "title": "Container" }, "ContainerHistory": { "type": "object", "properties": { "entity-id": { "type": "string" }, "entity-type": { "type": "string" }, "exitCode": { "type": "string" }, "external-timestamp": { "type": "string" }, "id": { "type": "integer", "format": "int64" }, "message": { "type": "string" }, "status": { "type": "string" }, "time-recorded": { "type": "string", "format": "date-time" } }, "title": "ContainerHistory" }, "ContainerInput": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "sensitive": { "type": "boolean" }, "type": { "type": "string", "enum": [ "raw", "wrapper", "command", "wrapper-external", "wrapper-derived" ] }, "value": { "type": "string" } }, "title": "ContainerInput" }, "ContainerLogPollResponse": { "type": "object", "properties": { "bytesRead": { "type": "integer", "format": "int64" }, "content": { "type": "string" }, "fromFile": { "type": "boolean" }, "timestamp": { "type": "string" } }, "title": "ContainerLogPollResponse" }, "ContainerMount": { "type": "object", "properties": { "container-host-path": { "type": "string" }, "container-path": { "type": "string" }, "id": { "type": "integer", "format": "int64" }, "input-files": { "type": "array", "items": { "$ref": "#/definitions/ContainerMountFiles" } }, "mount-pvc-name": { "type": "string" }, "name": { "type": "string" }, "writable": { "type": "boolean" }, "xnat-host-path": { "type": "string" } }, "title": "ContainerMount" }, "ContainerMountFiles": { "type": "object", "properties": { "from-uri": { "type": "string" }, "from-xnat-input": { "type": "string" }, "id": { "type": "integer", "format": "int64" }, "path": { "type": "string" }, "root-directory": { "type": "string" } }, "title": "ContainerMountFiles" }, "ContainerOutput": { "type": "object", "properties": { "content": { "type": "string" }, "created": { "type": "string" }, "description": { "type": "string" }, "format": { "type": "string" }, "from-command-output": { "type": "string" }, "from-output-handler": { "type": "string" }, "glob": { "type": "string" }, "handled-by": { "type": "string" }, "id": { "type": "integer", "format": "int64" }, "label": { "type": "string" }, "mount": { "type": "string" }, "name": { "type": "string" }, "path": { "type": "string" }, "required": { "type": "boolean" }, "tags": { "type": "array", "items": { "type": "string" } }, "type": { "type": "string" }, "via-wrapup-container": { "type": "string" } }, "title": "ContainerOutput" }, "ContainerPaginatedRequest": { "type": "object", "properties": { "defaultSortColumn": { "type": "string" }, "filters": { "type": "object", "additionalProperties": { "$ref": "#/definitions/Filter" } }, "id": { "type": "string" }, "offset": { "type": "integer", "format": "int32" }, "order": { "$ref": "#/definitions/Pair«string,string»" }, "page": { "type": "integer", "format": "int32" }, "size": { "type": "integer", "format": "int32" }, "sortBys": { "type": "array", "items": { "$ref": "#/definitions/Pair«string,string»" } }, "sort_col": { "type": "string" }, "sort_dir": { "type": "string", "enum": [ "desc", "asc" ] } }, "title": "ContainerPaginatedRequest" }, "ContrastBolus": { "type": "object", "properties": { "administrations": { "type": "array", "items": { "$ref": "#/definitions/Administration" } }, "agent": { "type": "string" }, "agentNumber": { "type": "string" }, "concentration": { "type": "string" }, "ingredientOpaque": { "type": "string" }, "ingredients": { "type": "array", "items": { "$ref": "#/definitions/Ingredient" } }, "percentageByVolume": { "type": "string" }, "pk": { "type": "integer", "format": "int32" }, "route": { "type": "string" }, "scanId": { "type": "integer", "format": "int32" }, "t1Relaxivity": { "type": "string" }, "t2Relaxivity": { "type": "string" } }, "title": "ContrastBolus" }, "DicomInboxImportRequest": { "type": "object", "properties": { "cleanupAfterImport": { "type": "boolean" }, "created": { "type": "string", "format": "date-time" }, "disabled": { "type": "string", "format": "date-time" }, "enabled": { "type": "boolean" }, "id": { "type": "integer", "format": "int64" }, "objectParametersMap": { "type": "object" }, "parameters": { "type": "object", "additionalProperties": { "type": "string" } }, "resolution": { "type": "string" }, "sessionPath": { "type": "string" }, "status": { "type": "string", "enum": [ "Queued", "Trawling", "Importing", "Accepted", "Processed", "Failed", "Completed" ] }, "timestamp": { "type": "string", "format": "date-time" }, "username": { "type": "string" } }, "title": "DicomInboxImportRequest" }, "DicomMapping": { "type": "object", "properties": { "dicomTag": { "type": "string" }, "fieldName": { "type": "string" }, "fieldType": { "type": "string", "enum": [ "string", "integer", "float", "boolean", "date", "time" ] }, "id": { "type": "integer", "format": "int64" }, "schemaElement": { "type": "string" }, "scope": { "type": "string", "enum": [ "Site", "Project", "Subject", "Experiment", "User", "DataType" ] }, "scopeObjectId": { "type": "string" } }, "title": "DicomMapping" }, "DicomSCPInstance": { "type": "object", "properties": { "aeTitle": { "type": "string" }, "anonymizationEnabled": { "type": "boolean" }, "created": { "type": "string", "format": "date-time" }, "customProcessing": { "type": "boolean" }, "directArchive": { "type": "boolean" }, "directArchiveOverwrite": { "type": "boolean" }, "disabled": { "type": "string", "format": "date-time" }, "enabled": { "type": "boolean" }, "fileNamer": { "type": "string" }, "id": { "type": "integer", "format": "int64" }, "identifier": { "type": "string" }, "label": { "type": "string" }, "port": { "type": "integer", "format": "int32" }, "projectRoutingExpression": { "type": "string" }, "routingExpressionsEnabled": { "type": "boolean" }, "sessionRoutingExpression": { "type": "string" }, "subjectRoutingExpression": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" }, "whitelist": { "type": "array", "items": { "type": "string" } }, "whitelistEnabled": { "type": "boolean" } }, "title": "DicomSCPInstance" }, "DicomWebPingRequest": { "type": "object", "properties": { "aeTitle": { "type": "string" }, "rootUrl": { "type": "string" } }, "title": "DicomWebPingRequest" }, "DicomWebPingResult": { "type": "object", "properties": { "httpStatus": { "type": "integer", "format": "int32" }, "reason": { "type": "string" }, "successful": { "type": "boolean" } }, "title": "DicomWebPingResult" }, "DirectArchiveSessionPaginatedRequest": { "type": "object", "properties": { "defaultSortColumn": { "type": "string" }, "filters": { "type": "object", "additionalProperties": { "$ref": "#/definitions/Filter" } }, "id": { "type": "string" }, "offset": { "type": "integer", "format": "int32" }, "order": { "$ref": "#/definitions/Pair«string,string»" }, "page": { "type": "integer", "format": "int32" }, "size": { "type": "integer", "format": "int32" }, "sortBys": { "type": "array", "items": { "$ref": "#/definitions/Pair«string,string»" } }, "sort_col": { "type": "string" }, "sort_dir": { "type": "string", "enum": [ "desc", "asc" ] } }, "title": "DirectArchiveSessionPaginatedRequest" }, "DisplayFieldDB": { "type": "object", "properties": { "content": { "type": "object", "additionalProperties": { "type": "string" } }, "created": { "type": "string", "format": "date-time" }, "dataType": { "type": "string" }, "description": { "type": "string" }, "disabled": { "type": "string", "format": "date-time" }, "elements": { "type": "array", "items": { "$ref": "#/definitions/DisplayFieldElementDB" } }, "enabled": { "type": "boolean" }, "fieldId": { "type": "string" }, "header": { "type": "string" }, "htmlCellAlign": { "type": "string" }, "htmlCellHeight": { "type": "integer", "format": "int32" }, "htmlCellServerLink": { "type": "string" }, "htmlCellValign": { "type": "string" }, "htmlCellWidth": { "type": "integer", "format": "int32" }, "htmlContent": { "type": "boolean" }, "htmlImage": { "type": "boolean" }, "htmlImageHeight": { "type": "integer", "format": "int32" }, "htmlImageWidth": { "type": "integer", "format": "int32" }, "htmlLinkProperties": { "type": "array", "items": { "$ref": "#/definitions/DisplayFieldHtmlLinkPropertyDB" } }, "htmlLinkSecureLinkTo": { "type": "string" }, "htmlLinkSecureProps": { "type": "object", "additionalProperties": { "type": "string" } }, "id": { "type": "integer", "format": "int64" }, "image": { "type": "boolean" }, "mappingColumns": { "type": "array", "items": { "$ref": "#/definitions/SubQueryMappingColumnDB" } }, "possibleValues": { "type": "array", "items": { "type": "string" } }, "searchable": { "type": "boolean" }, "sortBy": { "type": "string" }, "sortIndex": { "type": "integer", "format": "int32" }, "sortOrder": { "type": "string" }, "subQuery": { "type": "string" }, "subQueryValue": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" }, "visible": { "type": "boolean" } }, "title": "DisplayFieldDB" }, "DisplayFieldElementDB": { "type": "object", "properties": { "created": { "type": "string", "format": "date-time" }, "disabled": { "type": "string", "format": "date-time" }, "enabled": { "type": "boolean" }, "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "schemaElementName": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" }, "viewColumn": { "type": "string" }, "viewName": { "type": "string" }, "xdatType": { "type": "string" } }, "title": "DisplayFieldElementDB" }, "DisplayFieldHtmlLinkPropertyDB": { "type": "object", "properties": { "created": { "type": "string", "format": "date-time" }, "disabled": { "type": "string", "format": "date-time" }, "enabled": { "type": "boolean" }, "id": { "type": "integer", "format": "int64" }, "insertedValues": { "type": "object", "additionalProperties": { "type": "string" } }, "name": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" }, "value": { "type": "string" } }, "title": "DisplayFieldHtmlLinkPropertyDB" }, "DisplayFieldRefDB": { "type": "object", "properties": { "elementName": { "type": "string" }, "fieldId": { "type": "string" }, "header": { "type": "string" }, "id": { "type": "integer", "format": "int64" }, "sortOrder": { "type": "integer", "format": "int32" }, "type": { "type": "string" }, "value": { "type": "string" }, "visible": { "type": "boolean" } }, "title": "DisplayFieldRefDB" }, "DisplayVersionDB": { "type": "object", "properties": { "allowDiffs": { "type": "boolean" }, "briefDescription": { "type": "string" }, "created": { "type": "string", "format": "date-time" }, "darkColor": { "type": "string" }, "defaultOrderBy": { "type": "string" }, "defaultSortOrder": { "type": "string" }, "disabled": { "type": "string", "format": "date-time" }, "enabled": { "type": "boolean" }, "fields": { "type": "array", "items": { "$ref": "#/definitions/DisplayFieldRefDB" } }, "htmlCellAlign": { "type": "string" }, "htmlCellHeight": { "type": "integer", "format": "int32" }, "htmlCellServerLink": { "type": "string" }, "htmlCellValign": { "type": "string" }, "htmlCellWidth": { "type": "integer", "format": "int32" }, "id": { "type": "integer", "format": "int64" }, "lightColor": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" }, "versionName": { "type": "string" } }, "title": "DisplayVersionDB" }, "DockerHub": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "url": { "type": "string" }, "default": { "type": "boolean" }, "username": { "type": "string" }, "password": { "type": "string" }, "email": { "type": "string" }, "token": { "type": "string" } }, "title": "DockerHub" }, "DockerHubStatus": { "type": "object", "properties": { "message": { "type": "string" }, "ping": { "type": "boolean" }, "response": { "type": "string" } }, "title": "DockerHubStatus" }, "DockerHubWithPing": { "type": "object", "properties": { "default": { "type": "boolean" }, "email": { "type": "string" }, "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "status": { "$ref": "#/definitions/DockerHubStatus" }, "url": { "type": "string" }, "username": { "type": "string" } }, "title": "DockerHubWithPing" }, "DockerImage": { "type": "object", "properties": { "image-id": { "type": "string" }, "labels": { "type": "object", "additionalProperties": { "type": "string" } }, "tags": { "type": "array", "items": { "type": "string" } } }, "title": "DockerImage", "description": "Properties that define an image." }, "DockerImageAndCommandSummary": { "type": "object", "properties": { "commands": { "type": "array", "items": { "$ref": "#/definitions/Command" } }, "image-id": { "type": "string" }, "names": { "type": "array", "items": { "type": "string" } }, "server": { "type": "string" } }, "title": "DockerImageAndCommandSummary" }, "DockerServer": { "type": "object", "properties": { "archive-path-translation": { "type": "string" }, "archive-pvc-name": { "type": "string" }, "auto-cleanup": { "type": "boolean" }, "backend": { "type": "string", "enum": [ "docker", "swarm", "kubernetes" ] }, "build-path-translation": { "type": "string" }, "build-pvc-name": { "type": "string" }, "cert-path": { "type": "string" }, "combined-path-translation": { "type": "string" }, "combined-pvc-name": { "type": "string" }, "container-user": { "type": "string" }, "gpu-vendor": { "type": "string" }, "host": { "type": "string" }, "id": { "type": "integer", "format": "int64" }, "kubernetes-tolerations": { "type": "array", "items": { "$ref": "#/definitions/KubernetesToleration" } }, "max-concurrent-finalizing-jobs": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "path-translation-docker-prefix": { "type": "string" }, "path-translation-xnat-prefix": { "type": "string" }, "pull-images-on-xnat-init": { "type": "boolean" }, "status-email-enabled": { "type": "boolean" }, "swarm-constraints": { "type": "array", "items": { "$ref": "#/definitions/DockerServerSwarmConstraint" } }, "swarm-mode": { "type": "boolean" } }, "title": "DockerServer" }, "DockerServerSwarmConstraint": { "type": "object", "properties": { "attribute": { "type": "string" }, "comparator": { "type": "string" }, "id": { "type": "integer", "format": "int64" }, "user-settable": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "title": "DockerServerSwarmConstraint" }, "DockerServerWithPing": { "type": "object", "properties": { "archive-path-translation": { "type": "string" }, "archive-pvc-name": { "type": "string" }, "auto-cleanup": { "type": "boolean" }, "backend": { "type": "string", "enum": [ "docker", "swarm", "kubernetes" ] }, "build-path-translation": { "type": "string" }, "build-pvc-name": { "type": "string" }, "cert-path": { "type": "string" }, "combined-path-translation": { "type": "string" }, "combined-pvc-name": { "type": "string" }, "container-user": { "type": "string" }, "gpu-vendor": { "type": "string" }, "host": { "type": "string" }, "id": { "type": "integer", "format": "int64" }, "kubernetes-tolerations": { "type": "array", "items": { "$ref": "#/definitions/KubernetesToleration" } }, "max-concurrent-finalizing-jobs": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "path-translation-docker-prefix": { "type": "string" }, "path-translation-xnat-prefix": { "type": "string" }, "ping": { "type": "boolean" }, "pull-images-on-xnat-init": { "type": "boolean" }, "status-email-enabled": { "type": "boolean" }, "swarm-constraints": { "type": "array", "items": { "$ref": "#/definitions/DockerServerSwarmConstraint" } }, "swarm-mode": { "type": "boolean" } }, "title": "DockerServerWithPing" }, "DqrDateRange": { "type": "object", "properties": { "end": { "type": "string", "format": "date-time" }, "start": { "type": "string", "format": "date-time" } }, "title": "DqrDateRange" }, "DqrPersonName": { "type": "object", "properties": { "blank": { "type": "boolean" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "middleName": { "type": "string" }, "prefix": { "type": "string" }, "suffix": { "type": "string" } }, "title": "DqrPersonName" }, "DqrProjectSettings": { "type": "object", "properties": { "created": { "type": "string", "format": "date-time" }, "disabled": { "type": "string", "format": "date-time" }, "dqrEnabled": { "type": "boolean" }, "enabled": { "type": "boolean" }, "id": { "type": "integer", "format": "int64" }, "projectId": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" } }, "title": "DqrProjectSettings" }, "DqrProjectSettingsDTO": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "projectId": { "type": "string" } }, "title": "DqrProjectSettingsDTO" }, "Duration": { "type": "object", "properties": { "durationAmount": { "type": "integer", "format": "int64" }, "eternal": { "type": "boolean" }, "timeUnit": { "type": "string", "enum": [ "NANOSECONDS", "MICROSECONDS", "MILLISECONDS", "SECONDS", "MINUTES", "HOURS", "DAYS" ] }, "zero": { "type": "boolean" } }, "title": "Duration" }, "ElementDisplayArc": { "type": "object", "properties": { "commonFields": { "type": "object", "additionalProperties": { "type": "string" } }, "created": { "type": "string", "format": "date-time" }, "disabled": { "type": "string", "format": "date-time" }, "enabled": { "type": "boolean" }, "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" } }, "title": "ElementDisplayArc" }, "ElementDisplayDB": { "type": "object", "properties": { "arcs": { "type": "array", "items": { "$ref": "#/definitions/ElementDisplayArc" } }, "briefDescription": { "type": "string" }, "created": { "type": "string", "format": "date-time" }, "darkColor": { "type": "string" }, "disabled": { "type": "string", "format": "date-time" }, "displayField": { "type": "string" }, "displayFields": { "type": "array", "items": { "$ref": "#/definitions/DisplayFieldDB" } }, "displayLabel": { "type": "string" }, "displayVersions": { "type": "array", "items": { "$ref": "#/definitions/DisplayVersionDB" } }, "elementName": { "type": "string" }, "enabled": { "type": "boolean" }, "fullDescription": { "type": "string" }, "id": { "type": "integer", "format": "int64" }, "lightColor": { "type": "string" }, "sortOrder": { "type": "integer", "format": "int32" }, "timestamp": { "type": "string", "format": "date-time" }, "valueField": { "type": "string" }, "viewLinks": { "type": "array", "items": { "$ref": "#/definitions/ElementDisplayViewLinkDB" } } }, "title": "ElementDisplayDB" }, "ElementDisplayModel": { "type": "object", "properties": { "actions": { "type": "object", "additionalProperties": { "type": "string" } }, "elementName": { "type": "string" }, "experiment": { "type": "boolean" }, "imageAssessor": { "type": "boolean" }, "imageScan": { "type": "boolean" }, "imageSession": { "type": "boolean" }, "plural": { "type": "string" }, "properName": { "type": "string" }, "singular": { "type": "string" }, "subjectAssessor": { "type": "boolean" }, "supportsBrief": { "type": "boolean" }, "supportsDetailed": { "type": "boolean" }, "xsDescription": { "type": "string" } }, "title": "ElementDisplayModel", "description": "Contains the properties that define an element display model on the system." }, "ElementDisplayViewLinkDB": { "type": "object", "properties": { "alias": { "type": "string" }, "columns": { "type": "array", "items": { "$ref": "#/definitions/ElementDisplayViewLinkMappingColumnDB" } }, "created": { "type": "string", "format": "date-time" }, "disabled": { "type": "string", "format": "date-time" }, "enabled": { "type": "boolean" }, "id": { "type": "integer", "format": "int64" }, "timestamp": { "type": "string", "format": "date-time" }, "view": { "type": "string" } }, "title": "ElementDisplayViewLinkDB" }, "ElementDisplayViewLinkMappingColumnDB": { "type": "object", "properties": { "fieldElementXMLPath": { "type": "string" }, "id": { "type": "integer", "format": "int64" }, "mapsTo": { "type": "string" }, "rootElement": { "type": "string" } }, "title": "ElementDisplayViewLinkMappingColumnDB" }, "EnvironmentVariable": { "type": "object", "properties": { "key": { "type": "string" }, "value": { "type": "string" } }, "title": "EnvironmentVariable" }, "EnvironmentVariableSecretDestination": { "title": "EnvironmentVariableSecretDestination", "allOf": [ { "$ref": "#/definitions/SecretDestination" }, { "type": "object", "properties": { "identifier": { "type": "string" } }, "title": "EnvironmentVariableSecretDestination" } ] }, "EventClassInfo": { "type": "object", "properties": { "class": { "type": "string", "description": "Event class name (Should implement AutomationEventImplementerI" }, "description": { "type": "string", "description": "Description" }, "displayName": { "type": "string", "description": "Display Name" }, "eventIds": { "type": "array", "description": "List of event IDs.", "items": { "type": "string" } }, "filterableFields": { "type": "object", "description": "Map of Filterable fields.", "additionalProperties": { "$ref": "#/definitions/EventHandlerFilterInfo" } }, "includeEventIdsFromDatabase": { "type": "boolean" } }, "title": "EventClassInfo", "description": "Event class names and filterable fields." }, "EventFilter": { "type": "object", "properties": { "event-type": { "type": "string" }, "filter-nodes": { "type": "object", "additionalProperties": { "$ref": "#/definitions/JsonPathFilterNode" } }, "name": { "type": "string" }, "payload-filter": { "type": "string" }, "project-ids": { "type": "array", "items": { "type": "string" } }, "reactorCriteriaHash": { "type": "integer", "format": "int32" }, "schedule": { "type": "string" }, "schedule-description": { "type": "string" }, "status": { "type": "string" } }, "title": "EventFilter" }, "EventFilterCreator": { "type": "object", "properties": { "name": { "type": "string" }, "event-type": { "type": "string" }, "project-ids": { "type": "array", "items": { "type": "string" } }, "status": { "type": "string" }, "schedule": { "type": "string" }, "schedule-description": { "type": "string" }, "payload-filter": { "type": "string" }, "filter-nodes": { "type": "object", "additionalProperties": { "$ref": "#/definitions/JsonPathFilterNode" } } }, "title": "EventFilterCreator" }, "EventFilterUpdate": { "type": "object", "properties": { "name": { "type": "string" }, "event-type": { "type": "string" }, "project-ids": { "type": "array", "items": { "type": "string" } }, "status": { "type": "string" }, "schedule": { "type": "string" }, "schedule-description": { "type": "string" }, "payload-filter": { "type": "string" }, "filter-nodes": { "type": "object", "additionalProperties": { "$ref": "#/definitions/JsonPathFilterNode" } } }, "title": "EventFilterUpdate" }, "EventFilters": { "type": "object", "properties": { "filterVals": { "type": "array", "items": { "type": "string" } }, "filterVar": { "type": "string" }, "id": { "type": "integer", "format": "int64" } }, "title": "EventFilters" }, "EventHandlerFilterInfo": { "type": "object", "properties": { "defaultValue": { "type": "string", "description": "Default selected value for event filter values" }, "filterRequired": { "type": "boolean", "description": "Filter Required?" }, "filterValues": { "type": "array", "description": "Filter Values", "items": { "type": "string" } }, "includeValuesFromDatabase": { "type": "boolean", "description": "Include Values From Database?" } }, "title": "EventHandlerFilterInfo", "description": "Event class names and filterable fields." }, "EventPropertyNode": { "type": "object", "properties": { "name": { "type": "string" }, "replacement-key": { "type": "string" }, "type": { "type": "string" }, "value": { "type": "string" } }, "title": "EventPropertyNode" }, "EventServicePrefs": { "type": "object", "properties": { "enabled": { "type": "boolean" } }, "title": "EventServicePrefs" }, "EventTrackingDataPojo": { "type": "object", "properties": { "finalMessage": { "type": "string" }, "key": { "type": "string" }, "payload": { "type": "string" }, "succeeded": { "type": "boolean" } }, "title": "EventTrackingDataPojo" }, "ExecutedPacsRequest": { "type": "object", "properties": { "accessionNumber": { "type": "string" }, "created": { "type": "string", "format": "date-time" }, "decodedAeAndPort": { "type": "string" }, "destinationAeTitle": { "type": "string" }, "disabled": { "type": "string", "format": "date-time" }, "enabled": { "type": "boolean" }, "errorMessage": { "type": "string" }, "executedTime": { "type": "string", "format": "date-time" }, "id": { "type": "integer", "format": "int64" }, "pacsId": { "type": "integer", "format": "int64" }, "patientId": { "type": "string" }, "patientName": { "type": "string" }, "priority": { "type": "integer", "format": "int64" }, "queuedTime": { "type": "string", "format": "date-time" }, "remappingScript": { "type": "string" }, "requestId": { "type": "string" }, "seriesIds": { "type": "array", "items": { "type": "string" } }, "status": { "type": "string" }, "studyDate": { "type": "string" }, "studyId": { "type": "string" }, "studyInstanceUid": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" }, "username": { "type": "string" }, "xnatProject": { "type": "string" } }, "title": "ExecutedPacsRequest" }, "ExpiryPolicy": { "type": "object", "properties": { "expiryForAccess": { "$ref": "#/definitions/Duration" }, "expiryForCreation": { "$ref": "#/definitions/Duration" }, "expiryForUpdate": { "$ref": "#/definitions/Duration" } }, "title": "ExpiryPolicy" }, "Factory«CacheEntryEventFilter«object,object»»": { "type": "object", "title": "Factory«CacheEntryEventFilter«object,object»»" }, "Factory«CacheEntryListener«object,object»»": { "type": "object", "title": "Factory«CacheEntryListener«object,object»»" }, "Factory«CacheLoader«object,object»»": { "type": "object", "title": "Factory«CacheLoader«object,object»»" }, "Factory«CacheWriter«object,object»»": { "type": "object", "title": "Factory«CacheWriter«object,object»»" }, "Factory«ExpiryPolicy»": { "type": "object", "title": "Factory«ExpiryPolicy»" }, "Failure": { "type": "object", "properties": { "command-id": { "type": "integer", "format": "int64" }, "id": { "type": "integer", "format": "int64" }, "message": { "type": "string" }, "params": { "type": "object", "additionalProperties": { "type": "string" } }, "status": { "type": "string" }, "wrapper-id": { "type": "integer", "format": "int64" } }, "title": "Failure" }, "File": { "type": "object", "properties": { "absolute": { "type": "boolean" }, "absoluteFile": { "$ref": "#/definitions/File" }, "absolutePath": { "type": "string" }, "canonicalFile": { "$ref": "#/definitions/File" }, "canonicalPath": { "type": "string" }, "directory": { "type": "boolean" }, "file": { "type": "boolean" }, "freeSpace": { "type": "integer", "format": "int64" }, "hidden": { "type": "boolean" }, "name": { "type": "string" }, "parent": { "type": "string" }, "parentFile": { "$ref": "#/definitions/File" }, "path": { "type": "string" }, "totalSpace": { "type": "integer", "format": "int64" }, "usableSpace": { "type": "integer", "format": "int64" } }, "title": "File" }, "FileStore": { "type": "object", "properties": { "blockSize": { "type": "integer", "format": "int64" }, "readOnly": { "type": "boolean" }, "totalSpace": { "type": "integer", "format": "int64" }, "unallocatedSpace": { "type": "integer", "format": "int64" }, "usableSpace": { "type": "integer", "format": "int64" } }, "title": "FileStore" }, "FileSystem": { "type": "object", "properties": { "fileStores": { "$ref": "#/definitions/Iterable«FileStore»" }, "open": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "rootDirectories": { "$ref": "#/definitions/Iterable«Path»" }, "separator": { "type": "string" }, "userPrincipalLookupService": { "$ref": "#/definitions/UserPrincipalLookupService" } }, "title": "FileSystem" }, "FileSystemResource": { "type": "object", "properties": { "description": { "type": "string" }, "file": { "$ref": "#/definitions/File" }, "filename": { "type": "string" }, "inputStream": { "$ref": "#/definitions/InputStream" }, "open": { "type": "boolean" }, "outputStream": { "$ref": "#/definitions/OutputStream" }, "path": { "type": "string" }, "readable": { "type": "boolean" }, "uri": { "$ref": "#/definitions/URI" }, "url": { "$ref": "#/definitions/URL" }, "writable": { "type": "boolean" } }, "title": "FileSystemResource" }, "Filter": { "type": "object", "discriminator": "backend", "title": "Filter" }, "FindRow": { "type": "object", "properties": { "criteria": { "$ref": "#/definitions/PacsSearchCriteria" }, "relabelMap": { "type": "object", "additionalProperties": { "type": "string" } }, "studies": { "type": "array", "items": { "$ref": "#/definitions/Study" } } }, "title": "FindRow" }, "FormAppliesToPoJo": { "type": "object", "properties": { "entityId": { "type": "string" }, "idCustomVariableFormAppliesTo": { "type": "string" }, "status": { "type": "string" } }, "title": "FormAppliesToPoJo" }, "GenericResource": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string" } }, "title": "GenericResource" }, "GenericWrapperElement": { "type": "object", "properties": { "abstract": { "type": "boolean" }, "addIns": { "type": "array", "items": { "$ref": "#/definitions/XFTFieldWrapper" } }, "addin": { "type": "string" }, "alias": { "type": "string" }, "allFieldIDs": { "type": "object", "additionalProperties": { "type": "object" } }, "allFieldNames": { "type": "array", "items": { "type": "array", "items": { "type": "object" } } }, "allFields": { "type": "array", "items": { "type": "object" } }, "allPossibleXMLFieldNames": { "type": "object", "additionalProperties": { "type": "object" } }, "allPrimaryKeys": { "type": "array", "items": { "$ref": "#/definitions/GenericWrapperField" } }, "anoChildElement": { "type": "boolean" }, "autoActivate": { "type": "boolean" }, "autoIncrement": { "type": "boolean" }, "baseClass": { "type": "string" }, "basePeer": { "type": "string" }, "dbName": { "type": "string" }, "defaultKey": { "$ref": "#/definitions/XFTFieldWrapper" }, "dependencies": { "type": "array", "items": { "type": "object" } }, "directFields": { "type": "array", "items": { "$ref": "#/definitions/GenericWrapperField" } }, "directFieldsNoFilter": { "type": "array", "items": { "$ref": "#/definitions/XFTFieldWrapper" } }, "directXMLName": { "type": "string" }, "displayIdentifiers": { "type": "array", "items": { "type": "string" } }, "extended": { "type": "boolean" }, "extendedElement": { "$ref": "#/definitions/GenericWrapperElement" }, "extendedElements": { "type": "array", "items": { "type": "array", "items": { "type": "object" } } }, "extendedXSITypes": { "type": "array", "items": { "type": "string" } }, "extension": { "type": "boolean" }, "extensionField": { "$ref": "#/definitions/GenericWrapperField" }, "extensionFieldName": { "type": "string" }, "extensionType": { "$ref": "#/definitions/XMLType" }, "factory": { "$ref": "#/definitions/XFTFactoryI" }, "filter": { "type": "string" }, "filterField": { "type": "string" }, "formattedName": { "type": "string" }, "fullXMLName": { "type": "string" }, "genericXFTElement": { "$ref": "#/definitions/GenericWrapperElement" }, "hiddenSuperiorElements": { "type": "array", "items": { "type": "object" } }, "hiddenSuperiorReferences": { "type": "array", "items": { "$ref": "#/definitions/XFTSuperiorReference" } }, "idMethod": { "type": "string" }, "javaname": { "type": "string" }, "localXMLName": { "type": "string" }, "manyToManyReferences": { "type": "array", "items": { "$ref": "#/definitions/XFTManyToManyReference" } }, "metaDataField": { "$ref": "#/definitions/GenericWrapperField" }, "metaDataFieldName": { "type": "string" }, "metaFields": { "$ref": "#/definitions/MetaFieldCollection" }, "multiReferenceFields": { "type": "array", "items": { "type": "object" } }, "multiViewName": { "type": "string" }, "name": { "type": "string" }, "nonMultipleFields": { "type": "array", "items": { "type": "object" } }, "pkNames": { "type": "array", "items": { "type": "string" } }, "possibleExtenders": { "type": "array", "items": { "$ref": "#/definitions/SchemaElementI" } }, "preLoad": { "type": "boolean" }, "properName": { "type": "string" }, "quarantine": { "type": "boolean" }, "referenceFieldsWAddIns": { "type": "array", "items": { "type": "object" } }, "referencedElements": { "type": "array", "items": { "type": "object" } }, "relationFields": { "type": "array", "items": { "type": "object" } }, "rules": { "type": "array", "items": { "type": "object" } }, "schema": { "$ref": "#/definitions/XFTSchema" }, "schemaTargetNamespacePrefix": { "type": "string" }, "schemaTargetNamespaceURI": { "type": "string" }, "sequenceName": { "type": "string" }, "singleViewName": { "type": "string" }, "skipSQL": { "type": "boolean" }, "sqlkeys": { "type": "array", "items": { "type": "array", "items": { "type": "object" } } }, "sqlname": { "type": "string" }, "statedPrimaryKeyFields": { "type": "array", "items": { "type": "object" } }, "subordinateReferences": { "type": "array", "items": { "$ref": "#/definitions/XFTSuperiorReference" } }, "superiorReferences": { "type": "array", "items": { "$ref": "#/definitions/XFTSuperiorReference" } }, "textFunctionName": { "type": "string" }, "type": { "$ref": "#/definitions/XMLType" }, "typeCode": { "type": "string" }, "undefinedReferences": { "type": "array", "items": { "$ref": "#/definitions/GenericWrapperField" } }, "uniqueCompositeFields": { "type": "object", "additionalProperties": { "type": "object" } }, "uniqueFields": { "type": "array", "items": { "type": "object" } }, "uniqueIdentifierPrimaryKeyFields": { "type": "array", "items": { "type": "object" } }, "wrapped": { "$ref": "#/definitions/XFTElement" }, "xmljavaNameValue": { "type": "string" }, "xmlname": { "type": "string" }, "xmlsqlNameValue": { "type": "string" }, "xsitype": { "type": "string" } }, "title": "GenericWrapperElement" }, "GenericWrapperField": { "type": "object", "properties": { "adjustedSize": { "type": "string" }, "allFields": { "type": "array", "items": { "type": "object" } }, "allPossibleXMLFieldNames": { "type": "object", "additionalProperties": { "type": "object" } }, "attribute": { "type": "boolean" }, "autoIncrement": { "type": "string" }, "baseCol": { "type": "string" }, "baseElement": { "type": "string" }, "booleanField": { "type": "boolean" }, "childXMLNode": { "type": "boolean" }, "createdChild": { "type": "boolean" }, "defaultValue": { "type": "string" }, "directFields": { "type": "array", "items": { "type": "object" } }, "directFieldsNoFilter": { "type": "array", "items": { "type": "object" } }, "duplicateRelationships": { "type": "array", "items": { "type": "object" } }, "expose": { "type": "boolean" }, "extension": { "type": "boolean" }, "factory": { "$ref": "#/definitions/XFTFactoryI" }, "filter": { "type": "boolean" }, "foreignCol": { "type": "string" }, "foreignKeyTable": { "type": "string" }, "genericXFTField": { "$ref": "#/definitions/GenericWrapperField" }, "hidden": { "type": "boolean" }, "id": { "type": "string" }, "inLineRepeaterElement": { "type": "boolean" }, "javaname": { "type": "string" }, "leafNode": { "type": "boolean" }, "localRefNames": { "type": "array", "items": { "type": "object" } }, "multiple": { "type": "boolean" }, "name": { "type": "string" }, "onDelete": { "type": "string" }, "onlyRoot": { "type": "boolean" }, "parentElement": { "$ref": "#/definitions/SchemaElementI" }, "possibleLoop": { "type": "boolean" }, "possibleValues": { "type": "array", "items": { "type": "object" } }, "prefix": { "type": "string" }, "preventLoop": { "type": "boolean" }, "primaryKey": { "type": "string" }, "reference": { "type": "boolean" }, "referenceElement": { "$ref": "#/definitions/SchemaElementI" }, "referenceElementName": { "$ref": "#/definitions/XMLType" }, "relationName": { "type": "string" }, "relationType": { "type": "string" }, "relationUnique": { "type": "boolean" }, "relationUniqueComposite": { "type": "string" }, "required": { "type": "string" }, "requiredWOPk": { "type": "string" }, "rules": { "type": "array", "items": { "type": "object" } }, "size": { "type": "string" }, "sqlField": { "$ref": "#/definitions/XFTSqlField" }, "sqlname": { "type": "string" }, "torqueField": { "$ref": "#/definitions/TorqueField" }, "unique": { "type": "boolean" }, "uniqueComposite": { "type": "string" }, "wrapped": { "$ref": "#/definitions/XFTField" }, "xftreference": { "$ref": "#/definitions/XFTReferenceI" }, "xmldisplay": { "type": "string" }, "xmljavaNameValue": { "type": "string" }, "xmlname": { "type": "string" }, "xmlonly": { "type": "boolean" }, "xmlpathString": { "type": "string" }, "xmlsqlNameValue": { "type": "string" }, "xmltype": { "$ref": "#/definitions/XMLType" }, "xpath": { "type": "string" } }, "title": "GenericWrapperField" }, "GrantedAuthority": { "type": "object", "properties": { "authority": { "type": "string" } }, "title": "GrantedAuthority" }, "Hardware": { "type": "object", "properties": { "name": { "type": "string" }, "cpuLimit": { "type": "number", "format": "double" }, "cpuReservation": { "type": "number", "format": "double" }, "memoryLimit": { "type": "string" }, "memoryReservation": { "type": "string" }, "constraints": { "type": "array", "items": { "$ref": "#/definitions/Constraint" } }, "environmentVariables": { "type": "array", "items": { "$ref": "#/definitions/EnvironmentVariable" } }, "genericResources": { "type": "array", "items": { "$ref": "#/definitions/GenericResource" } } }, "title": "Hardware" }, "HardwareConfig": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "hardware": { "$ref": "#/definitions/Hardware" }, "scopes": { "type": "object", "additionalProperties": { "$ref": "#/definitions/HardwareScope" } } }, "title": "HardwareConfig" }, "HardwareScope": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "ids": { "type": "array", "items": { "type": "string" } }, "scope": { "type": "string", "enum": [ "Site", "Project", "Subject", "Experiment", "User", "DataType" ] } }, "title": "HardwareScope" }, "HibernateFilter": { "title": "HibernateFilter", "allOf": [ { "$ref": "#/definitions/Filter" }, { "type": "object", "properties": { "andFilters": { "type": "array", "items": { "$ref": "#/definitions/HibernateFilter" } }, "hi": { "type": "object" }, "lo": { "type": "object" }, "not": { "type": "boolean" }, "operator": { "type": "string", "enum": [ "eq", "ne", "lt", "gt", "le", "ge", "like", "ilike", "in", "between" ] }, "orFilters": { "type": "array", "items": { "$ref": "#/definitions/HibernateFilter" } }, "value": { "type": "object" }, "values": { "type": "array", "items": { "type": "object" } } }, "title": "HibernateFilter" } ] }, "Ingredient": { "type": "object", "properties": { "name": { "type": "string" } }, "title": "Ingredient" }, "InputStream": { "type": "object", "title": "InputStream" }, "Investigator": { "type": "object", "properties": { "department": { "type": "string" }, "email": { "type": "string" }, "firstname": { "type": "string" }, "id": { "type": "string" }, "insertDate": { "type": "string", "format": "date-time" }, "insertUser": { "type": "string" }, "institution": { "type": "string" }, "investigatorProjects": { "type": "array", "items": { "type": "string" } }, "lastname": { "type": "string" }, "phone": { "type": "string" }, "primaryProjects": { "type": "array", "items": { "type": "string" } }, "title": { "type": "string" }, "xnatInvestigatordataId": { "type": "integer", "format": "int32" }, "xsitype": { "type": "string" } }, "title": "Investigator" }, "Iterable«CacheEntryListenerConfiguration«object,object»»": { "type": "object", "title": "Iterable«CacheEntryListenerConfiguration«object,object»»" }, "Iterable«FileStore»": { "type": "object", "title": "Iterable«FileStore»" }, "Iterable«Path»": { "type": "object", "title": "Iterable«Path»" }, "Iterator": { "type": "object", "title": "Iterator" }, "JsonNode": { "type": "object", "title": "JsonNode" }, "JsonPathFilterNode": { "type": "object", "properties": { "value": { "type": "string" }, "match-case": { "type": "boolean" }, "match-word": { "type": "boolean" }, "match-null-value": { "type": "boolean" }, "value-type": { "type": "string" }, "sample-value": { "type": "string" } }, "title": "JsonPathFilterNode" }, "KubernetesToleration": { "type": "object", "properties": { "effect": { "type": "string" }, "id": { "type": "integer", "format": "int64" }, "key": { "type": "string" }, "operator": { "type": "string" }, "value": { "type": "string" } }, "title": "KubernetesToleration" }, "LaunchReport": { "type": "object", "properties": { "command-id": { "type": "integer", "format": "int64" }, "id": { "type": "integer", "format": "int64" }, "params": { "type": "object", "additionalProperties": { "type": "string" } }, "status": { "type": "string" }, "wrapper-id": { "type": "integer", "format": "int64" } }, "title": "LaunchReport" }, "LaunchUi": { "type": "object", "properties": { "container-server-config": { "$ref": "#/definitions/LaunchUiServer" }, "input-config": { "type": "array", "items": { "$ref": "#/definitions/LaunchUiInputTree" } }, "input-values": { "type": "array", "items": { "$ref": "#/definitions/LaunchUiValueTree" } }, "meta": { "$ref": "#/definitions/LaunchUiMeta" } }, "title": "LaunchUi" }, "LaunchUiInputTree": { "type": "object", "properties": { "advanced": { "type": "boolean" }, "children": { "type": "array", "items": { "$ref": "#/definitions/LaunchUiInputTree" } }, "derived-value-info": { "type": "string" }, "derived-value-message": { "type": "string" }, "description": { "type": "string" }, "input-type": { "type": "string", "enum": [ "text", "password", "boolean", "select-one", "select-many", "static", "derived", "file" ] }, "label": { "type": "string" }, "multiple": { "type": "boolean" }, "name": { "type": "string" }, "required": { "type": "boolean" }, "select-values": { "type": "array", "items": { "type": "string" } }, "user-settable": { "type": "boolean" } }, "title": "LaunchUiInputTree" }, "LaunchUiMeta": { "type": "object", "properties": { "command-description": { "type": "string" }, "command-id": { "type": "integer", "format": "int64" }, "command-label": { "type": "string" }, "command-metadata": { "$ref": "#/definitions/JsonNode" }, "command-name": { "type": "string" }, "image-name": { "type": "string" }, "image-type": { "type": "string" }, "wrapper-description": { "type": "string" }, "wrapper-id": { "type": "integer", "format": "int64" }, "wrapper-label": { "type": "string" }, "wrapper-name": { "type": "string" } }, "title": "LaunchUiMeta" }, "LaunchUiServer": { "type": "object", "properties": { "swarm-constraints": { "type": "array", "items": { "$ref": "#/definitions/LaunchUiServerSwarmConstraint" } } }, "title": "LaunchUiServer" }, "LaunchUiServerSwarmConstraint": { "type": "object", "properties": { "attribute": { "type": "string" }, "comparator": { "type": "string" }, "values": { "type": "array", "items": { "type": "string" } } }, "title": "LaunchUiServerSwarmConstraint" }, "LaunchUiValueTree": { "type": "object", "properties": { "name": { "type": "string" }, "values": { "type": "array", "items": { "$ref": "#/definitions/LaunchUiValueTreeValueAndChildren" } } }, "title": "LaunchUiValueTree" }, "LaunchUiValueTreeValueAndChildren": { "type": "object", "properties": { "children": { "type": "array", "items": { "$ref": "#/definitions/LaunchUiValueTree" } }, "label": { "type": "string" }, "value": { "type": "string" } }, "title": "LaunchUiValueTreeValueAndChildren" }, "ListMultimap«string,string»": { "type": "object", "properties": { "empty": { "type": "boolean" } }, "title": "ListMultimap«string,string»" }, "Map«File,string»": { "type": "object", "title": "Map«File,string»", "additionalProperties": { "type": "string" } }, "Map«string,Map«File,string»»": { "type": "object", "title": "Map«string,Map«File,string»»", "additionalProperties": { "$ref": "#/definitions/Map" } }, "Map«string,string»": { "type": "object", "title": "Map«string,string»", "additionalProperties": { "type": "string" } }, "MetaFieldCollection": { "type": "object", "properties": { "collection": { "type": "array", "items": { "type": "object" } }, "iterator": { "$ref": "#/definitions/Iterator" } }, "title": "MetaFieldCollection" }, "Mount": { "type": "object", "properties": { "containerPath": { "type": "string" }, "localPath": { "type": "string" }, "readOnly": { "type": "boolean" }, "volumeName": { "type": "string" } }, "title": "Mount" }, "NumericFilter": { "title": "NumericFilter", "allOf": [ { "$ref": "#/definitions/Filter" }, { "type": "object", "properties": { "eq": { "$ref": "#/definitions/Number" }, "ge": { "$ref": "#/definitions/Number" }, "gt": { "$ref": "#/definitions/Number" }, "le": { "$ref": "#/definitions/Number" }, "lt": { "$ref": "#/definitions/Number" }, "neq": { "$ref": "#/definitions/Number" } }, "title": "NumericFilter" } ] }, "Orchestration": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "haltOnCommandFailure": { "type": "boolean" }, "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "wrapperIds": { "type": "array", "items": { "type": "integer", "format": "int64" } } }, "title": "Orchestration" }, "OrchestrationProject": { "type": "object", "properties": { "availableOrchestrations": { "type": "array", "items": { "$ref": "#/definitions/Orchestration" } }, "selectedOrchestrationId": { "type": "integer", "format": "int64" } }, "title": "OrchestrationProject" }, "OutputStream": { "type": "object", "title": "OutputStream" }, "Pacs": { "type": "object", "properties": { "aeTitle": { "type": "string" }, "anonymizationEnabled": { "type": "boolean" }, "created": { "type": "string", "format": "date-time" }, "defaultQueryRetrievePacs": { "type": "boolean" }, "defaultStoragePacs": { "type": "boolean" }, "dicomObjectIdentifier": { "type": "string" }, "dicomWebEnabled": { "type": "boolean" }, "dicomWebRootUrl": { "type": "string" }, "disabled": { "type": "string", "format": "date-time" }, "enabled": { "type": "boolean" }, "host": { "type": "string" }, "id": { "type": "integer", "format": "int64" }, "label": { "type": "string" }, "ormStrategySpringBeanId": { "type": "string" }, "queryRetrievePort": { "type": "integer", "format": "int32" }, "queryable": { "type": "boolean" }, "storable": { "type": "boolean" }, "supportsExtendedNegotiations": { "type": "boolean" }, "timestamp": { "type": "string", "format": "date-time" } }, "title": "Pacs" }, "PacsAvailability": { "type": "object", "properties": { "availabilityEnd": { "type": "string" }, "availabilityStart": { "type": "string" }, "availableNow": { "type": "boolean" }, "created": { "type": "string", "format": "date-time" }, "dayOfWeek": { "type": "string", "enum": [ "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY" ] }, "disabled": { "type": "string", "format": "date-time" }, "enabled": { "type": "boolean" }, "id": { "type": "integer", "format": "int64" }, "pacsId": { "type": "integer", "format": "int64" }, "threads": { "type": "integer", "format": "int32" }, "timestamp": { "type": "string", "format": "date-time" }, "utilizationPercent": { "type": "integer", "format": "int32" } }, "title": "PacsAvailability" }, "PacsImportRequest": { "type": "object", "properties": { "aeTitle": { "type": "string" }, "forceImport": { "type": "boolean" }, "pacsId": { "type": "integer", "format": "int64" }, "port": { "type": "integer", "format": "int32" }, "projectId": { "type": "string" }, "requestId": { "type": "string" }, "studies": { "type": "array", "items": { "$ref": "#/definitions/StudyImportInformation" } } }, "title": "PacsImportRequest" }, "PacsPing": { "type": "object", "properties": { "created": { "type": "string", "format": "date-time" }, "disabled": { "type": "string", "format": "date-time" }, "enabled": { "type": "boolean" }, "id": { "type": "integer", "format": "int64" }, "pacsId": { "type": "integer", "format": "int64" }, "pingTime": { "type": "string", "format": "date-time" }, "successful": { "type": "boolean" }, "timestamp": { "type": "string", "format": "date-time" } }, "title": "PacsPing" }, "PacsSearchCriteria": { "type": "object", "properties": { "accessionNumber": { "type": "string" }, "dob": { "type": "string" }, "modality": { "type": "string" }, "pacsId": { "type": "integer", "format": "int64" }, "patientId": { "type": "string" }, "patientName": { "type": "string" }, "seriesDescription": { "type": "string" }, "seriesInstanceUid": { "type": "string" }, "seriesNumber": { "type": "integer", "format": "int32" }, "studyDateRange": { "$ref": "#/definitions/DqrDateRange" }, "studyId": { "type": "string" }, "studyInstanceUid": { "type": "string" } }, "title": "PacsSearchCriteria" }, "PacsSearchResults«Patient»": { "type": "object", "properties": { "hasLimitedResultSetSize": { "type": "boolean" }, "results": { "type": "array", "items": { "$ref": "#/definitions/Patient" } }, "studyDateRangeLimitResults": { "$ref": "#/definitions/StudyDateRangeLimitResults" } }, "title": "PacsSearchResults«Patient»" }, "PacsSearchResults«Series»": { "type": "object", "properties": { "hasLimitedResultSetSize": { "type": "boolean" }, "results": { "type": "array", "items": { "$ref": "#/definitions/Series" } }, "studyDateRangeLimitResults": { "$ref": "#/definitions/StudyDateRangeLimitResults" } }, "title": "PacsSearchResults«Series»" }, "PacsSeriesSearchRequest": { "type": "object", "properties": { "pacsId": { "type": "integer", "format": "int64" }, "studyInstanceUids": { "type": "array", "items": { "type": "string" } } }, "title": "PacsSeriesSearchRequest" }, "PacsSettings": { "type": "object", "properties": { "aeTitle": { "type": "string" }, "defaultQueryRetrievePacs": { "type": "boolean" }, "defaultStoragePacs": { "type": "boolean" }, "dicomObjectIdentifier": { "type": "string" }, "dicomWebEnabled": { "type": "boolean" }, "dicomWebRootUrl": { "type": "string" }, "host": { "type": "string" }, "label": { "type": "string" }, "ormStrategySpringBeanId": { "type": "string" }, "queryRetrievePort": { "type": "integer", "format": "int32" }, "queryable": { "type": "boolean" }, "storable": { "type": "boolean" }, "supportsExtendedNegotiations": { "type": "boolean" } }, "title": "PacsSettings" }, "Pair«string,string»": { "type": "object", "properties": { "key": { "type": "string", "enum": [ "desc", "asc" ] }, "left": { "type": "string", "enum": [ "desc", "asc" ] }, "right": { "type": "string" }, "value": { "type": "string" } }, "title": "Pair«string,string»" }, "Path": { "type": "object", "properties": { "absolute": { "type": "boolean" }, "fileName": { "$ref": "#/definitions/Path" }, "fileSystem": { "$ref": "#/definitions/FileSystem" }, "nameCount": { "type": "integer", "format": "int32" }, "parent": { "$ref": "#/definitions/Path" }, "root": { "$ref": "#/definitions/Path" } }, "title": "Path" }, "Patient": { "type": "object", "properties": { "birthDate": { "type": "string", "format": "date-time" }, "id": { "type": "string" }, "name": { "$ref": "#/definitions/DqrPersonName" }, "sex": { "type": "string" }, "studies": { "type": "array", "items": { "$ref": "#/definitions/Study" } }, "uniqueIdentifier": { "type": "string" } }, "title": "Patient" }, "PipelineLaunchReport": { "type": "object", "properties": { "experimentLaunchStatuses": { "type": "array", "items": { "$ref": "#/definitions/PipelineLaunchStatus" } }, "failures": { "type": "integer", "format": "int32" }, "params": { "type": "object", "additionalProperties": { "type": "string" } }, "pipelineName": { "type": "string" }, "project": { "type": "string" }, "successes": { "type": "integer", "format": "int32" } }, "title": "PipelineLaunchReport" }, "PipelineLaunchStatus": { "type": "object", "properties": { "exptId": { "type": "string" }, "exptLabel": { "type": "string" }, "project": { "type": "string" }, "status": { "type": "string" }, "workflowId": { "type": "string" } }, "title": "PipelineLaunchStatus" }, "PluginVersionCheck": { "type": "object", "properties": { "compatible": { "type": "boolean" }, "message": { "type": "string" }, "min-xnat-version-required": { "type": "string" }, "xnat-version-detected": { "type": "string" } }, "title": "PluginVersionCheck" }, "ProjectEnabledReport": { "type": "object", "properties": { "enabled-for-project": { "type": "boolean" }, "enabled-for-site": { "type": "boolean" }, "project": { "type": "string" } }, "title": "ProjectEnabledReport" }, "ProjectEventFilterCreator": { "type": "object", "properties": { "name": { "type": "string" }, "event-type": { "type": "string" }, "project-ids": { "type": "array", "items": { "type": "string" } }, "status": { "type": "string" }, "payload-filter": { "type": "string" }, "filter-nodes": { "type": "object", "additionalProperties": { "$ref": "#/definitions/JsonPathFilterNode" } } }, "title": "ProjectEventFilterCreator" }, "ProjectSubscriptionCreator": { "type": "object", "properties": { "name": { "type": "string" }, "active": { "type": "boolean" }, "custom-listener-id": { "type": "string" }, "action-key": { "type": "string" }, "attributes": { "type": "object", "additionalProperties": { "type": "string" } }, "event-filter": { "$ref": "#/definitions/ProjectEventFilterCreator" } }, "title": "ProjectSubscriptionCreator" }, "Properties": { "type": "object", "title": "Properties", "additionalProperties": { "type": "object" } }, "PseudoConfiguration": { "type": "object", "properties": { "appliesToList": { "type": "array", "items": { "$ref": "#/definitions/FormAppliesToPoJo" } }, "contents": { "type": "string" }, "dateCreated": { "type": "string", "format": "date-time" }, "doProjectsShareForm": { "type": "boolean" }, "formDisplayOrder": { "type": "integer", "format": "int32" }, "formId": { "type": "string" }, "formUUID": { "type": "string" }, "hasData": { "type": "boolean" }, "path": { "type": "string" }, "scope": { "type": "string", "enum": [ "Site", "Project", "Subject", "Experiment", "User", "DataType" ] }, "username": { "type": "string" } }, "title": "PseudoConfiguration" }, "QueuedPacsRequest": { "type": "object", "properties": { "accessionNumber": { "type": "string" }, "created": { "type": "string", "format": "date-time" }, "decodedAeAndPort": { "type": "string" }, "destinationAeTitle": { "type": "string" }, "disabled": { "type": "string", "format": "date-time" }, "enabled": { "type": "boolean" }, "errorMessage": { "type": "string" }, "id": { "type": "integer", "format": "int64" }, "pacsId": { "type": "integer", "format": "int64" }, "patientId": { "type": "string" }, "patientName": { "type": "string" }, "priority": { "type": "integer", "format": "int64" }, "queuedTime": { "type": "string", "format": "date-time" }, "remappingScript": { "type": "string" }, "requestId": { "type": "string" }, "retries": { "type": "integer", "format": "int32" }, "seriesIds": { "type": "array", "items": { "type": "string" } }, "status": { "type": "string" }, "studyDate": { "type": "string" }, "studyId": { "type": "string" }, "studyInstanceUid": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" }, "username": { "type": "string" }, "xnatProject": { "type": "string" } }, "title": "QueuedPacsRequest" }, "ReferringPhysicianName": { "type": "object", "properties": { "blank": { "type": "boolean" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "middleName": { "type": "string" }, "prefix": { "type": "string" }, "suffix": { "type": "string" } }, "title": "ReferringPhysicianName" }, "ResolvedSecret": { "type": "object", "properties": { "destination": { "$ref": "#/definitions/SecretDestination" }, "source": { "$ref": "#/definitions/SecretSource" } }, "title": "ResolvedSecret" }, "Resource": { "type": "object", "properties": { "description": { "type": "string" }, "file": { "$ref": "#/definitions/File" }, "filename": { "type": "string" }, "inputStream": { "$ref": "#/definitions/InputStream" }, "open": { "type": "boolean" }, "readable": { "type": "boolean" }, "uri": { "$ref": "#/definitions/URI" }, "url": { "$ref": "#/definitions/URL" } }, "title": "Resource" }, "ResourceMitigationReport": { "type": "object", "properties": { "backupErrors": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "type": "string" } } }, "cachePath": { "type": "string" }, "catalogWriteError": { "type": "string" }, "deleteErrors": { "type": "object", "additionalProperties": { "type": "string" } }, "moveErrors": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "type": "string" } } }, "movedFiles": { "type": "object", "additionalProperties": { "$ref": "#/definitions/File" } }, "removedFiles": { "type": "object", "additionalProperties": { "$ref": "#/definitions/File" } }, "resourceSaveError": { "type": "string" }, "resourceSurveyRequestId": { "type": "integer", "format": "int64" }, "retainedFiles": { "type": "array", "items": { "$ref": "#/definitions/File" } }, "totalFileErrors": { "type": "integer", "format": "int32" }, "totalMovedFiles": { "type": "integer", "format": "int32" }, "totalRemovedFiles": { "type": "integer", "format": "int32" } }, "title": "ResourceMitigationReport" }, "ResourceSurveyReport": { "type": "object", "properties": { "badFiles": { "type": "array", "items": { "$ref": "#/definitions/File" } }, "duplicates": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "type": "string" } } } }, "mismatchedFiles": { "type": "object", "additionalProperties": { "type": "string" } }, "nonActionableDuplicates": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "type": "string" } } } }, "resourceSurveyRequestId": { "type": "integer", "format": "int64" }, "surveyDate": { "type": "string", "format": "date-time" }, "totalBadFiles": { "type": "integer", "format": "int32" }, "totalDuplicates": { "type": "integer", "format": "int32" }, "totalEntries": { "type": "integer", "format": "int32" }, "totalFilesInDuplicates": { "type": "integer", "format": "int32" }, "totalFilesInNonActionableDuplicates": { "type": "integer", "format": "int32" }, "totalMismatchedFiles": { "type": "integer", "format": "int32" }, "totalNonActionableDuplicates": { "type": "integer", "format": "int32" }, "totalUids": { "type": "integer", "format": "int32" }, "uids": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } }, "title": "ResourceSurveyReport" }, "ResourceSurveyRequest": { "type": "object", "properties": { "closingDate": { "type": "string", "format": "date-time" }, "created": { "type": "string", "format": "date-time" }, "disabled": { "type": "string", "format": "date-time" }, "enabled": { "type": "boolean" }, "experimentId": { "type": "string" }, "experimentLabel": { "type": "string" }, "id": { "type": "integer", "format": "int64" }, "mitigationReport": { "$ref": "#/definitions/ResourceMitigationReport" }, "mitigationRequester": { "type": "string" }, "projectId": { "type": "string" }, "requestTime": { "type": "string" }, "requester": { "type": "string" }, "resourceId": { "type": "integer", "format": "int32" }, "resourceLabel": { "type": "string" }, "resourceUri": { "type": "string" }, "rsnStatus": { "type": "string", "enum": [ "CREATED", "QUEUED_FOR_SURVEY", "SURVEYING", "DIVERGENT", "CONFORMING", "NONCOMPLIANT", "QUEUED_FOR_MITIGATION", "MITIGATING", "RESOURCE_DELETED", "CANCELED", "ERROR" ] }, "scanDescription": { "type": "string" }, "scanId": { "type": "integer", "format": "int32" }, "scanLabel": { "type": "string" }, "subjectId": { "type": "string" }, "subjectLabel": { "type": "string" }, "surveyReport": { "$ref": "#/definitions/ResourceSurveyReport" }, "timestamp": { "type": "string", "format": "date-time" }, "workflowId": { "type": "integer", "format": "int32" }, "xsiType": { "type": "string" } }, "title": "ResourceSurveyRequest" }, "SchemaElementI": { "type": "object", "properties": { "allPrimaryKeys": { "type": "array", "items": { "type": "object" } }, "dbName": { "type": "string" }, "formattedName": { "type": "string" }, "fullXMLName": { "type": "string" }, "genericXFTElement": { "$ref": "#/definitions/GenericWrapperElement" }, "preLoad": { "type": "boolean" }, "sqlname": { "type": "string" } }, "title": "SchemaElementI" }, "ScriptTrigger": { "type": "object", "properties": { "association": { "type": "string" }, "created": { "type": "string", "format": "date-time" }, "description": { "type": "string" }, "disabled": { "type": "string", "format": "date-time" }, "enabled": { "type": "boolean" }, "event": { "type": "string" }, "eventFilters": { "type": "array", "items": { "$ref": "#/definitions/EventFilters" } }, "eventFiltersAsMap": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "id": { "type": "integer", "format": "int64" }, "scriptId": { "type": "string" }, "srcEventClass": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" }, "triggerId": { "type": "string" } }, "title": "ScriptTrigger" }, "Secret": { "type": "object", "properties": { "destination": { "$ref": "#/definitions/SecretDestination" }, "source": { "$ref": "#/definitions/SecretSource" } }, "title": "Secret" }, "SecretDestination": { "type": "object", "discriminator": "type", "title": "SecretDestination" }, "SecretSource": { "type": "object", "discriminator": "type", "title": "SecretSource" }, "Series": { "type": "object", "properties": { "accessionNumber": { "type": "string" }, "modality": { "type": "string" }, "patientId": { "type": "string" }, "patientName": { "type": "string" }, "seriesDescription": { "type": "string" }, "seriesInstanceUid": { "type": "string" }, "seriesNumber": { "type": "integer", "format": "int32" }, "study": { "$ref": "#/definitions/Study" }, "studyDate": { "type": "string" }, "studyId": { "type": "string" }, "uniqueIdentifier": { "type": "string" } }, "title": "Series" }, "SessionData": { "type": "object", "title": "SessionData" }, "SetMultimap«string,string»": { "type": "object", "properties": { "empty": { "type": "boolean" } }, "title": "SetMultimap«string,string»" }, "SimpleEvent": { "type": "object", "title": "SimpleEvent" }, "SpawnerElement": { "type": "object", "properties": { "created": { "type": "string", "format": "date-time" }, "description": { "type": "string" }, "disabled": { "type": "string", "format": "date-time" }, "elementId": { "type": "string" }, "enabled": { "type": "boolean" }, "id": { "type": "integer", "format": "int64" }, "label": { "type": "string" }, "namespace": { "type": "string" }, "restricted": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" }, "yaml": { "type": "string" } }, "title": "SpawnerElement" }, "StreamingResponseBody": { "type": "object", "title": "StreamingResponseBody" }, "StringFilter": { "title": "StringFilter", "allOf": [ { "$ref": "#/definitions/Filter" }, { "type": "object", "properties": { "like": { "type": "string" }, "not": { "type": "boolean" } }, "title": "StringFilter" } ] }, "Study": { "type": "object", "properties": { "accessionNumber": { "type": "string" }, "formattedStudyDate": { "type": "string" }, "modalitiesInStudy": { "type": "array", "items": { "type": "string" } }, "patient": { "$ref": "#/definitions/Patient" }, "projectId": { "type": "string" }, "referringPhysicianName": { "$ref": "#/definitions/ReferringPhysicianName" }, "studyDate": { "type": "string", "format": "date-time" }, "studyDescription": { "type": "string" }, "studyId": { "type": "string" }, "studyInstanceUid": { "type": "string" }, "uniqueIdentifier": { "type": "string" } }, "title": "Study" }, "StudyDateRangeLimitResults": { "type": "object", "properties": { "dateRange": { "$ref": "#/definitions/DqrDateRange" }, "limitExplanation": { "type": "string" }, "limitType": { "type": "string", "enum": [ "NO_LIMIT", "RECENT_STUDIES_LIMIT" ] } }, "title": "StudyDateRangeLimitResults" }, "StudyImportInformation": { "type": "object", "properties": { "anonScript": { "type": "string" }, "relabelMap": { "type": "object", "additionalProperties": { "type": "string" } }, "seriesDescriptions": { "type": "array", "items": { "type": "string" } }, "seriesInstanceUids": { "type": "array", "items": { "type": "string" } }, "studyInstanceUid": { "type": "string" } }, "title": "StudyImportInformation" }, "SubQueryMappingColumnDB": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "queryField": { "type": "string" }, "schemaField": { "type": "string" } }, "title": "SubQueryMappingColumnDB" }, "Subscription": { "type": "object", "properties": { "act-as-event-user": { "type": "boolean" }, "action-key": { "type": "string" }, "active": { "type": "boolean" }, "attributes": { "type": "object", "additionalProperties": { "type": "string" } }, "created": { "type": "string", "example": "yyyy-MM-dd HH:mm:ss z" }, "event-filter": { "$ref": "#/definitions/EventFilter" }, "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "subscription-owner": { "type": "string" }, "valid": { "type": "boolean" }, "validation-message": { "type": "string" } }, "title": "Subscription" }, "SubscriptionCreator": { "type": "object", "properties": { "name": { "type": "string" }, "active": { "type": "boolean" }, "custom-listener-id": { "type": "string" }, "action-key": { "type": "string" }, "attributes": { "type": "object", "additionalProperties": { "type": "string" } }, "event-filter": { "$ref": "#/definitions/EventFilterCreator" }, "act-as-event-user": { "type": "boolean" } }, "title": "SubscriptionCreator" }, "SubscriptionDelivery": { "type": "object", "properties": { "error": { "type": "boolean" }, "event": { "$ref": "#/definitions/SimpleEvent" }, "event-type": { "type": "string" }, "id": { "type": "integer", "format": "int64" }, "inputs": { "type": "string" }, "payload": { "type": "object" }, "project": { "type": "string" }, "status": { "type": "array", "items": { "$ref": "#/definitions/TimedEventStatus" } }, "status-message": { "type": "string" }, "subscription": { "$ref": "#/definitions/Subscription" }, "timestamp": { "type": "string", "example": "yyyy-MM-dd HH:mm:ss z" }, "trigger": { "$ref": "#/definitions/TriggeringEvent" }, "user": { "type": "string" } }, "title": "SubscriptionDelivery" }, "SubscriptionDeliveryEntityPaginatedRequest": { "type": "object", "properties": { "filters": { "type": "object", "additionalProperties": { "$ref": "#/definitions/Filter" } }, "id": { "type": "string" }, "offset": { "type": "integer", "format": "int32" }, "order": { "$ref": "#/definitions/Pair«string,string»" }, "page": { "type": "integer", "format": "int32" }, "size": { "type": "integer", "format": "int32" }, "sortBys": { "type": "array", "items": { "$ref": "#/definitions/Pair«string,string»" } }, "sort_col": { "type": "string" }, "sort_dir": { "type": "string", "enum": [ "desc", "asc" ] } }, "title": "SubscriptionDeliveryEntityPaginatedRequest" }, "SubscriptionDeliverySummary": { "type": "object", "properties": { "error": { "type": "boolean" }, "event-name": { "type": "string" }, "id": { "type": "integer", "format": "int64" }, "project": { "type": "string" }, "status": { "type": "string" }, "subscription-id": { "type": "integer", "format": "int64" }, "subscription-name": { "type": "string" }, "timestamp": { "type": "string", "example": "yyyy-MM-dd HH:mm:ss z" }, "trigger-label": { "type": "string" }, "user": { "type": "string" } }, "title": "SubscriptionDeliverySummary" }, "SubscriptionDisplay": { "type": "object", "properties": { "act-as-event-user": { "type": "boolean" }, "action-key": { "type": "string" }, "active": { "type": "boolean" }, "attributes": { "type": "object", "additionalProperties": { "type": "string" } }, "created": { "type": "string", "example": "yyyy-MM-dd HH:mm:ss z" }, "editable": { "type": "boolean" }, "event-filter": { "$ref": "#/definitions/EventFilter" }, "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "subscription-owner": { "type": "string" }, "valid": { "type": "boolean" }, "validation-message": { "type": "string" } }, "title": "SubscriptionDisplay" }, "SubscriptionUpdate": { "type": "object", "properties": { "name": { "type": "string" }, "active": { "type": "boolean" }, "custom-listener-id": { "type": "string" }, "action-key": { "type": "string" }, "attributes": { "type": "object", "additionalProperties": { "type": "string" } }, "event-filter": { "$ref": "#/definitions/EventFilterUpdate" }, "act-as-event-user": { "type": "boolean" } }, "title": "SubscriptionUpdate" }, "Success": { "type": "object", "properties": { "command-id": { "type": "integer", "format": "int64" }, "id": { "type": "integer", "format": "int64" }, "params": { "type": "object", "additionalProperties": { "type": "string" } }, "status": { "type": "string" }, "workflow-id": { "type": "string" }, "wrapper-id": { "type": "integer", "format": "int64" } }, "title": "Success" }, "SurveyReportSummary": { "type": "object", "properties": { "overallStatus": { "type": "string" }, "projectId": { "type": "string" }, "totalBadFiles": { "type": "integer", "format": "int32" }, "totalDuplicates": { "type": "integer", "format": "int32" }, "totalEntries": { "type": "integer", "format": "int32" }, "totalFileErrors": { "type": "integer", "format": "int32" }, "totalMismatchedFiles": { "type": "integer", "format": "int32" }, "totalMovedFiles": { "type": "integer", "format": "int32" }, "totalRemovedFiles": { "type": "integer", "format": "int32" }, "totalUids": { "type": "integer", "format": "int32" } }, "title": "SurveyReportSummary" }, "SystemPropertySecretSource": { "title": "SystemPropertySecretSource", "allOf": [ { "$ref": "#/definitions/SecretSource" }, { "type": "object", "properties": { "identifier": { "type": "string" } }, "title": "SystemPropertySecretSource" } ] }, "ThemeConfig": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "name": { "type": "string" }, "path": { "type": "string" }, "roles": { "type": "array", "items": { "type": "object" } } }, "title": "ThemeConfig" }, "TimedEventStatus": { "type": "object", "properties": { "message": { "type": "string" }, "status": { "type": "string" }, "timestamp": { "type": "string", "example": "yyyy-MM-dd HH:mm:ss z" } }, "title": "TimedEventStatus" }, "TimestampFilter": { "title": "TimestampFilter", "allOf": [ { "$ref": "#/definitions/Filter" }, { "type": "object", "properties": { "after": { "type": "string" }, "afterOrOn": { "type": "string" }, "before": { "type": "string" }, "beforeOrOn": { "type": "string" } }, "title": "TimestampFilter" } ] }, "TorqueField": { "type": "object", "properties": { "defaultValue": { "type": "string" }, "inheritance": { "type": "string" }, "inheritanceClass": { "type": "string" }, "inheritanceExtends": { "type": "string" }, "inheritanceKey": { "type": "string" }, "javaName": { "type": "string" } }, "title": "TorqueField" }, "TriggeringEvent": { "type": "object", "properties": { "URI": { "type": "string" }, "event-name": { "type": "string" }, "is-xsi-type": { "type": "boolean" }, "label": { "type": "string" }, "status": { "type": "string" }, "xnat-type": { "type": "string" } }, "title": "TriggeringEvent" }, "Triple«string,int,boolean»": { "type": "object", "properties": { "left": { "type": "string" }, "middle": { "type": "integer", "format": "int32" }, "right": { "type": "boolean" } }, "title": "Triple«string,int,boolean»" }, "TypeOption": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "type": "string" } }, "title": "TypeOption" }, "URI": { "type": "object", "properties": { "absolute": { "type": "boolean" }, "authority": { "type": "string" }, "fragment": { "type": "string" }, "host": { "type": "string" }, "opaque": { "type": "boolean" }, "path": { "type": "string" }, "port": { "type": "integer", "format": "int32" }, "query": { "type": "string" }, "rawAuthority": { "type": "string" }, "rawFragment": { "type": "string" }, "rawPath": { "type": "string" }, "rawQuery": { "type": "string" }, "rawSchemeSpecificPart": { "type": "string" }, "rawUserInfo": { "type": "string" }, "scheme": { "type": "string" }, "schemeSpecificPart": { "type": "string" }, "userInfo": { "type": "string" } }, "title": "URI" }, "URL": { "type": "object", "properties": { "authority": { "type": "string" }, "content": { "type": "object" }, "defaultPort": { "type": "integer", "format": "int32" }, "file": { "type": "string" }, "host": { "type": "string" }, "path": { "type": "string" }, "port": { "type": "integer", "format": "int32" }, "protocol": { "type": "string" }, "query": { "type": "string" }, "ref": { "type": "string" }, "userInfo": { "type": "string" } }, "title": "URL" }, "User": { "type": "object", "properties": { "authorization": { "description": "The user's authorization record used when logging in.", "$ref": "#/definitions/UserAuthI" }, "currentPassword": { "type": "string" }, "email": { "type": "string" }, "enabled": { "type": "boolean" }, "firstName": { "type": "string" }, "id": { "type": "integer", "format": "int32" }, "lastModified": { "type": "string", "format": "date-time" }, "lastName": { "type": "string" }, "lastSuccessfulLogin": { "type": "string", "format": "date-time" }, "password": { "type": "string", "description": "The user's encrypted password." }, "pendingEmail": { "type": "string" }, "salt": { "type": "string", "description": "The salt used to encrypt the user's password." }, "secured": { "type": "boolean" }, "username": { "type": "string" }, "verified": { "type": "boolean" } }, "title": "User", "description": "Contains the properties that define a user on the system." }, "UserAuth": { "type": "object", "properties": { "authMethod": { "type": "string" }, "authMethodId": { "type": "string" }, "authUser": { "type": "string" }, "failedLoginAttempts": { "type": "integer", "format": "int32" }, "lastLoginAttempt": { "type": "string", "format": "date-time" }, "lastSuccessfulLogin": { "type": "string", "format": "date-time" }, "xdatUsername": { "type": "string" } }, "title": "UserAuth", "description": "Contains the properties that define a user's authentication provider mapping entry on the system." }, "UserAuthI": { "type": "object", "discriminator": "type", "properties": { "accountNonExpired": { "type": "boolean" }, "accountNonLocked": { "type": "boolean" }, "authMethod": { "type": "string" }, "authMethodId": { "type": "string" }, "authUser": { "type": "string" }, "authorities": { "type": "array", "items": { "$ref": "#/definitions/GrantedAuthority" } }, "credentialsNonExpired": { "type": "boolean" }, "enabled": { "type": "boolean" }, "failedLoginAttempts": { "type": "integer", "format": "int32" }, "lastLoginAttempt": { "type": "string", "format": "date-time" }, "lastSuccessfulLogin": { "type": "string", "format": "date-time" }, "lockoutTime": { "type": "string", "format": "date-time" }, "passwordUpdated": { "type": "string", "format": "date-time" }, "xdatUsername": { "type": "string" } }, "title": "UserAuthI" }, "UserPrincipalLookupService": { "type": "object", "title": "UserPrincipalLookupService" }, "Validated": { "type": "object", "properties": { "message": { "type": "string" }, "valid": { "type": "boolean" } }, "title": "Validated" }, "Workflow": { "type": "object", "properties": { "comments": { "type": "string", "description": "The workflow comments" }, "createUser": { "type": "string", "description": "The workflow createUser" }, "dataType": { "type": "string", "description": "The workflow dataType" }, "details": { "type": "string", "description": "The workflow details" }, "externalId": { "type": "string", "description": "The workflow externalId" }, "id": { "type": "string", "description": "The workflow element id" }, "justification": { "type": "string", "description": "The workflow justification" }, "label": { "type": "string", "description": "The workflow element label" }, "launchTime": { "type": "string", "format": "date-time", "description": "The workflow launchTime" }, "modTime": { "type": "string", "format": "date-time", "description": "The workflow last modification" }, "percentageComplete": { "type": "string", "description": "The workflow percentageComplete" }, "pipelineName": { "type": "string", "description": "The workflow pipelineName" }, "status": { "type": "string", "description": "The workflow status" }, "stepDescription": { "type": "string", "description": "The workflow stepDescription" }, "wfid": { "type": "integer", "format": "int32", "description": "The workflow wfid" } }, "title": "Workflow", "description": "Contains the properties that define a workflow on the system." }, "WorkflowPaginatedRequest": { "type": "object", "required": [ "data_type" ], "properties": { "admin_workflows": { "type": "boolean" }, "data_type": { "type": "string" }, "days": { "type": "integer", "format": "int32" }, "defaultSortColumn": { "type": "string" }, "filters": { "type": "object", "additionalProperties": { "$ref": "#/definitions/Filter" } }, "id": { "type": "string" }, "offset": { "type": "integer", "format": "int32" }, "page": { "type": "integer", "format": "int32" }, "size": { "type": "integer", "format": "int32" }, "sortBys": { "type": "array", "items": { "$ref": "#/definitions/Pair«string,string»" } }, "sort_col": { "type": "string" }, "sort_dir": { "type": "string", "enum": [ "desc", "asc" ] }, "sortable": { "type": "boolean" } }, "title": "WorkflowPaginatedRequest" }, "XFTDataModel": { "type": "object", "properties": { "db": { "type": "string" }, "elementNames": { "type": "array", "items": { "type": "string" } }, "fileName": { "type": "string" }, "packageName": { "type": "string" }, "resource": { "$ref": "#/definitions/Resource" }, "schema": { "$ref": "#/definitions/XFTSchema" }, "schemaAbbr": { "type": "string" }, "source": { "$ref": "#/definitions/Resource" }, "uri": { "type": "string" } }, "title": "XFTDataModel" }, "XFTElement": { "type": "object", "properties": { "absoluteParent": { "$ref": "#/definitions/XFTElement" }, "abstract": { "type": "boolean" }, "addin": { "type": "string" }, "anoChildElement": { "type": "boolean" }, "autoActivate": { "type": "boolean" }, "briefDescription": { "type": "string" }, "code": { "type": "string" }, "createdChild": { "type": "boolean" }, "dataModel": { "$ref": "#/definitions/XFTDataModel" }, "displayIdentifiers": { "type": "array", "items": { "type": "string" } }, "extended": { "type": "boolean" }, "extension": { "type": "boolean" }, "extensionType": { "$ref": "#/definitions/XMLType" }, "fields": { "type": "object", "additionalProperties": { "type": "object" } }, "fullDescription": { "type": "string" }, "ignoreWarnings": { "type": "boolean" }, "matchByValues": { "type": "boolean" }, "metaElement": { "$ref": "#/definitions/XFTMetaElement" }, "name": { "type": "string" }, "parent": { "$ref": "#/definitions/XFTNode" }, "parentElement": { "$ref": "#/definitions/XFTElement" }, "preLoad": { "type": "boolean" }, "quarantine": { "type": "boolean" }, "rootElement": { "type": "boolean" }, "schema": { "$ref": "#/definitions/XFTSchema" }, "schemaPrefix": { "type": "string" }, "sequence": { "type": "integer", "format": "int32" }, "skipSQL": { "type": "boolean" }, "sortedFields": { "type": "array", "items": { "type": "object" } }, "sqlElement": { "$ref": "#/definitions/XFTSqlElement" }, "type": { "$ref": "#/definitions/XMLType" }, "webAppElement": { "$ref": "#/definitions/XFTWebAppElement" }, "xsDescription": { "type": "string" } }, "title": "XFTElement" }, "XFTFactoryI": { "type": "object", "title": "XFTFactoryI" }, "XFTField": { "type": "object", "properties": { "absoluteParent": { "$ref": "#/definitions/XFTElement" }, "attribute": { "type": "boolean" }, "baseCol": { "type": "string" }, "baseElement": { "type": "string" }, "childFields": { "type": "object", "additionalProperties": { "type": "object" } }, "description": { "type": "string" }, "displayName": { "type": "string" }, "expose": { "type": "string" }, "extension": { "type": "boolean" }, "filter": { "type": "boolean" }, "finalSqlName": { "type": "string" }, "fixed": { "type": "string" }, "fullName": { "type": "string" }, "id": { "type": "string" }, "localMap": { "type": "boolean" }, "maxOccurs": { "type": "string" }, "minOccurs": { "type": "string" }, "name": { "type": "string" }, "onlyRoot": { "type": "boolean" }, "parent": { "$ref": "#/definitions/XFTNode" }, "parentElement": { "$ref": "#/definitions/XFTElement" }, "possibleLoop": { "type": "boolean" }, "preventLoop": { "type": "boolean" }, "relation": { "$ref": "#/definitions/XFTRelation" }, "required": { "type": "string" }, "rule": { "$ref": "#/definitions/XFTRule" }, "sequence": { "type": "integer", "format": "int32" }, "size": { "type": "string" }, "sortedFields": { "type": "array", "items": { "type": "object" } }, "sqlField": { "$ref": "#/definitions/XFTSqlField" }, "unique": { "type": "string" }, "uniqueComposite": { "type": "string" }, "use": { "type": "string" }, "webAppField": { "$ref": "#/definitions/XFTWebAppField" }, "xmlDisplay": { "type": "string" }, "xmlOnly": { "type": "string" }, "xmltype": { "$ref": "#/definitions/XMLType" } }, "title": "XFTField" }, "XFTFieldWrapper": { "type": "object", "properties": { "booleanField": { "type": "boolean" }, "factory": { "$ref": "#/definitions/XFTFactoryI" }, "genericXFTField": { "$ref": "#/definitions/GenericWrapperField" }, "hidden": { "type": "boolean" }, "id": { "type": "string" }, "multiple": { "type": "boolean" }, "name": { "type": "string" }, "parentElement": { "$ref": "#/definitions/SchemaElementI" }, "reference": { "type": "boolean" }, "referenceElement": { "$ref": "#/definitions/SchemaElementI" }, "sqlname": { "type": "string" }, "wrapped": { "$ref": "#/definitions/XFTField" }, "xpath": { "type": "string" } }, "title": "XFTFieldWrapper" }, "XFTManyToManyReference": { "type": "object", "properties": { "element1": { "$ref": "#/definitions/GenericWrapperElement" }, "element2": { "$ref": "#/definitions/GenericWrapperElement" }, "field1": { "$ref": "#/definitions/GenericWrapperField" }, "field2": { "$ref": "#/definitions/GenericWrapperField" }, "historyTableName": { "type": "string" }, "manyToMany": { "type": "boolean" }, "mappingColumns": { "type": "array", "items": { "type": "object" } }, "mappingTable": { "type": "string" }, "unique": { "type": "boolean" } }, "title": "XFTManyToManyReference" }, "XFTMetaElement": { "type": "object", "properties": { "code": { "type": "string" }, "element": { "$ref": "#/definitions/XFTElement" }, "javaName": { "type": "string" }, "localXMLName": { "type": "string" }, "prefix": { "type": "string" }, "sqlName": { "type": "string" } }, "title": "XFTMetaElement" }, "XFTNode": { "type": "object", "properties": { "absoluteParent": { "$ref": "#/definitions/XFTElement" }, "parent": { "$ref": "#/definitions/XFTNode" }, "parentElement": { "$ref": "#/definitions/XFTElement" } }, "title": "XFTNode" }, "XFTReferenceI": { "type": "object", "properties": { "manyToMany": { "type": "boolean" } }, "title": "XFTReferenceI" }, "XFTRelation": { "type": "object", "properties": { "duplicateRelationships": { "type": "array", "items": { "type": "object" } }, "foreignCol": { "type": "string" }, "foreignKeyName": { "type": "string" }, "foreignKeyTable": { "type": "string" }, "onDelete": { "type": "string" }, "onUpdate": { "type": "string" }, "relationName": { "type": "string" }, "relationType": { "type": "string" }, "unique": { "type": "boolean" }, "uniqueComposite": { "type": "string" } }, "title": "XFTRelation" }, "XFTRelationSpecification": { "type": "object", "properties": { "foreignCol": { "type": "string" }, "foreignKey": { "$ref": "#/definitions/GenericWrapperField" }, "foreignTable": { "type": "string" }, "localCol": { "type": "string" }, "localKey": { "$ref": "#/definitions/GenericWrapperField" }, "localTable": { "type": "string" }, "localXMLPath": { "type": "string" }, "schemaType": { "$ref": "#/definitions/XMLType" } }, "title": "XFTRelationSpecification" }, "XFTRule": { "type": "object", "properties": { "baseType": { "type": "string" }, "length": { "type": "string" }, "mask": { "type": "string" }, "maxInclusive": { "type": "string" }, "maxLength": { "type": "string" }, "message": { "type": "string" }, "minInclusive": { "type": "string" }, "minLength": { "type": "string" }, "possibleValues": { "type": "array", "items": { "type": "object" } } }, "title": "XFTRule" }, "XFTSchema": { "type": "object", "properties": { "dataModel": { "$ref": "#/definitions/XFTDataModel" }, "dbType": { "type": "string" }, "elementsByName": { "type": "object", "additionalProperties": { "type": "object" } }, "sortedElementNames": { "type": "array", "items": { "type": "string" } }, "sortedElements": { "type": "array", "items": { "type": "object" } }, "targetNamespacePrefix": { "type": "string" }, "targetNamespaceURI": { "type": "string" }, "webAppSchema": { "$ref": "#/definitions/XFTWebAppSchema" }, "xmlns": { "type": "string" } }, "title": "XFTSchema" }, "XFTSqlElement": { "type": "object", "properties": { "name": { "type": "string" } }, "title": "XFTSqlElement" }, "XFTSqlField": { "type": "object", "properties": { "autoIncrement": { "type": "string" }, "defaultValue": { "type": "string" }, "index": { "type": "string" }, "key": { "type": "string" }, "primaryKey": { "type": "string" }, "sqlName": { "type": "string" }, "type": { "type": "string" } }, "title": "XFTSqlField" }, "XFTSuperiorReference": { "type": "object", "properties": { "element1": { "$ref": "#/definitions/GenericWrapperElement" }, "element2": { "$ref": "#/definitions/GenericWrapperElement" }, "field1": { "$ref": "#/definitions/GenericWrapperField" }, "field2": { "$ref": "#/definitions/GenericWrapperField" }, "keyRelations": { "type": "array", "items": { "$ref": "#/definitions/XFTRelationSpecification" } }, "manyToMany": { "type": "boolean" }, "subordinateElement": { "$ref": "#/definitions/GenericWrapperElement" }, "subordinateElementName": { "type": "string" }, "subordinateField": { "$ref": "#/definitions/GenericWrapperField" }, "subordinateFieldSQLName": { "type": "string" }, "superiorElement": { "$ref": "#/definitions/GenericWrapperElement" }, "superiorElementLocalName": { "type": "string" }, "superiorElementName": { "type": "string" }, "superiorField": { "$ref": "#/definitions/GenericWrapperField" }, "superiorFieldSQLName": { "type": "string" } }, "title": "XFTSuperiorReference" }, "XFTWebAppElement": { "type": "object", "properties": { "idMethod": { "type": "string" }, "javaName": { "type": "string" } }, "title": "XFTWebAppElement" }, "XFTWebAppField": { "type": "object", "properties": { "javaName": { "type": "string" } }, "title": "XFTWebAppField" }, "XFTWebAppSchema": { "type": "object", "title": "XFTWebAppSchema" }, "XMLType": { "type": "object", "properties": { "foreignPrefix": { "type": "string" }, "foreignXMLNS": { "type": "string" }, "fullForeignType": { "type": "string" }, "fullLocalType": { "type": "string" }, "localPrefix": { "type": "string" }, "localType": { "type": "string" }, "localXMLNS": { "type": "string" }, "schema": { "$ref": "#/definitions/XFTSchema" } }, "title": "XMLType" }, "XdatUserAuth": { "title": "XdatUserAuth", "allOf": [ { "$ref": "#/definitions/UserAuthI" }, { "type": "object", "properties": { "accountNonExpired": { "type": "boolean" }, "accountNonLocked": { "type": "boolean" }, "authMethod": { "type": "string" }, "authMethodId": { "type": "string" }, "authUser": { "type": "string" }, "authorities": { "type": "array", "items": { "$ref": "#/definitions/GrantedAuthority" } }, "created": { "type": "string", "format": "date-time" }, "credentialsNonExpired": { "type": "boolean" }, "disabled": { "type": "string", "format": "date-time" }, "enabled": { "type": "boolean" }, "failedLoginAttempts": { "type": "integer", "format": "int32" }, "id": { "type": "integer", "format": "int64" }, "lastLoginAttempt": { "type": "string", "format": "date-time" }, "lastSuccessfulLogin": { "type": "string", "format": "date-time" }, "lockoutTime": { "type": "string", "format": "date-time" }, "passwordUpdated": { "type": "string", "format": "date-time" }, "timestamp": { "type": "string", "format": "date-time" }, "xdatUsername": { "type": "string" } }, "title": "XdatUserAuth" } ] }, "XnatAuthenticationProviderApiPojo": { "type": "object", "properties": { "authMethod": { "type": "string" }, "name": { "type": "string" }, "providerId": { "type": "string" } }, "title": "XnatAuthenticationProviderApiPojo" }, "XnatDataModelBean": { "type": "object", "properties": { "code": { "type": "string" }, "plural": { "type": "string" }, "secured": { "type": "boolean" }, "singular": { "type": "string" }, "type": { "type": "string" } }, "title": "XnatDataModelBean" }, "XnatFormsIOEnv": { "type": "object", "properties": { "features": { "type": "object", "additionalProperties": { "type": "object" } }, "siteHasProtocolsPluginDeployed": { "type": "boolean" } }, "title": "XnatFormsIOEnv" }, "XnatPluginBean": { "type": "object", "properties": { "beanName": { "type": "string" }, "dataModelBeans": { "type": "array", "items": { "$ref": "#/definitions/XnatDataModelBean" } }, "description": { "type": "string" }, "entityPackages": { "type": "array", "items": { "type": "string" } }, "extendedAttributes": { "$ref": "#/definitions/ListMultimap«string,string»" }, "id": { "type": "string" }, "logConfigurationFile": { "type": "string" }, "name": { "type": "string" }, "namespace": { "type": "string" }, "pluginClass": { "type": "string" }, "version": { "type": "string" } }, "title": "XnatPluginBean" } } }