Page tree
Skip to end of metadata
Go to start of metadata
{ "swagger": "2.0", "info": { "description": "The Preferences API was introduced in XNAT 1.7 to store preferences and make them accessible outside of prefs files.", "version": "1.7.4.1", "title": "Prefs API" }, "tags": [ { "name": "preferences-api", "description": "Prefs API" } ], "definitions": { }, "paths": { "/xapi/prefs": {"get": { "tags": ["preferences-api"], "summary": "Returns the full map of preferences and values for this XNAT application.", "operationId": "getAllPreferenceSettingsUsingGET", "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "Preference settings successfully retrieved.", "schema": { "type": "object", "additionalProperties": {"type": "object"} } }, "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/prefs/ini": {"get": { "tags": ["preferences-api"], "summary": "Returns the full map of preferences and values for this XNAT application.", "operationId": "getPreferenceSettingsIniUsingGET_1", "consumes": ["application/json"], "produces": ["text/plain"], "responses": { "200": { "description": "Preference 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"} } }}, "/xapi/prefs/ini/{toolId}": {"get": { "tags": ["preferences-api"], "summary": "Returns the full map of preferences and values for this XNAT application.", "operationId": "getPreferenceSettingsIniUsingGET", "consumes": ["application/json"], "produces": ["text/plain"], "parameters": [{ "name": "toolId", "in": "path", "description": "toolId", "required": true, "type": "string" }], "responses": { "200": { "description": "Preference 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": "Tool ID not found in the system."} } }}, } }


  • No labels