Slicebox API API

by slicebox.local

Overview

Slicebox - safe sharing of medical images

Slicebox API is a documents & productivity API from slicebox.local. It needs no API key. It is served over plain HTTP. Its OpenAPI description documents 118 endpoints.

At a glance

Authentication: No auth
HTTPS: No
CORS: Unknown
Category: Documents & Productivity
Base URL: http://slicebox.local/api
Version: 2.0
Endpoints: 118
OpenAPI: Specification ↗
Spec updated: 2021-06-21

Make a first request

Replace the placeholders; the documentation says exactly where credentials go.

cURL

curl -X GET "http://slicebox.local/api/anonymization/keys" \
  -H "Accept: application/json"

JavaScript

const response = await fetch("http://slicebox.local/api/anonymization/keys", {
  method: "GET",
  headers: {
    "Accept": "application/json",
  },
});
const data = await response.json();
console.log(data);

Python

import requests

response = requests.request(
    "GET",
    "http://slicebox.local/api/anonymization/keys",
    headers={
    "Accept": "application/json",
    },
    timeout=30,
)
print(response.json())

Endpoints

Method	Path	What it does
POST	`/anonymization/anonymize`	anonymize the images corresponding to the supplied list of image IDs (each paired with a list of DICOM tag translation). This route corresponds to repeated use
GET	`/anonymization/keys`	get a list of anonymization keys, each specifying how vital DICOM attributes have been anonymized for a particular image
GET	`/anonymization/keys/export/csv`	export all anonymization keys as a csv file
POST	`/anonymization/keys/query`	submit a query for anonymization keys
GET	`/anonymization/keys/{id}`	get the anonymization key with the supplied ID
DELETE	`/anonymization/keys/{id}`	delete an anonymization key that is no longer of interest
GET	`/anonymization/keys/{id}/keyvalues`	get pointers to the images corresponding to the anonymization key with the supplied ID
GET	`/anonymization/options`	list all supported anonymization options defining an anonymization profile
GET	`/boxes`	get a list of box connections
POST	`/boxes/connect`	connect to another box using a received URL. Used to connect to a public box.
POST	`/boxes/createconnection`	create a new box connection where the supplied entity holds the remote box name. Used by publicly available boxes.
GET	`/boxes/incoming`	get incoming transactions (finished, currently receiving, waiting or failed)
DELETE	`/boxes/incoming/{id}`	delete an incoming transaction. If a currently active transaction is deleted, a new transaction with the remainder of the images is created when receiving the n
GET	`/boxes/incoming/{id}/images`	get the received images corresponding to the incoming transaction with the supplied ID
GET	`/boxes/outgoing`	get outgoing transactions (finished, currently sending, waiting or failed)
DELETE	`/boxes/outgoing/{id}`	delete an outgoing transaction. This will stop ongoing transactions.
GET	`/boxes/outgoing/{id}/images`	get the sent images corresponding to the outgoing transaction with the supplied ID
DELETE	`/boxes/{id}`	Delete the remote box with the supplied ID
POST	`/boxes/{id}/send`	send images corresponding to the supplied image ids to the remote box with the supplied ID
GET	`/destinations`	Returns a list of currently available destinations. Possible destinations are box - sending data to a remote box, and scu - sending data a receiving SCP.
GET	`/directorywatches`	get a list of watch directories. Each watch directory and its sub-directories are watched for incoming DICOM files, which are read and imported into slicebox.
POST	`/directorywatches`	add a new directory to watch for incoming DICOM files
DELETE	`/directorywatches/{id}`	stop watching and remove the directory corresponding to the supplied ID
GET	`/filtering/associations`	Get a list of source to filter associations.
POST	`/filtering/associations`	Inserts or updates a source <-> filter associations. If the specified Source already has an association this is updated, otherwise a new is inserted.
DELETE	`/filtering/associations/{id}`	remove the source <-> filter association corresponding to the supplied ID
GET	`/filtering/filters`	List defined filters
POST	`/filtering/filters`	Inserts or updates a filter. If a filter with same name as supplied filter exists this filter is updated, otherwise a new filter is inserted.
DELETE	`/filtering/filters/{id}`	remove the filter corresponding to the supplied ID
GET	`/filtering/filters/{id}/tagpaths`	List tagpaths for the selected filter
POST	`/filtering/filters/{id}/tagpaths`	add a tagpath to a filter
DELETE	`/filtering/filters/{id}/tagpaths/{tagpathid}`	remove the tagpath corresponding to the supplied ID
DELETE	`/forwarding/rule/{id}`	remove the forwarding rule corresponding to the supplied ID
GET	`/forwarding/rules`	get a list of all forwarding rules. A forwarding rule specifies the automatic forwarding of images from a source (SCP, BOX, etc.) to a destimation (BOX, SCU, et
POST	`/forwarding/rules`	add a new forwarding rule
POST	`/images`	add a DICOM dataset to slicebox
POST	`/images/delete`	bulk delete a sequence of images according to the supplied image IDs. This is the same as a sequence of DELETE requests to /images/{id}
GET	`/images/export`	download the export set with the supplied export set ID as a zip archive
POST	`/images/export`	create an export set, a group of image IDs of images to export. The export set will contain the selected images. The export set is available for download 12 hou
POST	`/images/jpeg`	add a JPEG image to slicebox. The image data will be wrapped in a DICOM file and added as a new series belonging to the study with the supplied ID
GET	`/images/{id}`	fetch dataset corresponding to the supplied image ID
DELETE	`/images/{id}`	Delete the image with the supplied ID
PUT	`/images/{id}/anonymize`	delete the selected image and replace it with an anonymized version
POST	`/images/{id}/anonymized`	get an anonymized version of the image with the supplied ID
GET	`/images/{id}/attributes`	list all DICOM attributes of the dataset corresponding to the supplied image ID
GET	`/images/{id}/imageinformation`	get basic information about the pixel data of an image
PUT	`/images/{id}/modify`	modify and/or insert image attributes according to the input tagpath-value mappings
GET	`/images/{id}/png`	get a PNG image representation of the image corresponding to the supplied ID
GET	`/import/sessions`	Returns a list of available import sessions.
POST	`/import/sessions`	create a new import sessions
GET	`/import/sessions/{id}`	Returns the import sessions with the supplied ID
DELETE	`/import/sessions/{id}`	deletes the import session with the supplied ID
GET	`/import/sessions/{id}/images`	get the imported images corresponding to the import session with the supplied ID
POST	`/import/sessions/{id}/images`	add a DICOM dataset to the import session with the supplied ID
GET	`/log`	get a list of slicebox log messages
DELETE	`/log`	delete all log messages
DELETE	`/log/{id}`	Delete the log entry with the supplied ID
GET	`/metadata/flatseries`	Returns a list of flattened metadata on the patient, study and series levels
POST	`/metadata/flatseries/query`	submit a query for flat series
GET	`/metadata/flatseries/{id}`	Return the flat series with the supplied ID
GET	`/metadata/images`	Returns a list of metadata on the image level of the DICOM hierarchy
POST	`/metadata/images/query`	submit a query for images
GET	`/metadata/images/{id}`	Return the image with the supplied ID
GET	`/metadata/patients`	Returns a list of metadata on the patient level of the DICOM hierarchy
POST	`/metadata/patients/query`	submit a query for patients
GET	`/metadata/patients/{id}`	Return the patient with the supplied ID
GET	`/metadata/patients/{id}/images`	Returns all images for the patient with the supplied patient ID
GET	`/metadata/series`	Returns a list of metadata on the series level of the DICOM hierarchy
POST	`/metadata/series/query`	submit a query for series
GET	`/metadata/series/{id}`	Return the series with the supplied ID
GET	`/metadata/series/{id}/seriestags`	get the list of series tags for the series with the supplied ID.
POST	`/metadata/series/{id}/seriestags`	add a series tag to the series with the supplied ID
GET	`/metadata/series/{id}/seriestypes`	get the list of series types for the series with the supplied ID.
DELETE	`/metadata/series/{id}/seriestypes`	Delete all series types for the series with the supplied ID
GET	`/metadata/series/{id}/source`	Return the source of the series with the supplied ID
DELETE	`/metadata/series/{seriesId}/seriestags/{seriesTagId}`	Delete the series tag with the supplied series tag ID from the series with the supplied series ID
PUT	`/metadata/series/{seriesId}/seriestypes/{seriesTypeId}`	Add the series type with the supplied series type ID to the series with the supplied series ID
DELETE	`/metadata/series/{seriesId}/seriestypes/{seriesTypeId}`	Delete the series type with the supplied series type ID from the series with the supplied series ID
GET	`/metadata/seriestags`	Returns a list of series tags currently currently in use.
GET	`/metadata/studies`	Returns a list of metadata on the study level of the DICOM hierarchy
POST	`/metadata/studies/query`	submit a query for studies
GET	`/metadata/studies/{id}`	Return the study with the supplied ID
GET	`/metadata/studies/{id}/images`	Returns all images for the study with the supplied study ID
GET	`/scps`	get a list of DICOM SCPs. Each SCP is a server for receiving DICOM images from e.g. a PACS system.
POST	`/scps`	add a new SCP for receiving DICOM images
DELETE	`/scps/{id}`	shut down and remove the SCP corresponding to the supplied ID
GET	`/scus`	get a list of DICOM SCUs. Each SCU is a client for sending DICOM images to an SCP, e.g. a PACS system.
POST	`/scus`	add a new SCU for sending DICOM images
DELETE	`/scus/{id}`	remove the SCU corresponding to the supplied ID
POST	`/scus/{id}/send`	send the images with the supplied image IDs to a DICOM SCP using the the SCU with the supplied scu ID
GET	`/seriestypes`	get a list of all added series types. By filtering search results for certain series types, it is easier for applications to ensure that they read images of app
POST	`/seriestypes`	add a new series type
GET	`/seriestypes/rules`	get a list of rules for assigning series types to series. A rule connects to a series of attributes with values and a resulting series type. If a series has the
POST	`/seriestypes/rules`	add a new series type rule
GET	`/seriestypes/rules/updatestatus`	get the status of the internal process of updating series types for series following a change of series types, rules or attributes.
DELETE	`/seriestypes/rules/{id}`	remove the series type rule corresponding to the supplied ID
GET	`/seriestypes/rules/{id}/attributes`	get the list of attributes for the series type rule with the supplied ID.
POST	`/seriestypes/rules/{id}/attributes`	add a new series type rule attribute
DELETE	`/seriestypes/rules/{ruleId}/attributes/{attributeId}`	remove the series type rule attribute corresponding to the supplied series type and attribute IDs
POST	`/seriestypes/series/query`	submit a query for seriestypes for a list of series