FetchFile
| Full path | FetchFile?ClientID={ClientID}&FileID={FileID} |
| HTTP Verb | GET |
| Description | This endpoint expects an HTTP GET request with a ClientID and a FileID. Requires authentication with an OAuth2 token |
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| ClientID |
The unique client id |
string |
Required |
| FileID |
The unique file id |
string |
Required |
Body Parameters
None.
Response Information
Resource Description
a document containing a base64 string of a file
Document| Name | Description | Type | Additional information |
|---|---|---|---|
| base64 | string |
None. |
|
| mimeType | string |
None. |
|
| metadata | Collection of Metadata |
None. |
Response Formats
application/json, text/json
Sample:
{
"base64": "sample string 1",
"mimeType": "sample string 2",
"metadata": [
{
"name": "sample string 1",
"value": "sample string 2"
},
{
"name": "sample string 1",
"value": "sample string 2"
}
]
}
application/xml, text/xml
Sample:
<Document xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/External.Cecurity">
<base64>sample string 1</base64>
<metadata>
<Metadata>
<name>sample string 1</name>
<value>sample string 2</value>
</Metadata>
<Metadata>
<name>sample string 1</name>
<value>sample string 2</value>
</Metadata>
</metadata>
<mimeType>sample string 2</mimeType>
</Document>