Page tree
Skip to end of metadata
Go to start of metadata
{ "swagger": "2.0", "info": { "description": "The Automation Service (beta) API provides a way for XNAT to perform an automated action in response to an event", "version": "1.7.4.1", "title": "Automation Service API" }, "tags": [ { "name": "automation-api", "description": "Automation Service API" } ], "definitions": { }, "paths": { "/xapi/automation": { "get": { "tags": ["automation-api"], "summary": "Returns the full map of automation settings for this XNAT application.", "description": "Complex objects may be returned as encapsulated JSON strings.", "operationId": "getAllAutomationPreferencesUsingGET", "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "Automation settings successfully retrieved.", "schema": {"type": "string"} }, "401": {"description": "Must be authenticated to access the XNAT REST API."}, "500": {"description": "An unexpected error occurred."}, "403": {"description": "Insufficient privileges to retrieve the requested setting."}, "404": {"description": "Not Found"} } }, "post": { "tags": ["automation-api"], "summary": "Sets a map of automation properties.", "description": "Sets the automation properties specified in the map.", "operationId": "setBatchAutomationPreferencesUsingPOST", "consumes": [ "application/json", "application/x-www-form-urlencoded" ], "produces": ["*/*"], "parameters": [{ "in": "body", "name": "properties", "description": "The map of automation preferences to be set.", "required": true, "schema": { "type": "object", "additionalProperties": {"type": "string"} } }], "responses": { "200": {"description": "Automation properties successfully set."}, "201": {"description": "Created"}, "401": {"description": "Must be authenticated to access the XNAT REST API."}, "500": {"description": "An unexpected error occurred."}, "403": {"description": "Not authorized to set automation properties."}, "404": {"description": "Not Found"} } } }, "/xapi/automation/enabled": {"get": { "tags": ["automation-api"], "summary": "Returns whether internal scripting is enabled for this XNAT application.", "description": "Internal scripting may be used by XNAT itself even when disabled, but this setting indicates whether users and administrators can configure and execute scripts internally to the application process. Access to this setting is restricted to site administrators.", "operationId": "isInternalScriptingEnabledUsingGET", "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "Internal scripting setting successfully retrieved.", "schema": {"type": "boolean"} }, "401": {"description": "Must be authenticated to access the XNAT REST API."}, "500": {"description": "An unexpected error occurred."}, "403": {"description": "Insufficient privileges to retrieve the requested setting."}, "404": {"description": "Not Found"} } }}, "/xapi/automation/enabled/{setting}": {"put": { "tags": ["automation-api"], "summary": "Sets the internal scripting enabled flag for this XNAT application to the submitted value.", "description": "Internal scripting may be used by XNAT itself even when disabled, but this setting indicates whether users and administrators can configure and execute scripts internally to the application process. Access to this setting is restricted to site administrators.", "operationId": "setInternalScriptingEnabledUsingPUT", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "setting", "in": "path", "description": "setting", "required": true, "type": "boolean" }], "responses": { "200": { "description": "Internal scripting setting successfully set.", "schema": {"type": "boolean"} }, "201": {"description": "Created"}, "401": {"description": "Must be authenticated to access the XNAT REST API."}, "500": {"description": "An unexpected error occurred."}, "403": {"description": "Insufficient privileges to change the requested setting."}, "404": {"description": "Not Found"} } }}, } }



  • No labels