GET Documents?contextType={contextType}&contextUid={contextUid}

Gets all documents satisfying the given parameters.

Request Information

URI Parameters

Name	Description	Type	Additional information
contextType	Type of the context. Should be either "Patient" or "Study"	string	Required
contextUid	The context UID.	string	Required

Body Parameters

None.

Response Information

Resource Description

Gets all documents satisfying the given parameters.

Collection of Document

Name	Description	Type	Additional information
Id	Gets or sets the id.	integer	None.
OwnerUuid	Gets or sets the owner UUID.	string	None.
Title	Gets or sets the title.	string	None.
Created	gets or sets the created date	date	None.
ResourcePath	gets or sets the resource path	string	None.
UserLogin	User that uploaded the document	string	None.
UserFullName	User's full name	string	None.
UncPath	Unc Path	string	None.
HttpPath	Http Path	string	None.
HttpsPath	Https Path	string	None.
FullUncPath	Gets the full unc path.	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Id": 1,
    "OwnerUuid": "sample string 2",
    "Title": "sample string 3",
    "Created": "2025-04-30T18:44:10",
    "ResourcePath": "sample string 4",
    "UserLogin": "sample string 5",
    "UserFullName": "sample string 6",
    "UncPath": "sample string 7",
    "HttpPath": "sample string 8",
    "HttpsPath": "sample string 9",
    "FullUncPath": "sample string 10"
  },
  {
    "Id": 1,
    "OwnerUuid": "sample string 2",
    "Title": "sample string 3",
    "Created": "2025-04-30T18:44:10",
    "ResourcePath": "sample string 4",
    "UserLogin": "sample string 5",
    "UserFullName": "sample string 6",
    "UncPath": "sample string 7",
    "HttpPath": "sample string 8",
    "HttpsPath": "sample string 9",
    "FullUncPath": "sample string 10"
  }
]

application/xml, text/xml

Sample:

<ArrayOfDocument xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Fujifilm.Synapse.Workflow.Engine.Models.Documents">
  <Document>
    <Created xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2025-04-30T09:14:10.1591112Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>570</d3p1:OffsetMinutes>
    </Created>
    <FullUncPath>sample string 10</FullUncPath>
    <HttpPath>sample string 8</HttpPath>
    <HttpsPath>sample string 9</HttpsPath>
    <Id>1</Id>
    <OwnerUuid>sample string 2</OwnerUuid>
    <ResourcePath>sample string 4</ResourcePath>
    <Title>sample string 3</Title>
    <UncPath>sample string 7</UncPath>
    <UserFullName>sample string 6</UserFullName>
    <UserLogin>sample string 5</UserLogin>
  </Document>
  <Document>
    <Created xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2025-04-30T09:14:10.1591112Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>570</d3p1:OffsetMinutes>
    </Created>
    <FullUncPath>sample string 10</FullUncPath>
    <HttpPath>sample string 8</HttpPath>
    <HttpsPath>sample string 9</HttpsPath>
    <Id>1</Id>
    <OwnerUuid>sample string 2</OwnerUuid>
    <ResourcePath>sample string 4</ResourcePath>
    <Title>sample string 3</Title>
    <UncPath>sample string 7</UncPath>
    <UserFullName>sample string 6</UserFullName>
    <UserLogin>sample string 5</UserLogin>
  </Document>
</ArrayOfDocument>