Page tree

Versions Compared

Key

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


Panel



Contents

Table of Contents



Get A List Of All Sessions In The Prearchive

This REST endpoint returns a list of all sessions waiting to be archived that the currently logged-in user has permission to view.

...

Code Block
{
  "ResultSet": {
    "Result": [
      {
        "autoarchive": "",
        "folderName": "string",
        "lastmod": "datetime",
        "name": "string",
        "prevent_anon": boolean,
        "prevent_auto_commit": boolean,
        "project": "string {project-id}",
        "PROTOCOL": "",
        "scan_date": "date",
        "scan_time": "time",
        "SOURCE": "SessionImporter",
        "status": "string",
        "subject": "string",
        "tag": "string {UID}",
        "timestamp": "string",
        "TIMEZONE": "",
        "uploaded": "datetime",
        "url": "relative path",
        "VISIT": ""
      }
    ]
  }
}



Move A Session To A New Project

When an image session is imported into the prearchive, session metadata is inspected to determine which project it should eventually be archived in. This also determines which project users can see this session in the prearchive. If no project is found, an image session will go into the "Unassigned" prearchive, which is only visible to site administrators. This REST endpoint allows admins or project owners to change the project associated with an image session.

...

Code Block
{
  "ResultSet": {
    "Result": [
      {
        "autoarchive": "",
        "folderName": "string",
        "lastmod": "datetime",
        "name": "string",
        "prevent_anon": boolean,
        "prevent_auto_commit": boolean,
        "project": "string {project-id}",
        "PROTOCOL": "",
        "scan_date": "date",
        "scan_time": "time",
        "SOURCE": "SessionImporter",
        "status": "string",
        "subject": "string",
        "tag": "string {UID}",
        "timestamp": "string",
        "TIMEZONE": "",
        "uploaded": "datetime",
        "url": "relative path",
        "VISIT": ""
      }
    ]
  }
}


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
{
  "ResultSet": {
    "Result": [
      {
        "autoarchive": "",
        "folderName": "string",
        "lastmod": "datetime",
        "name": "string",
        "prevent_anon": boolean,
        "prevent_auto_commit": boolean,
        "project": "string {project-id}",
        "PROTOCOL": "",
        "scan_date": "date",
        "scan_time": "time",
        "SOURCE": "SessionImporter",
        "status": "string",
        "subject": "string",
        "tag": "string {UID}",
        "timestamp": "string",
        "TIMEZONE": "",
        "uploaded": "datetime",
        "url": "relative path",
        "VISIT": ""
      }
    ]
  }
}


Delete An Image Session From The Prearchive

Note

This URI is a mirror of DELETE - /data/prearchive/projects/{project-id}/{timestamp}/{session-label}, where the src param replaces the relative path

...

Code Block
{
  "ResultSet": {
    "Result": [
      {
        "autoarchive": "",
        "folderName": "string",
        "lastmod": "datetime",
        "name": "string",
        "prevent_anon": boolean,
        "prevent_auto_commit": boolean,
        "project": "string {project-id}",
        "PROTOCOL": "",
        "scan_date": "date",
        "scan_time": "time",
        "SOURCE": "SessionImporter",
        "status": "string",
        "subject": "string",
        "tag": "string {UID}",
        "timestamp": "string",
        "TIMEZONE": "",
        "uploaded": "datetime",
        "url": "relative path",
        "VISIT": ""
      }
    ]
  }
}


Get A List Of Scans From A Session In The Prearchive

Code Block
GET - /data/prearchive/projects/{project-id}/{timestamp}/{session}/scans

...

Code Block
{
  "ResultSet": {
    "Result": [
      {
        "ID": "integer"
        "series_description": "string",
        "xsiType": "xsiType",
      }
    ]
  }
}



Delete A Single Scan From A Session In The Prearchive

Specify a Scan ID from the above query.

...

project-id/timestamp/sessionThese src path attributes can be found in the "url" parameter of one of the above queries for sessions in the Prearchive
{scan-ID}Required path parameter.


Get A List Of Scan Resources From A Session In The Prearchive

Code Block
GET - /data/prearchive/projects/{project-id}/{timestamp}/{session}/scans/{scan-ID}/resources


Get A List Of Scan Resource Files From A Session In The Prearchive

Code Block
GET - /data/prearchive/projects/{project-id}/{timestamp}/{session}/scans/{scan-ID}/resources/{resource}/files


Get A Scan Resource File From A Session In The Prearchive

Code Block
GET - /data/prearchive/projects/{project-id}/{timestamp}/{session}/scans/{scan-ID}/resources/{resource}/files/{filename}

...