Page tree
Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Next »

XNAT plugin development and installation documentation can be found here:

{ "swagger": "2.0", "info": { "description": "The Plugins API was introduced in XNAT 1.7 to return summary information on installed plugins.", "version": "1.7.4.1", "title": "Plugin API" }, "tags": [ { "name": "xnat-plugin-api", "description": "Plugin API" }, { "name": "plugin-open-urls-configuration-api", "description": "Plugin Open URL Config API" } ], "definitions": { }, "paths": { "/xapi/plugins": {"get": { "tags": ["xnat-plugin-api"], "summary": "Returns a list of all of the installed and active XNAT plugins with their properties.", "description": "The maps returned from this call include all of the properties specified in the plugin's property file.", "operationId": "getAllDataTypeSchemasUsingGET_1", "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "XNAT plugin properties successfully retrieved.", "schema": {"type": "string"} }, "401": {"description": "Must be authenticated to access the XNAT REST API."}, "500": {"description": "Unexpected error"}, "403": {"description": "Forbidden"}, "404": {"description": "Not Found"} } }}, "/xapi/plugins/{plugin}": {"get": { "tags": ["xnat-plugin-api"], "summary": "Returns the indicated XNAT plugin with its properties.", "description": "The map returned from this call include all of the properties specified in the plugin's property file.", "operationId": "getRequestedDataTypeSchemaUsingGET_2", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "plugin", "in": "path", "description": "plugin", "required": true, "type": "string" }], "responses": { "200": { "description": "XNAT plugin properties successfully retrieved.", "schema": { "type": "object", "additionalProperties": {"type": "object"} } }, "401": {"description": "Must be authenticated to access the XNAT REST API."}, "500": {"description": "Unexpected error"}, "403": {"description": "Forbidden"}, "404": {"description": "The requested resource wasn't found."} } }}, "/xapi/pluginOpenUrls/settings": { "get": { "tags": ["plugin-open-urls-configuration-api"], "summary": "Gets the plugin open URL configuration.", "description": "Returns plugin open URL configuration for this installation.", "operationId": "getPluginOpenUrlsConfigurationUsingGET", "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "An array of properties", "schema": { "type": "object", "additionalProperties": {"type": "object"} } }, "401": {"description": "Unauthorized"}, "500": {"description": "Unexpected error"}, "403": {"description": "Forbidden"}, "404": {"description": "Not Found"} } }, "post": { "tags": ["plugin-open-urls-configuration-api"], "summary": "Sets the plugin open URL configuration.", "description": "Sets plugin open URL configuration for this installation.", "operationId": "setPluginOpenUrlsConfigurationUsingPOST", "consumes": ["application/json"], "produces": ["*/*"], "parameters": [{ "in": "body", "name": "config", "description": "config", "required": true, "schema": { "type": "object", "additionalProperties": {"type": "boolean"} } }], "responses": { "200": {"description": "OK"}, "201": {"description": "Created"}, "401": {"description": "Unauthorized"}, "500": {"description": "Unexpected error"}, "403": {"description": "Forbidden"}, "404": {"description": "Not Found"} } } }, } }


  • No labels