Upload a Linked File (Using Origami Storage)

post

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Overview

This endpoint uploads a linked 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

Content Type Requirements

Requests to this endpoint must use the multipart/form-data content type. The file itself is submitted as one part of the form-data payload.

Form-Data Attributes

For example purposes, this reference only shows the following fields:

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’ve got external workflows or Data Entry Events and you don’t want them firing, be sure to set the value to false.

Body Params

File

file

required

This is the encoded file.

FileName

string

required

This is the name of the file in the destination file system. Please include the file extension.
Please use standard best practices for choosing your filename (avoid spaces and long filenames, etc).

Description

string

A human readable description of what the file is. In the Origami UI this could appear as a the clickable hyperlink anchor text. If null, then the FileName will be used as the description.

Response

Overview

Content Type Requirements

Form-Data Attributes

200