Close
Web API

Deprecated MIDAS Web API

This RPC style API is now deprecated, instead use the RESTful API.



The api will send you an XML RPC response at the following URL:
http://slicer.kitware.com/midas3/api/rest?method=METHOD_NAME

The api will send you a JSON RPC response at the following URL:
http://slicer.kitware.com/midas3/api/json?method=METHOD_NAME

To authenticate requests you can provide a parameter of token with an authentication token value obtained by calling midas.login, or to authenticate using the current Midas session you can pass a parameter key of useSession.

Available methods:
  • midas.thumbnailcreator.create.big.thumbnail ?
  • Create a big thumbnail for the given bitstream with the given width. It is used as the main image of the given item and shown in the item view page.
    Parameters
    • bitstreamId - The bitstream to create the thumbnail from
    • itemId - The item to set the thumbnail on
    • width - (Optional) The width in pixels to resize to (aspect ratio will be preserved). Defaults to 575
    Return - The ItemthumbnailDao object that was created
  • midas.thumbnailcreator.create.small.thumbnail ?
  • Create a 100x100 small thumbnail for the given item. It is used for preview purpose and displayed in the 'preview' and 'thumbnails' sidebar sections.
    Parameters
    • itemId - The item to set the thumbnail on
    Return - The Item object (with the new thumbnail_id) and the path where the newly created thumbnail is stored
  • midas.version ?
  • Get the server version
    Return - Server version in the form ..
  • midas.modules.list ?
  • Get the enabled modules on the server
    Return - List of enabled modules on the server
  • midas.methods.list ?
  • List all available web api methods on the server
    Return - List of api method names and their corresponding documentation
  • midas.info ?
  • Get the server information including version, modules enabled, and available web api methods (names do not include the global prefix)
    Return - Server information
  • midas.login ?
  • Login as a user using a web api key
    Parameters
    • appname - The application name
    • email - The user email
    • apikey - The api key corresponding to the given application name
    Return - A web api token that will be valid for a set duration
  • midas.resource.get ?
  • Get a resource by its UUID
    Parameters
    • uuid - Universal identifier for the resource
    • folder - (Optional) If set, will return the folder instead of the community record
    Return - The resource's dao
  • midas.path.from.root ?
  • Returns a path of uuids from the root folder to the given node
    Parameters
    • uuid - Unique identifier of the resource
    Return - An ordered list of uuids representing a path from the root node
  • midas.path.to.root ?
  • Returns a path of uuids from the given node to the root node
    Parameters
    • uuid - Unique identifier of the resource
    Return - An ordered list of uuids representing a path to the root node
  • midas.item.search ?
  • Search items for the given words
    Parameters
    • token - (Optional) Authentication token
    • search - The search query
    • folder - Parent uuid folder
    Return - An array of matching resources
  • midas.resource.search ?
  • Search resources for the given words
    Parameters
    • token - (Optional) Authentication token
    • search - The search query
    Return - An array of matching resources
  • midas.link.create ?
  • Create a link bitstream.
    Parameters
    • token - Authentication token.
    • folderid - The id of the folder in which to create a new item that will contain the link. The new item will have the same name as url unless itemname is supplied.
    • url - The URL of the link you will create, will be used as the name of the bitstream and of the item (unless itemname is supplied).
    • itemname - (Optional) The name of the newly created item, if not supplied, the item will have the same name as url.
    • length - (Optional) The length in bytes of the file to which the link points.
    • checksum - (Optional) The md5 checksum of the file to which the link points.
    Return - The item information of the item created.
  • midas.upload.generatetoken ?
  • Generate a unique upload token. Either itemid or folderid is required, but both are not allowed.
    Parameters
    • token - Authentication token.
    • itemid - The id of the item to upload into.
    • folderid - The id of the folder to create a new item in and then upload to. The new item will have the same name as filename unless itemname is supplied.
    • filename - The filename of the file you will upload, will be used as the bitstream's name and the item's name (unless itemname is supplied).
    • itemdescription - (Optional) When passing the folderid param, the description of the item, if not supplied the item's description will be blank.
    • itemname - (Optional) When passing the folderid param, the name of the newly created item, if not supplied, the item will have the same name as filename.
    • checksum - (Optional) The md5 checksum of the file to be uploaded.
    • create_additional_revision - (Optional) When a checksum is passed and the server already has the file, by default a reference to the existing bitstream will be added to the latest revision. By setting create_additional_revision to true, a new revision will be created.
    Return - An upload token that can be used to upload a file. If folderid is passed instead of itemid, a new item will be created in that folder, but the id of the newly created item will not be returned. If the id of the newly created item is needed, then call the midas.item.create method instead. If checksum is passed and the token returned is blank, the server already has this file and there is no need to follow this call with a call to midas.upload.perform, as the passed in file will have been added as a bitstream to the item's latest revision, creating a new revision if one doesn't exist.
  • midas.upload.getoffset ?
  • Get the size of a partially completed upload
    Parameters
    • uploadtoken - The upload token for the file
    Return - [offset] The size of the file currently on the server
  • midas.upload.perform ?
  • Upload a file to the server. PUT or POST is required. Will add the file as a bitstream to the item that was specified when generating the upload token in a new revision to that item, unless revision param is set.
    Parameters
    • uploadtoken - The upload token (see midas.upload.generatetoken).
    • filename - The name of the bitstream that will be added to the item.
    • length - The length in bytes of the file being uploaded.
    • mode - (Optional) Stream or multipart. Default is stream.
    • revision - (Optional) If set, will add a new file into the existing passed in revision number. If set to "head", will add a new file into the most recent revision, and will create a new revision in this case if none exists.
    • changes - (Optional) The changes field on the affected item revision, e.g. for recording what has changed since the previous revision.
    Return - The item information of the item created or changed.
  • midas.community.create ?
  • Create a new community or update an existing one using the uuid
    Parameters
    • token - Authentication token
    • name - The community name
    • description - (Optional) The community description
    • uuid - (Optional) Uuid of the community. If none is passed, will generate one.
    • privacy - (Optional) Default 'Public', possible values [Public|Private].
    • canjoin - (Optional) Default 'Everyone', possible values [Everyone|Invitation].
    Return - The community dao that was created
  • midas.community.get ?
  • Get a community's information based on the id OR name
    Parameters
    • token - (Optional) Authentication token
    • id - The id of the community
    • name - the name of the community
    Return - The community information
  • midas.community.children ?
  • Get the immediate children of a community (non-recursive)
    Parameters
    • token - (Optional) Authentication token
    • id - The id of the community
    Return - The folders in the community
  • midas.community.list ?
  • Return a list of all communities visible to a user
    Parameters
    • token - (Optional) Authentication token
    Return - A list of all communities
  • midas.community.delete ?
  • Delete a community. Requires admin privileges on the community
    Parameters
    • token - Authentication token
    • id - The id of the community
  • midas.folder.create ?
  • Create a folder or update an existing one if one exists by the uuid passed.If a folder is requested to be created with the same parentid and name asan existing folder, an exception will be thrown and no new folder willbe created.
    Parameters
    • token - Authentication token
    • name - The name of the folder to create
    • description - (Optional) The description of the folder
    • uuid - (Optional) Uuid of the folder. If none is passed, will generate one.
    • privacy - (Optional) Possible values [Public|Private]. Default behavior is to inherit from parent folder.
    • reuseExisting - (Optional) If this parameter is set, will just return the existing folder if there is one with the name provided
    • parentid - The id of the parent folder. Set this to -1 to create a top level user folder.
    Return - The folder object that was created
  • midas.folder.get ?
  • Get information about the folder
    Parameters
    • token - (Optional) Authentication token
    • id - The id of the folder
    Return - The folder object, including its parent object
  • midas.folder.children ?
  • Get the immediate children of a folder (non-recursive)
    Parameters
    • token - (Optional) Authentication token
    • id - The id of the folder
    Return - The items and folders in the given folder
  • midas.folder.delete ?
  • Delete a folder. Requires admin privileges on the folder
    Parameters
    • token - Authentication token
    • id - The id of the folder
  • midas.folder.download ?
  • Download a folder
    Parameters
    • token - (Optional) Authentication token
    • id - The id of the folder
    Return - A zip archive of the folder's contents
  • midas.folder.move ?
  • Move a folder to the destination folder
    Parameters
    • token - Authentication token
    • id - The id of the folder
    • dstfolderid - The id of destination folder (new parent folder) where the folder is moved to
    Return - The folder object
  • midas.folder.list.permissions ?
  • List the permissions on a folder, requires Admin access to the folder.
    Parameters
    • folder_id - The id of the folder
    Return - A list with three keys: privacy, user, group; privacy will be the folder's privacy string [Public|Private]; user will be a list of (user_id, policy, email); group will be a list of (group_id, policy, name). policy for user and group will be a policy string [Admin|Write|Read].
  • midas.folder.set.privacy.recursive ?
  • Set the privacy status on a folder, and push this value down recursively to all children folders and items, requires Admin access to the folder.
    Parameters
    • folder_id - The id of the folder.
    • privacy - Desired privacy status, one of [Public|Private].
    Return - An array with keys 'success' and 'failure' indicating a count of children resources that succeeded or failed the permission change.
  • midas.folder.add.policygroup ?
  • Add a folderpolicygroup to a folder with the passed in group and policy; if a folderpolicygroup exists for that group and folder, it will be replaced with the passed in policy.
    Parameters
    • folder_id - The id of the folder.
    • group_id - The id of the group.
    • policy - Desired policy status, one of [Admin|Write|Read].
    • recursive - If included will push all policies from the passed in folder down to its child folders and items, default is non-recursive.
    Return - An array with keys 'success' and 'failure' indicating a count of resources affected by the addition.
  • midas.folder.remove.policygroup ?
  • Remove a folderpolicygroup from a folder with the passed in group if the folderpolicygroup exists.
    Parameters
    • folder_id - The id of the folder.
    • group_id - The id of the group.
    • recursive - If included will push all policies after the removal from the passed in folder down to its child folders and items, default is non-recursive.
    Return - An array with keys 'success' and 'failure' indicating a count of resources affected by the removal.
  • midas.folder.add.policyuser ?
  • Add a folderpolicyuser to a folder with the passed in user and policy; if a folderpolicyuser exists for that user and folder, it will be replaced with the passed in policy.
    Parameters
    • folder_id - The id of the folder.
    • user_id - The id of the targeted user to create the policy for.
    • policy - Desired policy status, one of [Admin|Write|Read].
    • recursive - If included will push all policies from the passed in folder down to its child folders and items, default is non-recursive.
    Return - An array with keys 'success' and 'failure' indicating a count of resources affected by the addition.
  • midas.folder.remove.policyuser ?
  • Remove a folderpolicyuser from a folder with the passed in user if the folderpolicyuser exists.
    Parameters
    • folder_id - The id of the folder.
    • user_id - The id of the target user.
    • recursive - If included will push all policies after the removal from the passed in folder down to its child folders and items, default is non-recursive.
    Return - An array with keys 'success' and 'failure' indicating a count of resources affected by the removal.
  • midas.item.exists ?
  • Check whether an item with the given name exists in the given folder
    Parameters
    • parentid - The id of the parent folder
    • name - The name of the item
    Return - array('exists' => bool)
  • midas.item.create ?
  • Create an item or update an existing one if one exists by the uuid passed. Note: In the case of an already existing item, any parameters passed whose name begins with an underscore are assumed to be metadata fields to set on the item.
    Parameters
    • token - Authentication token
    • parentid - The id of the parent folder. Only required for creating a new item.
    • name - The name of the item to create
    • description - (Optional) The description of the item
    • uuid - (Optional) Uuid of the item. If none is passed, will generate one.
    • privacy - (Optional) [Public|Private], default will inherit from parent folder
    • updatebitstream - (Optional) If set, the bitstream's name will be updated simultaneously with the item's name if and only if the item has already existed and its latest revision contains only one bitstream.
    Return - The item object that was created
  • midas.item.get ?
  • Get an item's information
    Parameters
    • token - (Optional) Authentication token
    • id - The item id
    • head - (Optional) only list the most recent revision
    Return - The item object
  • midas.item.download ?
  • Download an item
    Parameters
    • token - (Optional) Authentication token
    • id - The id of the item
    • revision - (Optional) Revision to download. Defaults to latest revision
    Return - The bitstream(s) in the item
  • midas.item.delete ?
  • Delete an item
    Parameters
    • token - Authentication token
    • id - The id of the item
  • midas.item.getmetadata ?
  • Get the item's metadata
    Parameters
    • token - (Optional) Authentication token
    • id - The id of the item
    • revision - (Optional) Revision of the item. Defaults to latest revision
    Return - the sought metadata array on success, will fail if there are no revisions or the specified revision is not found.
  • midas.item.setmetadata ?
  • Set a metadata field on an item
    Parameters
    • token - Authentication token
    • itemId - The id of the item
    • element - The metadata element
    • value - The metadata value for the field
    • qualifier - (Optional) The metadata qualifier. Defaults to empty string.
    • type - (Optional) The metadata type (integer constant). Defaults to MIDAS_METADATA_TEXT type (0).
    • revision - (Optional) Revision of the item. Defaults to latest revision.
    Return - true on success, will fail if there are no revisions or the specified revision is not found.
  • midas.item.setmultiplemetadata ?
  • Set multiple metadata fields on an item, requires specifying the number of metadata tuples to add.
    Parameters
    • token - Authentication token
    • itemid - The id of the item
    • revision - (Optional) Item Revision number to set metadata on, defaults to latest revision.
    • count - The number of metadata tuples that will be set. For every one of these metadata tuples there will be the following set of params with counters at the end of each param name, from 1..count, following the example using the value i (i.e., replace i with values 1..count) (element_i, value_i, qualifier_i, type_i).
    • element_i - metadata element for tuple i
    • value_i - metadata value for the field, for tuple i
    • qualifier_i - (Optional) metadata qualifier for tuple i. Defaults to empty string.
    • type_i - (Optional) metadata type (integer constant). Defaults to MIDAS_METADATA_TEXT type (0).
    Return - true on success, will fail if there are no revisions or the specified revision is not found.
  • midas.item.deletemetadata ?
  • Delete a metadata tuple (element, qualifier, type) from a specific item revision, defaults to the latest revision of the item.
    Parameters
    • token - Authentication token
    • itemid - The id of the item
    • element - The metadata element
    • qualifier - (Optional) The metadata qualifier. Defaults to empty string.
    • type - (Optional) metadata type (integer constant). Defaults to MIDAS_METADATA_TEXT (0).
    • revision - (Optional) Revision of the item. Defaults to latest revision.
    Return - true on success, false if the metadata was not found on the item revision, will fail if there are no revisions or the specified revision is not found.
  • midas.item.deletemetadata.all ?
  • Deletes all metadata associated with a specific item revision; defaults to the latest revision of the item; pass revision=all to delete all metadata from all revisions.
    Parameters
    • token - Authentication token
    • itemid - The id of the item
    • revision - (Optional) Revision of the item. Defaults to latest revision; pass all to delete all metadata from all revisions.
    Return - true on success, will fail if there are no revisions or the specified revision is not found.
  • midas.item.duplicate ?
  • Duplicate an item to the destination folder
    Parameters
    • token - Authentication token
    • id - The id of the item
    • dstfolderid - The id of destination folder where the item is duplicated to
    Return - The item object that was created
  • midas.item.share ?
  • Share an item to the destination folder
    Parameters
    • token - Authentication token
    • id - The id of the item
    • dstfolderid - The id of destination folder where the item is shared to
    Return - The item object
  • midas.item.list.permissions ?
  • List the permissions on an item, requires Admin access to the item.
    Parameters
    • item_id - The id of the item
    Return - A list with three keys: privacy, user, group; privacy will be the item's privacy string [Public|Private]; user will be a list of (user_id, policy, email); group will be a list of (group_id, policy, name). policy for user and group will be a policy string [Admin|Write|Read].
  • midas.item.move ?
  • Move an item from the source folder to the desination folder
    Parameters
    • token - Authentication token
    • id - The id of the item
    • srcfolderid - The id of source folder where the item is located
    • dstfolderid - The id of destination folder where the item is moved to
    Return - The item object
  • midas.item.searchbyname ?
  • Return all items
    Parameters
    • token - (Optional) Authentication token
    • name - The name of the item to search by
    Return - A list of all items with the given name
  • midas.item.searchbynameandfolder ?
  • Return all items with a given name and parent folder id
    Parameters
    • token - (Optional) Authentication token
    • name - The name of the item to search by
    • folderId - The id of the parent folder to search by
    Return - A list of all items with the given name and parent folder id
  • midas.item.searchbynameandfoldername ?
  • Return all items with a given name and parent folder name
    Parameters
    • token - (Optional) Authentication token
    • name - The name of the item to search by
    • folderName - The name of the parent folder to search by
    Return - A list of all items with the given name and parent folder name
  • midas.item.add.policygroup ?
  • Add an itempolicygroup to an item with the passed in group and policy; if an itempolicygroup exists for that group and item, it will be replaced with the passed in policy.
    Parameters
    • item_id - The id of the item.
    • group_id - The id of the group.
    • policy - Desired policy status, one of [Admin|Write|Read].
    Return - success = true on success.
  • midas.item.remove.policygroup ?
  • Remove a itempolicygroup from a item with the passed in group if the itempolicygroup exists.
    Parameters
    • item_id - The id of the item.
    • group_id - The id of the group.
    Return - success = true on success.
  • midas.item.add.policyuser ?
  • Add a itempolicyuser to an item with the passed in user and policy; if an itempolicyuser exists for that user and item, it will be replaced with the passed in policy.
    Parameters
    • item_id - The id of the item.
    • user_id - The id of the targeted user to create the policy for.
    • policy - Desired policy status, one of [Admin|Write|Read].
    Return - success = true on success.
  • midas.item.remove.policyuser ?
  • Remove an itempolicyuser from an item with the passed in user if the itempolicyuser exists.
    Parameters
    • item_id - The id of the item.
    • user_id - The id of the target user.
    Return - success = true on success.
  • midas.user.folders ?
  • Return a list of top level folders belonging to the user
    Parameters
    • token - Authentication token
    Return - List of the user's top level folders
  • midas.user.apikey.default ?
  • Returns the user's default API key given their username and password. POST method required.
    Parameters
    • email - The user's email
    • password - The user's password
    Return - Array with a single key, 'apikey', whose value is the user's default api key
  • midas.user.list ?
  • Returns a portion or the entire set of public users based on the limit var.
    Parameters
    • limit - The maximum number of users to return
    Return - the list of users
  • midas.user.get ?
  • Returns a user either by id or by email or by first name and last name.
    Parameters
    • user_id - The id of the user desired (ignores firstname and lastname)
    • email - The email of the user desired
    • firstname - The first name of the desired user (use with last name)
    • lastname - The last name of the desired user (use with first name)
    Return - The user corresponding to the user_id or first and last name
  • midas.bitstream.get ?
  • Fetch the information about a bitstream
    Parameters
    • token - (Optional) Authentication token
    • id - The id of the bitstream
    Return - Bitstream dao
  • midas.bitstream.download ?
  • Download a bitstream either by its id or by a checksum. Either an id or checksum parameter is required.
    Parameters
    • token - (Optional) Authentication token
    • id - (Optional) The id of the bitstream
    • checksum - (Optional) The checksum of the bitstream
    • name - (Optional) Alternate filename to download as
    • offset - (Optional) The download offset in bytes (used for resume)
  • midas.bitstream.count ?
  • Count the bitstreams under a containing resource. Uses latest revision of each item.
    Parameters
    • token - (Optional) Authentication token
    • uuid - The uuid of the containing resource
    Return - array(size=>total_size_in_bytes, count=>total_number_of_files)
  • midas.bitstream.edit ?
  • Change the properties of a bitstream. Requires write access to the containing item.
    Parameters
    • token - Authentication token
    • id - The id of the bitstream to edit
    • name - (optional) New name for the bitstream
    • mimetype - (optional) New MIME type for the bitstream
    Return - The bitstream dao
  • midas.admin.database.cleanup ?
  • Remove orphaned resources in the database. Must be admin to use.
  • midas.bitstream.delete ?
  • Delete a bitstream. Requires admin privileges on the containing item.
    Parameters
    • token - Authentication token
    • id - The id of the bitstream to delete
  • midas.metadata.types.list ?
  • Get the metadata types stored in the system
  • midas.metadata.elements.list ?
  • Get the metadata elements stored in the system for a given metadata type.If the type name is specified, it will be used instead of the index.
    Parameters
    • type - the metadata type index
    • typename - (optional) the metadata type name
  • midas.metadata.qualifiers.list ?
  • Get the metadata qualifiers stored in the system for a given metadata typeand element. If the type name is specified, it will be used instead of thetype.
    Parameters
    • type - the metadata type index
    • element - the metadata element under which the qualifier is collated
    • typename - (optional) the metadata type name
  • midas.group.add.user ?
  • Add a user to a group, returns 'success' => 'true' on success, requiresadmin privileges on the community associated with the group.
    Parameters
    • group_id - the group to add the user to
    • user_id - the user to add to the group
    Return - success = true on success.
  • midas.group.remove.user ?
  • Remove a user from a group, returns 'success' => 'true' on success, requiresadmin privileges on the community associated with the group.
    Parameters
    • group_id - the group to remove the user from
    • user_id - the user to remove from the group
    Return - success = true on success.
  • midas.group.add ?
  • add a group associated with a community, requires admin privileges on thecommunity.
    Parameters
    • community_id - the id of the community the group will associate with
    • name - the name of the new group
    Return - group_id of the newly created group on success.
  • midas.group.remove ?
  • remove a group associated with a community, requires admin privileges on thecommunity.
    Parameters
    • group_id - the id of the group to be removed
    Return - success = true on success.
  • midas.group.list.users ?
  • list the users for a group, requires admin privileges on the communityassociated with the group
    Parameters
    • group_id - id of group
    Return - array users => a list of user ids mapped to a two element list ofuser firstname and lastname
  • midas.community.list.groups ?
  • list the groups for a community, requires admin privileges on the community
    Parameters
    • community_id - id of community
    Return - array groups => a list of group ids mapped to group names
  • midas.slicerpackages.extension.list ?
  • Get a filtered list of available Slicer extensions
    Parameters
    • extension_id - (Optional) The extension id
    • os - (Optional) The target operating system of the package (linux | win | macosx)
    • arch - (Optional) The os chip architecture (i386 | amd64)
    • submissiontype - (Optional) Dashboard model used to submit (nightly | experimental | continuous)
    • packagetype - (Optional) The package type (installer | data | extension)
    • productname - (Optional) The product name (Example: Slicer)
    • category - (Optional) The category (Example: Segmentation, Diffusion.Denoising)
    • codebase - (Optional) The codebase name (Example: Slicer4)
    • revision - (Optional) The revision of the package
    • slicer_revision - (Optional) The slicer revision the package was built against
    • release - (Optional) Release identifier associated with a package. If not set, it will return both released and non-released packages.
    • search - (Optional) Text matched against extension name or description.
    • order - (Optional) What parameter to order results by (revision | packagetype | submissiontype | arch | os)
    • direction - (Optional) What direction to order results by (asc | desc). Default asc
    • limit - (Optional) Limit result count. Must be a positive integer.
    Return - An array of slicer extension daos
  • midas.slicerpackages.extension.upload ?
  • Upload an extension package
    Parameters
    • os - The target operating system of the package
    • arch - The os chip architecture (i386, amd64, etc)
    • name - The name of the package (ie installer name)
    • repository_type - The type of the repository (svn, git)
    • repository_url - The url of the repository
    • revision - The svn or git revision of the extension
    • slicer_revision - The revision of Slicer that the extension was built against
    • submissiontype - Whether this is from a nightly, experimental, continuous, etc dashboard
    • packagetype - Installer, data, etc
    • productname - The product name (Ex: Slicer)
    • codebase - The codebase name (Ex: Slicer4)
    • description - Text describing the extension
    • release - (Optional) Release identifier (Ex: 0.0.1, 0.0.2, 0.1)
    • icon_url - (Optional) The url of the icon for the extension
    • development_status - (Optional) Arbitrary description of the status of the extension (stable, active, etc)
    • category - (Optional) Category under which to place the extension. Subcategories should be delimited by . character. If none is passed, will render under the Miscellaneous category.
    • enabled - (Optional) Boolean indicating if the extension should be automatically enabled after its installation
    • homepage - (Optional) The url of the extension homepage
    • screenshots - (Optional) Space-separate list of URLs of screenshots for the extension
    • contributors - (Optional) List of contributors of the extension
    Return - Status of the upload
  • midas.slicerpackages.get.packages ?
  • [DEPRECATED] Get a filtered list of available Slicer packages
    Parameters
    • os - (Optional) The target operating system of the package (linux | win | macosx)
    • arch - (Optional) The os chip architecture (i386 | amd64)
    • submissiontype - (Optional) Dashboard model used to submit (nightly | experimental | continuous)
    • packagetype - (Optional) The package type (installer | data | extension)
    • productname - (Optional) The product name (Example: Slicer)
    • codebase - (Optional) The codebase name (Example: Slicer4)
    • revision - (Optional) The revision of the package
    • release - (Optional) Release identifier associated with a package. If not set, it will return both released and non-released packages.
    • order - (Optional) What parameter to order results by (revision | packagetype | submissiontype | arch | os)
    • direction - (Optional) What direction to order results by (asc | desc). Default asc
    • limit - (Optional) Limit result count. Must be a positive integer.
    Return - An array of slicer packages
  • midas.slicerpackages.package.list ?
  • Get a filtered list of available Slicer packages
    Parameters
    • os - (Optional) The target operating system of the package (linux | win | macosx)
    • arch - (Optional) The os chip architecture (i386 | amd64)
    • submissiontype - (Optional) Dashboard model used to submit (nightly | experimental | continuous)
    • packagetype - (Optional) The package type (installer | data | extension)
    • productname - (Optional) The product name (Example: Slicer)
    • codebase - (Optional) The codebase name (Example: Slicer4)
    • revision - (Optional) The revision of the package
    • release - (Optional) Release identifier associated with a package. If not set, it will return both released and non-released packages.
    • order - (Optional) What parameter to order results by (revision | packagetype | submissiontype | arch | os)
    • direction - (Optional) What direction to order results by (asc | desc). Default asc
    • limit - (Optional) Limit result count. Must be a positive integer.
    Return - An array of slicer packages
  • midas.slicerpackages.package.upload ?
  • Upload a core package
    Parameters
    • os - The target operating system of the package
    • arch - The os chip architecture (i386, amd64, etc)
    • name - The name of the package (ie installer name)
    • revision - The svn or git revision of the installer
    • submissiontype - Whether this is from a nightly, experimental, continuous, etc dashboard
    • packagetype - Installer, data, etc
    • productname - The product name (Ex: Slicer)
    • codebase - The codebase name (Ex: Slicer4)
    • release - (Optional) Release identifier (Ex: 4.0.0, 4.2)
    • checkoutdate - (Optional) The date of the checkout
    Return - Status of the upload
  • midas.slicerpackages.package.releaseidentifier.list ?
  • Get a list of release identifiers associated with the Slicer packages
    Parameters
    • direction - (Optional) What direction to order results by (asc | desc). Default desc
    Return - An array of release identifiers
  • midas.sizequota.user.get ?
  • Get the size quota for a user.
    Parameters
    • user - Id of the user to check
    Return - array('quota' => The size quota in bytes for the user, or empty string if unlimited, 'used' => Size in bytes currently used)
  • midas.sizequota.community.get ?
  • Get the size quota for a community.
    Parameters
    • community - Id of the community to check
    Return - array('quota' => The size quota in bytes for the community, or empty string if unlimited, 'used' => Size in bytes currently used)
  • midas.sizequota.set ?
  • Set a quota for a folder. For MIDAS admin use only.
    Parameters
    • folder - The folder id
    • quota - (Optional) The quota. Pass a number of bytes or the empty string for unlimited. If this parameter isn't specified, deletes the current quota entry if one exists.
  • midas.slicerappstore.test ?
  • Test the web api from this plugin
    Parameters
    • foo - (Optional) not used
    Return - a json object defining a foo --> bar relationship
  • midas.solr.search.advanced ?
  • Create a big thumbnail for the given bitstream with the given width. It is used as the main image of the given item and shown in the item view page.
    Parameters
    • token - (Optional) Authentication token
    • query - The Lucene search query
    • limit - (Optional) The limit of the search; defaults to 25
    Return - The list of items matching the search query
  • midas.slicerdatastore.categories ?
  • Get the list of categories
    Return - list categories
  • midas.slicerdatastore.authenticate ?
  • Automatically authenticate an user using local storage data
    Parameters
    • sting - Data
    Return - boolean
  • midas.slicerdatastore.listdatasets ?
  • Call with ajax and filter parameters to get a list of datasets
    Parameters
    • category - The category filter
    • limit - Pagination limit
    • offset - Pagination offset