The File Management Service (FMS) is a service that allows you to create and retrieve files. You can use FMS to store files for a wide range of use cases such as licenses, invoices, warehouse receipts, and so on.

FMS offers features for organizing files, configuring access to meet compliance requirements, and providing a searchable database for quick retrieval of files. You can store both documents and URLs of various formats (e.g., text, PDF, audio, video) and assign tags to facilitate searching. Tags consist of a key-value pair, where both are required, though the value can be an empty string (e.g., key: CONSIGNEE, value: ADDRESS).

Files are organized in folders and can be stored directly as files or as links to external files. Each file is assigned a document ID for retrieval, and access is granted through a pre-signed link with a configurable expiration time.

File Storage: If you’re in logistics, you know how important it is to keep track of documents. Use FMS to store your shipping invoices, delivery receipts, and compliance papers. Just upload them, create folders, and tag everything so it’s easy to find later.

Short-term File Management: You often handle documents that are only needed for a limited time—like shipping details or time-sensitive contracts. With FMS, you can set a Time-to-Live (TTL) for these files, so they’re automatically deleted after a certain period. This keeps your storage organized and avoids clutter, ensuring you only keep what’s truly necessary.

Compliance and Audit: In logistics, staying compliant is a big deal. FMS lets you control who can see and edit sensitive documents. Set permissions for your team so only the right people have access. This is super important for audits and keeping everything secure.

File Retrieval: You generate a lot of data in logistics, and finding the right document fast is key. With FMS, you can tag and use metadata to search for documents easily. So when you need a purchase order or inventory list, you can grab it quickly without any hassle.

To utilize FMS, developers interact with its API endpoints for creating folders, storing documents, retrieving files, and managing access. Below are the key actions for integrating FMS into your application.

Before you create or upload files in FMS, it’s essential to create a folder to organize your files and data effectively.

FMS allows you to create a folder to organize your files and data:

After the folder is created, the service generates a unique identifier (ID) for the folder and returns it in the response. This ID can be used for future operations, such as uploading files or managing permissions. View Example.

FMS allows you to store files in two ways:

After uploading the file, the service generates a UUID to use as the document ID and returns it in the response. The file is asynchronously uploaded on a separate thread. In the case of a URL, the URL is stored in FMS and a document ID is generated and returned in the response.

Some metadata (name, description, tags, etc.) is stored along with the file and URL. Files are stored asynchronously and the status of the file upload is returned by the callback. View Example.

The files are retrieved from FMS by their IDs. If the file is stored in FMS then the download is provided by a pre-signed link is provided. Users can download files using a pre-signed link. The presigned link will have one expiry time and if the link is expired, the user has to again make a call to get a new presigned link to download.

When you upload a file, you have the option to add a tag along with it. These tags can be used to search and filter uploaded files. During the search, matching files or URL metadata is exposed to you. After that, you can download the file based on your ID.

For one tag there can be multiple docs available. During the search, the metadata for all matching documents is sent. After searching based on a tag, you are sent the metadata but you'll not be able to view the file content yet.

To view the content of the file, you need to make a separate request to download the file. After making a download request, you are checked for download access. If you have access, the file is downloaded and can be viewed.

FMS provides features for auditing and managing access to your data. Access management is handled through Authentication And Authorization Service (AAA) integration. Since files are stored inside folders, you can provide access to folders for uploading or downloading files by creating resources and permissions in AAA.

With FMS, you can set a Time-to-Live (TTL) for files stored in folders, ensuring that temporary data is automatically cleaned up after a specified period. Here’s how to configure TTL:

To create a folder, call the Create Folder endpoint and pass the following values in the request body.

Request bodies are specified in JSON format. The following example shows a request body to create a folder:

To store a file in the File Management Service, call the Upload File endpoint .

Pass the following values in the request body.

The following example shows a request body to store a link to a file:

For detailed information on the FMS Service APIs, including endpoints, request/response formats, and additional configuration options, refer to the API documentation.