v18

latestOpenAPI 3.0.0raw.githubusercontent.com2024-11-18167108845.6 KB

filestorage/files

Retrieve Files

Retrieve Files from any connected Filestorage software

get/filestorage/files/{id}

Path parameters

idstring required

id of the file you want to retrieve.

Query parameters

remote_databoolean

Set to true to include data from the original File Storage software.

Headers

x-connection-tokenstring required

The connection token

Response

namestring nullable required

The name of the file

file_urlstring nullable required

The url of the file

mime_typestring nullable required

The mime type of the file

sizestring nullable required

The size of the file

folder_idstring nullable required

The UUID of the folder tied to the file

permissionstring nullable required

The UUID of the permission tied to the file

shared_linkstring nullable required

The UUID of the shared link tied to the file

field_mappingsobject nullable

The custom field mappings of the object between the remote 3rd party & Panora

idstring nullable

The UUID of the file

remote_idstring nullable

The id of the file in the context of the 3rd Party

remote_dataobject nullable

The remote data of the file in the context of the 3rd Party

created_atstring date-time nullable

The created date of the object

modified_atstring date-time nullable

The modified date of the object

Example response

{
  "name": "my_paris_photo.png",
  "file_url": "https://example.com/my_paris_photo.png",
  "mime_type": "application/pdf",
  "size": "1024",
  "folder_id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
  "permission": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
  "shared_link": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
  "field_mappings": {
    "fav_dish": "broccoli",
    "fav_color": "red"
  },
  "id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
  "remote_id": "id_1",
  "remote_data": {
    "fav_dish": "broccoli",
    "fav_color": "red"
  },
  "created_at": "2024-10-01T12:00:00Z",
  "modified_at": "2024-10-01T12:00:00Z"
}