Upload a Linked File (Using External Storage)

post

https://{environment}.origamirisk.com/OrigamiApi/api/Files/UploadExternal/{domain}/{id}

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Overview

This endpoint uploads an externally sourced file that becomes associated with a specific parent record (as defined by the {domain} and {id} values).

For example, if I want to upload a file for Policy 12345, then the route will be: /Files/Upload/Policy/12345

If you want to upload a file to Claim 76543 then the route will be:
/Files/Upload/Claim/76543

Required Attributes

The ExternalDirectURL property must be provided and set to a URL that points to the externally stored file.

For example purposes, this reference shows the following fields in the sample Payload:

ExternalDirectURL
FileName
Description

You are not limited to these fields. Any attribute defined in the Files domain may be supplied.
See the, Files Data Dictionary for a full description of all fields.

Path Params

domain

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

Numeric primary identifier for record to be updated.

Query Params

fireEvents

boolean

Defaults to false

This field lets you decide whether creating this domain record should trigger a corresponding system event. If you have external workflows or Data Entry Events and you don’t want them firing, be sure to set the value to false.

Body Params

RAW_BODY

json

required

Defaults to { "ExternalDirectURL" : "https://yourlocation.com/path-to-file/filename.pdf", "FileName" : "filename.pdf", "Description": "Description or Title of the File Goes Here", "Folder": "" }

This is a JSON object representing the key-value data of the Files domain object. See the Files Data Dictionary for a full view of this object. Note the ExternalDirectURL value is required.

Response

Overview

Required Attributes

200