Files

Appmixer allows you to upload files to use them in your flows.

Get file info

GET https://api.YOUR_TENANT.appmixer.cloud/files/metadata/:fileId

Get the information for the specified file. Note that the file content is not included.

Path Parameters

NameTypeDescription

fileId

string

The UUID of the required file.

{
    "length": 146737,
    "chunkSize": 261120,
    "uploadDate": "2020-07-24T19:19:49.755Z",
    "filename": "chart1.png",
    "md5": "1d0ed5eb2cacbab4526de272837102dd",
    "metadata": {
        "userId": "5f15d59cef81ecb3344fab55"
    },
    "contentType": "image/png",
    "fileId": "f179c163-2ad8-4f9d-bce5-95200691b7f9"
}

Upload a file

POST https://api.YOUR_TENANT.appmixer.cloud/files

Upload file to Appmixer. Uploads by chunks are supported, and whether if sent file is treated as a chunk or a new file depends on the headers sent. Also, Content-type must be set to multipart/form-data.

Headers

NameTypeDescription

Content-type

string

Must be set to multipart/form-data

uploader-file-id

string

If set, the current file will be appended as a chunk to the file specified by this. If not present, a new file will be created. The response includes the resulting file's ID, so it can be used in subsequent requests to add chunks to the generated file.

uploader-file-name

string

The name of the file. This will be ignored in case that uploader-file-id header is present.

uploader-chunk-size

string

The size in bytes of the file/chunk being uploaded.

uploader-chunk-number

string

This header is uploader-chunk-number. The ordinal number of this chunk - e.g. the first chunk is 1, the second is 2 and so on.

uploader-chunks-total

string

This header is uploader-chunks-total. The total number of chunks that compose the file. If set to 1, it means that this is the complete file

Request Body

NameTypeDescription

file

string

The file/chunk to be uploaded

{
  "length": 146737,
  "chunkSize": 261120,
  "uploadDate": "2020-07-24T20:23:38.565Z",
  "filename": "chart1.png",
  "md5": "1d0ed5eb2cacbab4526de272837102dd",
  "metadata": {
    "userId": "5f15d59cef81ecb3344fab55"
  },
  "contentType": "image/png",
  "fileId": "8cb8fed0-0cd8-4478-8372-9f7cb4eb16e3"
}

Get user files

GET https://api.YOUR_TENANT.appmixer.cloud/files

Example: https://api.appmixer.com/files?limit=10&filter=filename:~invoice&sort=filename:1

The example will return 10 files with 'invoice' in the filename.

Query Parameters

NameTypeDescription

limit

number

offset

number

sort

String

projection

String

includeComponentSourceFiles

Boolean

By default, the endpoint returns only files (that are used in flows). Custom component source codes are stored as files as well, if the user owns some, they can be returned as well.

filter

String

[
    {
        "length": 2366210,
        "chunkSize": 261120,
        "uploadDate": "2022-09-14T15:25:33.281Z",
        "filename": "3mb.pdf",
        "md5": "69604bdd54ff681ecd0bf166544c0854",
        "metadata": {
            "userId": "6123bbeb34598f20b676833b"
        },
        "contentType": "application/pdf",
        "fileId": "7b917904-41b8-4c66-9f5f-0c1bf897eab6"
    }
]

Get number of files

GET https://api.YOUR_TENANT.appmixer.cloud/files/count

Used for paging.

Query Parameters

NameTypeDescription

includeComponentSourceFiles

Boolean

By default, the endpoint returns only files (that are used in flows). Custom component source codes are stored as files as well, if the user owns some, they can be returned as well.

filter

String

{
    count: 2
}

Remove file.

DELETE https://api.YOUR_TENANT.appmixer.cloud/files/:fileId

{
    // Response
}

Delete all user files.

DELETE https://api.YOUR_TENANT.appmixer.cloud/files

Example: DELETE https://api.appmixer.com/files?filter=filename:~invoice will delete all user's files with 'invoice' in the name.

Query Parameters

NameTypeDescription

filter

String

Can be used to filter files.

{
    // Response
}

Last updated