Params

Param name Description
data
required

External Report Attachment information

Validations:

  • Must be a Hash

data[type]
required

Validations:

data[attributes]
required

Validations:

  • Must be a Hash

data[attributes][title]
optional , nil allowed

Title of the file

Validations:

  • Must be a String

data[attributes][source]
required

the file in data URL format

Validations:

  • Must be a String

data[attributes][source-file-name]
required

Validations:

  • Must be a String

data[attributes][source-file-size]
optional , nil allowed

Validations:

  • Must be a String

data[relationships]
required

Validations:

  • Must be a Hash

data[relationships][external-report]
required

Validations:

  • Must be a Hash

data[relationships][external-report][data]
required

Validations:

  • Must be a Hash

data[relationships][external-report][data][type]
required

Type which is `external-reports`

Validations:

  • Must be a String

data[relationships][external-report][data][id]
required

External Report ID

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hyphen(-) with no leading or trailing space.