Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
POST - /data/services/prearchive/move

Parameters

srcRequired body parameter: The location of the session relative to the prearchive path. (e.g. /prearchive/projects/Sample_Project/20140411_140005287/Sample_Session)
newProjectRequired body parameter: The ID of the destination project
asyncOptional body parameter. Default is "false"
format

Optional querystring parameter. Specify the format of the response text

  • xml (default)
  • html
  • json
  • csv

Response (JSON format shown)

Code Block
{
  "ResultSet": {
    "Result": [
      {
        "scan_time": "time",
        "status": "QUEUED_MOVING",
        "subject": "string",
        "tag": "dicom_uuid",
        "TIMEZONE": "",
        "uploaded": "datetime",
        "lastmod": "datetime",
        "scan_date": "datetime",
        "url": "string",
        "timestamp": "string",
        "prevent_auto_commit": "boolean",
        "project": "string",
        "SOURCE": "",
        "prevent_anon": "boolean",
        "autoarchive": "string",
        "name": "string",
        "folderName": "string",
        "VISIT": "string",
        "PROTOCOL": "string"
      }
    ]
  }
}


Rebuild An Image Session Listing

Refreshes the session XML metadata. Note that if a session was moved, this function will not reset the project to its original state.

Code Block
POST - /data/services/prearchive/rebuild

Parameters

srcRequired body parameter. The location of the session relative to the prearchive path. (e.g. /prearchive/projects/Sample_Project/20140411_140005287/Sample_Session)
format

Optional querystring parameter. Specify the format of the response text

  • xml (default)
  • html
  • json
  • csv

Response (JSON format shown)

Code Block
{
  "ResultSet": {
    "Result": [
      {
        "scan_time": "time",
        "status": "QUEUED_MOVING",
        "subject": "string",
        "tag": "dicom_uuid",
        "TIMEZONE": "",
        "uploaded": "datetime",
        "lastmod": "datetime",
        "scan_date": "datetime",
        "url": "string",
        "timestamp": "string",
        "prevent_auto_commit": "boolean",
        "project": "string",
        "SOURCE": "",
        "prevent_anon": "boolean",
        "autoarchive": "string",
        "name": "string",
        "folderName": "string",
        "VISIT": "string",
        "PROTOCOL": "string"
      }
    ]
  }
}


Delete An Image Session From The Prearchive

Code Block
POST - /data/services/prearchive/delete

Parameters

srcRequired body parameter. The location of the session relative to the prearchive path. (e.g. /prearchive/projects/Unassigned/20140411_140005287/Sample_Session)
format

Optional querystring parameter. Specify the format of the response text

  • xml (default)
  • html
  • json
  • csv

Response (JSON format shown)

Code Block
{
  "ResultSet": {
    "Result": [
      {
        "scan_time": "time",
        "status": "QUEUED_MOVING",
        "subject": "string",
        "tag": "dicom_uuid",
        "TIMEZONE": "",
        "uploaded": "datetime",
        "lastmod": "datetime",
        "scan_date": "datetime",
        "url": "string",
        "timestamp": "string",
        "prevent_auto_commit": "boolean",
        "project": "string",
        "SOURCE": "",
        "prevent_anon": "boolean",
        "autoarchive": "string",
        "name": "string",
        "folderName": "string",
        "VISIT": "string",
        "PROTOCOL": "string"
      }
    ]
  }
}