actionDELETEv1.0.0
delete_anonymization_keys_id
delete an anonymization key that is no longer of interest
actionDELETEv1.0.0
delete_boxes_id
Delete the remote box with the supplied ID
actionDELETEv1.0.0
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 next incoming image.
actionDELETEv1.0.0
delete_boxes_outgoing_id
delete an outgoing transaction. This will stop ongoing transactions.
actionDELETEv1.0.0
delete_directorywatches_id
stop watching and remove the directory corresponding to the supplied ID
actionDELETEv1.0.0
delete_filtering_associations_id
remove the source <-> filter association corresponding to the supplied ID
actionDELETEv1.0.0
delete_filtering_filters_id
remove the filter corresponding to the supplied ID
actionDELETEv1.0.0
delete_filtering_filters_id_tagpaths_tagpathid
remove the tagpath corresponding to the supplied ID
actionDELETEv1.0.0
delete_forwarding_rule_id
remove the forwarding rule corresponding to the supplied ID
actionDELETEv1.0.0
delete_images_id
Delete the image with the supplied ID
actionDELETEv1.0.0
delete_log
delete all log messages
actionDELETEv1.0.0
delete_log_id
Delete the log entry with the supplied ID
actionDELETEv1.0.0
delete_metadata_series_id_seriestypes
Delete all series types for the series with the supplied ID
actionDELETEv1.0.0
delete_metadata_series_seriesId_seriestags_seriesTagId
Delete the series tag with the supplied series tag ID from the series with the supplied series ID
actionDELETEv1.0.0
delete_metadata_series_seriesId_seriestypes_seriesTypeId
Delete the series type with the supplied series type ID from the series with the supplied series ID
actionDELETEv1.0.0
delete_scps_id
shut down and remove the SCP corresponding to the supplied ID
actionDELETEv1.0.0
delete_scus_id
remove the SCU corresponding to the supplied ID
actionDELETEv1.0.0
delete_seriestypes_id
remove the series type corresponding to the supplied ID
actionDELETEv1.0.0
delete_seriestypes_rules_id
remove the series type rule corresponding to the supplied ID
actionDELETEv1.0.0
delete_seriestypes_rules_ruleId_attributes_attributeId
remove the series type rule attribute corresponding to the supplied series type and attribute IDs
actionDELETEv1.0.0
delete_users_id
deletes a single user based on the ID supplied
actionGETv1.0.0
get_anonymization_keys
get a list of anonymization keys, each specifying how vital DICOM attributes have been anonymized for a particular image
actionGETv1.0.0
get_anonymization_keys_id
get the anonymization key with the supplied ID
actionGETv1.0.0
get_anonymization_keys_id_keyvalues
get pointers to the images corresponding to the anonymization key with the supplied ID
actionGETv1.0.0
get_anonymization_options
list all supported anonymization options defining an anonymization profile
actionGETv1.0.0
get_boxes
get a list of box connections
actionGETv1.0.0
get_boxes_incoming
get incoming transactions (finished, currently receiving, waiting or failed)
actionGETv1.0.0
get_boxes_incoming_id_images
get the received images corresponding to the incoming transaction with the supplied ID
actionGETv1.0.0
get_boxes_outgoing
get outgoing transactions (finished, currently sending, waiting or failed)
actionGETv1.0.0
get_boxes_outgoing_id_images
get the sent images corresponding to the outgoing transaction with the supplied ID
actionGETv1.0.0
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.
actionGETv1.0.0
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.
actionGETv1.0.0
get_filtering_associations
Get a list of source to filter associations.
actionGETv1.0.0
get_filtering_filters
List defined filters
actionGETv1.0.0
get_filtering_filters_id_tagpaths
List tagpaths for the selected filter
actionGETv1.0.0
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, etc.)
actionGETv1.0.0
get_images_id
fetch dataset corresponding to the supplied image ID
actionGETv1.0.0
get_images_id_attributes
list all DICOM attributes of the dataset corresponding to the supplied image ID
actionGETv1.0.0
get_images_id_imageinformation
get basic information about the pixel data of an image
actionGETv1.0.0
get_images_id_png
get a PNG image representation of the image corresponding to the supplied ID
actionGETv1.0.0
get_log
get a list of slicebox log messages
actionGETv1.0.0
get_metadata_flatseries
Returns a list of flattened metadata on the patient, study and series levels
actionGETv1.0.0
get_metadata_flatseries_id
Return the flat series with the supplied ID
actionGETv1.0.0
get_metadata_images
Returns a list of metadata on the image level of the DICOM hierarchy
actionGETv1.0.0
get_metadata_images_id
Return the image with the supplied ID
actionGETv1.0.0
get_metadata_patients
Returns a list of metadata on the patient level of the DICOM hierarchy
actionGETv1.0.0
get_metadata_patients_id
Return the patient with the supplied ID
actionGETv1.0.0
get_metadata_patients_id_images
Returns all images for the patient with the supplied patient ID
actionGETv1.0.0
get_metadata_series
Returns a list of metadata on the series level of the DICOM hierarchy
actionGETv1.0.0
get_metadata_series_id
Return the series with the supplied ID
actionGETv1.0.0
get_metadata_series_id_seriestags
get the list of series tags for the series with the supplied ID.
actionGETv1.0.0
get_metadata_series_id_seriestypes
get the list of series types for the series with the supplied ID.
actionGETv1.0.0
get_metadata_series_id_source
Return the source of the series with the supplied ID
actionGETv1.0.0
get_metadata_seriestags
Returns a list of series tags currently currently in use.
actionGETv1.0.0
get_metadata_studies
Returns a list of metadata on the study level of the DICOM hierarchy
actionGETv1.0.0
get_metadata_studies_id
Return the study with the supplied ID
actionGETv1.0.0
get_metadata_studies_id_images
Returns all images for the study with the supplied study ID
actionGETv1.0.0
get_scps
get a list of DICOM SCPs. Each SCP is a server for receiving DICOM images from e.g. a PACS system.
actionGETv1.0.0
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.
actionGETv1.0.0
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 applicable types.
actionGETv1.0.0
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 required values of the listed attributes, it is assigned to the series type of the rule.
actionGETv1.0.0
get_seriestypes_rules_id_attributes
get the list of attributes for the series type rule with the supplied ID.
actionGETv1.0.0
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.
actionGETv1.0.0
get_sources
Returns a list of currently available data sources. Possible source types are user - data imported by an API call by a user, box - data received from a remote box, directory - data imported via a watched directory, import - data imported into slicebox using import sessions, or scp - data received from a PACS.
actionGETv1.0.0
get_users
Returns all users of slicebox
actionGETv1.0.0
get_users_current
obtain information on the currently logged in user as specified by the supplied session cookie, IP address and user agent.
actionPOSTv1.0.0
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 of the route /images/{id}/anonymize.
actionPOSTv1.0.0
post_anonymization_keys_query
submit a query for anonymization keys
actionPOSTv1.0.0
post_boxes_connect
connect to another box using a received URL. Used to connect to a public box.
actionPOSTv1.0.0
post_boxes_createconnection
create a new box connection where the supplied entity holds the remote box name. Used by publicly available boxes.
actionPOSTv1.0.0
post_boxes_id_send
send images corresponding to the supplied image ids to the remote box with the supplied ID
actionPOSTv1.0.0
post_directorywatches
add a new directory to watch for incoming DICOM files
actionPOSTv1.0.0
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.
actionPOSTv1.0.0
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.
actionPOSTv1.0.0
post_filtering_filters_id_tagpaths
add a tagpath to a filter
actionPOSTv1.0.0
post_forwarding_rules
add a new forwarding rule
actionPOSTv1.0.0
post_images
add a DICOM dataset to slicebox
actionPOSTv1.0.0
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}
actionPOSTv1.0.0
post_images_id_anonymized
get an anonymized version of the image with the supplied ID
actionPOSTv1.0.0
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
actionPOSTv1.0.0
post_metadata_flatseries_query
submit a query for flat series
actionPOSTv1.0.0
post_metadata_images_query
submit a query for images
actionPOSTv1.0.0
post_metadata_patients_query
submit a query for patients
actionPOSTv1.0.0
post_metadata_series_id_seriestags
add a series tag to the series with the supplied ID
actionPOSTv1.0.0
post_metadata_series_query
submit a query for series
actionPOSTv1.0.0
post_metadata_studies_query
submit a query for studies
actionPOSTv1.0.0
post_scps
add a new SCP for receiving DICOM images
actionPOSTv1.0.0
post_scus
add a new SCU for sending DICOM images
actionPOSTv1.0.0
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
actionPOSTv1.0.0
post_seriestypes
add a new series type
actionPOSTv1.0.0
post_seriestypes_rules
add a new series type rule
actionPOSTv1.0.0
post_seriestypes_rules_id_attributes
add a new series type rule attribute
actionPOSTv1.0.0
post_seriestypes_series_query
submit a query for seriestypes for a list of series
actionPOSTv1.0.0
post_system_stop
stop and shut down slicebox
actionPOSTv1.0.0
post_users
Creates a new user. Dupicates are accepted but not added.
actionPOSTv1.0.0
post_users_login
Obtain a session cookie that can be used to authenticate future API calls from the present IP address and with the present user agent.
actionPOSTv1.0.0
post_users_logout
Logout the current user by responding with a delete cookie header removing the session cookie for this user.
actionPUTv1.0.0
put_images_id_anonymize
delete the selected image and replace it with an anonymized version
actionPUTv1.0.0
put_images_id_modify
modify and/or insert image attributes according to the input tagpath-value mappings
actionPUTv1.0.0
put_metadata_series_seriesId_seriestypes_seriesTypeId
Add the series type with the supplied series type ID to the series with the supplied series ID
Beyond the catalog
Any provider, on request.
01
Request it
Tell us which provider you need, and we will ship it in the registry.
02
Generate it
Point swirls add at an OpenAPI or GraphQL spec. Typed actions for any API you hold credentials for, today.
acme · integrations
terminal
~/acme $swirls add linear
✓ 12 typed actions · scopes and schemas included
~/acme $swirls add https://api.acme.dev/openapi.json
◆ Fetched spec · 38 operations
✓ 6 typed actions · generated from spec