Skip to content

Latest commit

 

History

History
34 lines (24 loc) · 2.11 KB

FileReferenceCreate.md

File metadata and controls

34 lines (24 loc) · 2.11 KB

MissionControl.FileReferenceCreate

Properties

Name Type Description Notes
referenceableType String The type of object this file reference is attached to, used in conjunction with the referenceable_id attribute to locate the item referenced. [optional]
referenceableId String The UUID of the object this file reference is attached to, this forms a compound link in combination with the referenceable_type field [optional]
kind String The kind of the file reference [optional]
url String The URL under which this file is accessible. Supported protocols are `http` and `https` as well as `smb`. Whenever file placement is within our control, you should ensure to use https, so that other non-local apps can easily retrieve the file. Must not be provided if `zaikio_vault_ref` is provided. [optional]
zaikioVaultRef String A resource locator for a file stored within a Zaikio Vault. This will allow autopopulation of metadata attributes as well as all of the other benefits that the Zaikio Vault brings in security, simplicity and reliability. [optional]
mimeType String The RFC 2045 mime-type of the file. For `artwork` and `imposing` kinds this must be `application/pdf`, for paths it must be `image/svg+xml`. Can be autopopulated if the record is created using a `zaikio_vault_ref` instead of a URL. [optional]
size Number The file size on disk in bytes. This will be auto populated if the record is created using a `zaikio_vault_ref` instead of a URL. [optional]

Enum: ReferenceableTypeEnum

  • finishing (value: "Finishing")
  • part (value: "Part")

Enum: KindEnum

  • artwork (value: "artwork")
  • imposing (value: "imposing")
  • path (value: "path")

Enum: MimeTypeEnum

  • applicationpdf (value: "application/pdf")
  • imagesvgxml (value: "image/svg+xml")