Files

Import file

Import a file.

POST

/gb/files

Import file

curl --request POST \
  --url https://api.catch-e.com/gb/files \
  --header 'Authorization: <api-key>' \
  --header 'Audit-User-Id: <string>' \
  --header 'Time-Zone: UTC' \
  --form 'file=<string>' \
  --form 'file_name=<string>' \
  --form 'file_type=<string>' \
  --form 'platform=catch-e'

{
  "file_id": "<string>",
  "file_type_id": "<string>",
  "last_edit": "2023-11-07T05:31:56Z",
  "md5": "<string>",
  "name": "<string>",
  "status_flag": "active",
  "super_flag": "yes",
  "user_id_last_edit": "<string>"
}

Please note that file data can take up to 5 minutes to refresh on the back-office system.

This method requires the Files:Import permission to be associated with your role.

Authorizations

Authorizationstringheaderrequired

For accessing the API a valid token must be passed in all the queries in the 'Authorization' header.

A valid token is generated by the API and returned by the /authenticate method by supplying a valid username and password.

The following syntax must be used in the 'Authorization' header :

Bearer aaaaaa/bbbbbb.ccccccc.dddddd

Headers

Audit-User-Idstringheader

(Optional) User Id to use for audit purposes. This header requires the Audit:UserIdOverride permission to be associated with your role.

Maximum string length: 5

Pattern: ^[1-9]{1}[0-9]*$

Time-Zonestringheaderdefault:UTC

The timezone value can be given in several formats, none of which are case sensitive:

As a named time zone, such as 'Europe/Helsinki', 'US/Eastern', or 'MET'.
As a string indicating an offset from UTC of the form [H]H:MM, prefixed with a + or -, such as '+10:00', '-6:00', or '+05:30'. A leading zero can optionally be used for hours values less than 10;

Maximum string length: 100

Pattern: ^[a-zA-Z0-9\/\:\+\-\_]+$

Body

filestringrequired

File to import

file_namestring

(Optional) File Name.

If not specified, the file name will be the name of the file imported.

Maximum string length: 200

file_typestringrequired

File Type

Example: Quote Templates

Maximum string length: 50

platformenum<string>required

Platform

Available options: catch-e, catch-e-api, catch-e-driver-portal

Response

Success - File imported successfully

file_idstring

file_type_idstring

last_editstring

md5string

namestring

status_flagenum<string>

Available options: active, inactive

super_flagenum<string>

Available options: yes, no

user_id_last_editstring

Still need help? Ask the team