API Reference

Get Files that are associated with a Domain Record

get
https://{environment}.origamirisk.com/OrigamiApi/api///Files
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Get files that are attached to a given parent record. You must specify a set of columns to return. An optional filter may be used to limit results further. Note that the file stream itself will not be returned but the column DownloadURL will contain downloadable URL (with limited expiration date).


Path Params
string
required

This should match to the Domain Name in the system. It is case-sensitive. For Client Defined Entities it should start with "Custom.".

integer
required

This is the primary identifier for the parent record. For example, if my {domain} is Claim

Query Params
string
required
Defaults to FileID,FileName,EntryDate,Contents,ExternalDirectURL,DownloadURL

A comma separated list of the columns you want returned to you in the response.
See the sample 200 -OK response schema below for more information. Depending on your use case you will probably find high utility from the following:

FileID,FileName,EntryDate,Contents,ExternalDirectURL,DownloadURL


If any of the fields above are not available or cause your API call to fail, it may be due to a permission and/or licensing constraint. Please contact Origami Support for more info.

string

Record filter criteria in the Origami Advanced Search syntax.

string

Columns to sort by. Similar syntax to sorting in Views.

integer
Defaults to 0

Default is 0. If you are fetching subsequent pages of data indicate the record to start with.

integer

If you do not provide a value for take, the default is 30 records. The maximum allowed is configured per client and, while adjustable, it rarely exceeds 100.

string

Optional record filter criteria in C# LINQ syntax. Only to be used in cases where filter syntax does not meet needs.

Responses

Updated 8 months ago

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 8 months ago