{
"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"
}
],
"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."}
}
}},
}
}
Overview
Community Forums
Content Tools
Apps