Page tree
Skip to end of metadata
Go to start of metadata
{ "swagger": "2.0", "info": { "description": "The Schemas API was introduced in XNAT 1.7 to provide information on installed data types.", "version": "1.7.4.1", "title": "Schemas API" }, "tags": [ { "name": "schema-api", "description": "Schemas API" } ], "definitions": { }, "paths": { "/xapi/schemas": {"get": { "tags": ["schema-api"], "summary": "Returns a list of all of the installed XNAT data-type schemas.", "description": "The strings returned from this function tell you the name of the schema and can be used with other methods on this API to retrieve the full schema document. This tells you nothing about whether the data types defined in the schemas are active or configured.", "operationId": "getAllDataTypeSchemasUsingGET", "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "XNAT data-type schemas successfully retrieved.", "schema": { "type": "array", "items": {"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/schemas/{namespace}/{schema}": {"get": { "tags": ["schema-api"], "summary": "Returns the requested XNAT data-type schema.", "description": "XNAT data-type schemas are most often stored on the classpath in the folder schemas/SCHEMA/SCHEMA.xsd, but sometimes the folder name differs from the schema name. This function returns the schema named SCHEMA.xsd in the folder named NAMESPACE. This tells you nothing about whether the data types defined in the schemas are active or configured.", "operationId": "getRequestedDataTypeSchemaUsingGET", "consumes": ["application/json"], "produces": ["application/xml"], "parameters": [ { "name": "namespace", "in": "path", "description": "namespace", "required": true, "type": "string" }, { "name": "schema", "in": "path", "description": "schema", "required": true, "type": "string" } ], "responses": { "200": { "description": "XNAT data-type schemas 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": "The requested resource wasn't found."} } }}, "/xapi/schemas/{schema}": {"get": { "tags": ["schema-api"], "summary": "Returns the requested XNAT data-type schema.", "description": "XNAT data-type schemas are most often stored on the classpath in the folder schemas/SCHEMA/SCHEMA.xsd. This function returns the schema named SCHEMA.xsd in the folder named SCHEMA. You can use the function that allows you to specify the namespace as well if the folder name differs from the schema name. This tells you nothing about whether the data types defined in the schemas are active or configured.", "operationId": "getRequestedDataTypeSchemaUsingGET_1", "consumes": ["application/json"], "produces": ["application/xml"], "parameters": [{ "name": "schema", "in": "path", "description": "schema", "required": true, "type": "string" }], "responses": { "200": { "description": "XNAT data-type schemas 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": "The requested resource wasn't found."} } }}, } }
  • No labels