OttoFMS API - Start multi-file download

Start a multi-file download. Returns a link that streams files as a zip (or a single file directly). Supports copy, clone, and XML export types.

Request Body

application/json

POST /otto/api/fm-file/download Request body

concurrency?integer

Number of files to process concurrently

Default1

Range1 <= value <= 10

files*array<|>

FileMaker filenames to download. Pass strings for copy/clone, or objects with per-file credentials for XML.

Items1 <= items

includeDdrInfo?boolean

Include DDR info in XML output (XML type only)

Defaultfalse

saveToDocuments?boolean

Save XML to Documents folder (XML type only)

Defaultfalse

type?string

Type of download: copy, clone, or xml

Default"copy"

Value in"copy" | "clone" | "xml"

catalogList?array<>

Restrict the XML output to a subset of FileMaker DDR catalogs (e.g. ScriptCatalog). Empty or absent includes all catalogs. Requires FileMaker Server 26.

splitCatalogs?boolean

Output one XML file per catalog, returned as a zip archive. LibraryCatalog is automatically excluded and standalone binary data is forced on by the tool. Requires FileMaker Server 26.

standaloneBinaryData?boolean

Embed each layout object's binary data inline rather than referencing the deduplicated LibraryCatalog. Requires FileMaker Server 26.

Response Body

`application/json`

curl -X POST "https://your.server.net/otto/api/fm-file/download" \
  -H "Content-Type: application/json" \
  -d '{
    "files": [
      "string"
    ]
  }'

curl -X POST "https://your.server.net/otto/api/fm-file/download" \  -H "Content-Type: application/json" \  -d '{    "files": [      "string"    ]  }'

{
  "messages": [
    {
      "code": 0,
      "text": "ok"
    }
  ],
  "response": {}
}

{
  "messages": [
    {
      "code": 18011,
      "text": "OttoFMS sample error"
    }
  ],
  "response": {}
}

Was this page helpful?

Start multi-file download

Request Body

Response Body

200application/json

400application/json

`application/json`

`application/json`