Page tree

Versions Compared

Key

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

...

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

Parameters

{project-id}Optional path parameter. Restricts the results to a specified project
format

Optional querystring parameter. Specify the format of the response text

  • json (default)
  • html
  • xml
  • csv

Response

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": ""
      }
    ]
  }
}

...

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

Parameters

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

Response

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

...

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

Parameters

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}