Container Service API


The Container Service API swagger documentation can also be accessed inside your XNAT at https://{XNAT_HOME_URL}/xapi/swagger-ui.html. From that UI, you can execute all the API calls.



{"info": {"version": "1.5.0", "contact": {"name": "John Flavin", "email": "jflavin@wustl.edu"}, "description": "XAPI endpoints for the XNAT Container Service", "license": {"url": "https://github.com/NrgXnat/container-service/blob/master/LICENSE.md", "name": "BSD 2-Clause"}, "title": "Container Service API"}, "paths": {"/docker/images/{id}": {"delete": {"responses": {"200": {"description": "Image was removed"}, "404": {"description": "No docker image with given id on docker server"}, "424": {"description": "Admin must set up Docker server."}, "500": {"description": "Unexpected error"}}, "parameters": [{"required": true, "type": "string", "name": "id", "in": "path"}, {"required": true, "type": "boolean", "name": "force", "in": "query"}], "tags": ["Docker API for XNAT Container Service"], "description": "Remove information about a Docker image", "summary": "Delete Docker image", "operationId": "deleteImage"}, "get": {"responses": {"200": {"description": "Found the image", "schema": {"$ref": "#/definitions/DockerImage"}}, "404": {"description": "No docker image with given id on the server"}, "424": {"description": "Admin must set up Docker server."}, "500": {"description": "Unexpected error"}}, "description": "Retrieve information about a Docker image from the docker server", "parameters": [{"required": true, "type": "string", "name": "id", "in": "path"}], "produces": ["application/json;charset=UTF-8"], "tags": ["Docker API for XNAT Container Service"], "summary": "Get Docker image", "operationId": "getImage"}}, "/commandeventmapping/{id}": {"delete": {"responses": {"204": {"description": "successful operation", "schema": {"type": "string"}}}, "parameters": [{"format": "int64", "required": true, "type": "integer", "name": "id", "in": "path"}], "tags": ["Command Event Mapping API for XNAT Container Service"], "description": "", "summary": "Delete a Command-Event Mapping", "operationId": "delete"}, "get": {"responses": {"200": {"description": "successful operation", "schema": {"$ref": "#/definitions/CommandEventMapping"}}}, "parameters": [{"format": "int64", "required": true, "type": "integer", "name": "id", "in": "path"}], "tags": ["Command Event Mapping API for XNAT Container Service"], "description": "", "summary": "Get a Command-Event-Mapping", "operationId": "retrieve"}}, "/wrappers/{wrapperId}/disabled": {"put": {"responses": {"default": {"description": "successful operation"}}, "parameters": [{"format": "int64", "required": true, "type": "integer", "name": "wrapperId", "in": "path"}, {"required": false, "type": "string", "name": "reason", "in": "query"}], "tags": ["Command Configuration API for XNAT Container service"], "description": "", "summary": "Disable (site)", "operationId": "disableConfiguration"}}, "/commands/{commandId}/wrappers/{wrapperName}/launch": {"post": {"responses": {"200": {"description": "successful operation", "schema": {"$ref": "#/definitions/LaunchReport"}}}, "description": "", "parameters": [{"format": "int64", "required": true, "type": "integer", "name": "commandId", "in": "path"}, {"required": true, "type": "string", "name": "wrapperName", "in": "path"}, {"schema": {"additionalProperties": {"type": "string"}, "type": "object"}, "required": false, "name": "body", "in": "body"}], "tags": ["API for Launching Containers with XNAT Container service"], "summary": "Resolve a command from the variable values in the request body, and launch it", "consumes": ["application/json;charset=UTF-8"], "operationId": "launchCommandWJsonBody"}, "get": {"responses": {"200": {"description": "successful operation", "schema": {"$ref": "#/definitions/SingleLaunchUi"}}}, "parameters": [{"format": "int64", "required": true, "type": "integer", "name": "commandId", "in": "path"}, {"required": true, "type": "string", "name": "wrapperName", "in": "path"}, {"required": true, "type": "object", "name": "allRequestParams", "in": "query"}], "tags": ["API for Launching Containers with XNAT Container service"], "description": "DOES NOT WORK PROPERLY IN SWAGGER UI", "summary": "Get Launch UI for wrapper", "operationId": "getLaunchUi"}}, "/commands/{commandId}/wrappers/{wrapperName}/enabled": {"put": {"responses": {"default": {"description": "successful operation"}}, "parameters": [{"format": "int64", "required": true, "type": "integer", "name": "commandId", "in": "path"}, {"required": true, "type": "string", "name": "wrapperName", "in": "path"}, {"required": false, "type": "string", "name": "reason", "in": "query"}], "tags": ["Command Configuration API for XNAT Container service"], "description": "", "summary": "Enable (site)", "operationId": "enableConfiguration"}, "get": {"responses": {"200": {"description": "successful operation", "schema": {"type": "boolean"}}}, "parameters": [{"format": "int64", "required": true, "type": "integer", "name": "commandId", "in": "path"}, {"required": true, "type": "string", "name": "wrapperName", "in": "path"}], "tags": ["Command Configuration API for XNAT Container service"], "description": "", "summary": "Is Enabled (site)", "operationId": "isConfigurationEnabled"}}, "/projects/{project}/wrappers/{wrapperId}/enabled": {"put": {"responses": {"default": {"description": "successful operation"}}, "parameters": [{"required": true, "type": "string", "name": "project", "in": "path"}, {"format": "int64", "required": true, "type": "integer", "name": "wrapperId", "in": "path"}, {"required": false, "type": "string", "name": "reason", "in": "query"}], "tags": ["Command Configuration API for XNAT Container service"], "description": "", "summary": "Enable (project)", "operationId": "enableConfiguration"}, "get": {"responses": {"200": {"description": "successful operation", "schema": {"$ref": "#/definitions/ProjectEnabledReport"}}}, "parameters": [{"required": true, "type": "string", "name": "project", "in": "path"}, {"format": "int64", "required": true, "type": "integer", "name": "wrapperId", "in": "path"}], "tags": ["Command Configuration API for XNAT Container service"], "description": "", "summary": "Is Enabled (project)", "operationId": "isConfigurationEnabled"}}, "/docker/hubs": {"post": {"responses": {"201": {"description": "successful operation", "schema": {"$ref": "#/definitions/DockerHubWithPing"}}}, "parameters": [{"schema": {"$ref": "#/definitions/DockerHub"}, "required": false, "name": "body", "in": "body"}, {"required": true, "type": "boolean", "name": "default", "in": "query"}, {"required": true, "type": "string", "name": "reason", "in": "query"}], "tags": ["Docker API for XNAT Container Service"], "description": "", "summary": "Create new Docker Hub", "operationId": "createHub"}, "get": {"operationId": "getHubs", "responses": {"200": {"description": "successful operation", "schema": {"items": {"$ref": "#/definitions/DockerHubWithPing"}, "type": "array"}}}, "summary": "Get Docker Hubs", "description": "", "tags": ["Docker API for XNAT Container Service"]}}, "/wrappers/{wrapperId}": {"delete": {"responses": {"default": {"description": "successful operation"}}, "parameters": [{"format": "int64", "required": true, "type": "integer", "name": "wrapperId", "in": "path"}], "tags": ["Command API for XNAT Container Service"], "description": "", "summary": "Delete a Command Wrapper", "operationId": "deleteWrapper"}}, "/commands/{commandId}/wrappers/{wrapperName}/config": {"post": {"responses": {"default": {"description": "successful operation"}}, "parameters": [{"schema": {"$ref": "#/definitions/CommandConfiguration"}, "required": false, "name": "body", "in": "body"}, {"format": "int64", "required": true, "type": "integer", "name": "commandId", "in": "path"}, {"required": true, "type": "string", "name": "wrapperName", "in": "path"}, {"required": false, "type": "boolean", "name": "enable", "in": "query"}, {"required": false, "type": "string", "name": "reason", "in": "query"}], "tags": ["Command Configuration API for XNAT Container service"], "description": "", "summary": "Configure (site)", "operationId": "createConfiguration"}, "delete": {"responses": {"default": {"description": "successful operation"}}, "parameters": [{"format": "int64", "required": true, "type": "integer", "name": "commandId", "in": "path"}, {"required": true, "type": "string", "name": "wrapperName", "in": "path"}], "tags": ["Command Configuration API for XNAT Container service"], "description": "", "summary": "Delete (site)", "operationId": "deleteConfiguration"}, "get": {"responses": {"200": {"description": "successful operation", "schema": {"$ref": "#/definitions/CommandConfiguration"}}}, "parameters": [{"format": "int64", "required": true, "type": "integer", "name": "commandId", "in": "path"}, {"required": true, "type": "string", "name": "wrapperName", "in": "path"}], "tags": ["Command Configuration API for XNAT Container service"], "description": "", "summary": "Get (site)", "operationId": "getConfiguration"}}, "/docker/hubs/{name}": {"delete": {"responses": {"default": {"description": "successful operation"}}, "parameters": [{"pattern": "\\d*[^\\d]+\\d*", "required": true, "type": "string", "name": "name", "in": "path"}], "tags": ["Docker API for XNAT Container Service"], "description": "", "summary": "Delete Docker Hub by Name", "operationId": "deleteHub"}, "get": {"responses": {"200": {"description": "successful operation", "schema": {"$ref": "#/definitions/DockerHubWithPing"}}}, "parameters": [{"pattern": "\\d*[^\\d]+\\d*", "required": true, "type": "string", "name": "name", "in": "path"}], "tags": ["Docker API for XNAT Container Service"], "description": "", "summary": "Get Docker Hub by Name", "operationId": "getHub"}}, "/projects/{project}/wrappers/{wrapperId}/disabled": {"put": {"responses": {"default": {"description": "successful operation"}}, "parameters": [{"required": true, "type": "string", "name": "project", "in": "path"}, {"format": "int64", "required": true, "type": "integer", "name": "wrapperId", "in": "path"}, {"required": false, "type": "string", "name": "reason", "in": "query"}], "tags": ["Command Configuration API for XNAT Container service"], "description": "", "summary": "Disable (project)", "operationId": "disableConfiguration"}}, "/commands/available": {"get": {"responses": {"200": {"description": "successful operation", "schema": {"items": {"$ref": "#/definitions/CommandSummaryForContext"}, "type": "array"}}}, "parameters": [{"required": true, "type": "string", "name": "project", "in": "query"}, {"required": true, "type": "string", "name": "xsiType", "in": "query"}], "tags": ["Command API for XNAT Container Service"], "description": "", "summary": "Get Commands available in given project context and XSIType", "operationId": "availableCommands"}}, "/projects/{project}/wrappers/{wrapperId}/config": {"post": {"responses": {"default": {"description": "successful operation"}}, "parameters": [{"schema": {"$ref": "#/definitions/CommandConfiguration"}, "required": false, "name": "body", "in": "body"}, {"required": true, "type": "string", "name": "project", "in": "path"}, {"format": "int64", "required": true, "type": "integer", "name": "wrapperId", "in": "path"}, {"required": false, "type": "boolean", "name": "enable", "in": "query"}, {"required": false, "type": "string", "name": "reason", "in": "query"}], "tags": ["Command Configuration API for XNAT Container service"], "description": "", "summary": "Configure (project)", "operationId": "createConfiguration"}, "delete": {"responses": {"default": {"description": "successful operation"}}, "parameters": [{"required": true, "type": "string", "name": "project", "in": "path"}, {"format": "int64", "required": true, "type": "integer", "name": "wrapperId", "in": "path"}], "tags": ["Command Configuration API for XNAT Container service"], "description": "", "summary": "Delete (project)", "operationId": "deleteConfiguration"}, "get": {"responses": {"200": {"description": "successful operation", "schema": {"$ref": "#/definitions/CommandConfiguration"}}}, "parameters": [{"required": true, "type": "string", "name": "project", "in": "path"}, {"format": "int64", "required": true, "type": "integer", "name": "wrapperId", "in": "path"}], "tags": ["Command Configuration API for XNAT Container service"], "description": "", "summary": "Get (project)", "operationId": "getConfiguration"}}, "/commandeventmapping": {"post": {"responses": {"201": {"description": "successful operation", "schema": {"$ref": "#/definitions/CommandEventMapping"}}}, "parameters": [{"schema": {"$ref": "#/definitions/CommandEventMapping"}, "required": false, "name": "body", "in": "body"}], "tags": ["Command Event Mapping API for XNAT Container Service"], "description": "", "summary": "Create a Command-Event Mapping", "operationId": "create"}, "get": {"operationId": "getMappings", "responses": {"200": {"description": "successful operation", "schema": {"items": {"$ref": "#/definitions/CommandEventMapping"}, "type": "array"}}}, "summary": "Get all Command-Event Mappings", "description": "", "tags": ["Command Event Mapping API for XNAT Container Service"]}}, "/docker/images": {"get": {"responses": {"200": {"description": "A list of images on the server", "schema": {"items": {"$ref": "#/definitions/DockerImage"}, "type": "array"}}, "424": {"description": "Admin must set up Docker server."}, "500": {"description": "Unexpected error"}}, "produces": ["application/json;charset=UTF-8"], "description": "Returns a list of all Docker images on the Docker server.", "tags": ["Docker API for XNAT Container Service"], "summary": "Get list of images.", "operationId": "getImages"}}, "/docker/hubs/{name}/pull": {"post": {"responses": {"default": {"description": "successful operation"}}, "parameters": [{"pattern": "\\d*[^\\d]+\\d*", "required": true, "type": "string", "name": "name", "in": "path"}, {"required": true, "type": "string", "name": "image", "in": "query"}, {"required": true, "type": "boolean", "name": "save-commands", "in": "query"}, {"required": false, "type": "string", "name": "username", "in": "query"}, {"required": false, "type": "string", "name": "password", "in": "query"}], "tags": ["Docker API for XNAT Container Service"], "description": "", "summary": "Pull image from Docker Hub by Name", "operationId": "pullImageFromHub"}}, "/projects/{project}/commands/{commandId}/wrappers/{wrapperName}/config": {"post": {"responses": {"default": {"description": "successful operation"}}, "parameters": [{"schema": {"$ref": "#/definitions/CommandConfiguration"}, "required": false, "name": "body", "in": "body"}, {"required": true, "type": "string", "name": "project", "in": "path"}, {"format": "int64", "required": true, "type": "integer", "name": "commandId", "in": "path"}, {"required": true, "type": "string", "name": "wrapperName", "in": "path"}, {"required": false, "type": "boolean", "name": "enable", "in": "query"}, {"required": false, "type": "string", "name": "reason", "in": "query"}], "tags": ["Command Configuration API for XNAT Container service"], "description": "", "summary": "Configure (project)", "operationId": "createConfiguration"}, "delete": {"responses": {"default": {"description": "successful operation"}}, "parameters": [{"required": true, "type": "string", "name": "project", "in": "path"}, {"format": "int64", "required": true, "type": "integer", "name": "commandId", "in": "path"}, {"required": true, "type": "string", "name": "wrapperName", "in": "path"}], "tags": ["Command Configuration API for XNAT Container service"], "description": "", "summary": "Delete (project)", "operationId": "deleteConfiguration"}, "get": {"responses": {"200": {"description": "successful operation", "schema": {"$ref": "#/definitions/CommandConfiguration"}}}, "parameters": [{"required": true, "type": "string", "name": "project", "in": "path"}, {"format": "int64", "required": true, "type": "integer", "name": "commandId", "in": "path"}, {"required": true, "type": "string", "name": "wrapperName", "in": "path"}], "tags": ["Command Configuration API for XNAT Container service"], "description": "", "summary": "Get (project)", "operationId": "getConfiguration"}}, "/docker/image-summaries": {"get": {"responses": {"200": {"description": "successful operation", "schema": {"items": {"$ref": "#/definitions/DockerImageAndCommandSummary"}, "type": "array"}}}, "produces": ["application/json;charset=UTF-8"], "description": "", "tags": ["Docker API for XNAT Container Service"], "summary": "Get summary list of images and commands.", "operationId": "getImageSummaries"}}, "/projects/{project}/commands/{commandId}/wrappers/{wrapperName}/launch": {"post": {"responses": {"200": {"description": "successful operation", "schema": {"$ref": "#/definitions/LaunchReport"}}}, "description": "", "parameters": [{"required": true, "type": "string", "name": "project", "in": "path"}, {"format": "int64", "required": true, "type": "integer", "name": "commandId", "in": "path"}, {"required": true, "type": "string", "name": "wrapperName", "in": "path"}, {"schema": {"additionalProperties": {"type": "string"}, "type": "object"}, "required": false, "name": "body", "in": "body"}], "tags": ["API for Launching Containers with XNAT Container service"], "summary": "Resolve a command from the variable values in the request body, and launch it", "consumes": ["application/json;charset=UTF-8"], "operationId": "launchCommandWJsonBody"}, "get": {"responses": {"200": {"description": "successful operation", "schema": {"$ref": "#/definitions/SingleLaunchUi"}}}, "parameters": [{"required": true, "type": "string", "name": "project", "in": "path"}, {"format": "int64", "required": true, "type": "integer", "name": "commandId", "in": "path"}, {"required": true, "type": "string", "name": "wrapperName", "in": "path"}, {"required": true, "type": "object", "name": "allRequestParams", "in": "query"}], "tags": ["API for Launching Containers with XNAT Container service"], "description": "DOES NOT WORK PROPERLY IN SWAGGER UI", "summary": "Get Launch UI for wrapper", "operationId": "getLaunchUi"}}, "/wrappers/{wrapperId}/bulklaunch": {"post": {"responses": {"200": {"description": "successful operation", "schema": {"$ref": "#/definitions/BulkLaunchReport"}}}, "description": "", "parameters": [{"format": "int64", "required": true, "type": "integer", "name": "wrapperId", "in": "path"}, {"schema": {"items": {"additionalProperties": {"type": "string"}, "type": "object"}, "type": "array"}, "required": false, "name": "body", "in": "body"}], "tags": ["API for Launching Containers with XNAT Container service"], "summary": "Resolve a command from the variable values in the request body, and launch it", "consumes": ["application/json;charset=UTF-8"], "operationId": "bulklaunch"}, "get": {"responses": {"200": {"description": "successful operation", "schema": {"$ref": "#/definitions/BulkLaunchUi"}}}, "parameters": [{"format": "int64", "required": true, "type": "integer", "name": "wrapperId", "in": "path"}, {"required": true, "type": "object", "name": "allRequestParams", "in": "query"}], "tags": ["API for Launching Containers with XNAT Container service"], "description": "DOES NOT WORK PROPERLY IN SWAGGER UI", "summary": "Get Bulk Launch UI for wrapper", "operationId": "getBulkLaunchUi"}}, "/wrappers/{wrapperId}/config": {"post": {"responses": {"default": {"description": "successful operation"}}, "parameters": [{"schema": {"$ref": "#/definitions/CommandConfiguration"}, "required": false, "name": "body", "in": "body"}, {"format": "int64", "required": true, "type": "integer", "name": "wrapperId", "in": "path"}, {"required": false, "type": "boolean", "name": "enable", "in": "query"}, {"required": false, "type": "string", "name": "reason", "in": "query"}], "tags": ["Command Configuration API for XNAT Container service"], "description": "", "summary": "Configure (site)", "operationId": "createConfiguration"}, "delete": {"responses": {"default": {"description": "successful operation"}}, "parameters": [{"format": "int64", "required": true, "type": "integer", "name": "wrapperId", "in": "path"}], "tags": ["Command Configuration API for XNAT Container service"], "description": "", "summary": "Delete (site)", "operationId": "deleteConfiguration"}, "get": {"responses": {"200": {"description": "successful operation", "schema": {"$ref": "#/definitions/CommandConfiguration"}}}, "parameters": [{"format": "int64", "required": true, "type": "integer", "name": "wrapperId", "in": "path"}], "tags": ["Command Configuration API for XNAT Container service"], "description": "", "summary": "Get (site)", "operationId": "getConfiguration"}}, "/projects/{project}/commands/{commandId}/wrappers/{wrapperName}/enabled": {"put": {"responses": {"default": {"description": "successful operation"}}, "parameters": [{"required": true, "type": "string", "name": "project", "in": "path"}, {"format": "int64", "required": true, "type": "integer", "name": "commandId", "in": "path"}, {"required": true, "type": "string", "name": "wrapperName", "in": "path"}, {"required": false, "type": "string", "name": "reason", "in": "query"}], "tags": ["Command Configuration API for XNAT Container service"], "description": "", "summary": "Enable (project)", "operationId": "enableConfiguration"}, "get": {"responses": {"200": {"description": "successful operation", "schema": {"$ref": "#/definitions/ProjectEnabledReport"}}}, "parameters": [{"required": true, "type": "string", "name": "project", "in": "path"}, {"format": "int64", "required": true, "type": "integer", "name": "commandId", "in": "path"}, {"required": true, "type": "string", "name": "wrapperName", "in": "path"}], "tags": ["Command Configuration API for XNAT Container service"], "description": "", "summary": "Is Enabled (project)", "operationId": "isConfigurationEnabled"}}, "/commandeventmapping/{id}/disable": {"put": {"responses": {"default": {"description": "successful operation"}}, "parameters": [{"format": "int64", "required": true, "type": "integer", "name": "id", "in": "path"}], "tags": ["Command Event Mapping API for XNAT Container Service"], "description": "", "summary": "Disable a Command-Event Mapping", "operationId": "disable"}}, "/projects/{project}/commands/{commandId}/wrappers/{wrapperName}/disabled": {"put": {"responses": {"default": {"description": "successful operation"}}, "parameters": [{"required": true, "type": "string", "name": "project", "in": "path"}, {"format": "int64", "required": true, "type": "integer", "name": "commandId", "in": "path"}, {"required": true, "type": "string", "name": "wrapperName", "in": "path"}, {"required": false, "type": "string", "name": "reason", "in": "query"}], "tags": ["Command Configuration API for XNAT Container service"], "description": "", "summary": "Disable (project)", "operationId": "disableConfiguration"}}, "/docker/hubs/{id}/ping": {"get": {"responses": {"200": {"description": "successful operation", "schema": {"type": "string"}}}, "parameters": [{"name": "id", "format": "int64", "pattern": "\\d+", "required": true, "in": "path", "type": "integer"}, {"required": false, "type": "string", "name": "username", "in": "query"}, {"required": false, "type": "string", "name": "password", "in": "query"}], "tags": ["Docker API for XNAT Container Service"], "description": "Returns \"OK\" on success.", "summary": "Ping Docker Hub by ID", "operationId": "pingHub"}}, "/projects/{project}/wrapper/{wrapperId}/launch": {"post": {"responses": {"200": {"description": "successful operation", "schema": {"$ref": "#/definitions/LaunchReport"}}}, "parameters": [{"required": true, "type": "string", "name": "project", "in": "path"}, {"format": "int64", "required": true, "type": "integer", "name": "wrapperId", "in": "path"}, {"required": true, "type": "object", "name": "allRequestParams", "in": "query"}], "tags": ["API for Launching Containers with XNAT Container service"], "description": "DOES NOT WORK PROPERLY IN SWAGGER UI", "summary": "Resolve a command from the variable values in the query params, and launch it", "operationId": "launchCommandWQueryParams"}}, "/docker/server/ping": {"get": {"operationId": "pingServer", "responses": {"200": {"description": "successful operation", "schema": {"type": "string"}}}, "summary": "Ping docker server.", "description": "Returns \"OK\" on success.", "tags": ["Docker API for XNAT Container Service"]}}, "/commands/{commandId}/wrappers/{wrapperId}": {"post": {"responses": {"default": {"description": "successful operation"}}, "parameters": [{"schema": {"$ref": "#/definitions/CommandWrapper"}, "required": false, "name": "body", "in": "body"}, {"format": "int64", "required": true, "type": "integer", "name": "commandId", "in": "path"}, {"format": "int64", "required": true, "type": "integer", "name": "wrapperId", "in": "path"}], "tags": ["Command API for XNAT Container Service"], "description": "", "summary": "Update a Command Wrapper", "operationId": "updateWrapper"}}, "/docker/pull": {"post": {"responses": {"default": {"description": "successful operation"}}, "parameters": [{"required": true, "type": "string", "name": "image", "in": "query"}, {"required": true, "type": "boolean", "name": "save-commands", "in": "query"}], "tags": ["Docker API for XNAT Container Service"], "description": "", "summary": "Pull image from default Docker Hub", "operationId": "pullImageFromDefaultHub"}}, "/commands": {"post": {"responses": {"201": {"description": "successful operation", "schema": {"type": "integer", "format": "int64"}}}, "description": "", "parameters": [{"required": false, "type": "string", "name": "image", "in": "query"}, {"schema": {"$ref": "#/definitions/CommandCreation"}, "required": false, "name": "body", "in": "body"}], "produces": ["application/json;charset=UTF-8"], "tags": ["Command API for XNAT Container Service"], "summary": "Create a Command", "operationId": "createCommand"}, "get": {"responses": {"200": {"description": "successful operation", "schema": {"items": {"$ref": "#/definitions/Command"}, "type": "array"}}}, "parameters": [{"required": false, "type": "string", "name": "name", "in": "query"}, {"required": false, "type": "string", "name": "version", "in": "query"}, {"required": false, "type": "string", "name": "image", "in": "query"}], "tags": ["Command API for XNAT Container Service"], "description": "", "summary": "Get Commands by criteria", "operationId": "getCommands"}}, "/wrappers/{wrapperId}/enabled": {"put": {"responses": {"default": {"description": "successful operation"}}, "parameters": [{"format": "int64", "required": true, "type": "integer", "name": "wrapperId", "in": "path"}, {"required": false, "type": "string", "name": "reason", "in": "query"}], "tags": ["Command Configuration API for XNAT Container service"], "description": "", "summary": "Enable (site)", "operationId": "enableConfiguration"}, "get": {"responses": {"200": {"description": "successful operation", "schema": {"type": "boolean"}}}, "parameters": [{"format": "int64", "required": true, "type": "integer", "name": "wrapperId", "in": "path"}], "tags": ["Command Configuration API for XNAT Container service"], "description": "", "summary": "Is Enabled (site)", "operationId": "isConfigurationEnabled"}}, "/commands/{id}": {"post": {"responses": {"default": {"description": "successful operation"}}, "parameters": [{"schema": {"$ref": "#/definitions/Command"}, "required": false, "name": "body", "in": "body"}, {"format": "int64", "required": true, "type": "integer", "name": "id", "in": "path"}], "tags": ["Command API for XNAT Container Service"], "description": "", "summary": "Update a Command", "operationId": "updateCommand"}, "delete": {"responses": {"default": {"description": "successful operation"}}, "parameters": [{"format": "int64", "required": true, "type": "integer", "name": "id", "in": "path"}], "tags": ["Command API for XNAT Container Service"], "description": "", "summary": "Delete a Command", "operationId": "delete"}, "get": {"responses": {"200": {"description": "successful operation", "schema": {"$ref": "#/definitions/Command"}}}, "parameters": [{"format": "int64", "required": true, "type": "integer", "name": "id", "in": "path"}], "tags": ["Command API for XNAT Container Service"], "description": "", "summary": "Get a Command by ID", "operationId": "retrieveCommand"}}, "/commands/{id}/wrappers": {"post": {"responses": {"201": {"description": "successful operation", "schema": {"type": "integer", "format": "int64"}}}, "description": "", "parameters": [{"schema": {"$ref": "#/definitions/CommandWrapperCreation"}, "required": false, "name": "body", "in": "body"}, {"format": "int64", "required": true, "type": "integer", "name": "id", "in": "path"}], "produces": ["application/json;charset=UTF-8"], "tags": ["Command API for XNAT Container Service"], "summary": "Create a Command Wrapper", "operationId": "createWrapper"}}, "/docker/hubs/{id}/pull": {"post": {"responses": {"default": {"description": "successful operation"}}, "parameters": [{"name": "id", "format": "int64", "pattern": "\\d+", "required": true, "in": "path", "type": "integer"}, {"required": true, "type": "string", "name": "image", "in": "query"}, {"required": true, "type": "boolean", "name": "save-commands", "in": "query"}, {"required": false, "type": "string", "name": "username", "in": "query"}, {"required": false, "type": "string", "name": "password", "in": "query"}], "tags": ["Docker API for XNAT Container Service"], "description": "", "summary": "Pull image from Docker Hub by ID", "operationId": "pullImageFromHub"}}, "/projects/{project}/commands/{commandId}/wrappers/{wrapperName}/bulklaunch": {"post": {"responses": {"200": {"description": "successful operation", "schema": {"$ref": "#/definitions/BulkLaunchReport"}}}, "description": "", "parameters": [{"required": true, "type": "string", "name": "project", "in": "path"}, {"format": "int64", "required": true, "type": "integer", "name": "commandId", "in": "path"}, {"required": true, "type": "string", "name": "wrapperName", "in": "path"}, {"schema": {"items": {"additionalProperties": {"type": "string"}, "type": "object"}, "type": "array"}, "required": false, "name": "body", "in": "body"}], "tags": ["API for Launching Containers with XNAT Container service"], "summary": "Resolve a command from the variable values in the request body, and launch it", "consumes": ["application/json;charset=UTF-8"], "operationId": "bulklaunch"}, "get": {"responses": {"200": {"description": "successful operation", "schema": {"$ref": "#/definitions/BulkLaunchUi"}}}, "parameters": [{"required": true, "type": "string", "name": "project", "in": "path"}, {"format": "int64", "required": true, "type": "integer", "name": "commandId", "in": "path"}, {"required": true, "type": "string", "name": "wrapperName", "in": "path"}, {"required": true, "type": "object", "name": "allRequestParams", "in": "query"}], "tags": ["API for Launching Containers with XNAT Container service"], "description": "DOES NOT WORK PROPERLY IN SWAGGER UI", "summary": "Get Bulk Launch UI for wrapper", "operationId": "getBulkLaunchUi"}}, "/docker/server": {"post": {"responses": {"201": {"description": "The Docker server configuration was saved"}, "200": {"description": "successful operation", "schema": {"$ref": "#/definitions/DockerServerWithPing"}}, "500": {"description": "Unexpected error"}, "400": {"description": "Must set the \"host\" property in request body"}}, "parameters": [{"schema": {"$ref": "#/definitions/DockerServer"}, "required": false, "name": "body", "in": "body"}], "tags": ["Docker API for XNAT Container Service"], "description": "Save new Docker server configuration values", "summary": "Set Docker server configuration", "operationId": "setServer"}, "get": {"responses": {"200": {"description": "The Docker server configuration", "schema": {"$ref": "#/definitions/DockerServer"}}, "500": {"description": "Unexpected error"}, "400": {"description": "The server has not been configured"}}, "produces": ["application/json;charset=UTF-8"], "description": "Returns Docker server configuration values", "tags": ["Docker API for XNAT Container Service"], "summary": "Docker server", "operationId": "getServer"}}, "/commands/available/site": {"get": {"responses": {"200": {"description": "successful operation", "schema": {"items": {"$ref": "#/definitions/CommandSummaryForContext"}, "type": "array"}}}, "parameters": [{"required": true, "type": "string", "name": "xsiType", "in": "query"}], "tags": ["Command API for XNAT Container Service"], "description": "", "summary": "Get Commands sitewide with given XSIType", "operationId": "availableCommands"}}, "/docker/images/save": {"post": {"responses": {"200": {"description": "successful operation", "schema": {"items": {"$ref": "#/definitions/Command"}, "type": "array"}}}, "parameters": [{"required": true, "type": "string", "name": "image", "in": "query"}], "tags": ["Docker API for XNAT Container Service"], "description": "Read labels from Docker image. If any labels contain key org.nrg.commands, parse value as list of Commands.", "summary": "Save Commands from labels", "operationId": "saveFromLabels"}}, "/projects/{project}/wrappers/{wrapperId}/bulklaunch": {"post": {"responses": {"200": {"description": "successful operation", "schema": {"$ref": "#/definitions/BulkLaunchReport"}}}, "description": "", "parameters": [{"required": true, "type": "string", "name": "project", "in": "path"}, {"format": "int64", "required": true, "type": "integer", "name": "wrapperId", "in": "path"}, {"schema": {"items": {"additionalProperties": {"type": "string"}, "type": "object"}, "type": "array"}, "required": false, "name": "body", "in": "body"}], "tags": ["API for Launching Containers with XNAT Container service"], "summary": "Resolve a command from the variable values in the request body, and launch it", "consumes": ["application/json;charset=UTF-8"], "operationId": "bulklaunch"}, "get": {"responses": {"200": {"description": "successful operation", "schema": {"$ref": "#/definitions/BulkLaunchUi"}}}, "parameters": [{"required": true, "type": "string", "name": "project", "in": "path"}, {"format": "int64", "required": true, "type": "integer", "name": "wrapperId", "in": "path"}, {"required": true, "type": "object", "name": "allRequestParams", "in": "query"}], "tags": ["API for Launching Containers with XNAT Container service"], "description": "DOES NOT WORK PROPERLY IN SWAGGER UI", "summary": "Get Bulk Launch UI for wrapper", "operationId": "getBulkLaunchUi"}}, "/wrappers/{wrapperId}/launch": {"post": {"responses": {"200": {"description": "successful operation", "schema": {"$ref": "#/definitions/LaunchReport"}}}, "description": "", "parameters": [{"format": "int64", "required": true, "type": "integer", "name": "wrapperId", "in": "path"}, {"schema": {"additionalProperties": {"type": "string"}, "type": "object"}, "required": false, "name": "body", "in": "body"}], "tags": ["API for Launching Containers with XNAT Container service"], "summary": "Resolve a command from the variable values in the request body, and launch it", "consumes": ["application/json;charset=UTF-8"], "operationId": "launchCommandWJsonBody"}, "get": {"responses": {"200": {"description": "successful operation", "schema": {"$ref": "#/definitions/SingleLaunchUi"}}}, "parameters": [{"format": "int64", "required": true, "type": "integer", "name": "wrapperId", "in": "path"}, {"required": true, "type": "object", "name": "allRequestParams", "in": "query"}], "tags": ["API for Launching Containers with XNAT Container service"], "description": "DOES NOT WORK PROPERLY IN SWAGGER UI", "summary": "Get Launch UI for wrapper", "operationId": "getLaunchUi"}}, "/commands/{commandId}/wrappers/{wrapperName}/bulklaunch": {"post": {"responses": {"200": {"description": "successful operation", "schema": {"$ref": "#/definitions/BulkLaunchReport"}}}, "description": "", "parameters": [{"format": "int64", "required": true, "type": "integer", "name": "commandId", "in": "path"}, {"required": true, "type": "string", "name": "wrapperName", "in": "path"}, {"schema": {"items": {"additionalProperties": {"type": "string"}, "type": "object"}, "type": "array"}, "required": false, "name": "body", "in": "body"}], "tags": ["API for Launching Containers with XNAT Container service"], "summary": "Resolve a command from the variable values in the request body, and launch it", "consumes": ["application/json;charset=UTF-8"], "operationId": "bulklaunch"}, "get": {"responses": {"200": {"description": "successful operation", "schema": {"$ref": "#/definitions/BulkLaunchUi"}}}, "parameters": [{"format": "int64", "required": true, "type": "integer", "name": "commandId", "in": "path"}, {"required": true, "type": "string", "name": "wrapperName", "in": "path"}, {"required": true, "type": "object", "name": "allRequestParams", "in": "query"}], "tags": ["API for Launching Containers with XNAT Container service"], "description": "DOES NOT WORK PROPERLY IN SWAGGER UI", "summary": "Get Bulk Launch UI for wrapper", "operationId": "getBulkLaunchUi"}}, "/docker/hubs/{name}/ping": {"get": {"responses": {"200": {"description": "successful operation", "schema": {"type": "string"}}}, "parameters": [{"pattern": "\\d*[^\\d]+\\d*", "required": true, "type": "string", "name": "name", "in": "path"}, {"required": false, "type": "string", "name": "username", "in": "query"}, {"required": false, "type": "string", "name": "password", "in": "query"}], "tags": ["Docker API for XNAT Container Service"], "description": "Returns \"OK\" on success.", "summary": "Ping Docker Hub by Name", "operationId": "pingHub"}}, "/commandeventmapping/{id}/enable": {"put": {"responses": {"default": {"description": "successful operation"}}, "parameters": [{"format": "int64", "required": true, "type": "integer", "name": "id", "in": "path"}], "tags": ["Command Event Mapping API for XNAT Container Service"], "description": "", "summary": "Enable a Command-Event Mapping", "operationId": "enable"}}, "/docker/hubs/{id}": {"post": {"responses": {"default": {"description": "successful operation"}}, "parameters": [{"name": "id", "format": "int64", "pattern": "\\d+", "required": true, "in": "path", "type": "integer"}, {"schema": {"$ref": "#/definitions/DockerHub"}, "required": false, "name": "body", "in": "body"}, {"required": true, "type": "boolean", "name": "default", "in": "query"}, {"required": true, "type": "string", "name": "reason", "in": "query"}], "tags": ["Docker API for XNAT Container Service"], "description": "", "summary": "Update Docker Hub by ID", "operationId": "updateHub"}, "delete": {"responses": {"default": {"description": "successful operation"}}, "parameters": [{"name": "id", "format": "int64", "pattern": "\\d+", "required": true, "in": "path", "type": "integer"}], "tags": ["Docker API for XNAT Container Service"], "description": "", "summary": "Delete Docker Hub by ID", "operationId": "deleteHub"}, "get": {"responses": {"200": {"description": "successful operation", "schema": {"$ref": "#/definitions/DockerHubWithPing"}}}, "parameters": [{"name": "id", "format": "int64", "pattern": "\\d+", "required": true, "in": "path", "type": "integer"}], "tags": ["Docker API for XNAT Container Service"], "description": "", "summary": "Get Docker Hub by ID", "operationId": "getHub"}}, "/projects/{project}/wrappers/{wrapperId}/launch": {"post": {"responses": {"200": {"description": "successful operation", "schema": {"$ref": "#/definitions/LaunchReport"}}}, "description": "", "parameters": [{"required": true, "type": "string", "name": "project", "in": "path"}, {"format": "int64", "required": true, "type": "integer", "name": "wrapperId", "in": "path"}, {"schema": {"additionalProperties": {"type": "string"}, "type": "object"}, "required": false, "name": "body", "in": "body"}], "tags": ["API for Launching Containers with XNAT Container service"], "summary": "Resolve a command from the variable values in the request body, and launch it", "consumes": ["application/json;charset=UTF-8"], "operationId": "launchCommandWJsonBody"}, "get": {"responses": {"200": {"description": "successful operation", "schema": {"$ref": "#/definitions/SingleLaunchUi"}}}, "parameters": [{"required": true, "type": "string", "name": "project", "in": "path"}, {"format": "int64", "required": true, "type": "integer", "name": "wrapperId", "in": "path"}, {"required": true, "type": "object", "name": "allRequestParams", "in": "query"}], "tags": ["API for Launching Containers with XNAT Container service"], "description": "DOES NOT WORK PROPERLY IN SWAGGER UI", "summary": "Get Launch UI for wrapper", "operationId": "getLaunchUi"}}, "/commands/{commandId}/wrappers/{wrapperName}/disabled": {"put": {"responses": {"default": {"description": "successful operation"}}, "parameters": [{"format": "int64", "required": true, "type": "integer", "name": "commandId", "in": "path"}, {"required": true, "type": "string", "name": "wrapperName", "in": "path"}, {"required": false, "type": "string", "name": "reason", "in": "query"}], "tags": ["Command Configuration API for XNAT Container service"], "description": "", "summary": "Disable (site)", "operationId": "disableConfiguration"}}}, "schemes": ["http", "https"], "tags": [{"name": "API for Launching Containers with XNAT Container service"}, {"name": "Command API for XNAT Container Service"}, {"name": "Command Configuration API for XNAT Container service"}, {"name": "Command Event Mapping API for XNAT Container Service"}, {"name": "Docker API for XNAT Container Service"}], "basePath": "/xapi", "host": "xnat.org", "definitions": {"CommandConfiguration": {"type": "object", "properties": {"inputs": {"additionalProperties": {"$ref": "#/definitions/CommandInputConfiguration"}, "readOnly": true, "type": "object"}, "outputs": {"additionalProperties": {"$ref": "#/definitions/CommandOutputConfiguration"}, "readOnly": true, "type": "object"}}}, "DockerHub": {"type": "object", "properties": {"url": {"readOnly": true, "type": "string"}, "default": {"readOnly": true, "type": "boolean"}, "id": {"readOnly": true, "type": "integer", "format": "int64"}, "name": {"readOnly": true, "type": "string"}}}, "CommandOutputConfiguration": {"type": "object", "properties": {"type": {"readOnly": true, "type": "string"}, "label": {"readOnly": true, "type": "string"}}}, "BulkLaunchReport": {"type": "object", "properties": {"successes": {"items": {"$ref": "#/definitions/Success"}, "readOnly": true, "type": "array"}, "failures": {"items": {"$ref": "#/definitions/Failure"}, "readOnly": true, "type": "array"}}}, "DockerServerWithPing": {"type": "object", "properties": {"cert-path": {"readOnly": true, "type": "string"}, "name": {"readOnly": true, "type": "string"}, "ping": {"readOnly": true, "type": "boolean"}, "host": {"readOnly": true, "type": "string"}, "id": {"readOnly": true, "type": "integer", "format": "int64"}, "swarm-mode": {"readOnly": true, "type": "boolean"}}}, "LaunchUiInputValue": {"type": "object", "properties": {"value": {"readOnly": true, "type": "string"}, "label": {"readOnly": true, "type": "string"}}}, "CommandSummaryForContext": {"type": "object", "properties": {"command-description": {"readOnly": true, "type": "string"}, "wrapper-name": {"readOnly": true, "type": "string"}, "command-name": {"readOnly": true, "type": "string"}, "image-name": {"readOnly": true, "type": "string"}, "enabled": {"readOnly": true, "type": "boolean"}, "wrapper-description": {"readOnly": true, "type": "string"}, "command-id": {"readOnly": true, "type": "integer", "format": "int64"}, "image-type": {"readOnly": true, "type": "string"}, "root-element-name": {"readOnly": true, "type": "string"}, "wrapper-id": {"readOnly": true, "type": "integer", "format": "int64"}}}, "CommandWrapper": {"type": "object", "properties": {"description": {"readOnly": true, "type": "string"}, "contexts": {"uniqueItems": true, "items": {"type": "string"}, "readOnly": true, "type": "array"}, "name": {"readOnly": true, "type": "string"}, "output-handlers": {"items": {"$ref": "#/definitions/CommandWrapperOutput"}, "readOnly": true, "type": "array"}, "id": {"readOnly": true, "type": "integer", "format": "int64"}, "external-inputs": {"items": {"$ref": "#/definitions/CommandWrapperExternalInput"}, "readOnly": true, "type": "array"}, "derived-inputs": {"items": {"$ref": "#/definitions/CommandWrapperDerivedInput"}, "readOnly": true, "type": "array"}}}, "LaunchUiInput": {"type": "object", "properties": {"description": {"readOnly": true, "type": "string"}, "parent": {"readOnly": true, "type": "string"}, "required": {"readOnly": true, "type": "boolean"}, "label": {"readOnly": true, "type": "string"}, "ui": {"additionalProperties": {"$ref": "#/definitions/LaunchUiInputValuesAndType"}, "readOnly": true, "type": "object"}, "user-settable": {"readOnly": true, "type": "boolean"}, "children": {"items": {"type": "string"}, "readOnly": true, "type": "array"}, "advanced": {"readOnly": true, "type": "boolean"}}}, "Success": {"discriminator": "type", "type": "object", "properties": {"status": {"readOnly": true, "type": "string"}, "command-id": {"readOnly": true, "type": "integer", "format": "int64"}, "type": {"readOnly": true, "type": "string"}, "params": {"additionalProperties": {"type": "string"}, "readOnly": true, "type": "object"}, "wrapper-id": {"readOnly": true, "type": "integer", "format": "int64"}}}, "CommandCreation": {"type": "object", "properties": {"image": {"readOnly": true, "type": "string"}, "limit-cpu": {"readOnly": true, "type": "number", "format": "double"}, "info-url": {"readOnly": true, "type": "string"}, "index": {"readOnly": true, "type": "string"}, "command-line": {"readOnly": true, "type": "string"}, "label": {"readOnly": true, "type": "string"}, "version": {"readOnly": true, "type": "string"}, "environment-variables": {"additionalProperties": {"type": "string"}, "readOnly": true, "type": "object"}, "type": {"readOnly": true, "type": "string"}, "inputs": {"items": {"$ref": "#/definitions/CommandInput"}, "readOnly": true, "type": "array"}, "working-directory": {"readOnly": true, "type": "string"}, "hash": {"readOnly": true, "type": "string"}, "description": {"readOnly": true, "type": "string"}, "reserve-memory": {"readOnly": true, "type": "integer", "format": "int64"}, "outputs": {"items": {"$ref": "#/definitions/CommandOutput"}, "readOnly": true, "type": "array"}, "limit-memory": {"readOnly": true, "type": "integer", "format": "int64"}, "override-entrypoint": {"readOnly": true, "type": "boolean"}, "schema-version": {"readOnly": true, "type": "string"}, "name": {"readOnly": true, "type": "string"}, "xnat": {"items": {"$ref": "#/definitions/CommandWrapperCreation"}, "readOnly": true, "type": "array"}, "mounts": {"items": {"$ref": "#/definitions/CommandMount"}, "readOnly": true, "type": "array"}, "ports": {"additionalProperties": {"type": "string"}, "readOnly": true, "type": "object"}}}, "CommandOutput": {"type": "object", "properties": {"name": {"readOnly": true, "type": "string"}, "glob": {"readOnly": true, "type": "string"}, "required": {"readOnly": true, "type": "boolean"}, "path": {"readOnly": true, "type": "string"}, "mount": {"readOnly": true, "type": "string"}, "description": {"readOnly": true, "type": "string"}}}, "DockerImage": {"type": "object", "properties": {"labels": {"additionalProperties": {"type": "string"}, "readOnly": true, "type": "object"}, "tags": {"items": {"type": "string"}, "readOnly": true, "type": "array"}, "image-id": {"readOnly": true, "type": "string"}}, "description": "Properties that define an image."}, "Failure": {"type": "object", "properties": {"status": {"readOnly": true, "type": "string"}, "command-id": {"readOnly": true, "type": "integer", "format": "int64"}, "message": {"readOnly": true, "type": "string"}, "params": {"additionalProperties": {"type": "string"}, "readOnly": true, "type": "object"}, "wrapper-id": {"readOnly": true, "type": "integer", "format": "int64"}}}, "LaunchReport": {"type": "object", "properties": {"status": {"readOnly": true, "type": "string"}, "command-id": {"readOnly": true, "type": "integer", "format": "int64"}, "params": {"additionalProperties": {"type": "string"}, "readOnly": true, "type": "object"}, "wrapper-id": {"readOnly": true, "type": "integer", "format": "int64"}}}, "ServiceSuccess": {"allOf": [{"$ref": "#/definitions/Success"}, {"type": "object", "properties": {"service-id": {"readOnly": true, "type": "string"}}}]}, "CommandWrapperDerivedInput": {"type": "object", "properties": {"provides-value-for-command-input": {"readOnly": true, "type": "string"}, "name": {"readOnly": true, "type": "string"}, "default-value": {"readOnly": true, "type": "string"}, "derived-from-xnat-object-property": {"readOnly": true, "type": "string"}, "matcher": {"readOnly": true, "type": "string"}, "load-children": {"readOnly": true, "type": "boolean"}, "required": {"readOnly": true, "type": "boolean"}, "provides-files-for-command-mount": {"readOnly": true, "type": "string"}, "replacement-key": {"readOnly": true, "type": "string"}, "via-setup-command": {"readOnly": true, "type": "string"}, "user-settable": {"readOnly": true, "type": "boolean"}, "derived-from-wrapper-input": {"readOnly": true, "type": "string"}, "type": {"readOnly": true, "type": "string"}, "description": {"readOnly": true, "type": "string"}}}, "CommandInput": {"type": "object", "properties": {"command-line-flag": {"readOnly": true, "type": "string"}, "name": {"readOnly": true, "type": "string"}, "default-value": {"readOnly": true, "type": "string"}, "matcher": {"readOnly": true, "type": "string"}, "false-value": {"readOnly": true, "type": "string"}, "required": {"readOnly": true, "type": "boolean"}, "true-value": {"readOnly": true, "type": "string"}, "replacement-key": {"readOnly": true, "type": "string"}, "command-line-separator": {"readOnly": true, "type": "string"}, "type": {"readOnly": true, "type": "string"}, "description": {"readOnly": true, "type": "string"}}}, "ProjectEnabledReport": {"type": "object", "properties": {"project": {"readOnly": true, "type": "string"}, "enabled-for-project": {"readOnly": true, "type": "boolean"}, "enabled-for-site": {"readOnly": true, "type": "boolean"}}}, "DockerServer": {"type": "object", "properties": {"host": {"readOnly": true, "type": "string"}, "cert-path": {"readOnly": true, "type": "string"}, "id": {"readOnly": true, "type": "integer", "format": "int64"}, "swarm-mode": {"readOnly": true, "type": "boolean"}, "name": {"readOnly": true, "type": "string"}}}, "CommandMount": {"type": "object", "properties": {"writable": {"readOnly": true, "type": "boolean"}, "path": {"readOnly": true, "type": "string"}, "name": {"readOnly": true, "type": "string"}}}, "CommandInputConfiguration": {"type": "object", "properties": {"description": {"readOnly": true, "type": "string"}, "default-value": {"readOnly": true, "type": "string"}, "matcher": {"readOnly": true, "type": "string"}, "required": {"readOnly": true, "type": "boolean"}, "user-settable": {"readOnly": true, "type": "boolean"}, "type": {"readOnly": true, "type": "string"}, "advanced": {"readOnly": true, "type": "boolean"}}}, "LaunchUiInputValuesAndType": {"type": "object", "properties": {"values": {"items": {"$ref": "#/definitions/LaunchUiInputValue"}, "readOnly": true, "type": "array"}, "type": {"readOnly": true, "enum": ["DEFAULT", "TEXT", "NUMBER", "BOOLEAN", "SELECT", "HIDDEN", "STATIC"], "type": "string"}}}, "SingleLaunchUi": {"type": "object", "properties": {"command-description": {"readOnly": true, "type": "string"}, "wrapper-name": {"readOnly": true, "type": "string"}, "command-name": {"readOnly": true, "type": "string"}, "image-name": {"readOnly": true, "type": "string"}, "inputs": {"additionalProperties": {"$ref": "#/definitions/LaunchUiInput"}, "readOnly": true, "type": "object"}, "wrapper-description": {"readOnly": true, "type": "string"}, "command-id": {"readOnly": true, "type": "integer", "format": "int64"}, "image-type": {"readOnly": true, "type": "string"}, "wrapper-id": {"readOnly": true, "type": "integer", "format": "int64"}}}, "DockerHubWithPing": {"type": "object", "properties": {"url": {"readOnly": true, "type": "string"}, "default": {"readOnly": true, "type": "boolean"}, "ping": {"readOnly": true, "type": "boolean"}, "id": {"readOnly": true, "type": "integer", "format": "int64"}, "name": {"readOnly": true, "type": "string"}}}, "CommandWrapperOutput": {"type": "object", "properties": {"name": {"readOnly": true, "type": "string"}, "label": {"readOnly": true, "type": "string"}, "via-wrapup-command": {"readOnly": true, "type": "string"}, "accepts-command-output": {"readOnly": true, "type": "string"}, "type": {"readOnly": true, "type": "string"}, "as-a-child-of-wrapper-input": {"readOnly": true, "type": "string"}}}, "CommandWrapperCreation": {"type": "object", "properties": {"derived-inputs": {"items": {"$ref": "#/definitions/CommandWrapperDerivedInput"}, "readOnly": true, "type": "array"}, "contexts": {"uniqueItems": true, "items": {"type": "string"}, "readOnly": true, "type": "array"}, "description": {"readOnly": true, "type": "string"}, "output-handlers": {"items": {"$ref": "#/definitions/CommandWrapperOutput"}, "readOnly": true, "type": "array"}, "external-inputs": {"items": {"$ref": "#/definitions/CommandWrapperExternalInput"}, "readOnly": true, "type": "array"}, "name": {"readOnly": true, "type": "string"}}}, "DockerImageAndCommandSummary": {"type": "object", "properties": {"commands": {"items": {"$ref": "#/definitions/Command"}, "readOnly": true, "type": "array"}, "server": {"readOnly": true, "type": "string"}, "names": {"uniqueItems": true, "items": {"type": "string"}, "readOnly": true, "type": "array"}, "image-id": {"readOnly": true, "type": "string"}}}, "CommandWrapperExternalInput": {"type": "object", "properties": {"provides-value-for-command-input": {"readOnly": true, "type": "string"}, "name": {"readOnly": true, "type": "string"}, "default-value": {"readOnly": true, "type": "string"}, "matcher": {"readOnly": true, "type": "string"}, "required": {"readOnly": true, "type": "boolean"}, "provides-files-for-command-mount": {"readOnly": true, "type": "string"}, "replacement-key": {"readOnly": true, "type": "string"}, "via-setup-command": {"readOnly": true, "type": "string"}, "user-settable": {"readOnly": true, "type": "boolean"}, "load-children": {"readOnly": true, "type": "boolean"}, "type": {"readOnly": true, "type": "string"}, "description": {"readOnly": true, "type": "string"}}}, "BulkLaunchUi": {"type": "object", "properties": {"inputs": {"items": {"additionalProperties": {"$ref": "#/definitions/LaunchUiInput"}, "type": "object"}, "readOnly": true, "type": "array"}, "command-description": {"readOnly": true, "type": "string"}, "image-name": {"readOnly": true, "type": "string"}, "wrapper-description": {"readOnly": true, "type": "string"}, "command-name": {"readOnly": true, "type": "string"}, "image-type": {"readOnly": true, "type": "string"}, "command-id": {"readOnly": true, "type": "integer", "format": "int64"}, "wrapper-id": {"readOnly": true, "type": "integer", "format": "int64"}, "wrapper-name": {"readOnly": true, "type": "string"}}}, "CommandEventMapping": {"type": "object", "properties": {"project": {"type": "string"}, "created": {"type": "string", "format": "date-time"}, "timestamp": {"type": "string", "format": "date-time"}, "enabled": {"type": "boolean"}, "xnat-command-wrapper": {"type": "string"}, "disabled": {"type": "string", "format": "date-time"}, "command-id": {"type": "integer", "format": "int64"}, "event-type": {"type": "string"}, "id": {"type": "integer", "format": "int64"}, "subscription-user-name": {"type": "string"}}}, "Command": {"type": "object", "properties": {"image": {"readOnly": true, "type": "string"}, "limit-cpu": {"readOnly": true, "type": "number", "format": "double"}, "info-url": {"readOnly": true, "type": "string"}, "id": {"readOnly": true, "type": "integer", "format": "int64"}, "index": {"readOnly": true, "type": "string"}, "command-line": {"readOnly": true, "type": "string"}, "label": {"readOnly": true, "type": "string"}, "version": {"readOnly": true, "type": "string"}, "environment-variables": {"additionalProperties": {"type": "string"}, "readOnly": true, "type": "object"}, "type": {"readOnly": true, "type": "string"}, "inputs": {"items": {"$ref": "#/definitions/CommandInput"}, "readOnly": true, "type": "array"}, "working-directory": {"readOnly": true, "type": "string"}, "hash": {"readOnly": true, "type": "string"}, "description": {"readOnly": true, "type": "string"}, "reserve-memory": {"readOnly": true, "type": "integer", "format": "int64"}, "outputs": {"items": {"$ref": "#/definitions/CommandOutput"}, "readOnly": true, "type": "array"}, "limit-memory": {"readOnly": true, "type": "integer", "format": "int64"}, "override-entrypoint": {"readOnly": true, "type": "boolean"}, "schema-version": {"readOnly": true, "type": "string"}, "name": {"readOnly": true, "type": "string"}, "xnat": {"items": {"$ref": "#/definitions/CommandWrapper"}, "readOnly": true, "type": "array"}, "mounts": {"items": {"$ref": "#/definitions/CommandMount"}, "readOnly": true, "type": "array"}, "ports": {"additionalProperties": {"type": "string"}, "readOnly": true, "type": "object"}}}, "ContainerSuccess": {"allOf": [{"$ref": "#/definitions/Success"}, {"type": "object", "properties": {"container-id": {"readOnly": true, "type": "string"}}}]}}, "swagger": "2.0"}

$label.name