List all S3Files

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Query Params

parent_type

string

optional

Type of the parent object to which the document is related

Example:

Logistics::Loading

parent_id

string

optional

The UUID of the parent object.(Booking e.g.)

Example:

9093ab21-1926-409e-a82f-3a6b1d7a4921

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request GET 'https://demo.modaltrans.com/api/v1/s3files?parent_type=Logistics::Loading&parent_id=9093ab21-1926-409e-a82f-3a6b1d7a4921'

Responses

🟢200OK

application/json

Body

array of:

id

integer

optional

name

string

optional

file_data

string

optional

size

string

optional

file_type

null

optional

created_at

string

optional

parent_type

string

optional

parent_id

integer

optional

document_url

string

optional

user_id

integer

optional

user_name

string

optional

file_class

string

optional

Example

[
    {
        "id": 0,
        "name": "string",
        "file_data": "string",
        "size": "string",
        "file_type": null,
        "created_at": "string",
        "parent_type": "string",
        "parent_id": 0,
        "document_url": "string",
        "user_id": 0,
        "user_name": "string",
        "file_class": "string"
    }
]

🟠400Bad Request

🟠403Forbidden

🟠404Record Not Found