Page tree
Skip to end of metadata
Go to start of metadata
{ "swagger": "2.0", "info": { "description": "The XNAT Archive and Resource Management API allows you to get and store elements of the XNAT archive catalog", "version": "1.7.4.1", "title": "XNAT Archive and Resource Management API" }, "tags": [ { "name": "catalog-api", "description": "XNAT Archive and Resource Management API" } ], "definitions": { "CatCatalogBean": { "type": "object", "properties": { "allFields": { "type": "array", "items": {"type": "object"} }, "catCatalogId": { "type": "integer", "format": "int32" }, "description": {"type": "string"}, "entries_entry": { "type": "array", "items": {"$ref": "#/definitions/CatEntryI"} }, "fullSchemaElementName": {"type": "string"}, "headerString": {"type": "string"}, "id": {"type": "string"}, "metafields_metafield": { "type": "array", "items": {"$ref": "#/definitions/CatCatalogMetafieldI"} }, "name": {"type": "string"}, "schemaElementName": {"type": "string"}, "sets_entryset": { "type": "array", "items": {"$ref": "#/definitions/CatCatalogI"} }, "tags_tag": { "type": "array", "items": {"$ref": "#/definitions/CatCatalogTagI"} } } }, "StreamingResponseBody": {"type": "object"}, "CatCatalogTagI": { "type": "object", "properties": { "catCatalogTagId": { "type": "integer", "format": "int32" }, "tag": {"type": "string"}, "xsitype": {"type": "string"} } }, "CatCatalogMetafieldI": { "type": "object", "properties": { "catCatalogMetafieldId": { "type": "integer", "format": "int32" }, "metafield": {"type": "string"}, "name": {"type": "string"}, "xsitype": {"type": "string"} } }, "CatCatalogI": { "type": "object", "properties": { "catCatalogId": { "type": "integer", "format": "int32" }, "description": {"type": "string"}, "entries_entry": { "type": "array", "items": {"$ref": "#/definitions/CatEntryI"} }, "id": {"type": "string"}, "metafields_metafield": { "type": "array", "items": {"$ref": "#/definitions/CatCatalogMetafieldI"} }, "name": {"type": "string"}, "sets_entryset": { "type": "array", "items": {"$ref": "#/definitions/CatCatalogI"} }, "tags_tag": { "type": "array", "items": {"$ref": "#/definitions/CatCatalogTagI"} }, "xsitype": {"type": "string"} } }, "CatEntryI": { "type": "object", "properties": { "cachepath": {"type": "string"}, "catEntryId": { "type": "integer", "format": "int32" }, "content": {"type": "string"}, "createdby": {"type": "string"}, "createdeventid": { "type": "integer", "format": "int32" }, "createdtime": {"type": "object"}, "description": {"type": "string"}, "digest": {"type": "string"}, "format": {"type": "string"}, "id": {"type": "string"}, "metafields_metafield": { "type": "array", "items": {"type": "object"} }, "modifiedby": {"type": "string"}, "modifiedeventid": { "type": "integer", "format": "int32" }, "modifiedtime": {"type": "object"}, "name": {"type": "string"}, "tags_tag": { "type": "array", "items": {"type": "object"} }, "uri": {"type": "string"}, "xsitype": {"type": "string"} } } }, "paths": { "/xapi/archive/catalogs/refresh": {"put": { "tags": ["catalog-api"], "summary": "Refresh the catalog entry for one or more resources.", "description": "The resource should be identified by standard archive-relative paths, such as /archive/experiments/XNAT_E0001 or /archive/projects/XNAT_01/subjects/XNAT_01_01.", "operationId": "refreshResourceCatalogUsingPUT", "consumes": ["application/json"], "produces": ["*/*"], "parameters": [{ "in": "body", "name": "resources", "description": "The list of resources to be refreshed.", "required": false, "schema": { "type": "array", "items": {"type": "string"} } }], "responses": { "200": {"description": "The refresh operation(s) were completed successfully."}, "201": {"description": "Created"}, "401": {"description": "Unauthorized"}, "500": {"description": "An unexpected or unknown error occurred"}, "403": {"description": "Forbidden"}, "404": {"description": "Not Found"} } }}, "/xapi/archive/catalogs/refresh/{operations}": {"put": { "tags": ["catalog-api"], "summary": "Refresh the catalog entry for one or more resources, performing only the operations specified.", "description": "The resource should be identified by standard archive-relative paths, such as /archive/experiments/XNAT_E0001 or /archive/projects/XNAT_01/subjects/XNAT_01_01. The available operations are All, Append, Checksum, Delete, and PopulateStats. They should be comma separated but without spaces. Omitting the operations implies All.", "operationId": "refreshResourceCatalogWithOptionsUsingPUT", "consumes": ["application/json"], "produces": ["*/*"], "parameters": [ { "name": "operations", "in": "path", "description": "The operations to be performed", "required": false, "type": "string" }, { "in": "body", "name": "resources", "description": "The list of resources to be refreshed.", "required": false, "schema": { "type": "array", "items": {"type": "string"} } } ], "responses": { "200": {"description": "The refresh operation(s) were completed successfully."}, "201": {"description": "Created"}, "401": {"description": "Unauthorized"}, "500": {"description": "An unexpected or unknown error occurred"}, "403": {"description": "Forbidden"}, "404": {"description": "Not Found"} } }}, "/xapi/archive/download": {"post": { "tags": ["catalog-api"], "summary": "Creates a download catalog for the submitted sessions and other data objects.", "description": "The map submitted to this call supports lists of object IDs organized by key type: sessions, scan_type, scan_format, recon, assessors, and resources. The response for this method is the ID for the catalog of resolved resources, which can be submitted to the download/{catalog} function to retrieve the catalog or to the download/{catalog}/zip function to retrieve thefiles in the catalog as a zip archive.", "operationId": "createDownloadSessionsCatalogUsingPOST", "consumes": ["application/json"], "produces": ["application/xml"], "parameters": [{ "in": "body", "name": "resources", "description": "The resources to be cataloged.", "required": false, "schema": { "type": "object", "additionalProperties": { "type": "array", "items": {"type": "string"} } } }], "responses": { "200": { "description": "The download catalog was successfully built.", "schema": {"type": "string"} }, "201": {"description": "Created"}, "400": {"description": "Something is wrong with the request format."}, "401": {"description": "Unauthorized"}, "500": {"description": "An unexpected or unknown error occurred"}, "204": { "description": "No resources were specified.", "schema": {"type": "string"} }, "403": {"description": "The user is not authorized to access one or more of the specified resources."}, "404": {"description": "The request was valid but one or more of the specified resources was not found."} } }}, "/xapi/archive/download/{catalogId}": {"get": { "tags": ["catalog-api"], "summary": "Retrieves the download catalog for the submitted catalog ID.", "description": "This retrieves a catalog created earlier by the catalog service.", "operationId": "getDownloadSessionsCatalogUsingGET", "consumes": ["application/json"], "produces": ["application/xml"], "parameters": [{ "name": "catalogId", "in": "path", "description": "The ID of the catalog to be downloaded.", "required": false, "type": "string" }], "responses": { "200": { "description": "The download catalog was successfully built.", "schema": {"$ref": "#/definitions/CatCatalogBean"} }, "400": {"description": "Something is wrong with the request format."}, "401": {"description": "Unauthorized"}, "500": {"description": "An unexpected or unknown error occurred"}, "204": { "description": "No resources were specified.", "schema": {"$ref": "#/definitions/CatCatalogBean"} }, "403": {"description": "The user is not authorized to access one or more of the specified resources."}, "404": {"description": "The request was valid but one or more of the specified resources was not found."} } }}, "/xapi/archive/download/{catalogId}/test": {"get": { "tags": ["catalog-api"], "summary": "Downloads the specified catalog as a zip archive, using a small empty file for each entry.", "operationId": "downloadSessionCatalogZipTestUsingGET", "consumes": ["application/json"], "produces": ["application/zip"], "parameters": [{ "name": "catalogId", "in": "path", "description": "The ID of the catalog of resources to be downloaded.", "required": false, "type": "string" }], "responses": { "200": { "description": "The requested resources were successfully downloaded.", "schema": {"$ref": "#/definitions/StreamingResponseBody"} }, "400": {"description": "Something is wrong with the request format."}, "401": {"description": "Unauthorized"}, "500": {"description": "An unexpected or unknown error occurred"}, "204": { "description": "No resources were specified.", "schema": {"$ref": "#/definitions/StreamingResponseBody"} }, "403": {"description": "The user is not authorized to access one or more of the specified resources."}, "404": {"description": "The request was valid but one or more of the specified resources was not found."} } }}, "/xapi/archive/download/{catalogId}/xml": {"get": { "tags": ["catalog-api"], "summary": "Downloads the specified catalog as an XML file.", "operationId": "downloadSessionCatalogXmlUsingGET", "consumes": ["application/json"], "produces": ["application/xml"], "parameters": [{ "name": "catalogId", "in": "path", "description": "The ID of the catalog to be downloaded.", "required": false, "type": "string" }], "responses": { "200": { "description": "The requested catalog was successfully downloaded.", "schema": {"$ref": "#/definitions/StreamingResponseBody"} }, "400": {"description": "Something is wrong with the request format."}, "401": {"description": "Unauthorized"}, "500": {"description": "An unexpected or unknown error occurred"}, "204": { "description": "No catalog was specified.", "schema": {"$ref": "#/definitions/StreamingResponseBody"} }, "403": {"description": "The user is not authorized to access the specified catalog."}, "404": {"description": "The request was valid but the specified catalog was not found."} } }}, "/xapi/archive/download/{catalogId}/zip": {"get": { "tags": ["catalog-api"], "summary": "Downloads the contents of the specified catalog as a zip archive.", "operationId": "downloadSessionCatalogZipUsingGET", "consumes": ["application/json"], "produces": ["application/zip"], "parameters": [{ "name": "catalogId", "in": "path", "description": "The ID of the catalog of resources to be downloaded.", "required": false, "type": "string" }], "responses": { "200": { "description": "The requested resources were successfully downloaded.", "schema": {"$ref": "#/definitions/StreamingResponseBody"} }, "400": {"description": "Something is wrong with the request format."}, "401": {"description": "Unauthorized"}, "500": {"description": "An unexpected or unknown error occurred"}, "204": { "description": "No resources were specified.", "schema": {"$ref": "#/definitions/StreamingResponseBody"} }, "403": {"description": "The user is not authorized to access one or more of the specified resources."}, "404": {"description": "The request was valid but one or more of the specified resources was not found."} } }} } }
  • No labels