Page tree
Skip to end of metadata
Go to start of metadata
{ "swagger": "2.0", "info": { "description": "The Site-wide Config Service API was introduced in XNAT 1.7 to store configurations and make them accessible outside of conf files.", "version": "1.7.4.1", "title": "Site Config API" }, "tags": [ { "name": "site-config-api", "description": "Site Config API" } ], "definitions": { }, "paths": { "/xapi/siteConfig": { "get": { "tags": ["site-config-api"], "summary": "Returns the full map of site configuration properties.", "description": "Complex objects may be returned as encapsulated JSON strings.", "operationId": "getSiteConfigPropertiesUsingGET", "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "Site configuration properties successfully retrieved.", "schema": {"type": "string"} }, "401": {"description": "Must be authenticated to access the XNAT REST API."}, "500": {"description": "Unexpected error"}, "403": {"description": "Not authorized to set site configuration properties."}, "404": {"description": "Not Found"} } }, "post": { "tags": ["site-config-api"], "summary": "Sets a map of site configuration properties.", "description": "Sets the site configuration properties specified in the map.", "operationId": "setSiteConfigPropertiesUsingPOST", "consumes": [ "application/json", "application/x-www-form-urlencoded" ], "produces": ["*/*"], "parameters": [{ "in": "body", "name": "properties", "description": "The map of site configuration properties to be set.", "required": true, "schema": {"type": "object"} }], "responses": { "200": {"description": "Site configuration properties successfully set."}, "201": {"description": "Created"}, "401": {"description": "Must be authenticated to access the XNAT REST API."}, "500": {"description": "Unexpected error"}, "403": {"description": "Not authorized to set site configuration properties."}, "404": {"description": "Not Found"} } } }, "/xapi/siteConfig/buildInfo": {"get": { "tags": ["site-config-api"], "summary": "Returns a map of application build properties.", "description": "This includes the implementation version, Git commit hash, and build number and number.", "operationId": "getBuildInfoUsingGET", "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "Application build 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": "Not Found"} } }}, "/xapi/siteConfig/buildInfo/attributes": {"get": { "tags": ["site-config-api"], "summary": "Returns a map of extended build attributes.", "description": "The values are dependent on what attributes are set for the build. It is not unexpected that there are no extended build attributes.", "operationId": "getBuildAttributeInfoUsingGET", "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "Extended build attributes 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/siteConfig/uptime": {"get": { "tags": ["site-config-api"], "summary": "Returns the system uptime.", "description": "This returns the uptime as a map of time units: days, hours, minutes, and seconds.", "operationId": "getSystemUptimeUsingGET", "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "System uptime 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/siteConfig/uptime/display": {"get": { "tags": ["site-config-api"], "summary": "Returns the system uptime.", "description": "This returns the uptime as a formatted string.", "operationId": "getFormattedSystemUptimeUsingGET", "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "System uptime 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/siteConfig/values/{preferences}": {"get": { "tags": ["site-config-api"], "summary": "Returns a map of the selected site configuration properties.", "description": "Complex objects may be returned as encapsulated JSON strings.", "operationId": "getSpecifiedSiteConfigPropertiesUsingGET", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "preferences", "in": "path", "description": "preferences", "required": true, "type": "string" }], "responses": { "200": { "description": "Site configuration properties successfully retrieved.", "schema": {"type": "string"} }, "401": {"description": "Must be authenticated to access the XNAT REST API."}, "500": {"description": "Unexpected error"}, "403": {"description": "Not authorized to set site configuration properties."}, "404": {"description": "Not Found"} } }}, "/xapi/siteConfig/{property}": { "get": { "tags": ["site-config-api"], "summary": "Returns the value of the selected site configuration property.", "description": "Complex objects may be returned as encapsulated JSON strings.", "operationId": "getSpecifiedSiteConfigPropertyUsingGET", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "property", "in": "path", "description": "The site configuration property to retrieve.", "required": true, "type": "string" }], "responses": { "200": { "description": "Site configuration property successfully retrieved.", "schema": {"type": "object"} }, "401": {"description": "Must be authenticated to access the XNAT REST API."}, "500": {"description": "Unexpected error"}, "403": {"description": "Not authorized to access site configuration properties."}, "404": {"description": "Not Found"} } }, "post": { "tags": ["site-config-api"], "summary": "Sets a single site configuration property.", "description": "Sets the site configuration property specified in the URL to the value set in the body.", "operationId": "setSiteConfigPropertyUsingPOST", "consumes": [ "application/json", "text/plain" ], "produces": ["application/json"], "parameters": [ { "name": "property", "in": "path", "description": "The property to be set.", "required": true, "type": "string" }, { "in": "body", "name": "value", "description": "The value to be set for the property.", "required": false, "schema": {"type": "string"} } ], "responses": { "200": {"description": "Site configuration properties successfully set."}, "201": {"description": "Created"}, "401": {"description": "Must be authenticated to access the XNAT REST API."}, "500": {"description": "Unexpected error"}, "403": {"description": "Not authorized to set site configuration properties."}, "404": {"description": "Not Found"} } } } } }
  • No labels