Servlet: /daris/object.mfjp

Owned by Andy Tseng
Mar 21, 2024
2 min read

  • Path:* /daris/object.mfjp

The servlet can be used to

    • get the the DaRIS object meta data in html or xml format;
    • list the the member/child objects of the specific DaRIS object in html or xml format;
    • download the content of the DaRIS object;
    • download all the contents of the DaRIS object and its descendants

1. Generic Arguments

  • Argument _skey: The session key if known. If this argument and the _token* argument are not given or invalid. It will redirect to the login page(/daris/main.mfjp?module=logon)
  • Argument _token: The secure identity token if known. If this argument and the _skey* argument are not given or invalid. It will redirect to the login page(/daris/main.mfjp?module=logon)
  • Argument module: It is the action to execute. There are there moudles can be chosen from: “describe”, “list” and “download”*.
  • Argument cid: It is the citeable identifier of the DaRIS object. It the module is “list” and cid* is not given, the list of all the porjects in DaRIS repository will be returned.

2. Module: describe

2.1. Arguments for “describe” module

  • Argument cid*: the citeable identifier of the object.
  • Argument format: specifies the output format. Can be xml or html. Defaults to html*.

2.2. Examples

  • Get the object meta data in xml* format:
https://daris.yourdomain.org:port/daris/object.mfjp?module=describe&cid=1.5.1.1&format=xml
  • Get the object meta data in html* format(or display it in browser):
https://daris.yourdomain.org:port/daris/object.mfjp?module=describe&cid=1.5.1.1&format=html

3. Module: list

3.1. Arguments for “list” module

  • Argument cid*: the citeable identifier of the parent object. If not given, all the project objects are returned.
  • Argument format: specifies the output format. Can be xml or html. Defaults to html*.
  • Argument sort*: set to true to sort the result members by their cid. Defaults to false.

3.2. Examples

  • Get the member list of object 1.5.1 in xml* format:
https://daris.yourdomain.org:port/daris/object.mfjp?module=list&cid=1.5.1&format=xml
  • Get the member list of object 1.5.1 in html* format and sort the results by cid(or display it in browser):
https://daris.yourdomain.org:port/daris/object.mfjp?module=list&cid=1.5.1&sort=true

4. Module: dowload

4.1. Arguments for “download” module

  • Argument cid*: the citeable identifier of the object.
  • Argument recursive*: set to true to include the contents of all the descendants when downloading the object (It will call the shoppingcart servlet: /daris/shoppingcart.mfjp to download). Defaults to false, which will download the content of the specified object.
  • Argument transcode*: The transcodes to be applied when downloading the object. The value of this argument is in the form of from_type1-to_type1|from_type2-to_type2.
  • Argument filename*: The name for the downloaded content/archive file. If not given, defaults to the object citeable id (if not recursive) or the shopping cart id (if recursive).
  • Argument disposition: How the content/archive should be treated by the caller. Can be attachment or inline. Defaults to attachment*.
  • Argument proceed*: Set to true to proceed to download, otherwise, displays(returns) to the download settings page. Defaults to true.

4.2. Examples

    • Download the content of the DaRIS object 1.5.3.2.1.2.3:
https://daris.yourdomain.org:port/daris/object.mfjp?module=download&cid=1.5.3.2.1.2.3
  • Transcode the content of the DaRIS object 1.5.3.2.1.2.3 to nifti/series* and download the result:
https://daris.yourdomain.org:port/daris/object.mfjp?module=download&cid=1.5.3.2.1.2.3&transcode=nifti/series
    • Download the contents of the DaRIS object 1.5.3.2.1.2 and all its descendants:
https://daris.yourdomain.org:port/daris/object.mfjp?module=download&cid=1.5.3.2.1.2&recursive=true