Page tree
Skip to end of metadata
Go to start of metadata
{ "swagger": "2.0", "info": { "description": "The XNAT DICOM SCP API allows you to specify SCP receiver definitions for your XNAT to allow XNAT to receive DICOM data sent from PACS or other DICOM AEs", "version": "1.7.4.1", "title": "XNAT DICOM SCP management API" }, "tags": [ { "name": "dicom-scp-api", "description": "XNAT DICOM SCP management API" } ], "definitions": { "DicomSCPInstance": { "type": "object", "properties": { "aeTitle": {"type": "string"}, "enabled": {"type": "boolean"}, "fileNamer": {"type": "string"}, "id": { "type": "integer", "format": "int32" }, "identifier": {"type": "string"}, "port": { "type": "integer", "format": "int32" } } } }, "paths": { "/xapi/dicomscp": { "get": { "tags": ["dicom-scp-api"], "summary": "Get list of all configured DICOM SCP receiver definitions.", "description": "The primary DICOM SCP retrieval function returns a list of all DICOM SCP receivers defined for the current system.", "operationId": "getDicomSCPInstancesUsingGET", "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "A list of DICOM SCP receiver definitions.", "schema": { "type": "array", "items": {"$ref": "#/definitions/DicomSCPInstance"} } }, "401": {"description": "Unauthorized"}, "500": {"description": "Unexpected error"}, "403": {"description": "Forbidden"}, "404": {"description": "Not Found"} } }, "post": { "tags": ["dicom-scp-api"], "summary": "Creates a new DICOM SCP receiver from the request body.", "description": "The newly created DICOM SCP receiver instance is returned from the call. This should include the instance ID for the new object.", "operationId": "createDicomSCPInstanceUsingPOST", "consumes": [ "application/json", "multipart/form-data", "application/x-www-form-urlencoded" ], "produces": ["application/json"], "parameters": [{ "in": "body", "name": "instance", "description": "instance", "required": true, "schema": {"$ref": "#/definitions/DicomSCPInstance"} }], "responses": { "200": { "description": "The newly created DICOM SCP receiver definition.", "schema": {"$ref": "#/definitions/DicomSCPInstance"} }, "201": {"description": "Created"}, "401": {"description": "Must be authenticated to access the XNAT REST API."}, "500": {"description": "Unexpected error"}, "403": {"description": "Not authorized to view this DICOM SCP receiver definition."}, "404": {"description": "Not Found"}, "409": {"description": "A DICOM SCP receiver already exists and is enabled at the same AE title and port."} } } }, "/xapi/dicomscp/identifiers": { "get": { "tags": ["dicom-scp-api"], "summary": "Get map of all configured DICOM object identifiers and names.", "description": "This function returns a map of all DICOM object identifiers defined for the current system along with each identifier's readable name. The default identifier will be the first in the list.", "operationId": "getDicomObjectIdentifiersUsingGET", "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "A map of DICOM object identifiers and names.", "schema": {"type": "string"} }, "401": {"description": "Unauthorized"}, "500": {"description": "Unexpected error"}, "403": {"description": "Forbidden"}, "404": {"description": "Not Found"} } }, "put": { "tags": ["dicom-scp-api"], "summary": "Resets all configured DICOM object identifiers.", "description": "This function resets all of the DICOM object identifiers defined for the current system. This causes each identifier to reload its configuration on next access.", "operationId": "resetDicomObjectIdentifiersUsingPUT", "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": {"description": "The DICOM object identifiers were successfully reset."}, "201": {"description": "Created"}, "401": {"description": "Unauthorized"}, "500": {"description": "An unexpected error occurred."}, "403": {"description": "Forbidden"}, "404": {"description": "Not Found"} } } }, "/xapi/dicomscp/identifiers/{beanId}": { "get": { "tags": ["dicom-scp-api"], "summary": "Get implementation name of the specified DICOM object identifier.", "description": "This function returns the fully-qualified class name of the specified DICOM object identifier. You can use the value 'default' to retrieve the default identifier even if you don't know the specific name.", "operationId": "getDicomObjectIdentifierUsingGET", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "beanId", "in": "path", "description": "beanId", "required": true, "type": "string" }], "responses": { "200": { "description": "The implementation class of the specified DICOM object identifier.", "schema": {"type": "string"} }, "401": {"description": "Unauthorized"}, "500": {"description": "Unexpected error"}, "403": {"description": "Forbidden"}, "404": {"description": "No DICOM object identifier with the specified ID was found."} } }, "put": { "tags": ["dicom-scp-api"], "summary": "Resets the specified DICOM object identifier.", "description": "This function resets the specified DICOM object identifier. This causes the identifier to reload its configuration on next access.", "operationId": "resetDicomObjectIdentifierUsingPUT", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "beanId", "in": "path", "description": "beanId", "required": true, "type": "string" }], "responses": { "200": {"description": "The DICOM object identifiers were successfully reset."}, "201": {"description": "Created"}, "401": {"description": "Unauthorized"}, "500": {"description": "An unexpected error occurred."}, "403": {"description": "Forbidden"}, "404": {"description": "No DICOM object identifier with the specified ID was found."} } } }, "/xapi/dicomscp/start": {"put": { "tags": ["dicom-scp-api"], "summary": "Starts all enabled DICOM SCP receivers.", "description": "This starts all enabled DICOM SCP receivers. The return value contains the AE titles and ports of all of the started receivers.", "operationId": "startAllUsingPUT", "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "DICOM SCP receivers successfully started.", "schema": { "type": "array", "items": {"type": "string"} } }, "201": {"description": "Created"}, "401": {"description": "Must be authenticated to access the XNAT REST API."}, "500": {"description": "Unexpected error"}, "403": {"description": "Not authorized to enable or disable this DICOM SCP receiver definition."}, "404": {"description": "DICOM SCP receiver definition not found."} } }}, "/xapi/dicomscp/stop": {"put": { "tags": ["dicom-scp-api"], "summary": "Stops all enabled DICOM SCP receivers.", "description": "This stops all enabled DICOM SCP receivers. The return value contains the AE titles of all of the stopped receivers.", "operationId": "stopDicomSCPInstancesUsingPUT", "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "DICOM SCP receivers successfully stopped.", "schema": { "type": "array", "items": {"type": "string"} } }, "201": {"description": "Created"}, "401": {"description": "Must be authenticated to access the XNAT REST API."}, "500": {"description": "Unexpected error"}, "403": {"description": "Not authorized to enable or disable this DICOM SCP receiver definition."}, "404": {"description": "DICOM SCP receiver definition not found."} } }}, "/xapi/dicomscp/title/{title}/{port}": {"get": { "tags": ["dicom-scp-api"], "summary": "Gets the DICOM SCP receiver definition with the specified AE title and port.", "description": "Returns the DICOM SCP receiver definition with the specified AE title and port.", "operationId": "getDicomSCPInstanceByTitleAndPortUsingGET", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [ { "name": "title", "in": "path", "description": "AE title of the DICOM SCP receiver definition to fetch", "required": true, "type": "string" }, { "name": "port", "in": "path", "description": "Port of the DICOM SCP receiver definition to fetch", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "DICOM SCP receiver definition successfully retrieved.", "schema": {"$ref": "#/definitions/DicomSCPInstance"} }, "401": {"description": "Must be authenticated to access the XNAT REST API."}, "500": {"description": "Unexpected error"}, "403": {"description": "Not authorized to view this DICOM SCP receiver definition."}, "404": {"description": "DICOM SCP receiver definition not found."} } }}, "/xapi/dicomscp/{id}": { "get": { "tags": ["dicom-scp-api"], "summary": "Gets the DICOM SCP receiver definition with the specified ID.", "description": "Returns the DICOM SCP receiver definition with the specified ID.", "operationId": "getDicomSCPInstanceUsingGET", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "description": "ID of the DICOM SCP receiver definition to fetch", "required": true, "type": "integer", "format": "int32" }], "responses": { "200": { "description": "DICOM SCP receiver definition successfully retrieved.", "schema": {"$ref": "#/definitions/DicomSCPInstance"} }, "401": {"description": "Must be authenticated to access the XNAT REST API."}, "500": {"description": "Unexpected error"}, "403": {"description": "Not authorized to view this DICOM SCP receiver definition."}, "404": {"description": "DICOM SCP receiver definition not found."} } }, "put": { "tags": ["dicom-scp-api"], "summary": "Updates the DICOM SCP receiver definition object with the ID specified in the path variable. Note that any ID specified in the serialized definition in the request body is ignored and set to the value from the path variable.", "description": "Returns the updated DICOM SCP receiver definition.", "operationId": "updateDicomSCPInstanceUsingPUT", "consumes": [ "application/json", "multipart/form-data", "application/x-www-form-urlencoded" ], "produces": ["application/json"], "parameters": [ { "name": "id", "in": "path", "description": "The ID of the DICOM SCP receiver definition to update.", "required": true, "type": "integer", "format": "int32" }, { "in": "body", "name": "instance", "description": "instance", "required": false, "schema": {"$ref": "#/definitions/DicomSCPInstance"} } ], "responses": { "200": { "description": "DICOM SCP receiver definition successfully updated.", "schema": {"$ref": "#/definitions/DicomSCPInstance"} }, "201": {"description": "Created"}, "401": {"description": "Must be authenticated to access the XNAT REST API."}, "500": {"description": "Unexpected error"}, "403": {"description": "Not authorized to create or update this DICOM SCP receiver definition."}, "404": {"description": "DICOM SCP receiver definition not found."} } }, "delete": { "tags": ["dicom-scp-api"], "summary": "Deletes the DICOM SCP receiver definition object with the specified ID.", "description": "This call will stop the receiver if it's currently running.", "operationId": "deleteDicomSCPInstanceUsingDELETE", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "description": "The ID of the DICOM SCP receiver definition to delete.", "required": true, "type": "integer", "format": "int32" }], "responses": { "200": {"description": "DICOM SCP receiver definition successfully deleted."}, "401": {"description": "Must be authenticated to access the XNAT REST API."}, "500": {"description": "Unexpected error"}, "204": {"description": "No Content"}, "403": {"description": "Not authorized to delete this DICOM SCP receiver definition."}, "404": {"description": "DICOM SCP receiver definition not found."} } } }, "/xapi/dicomscp/{id}/enabled": {"get": { "tags": ["dicom-scp-api"], "summary": "Returns whether the DICOM SCP receiver definition with the specified ID is enabled.", "description": "Returns true or false based on whether the specified DICOM SCP receiver definition is enabled or not.", "operationId": "getDicomSCPInstanceEnabledUsingGET", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [{ "name": "id", "in": "path", "description": "The ID of the DICOM SCP receiver definition to retrieve the enabled status for.", "required": true, "type": "integer", "format": "int32" }], "responses": { "200": { "description": "DICOM SCP receiver definition enabled status successfully retrieved.", "schema": {"type": "boolean"} }, "401": {"description": "Must be authenticated to access the XNAT REST API."}, "500": {"description": "Unexpected error"}, "403": {"description": "Not authorized to view this DICOM SCP receiver definition."}, "404": {"description": "DICOM SCP receiver definition not found."} } }}, "/xapi/dicomscp/{id}/enabled/{flag}": {"put": { "tags": ["dicom-scp-api"], "summary": "Sets the DICOM SCP receiver definition's enabled state.", "description": "Sets the enabled state of the DICOM SCP receiver definition with the specified ID to the value of the flag parameter.", "operationId": "enableDicomSCPInstanceUsingPUT", "consumes": ["application/json"], "produces": ["application/json"], "parameters": [ { "name": "id", "in": "path", "description": "ID of the DICOM SCP receiver definition to modify", "required": true, "type": "integer", "format": "int32" }, { "name": "flag", "in": "path", "description": "The value to set for the enabled status.", "required": true, "type": "boolean" } ], "responses": { "200": {"description": "DICOM SCP receiver definition enabled status 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 enable or disable this DICOM SCP receiver definition."}, "404": {"description": "DICOM SCP receiver definition not found."} } }} } }


  • No labels