Sign in
Utilities

Export Items

Export a larger data set to a file in the File Library

post/utils/export/{collection}

Path parameters

collectionstring required

Collection identifier

Request body

format'csv' | 'csv_utf8' | 'xml' | 'json' | 'yaml' required

What file format to save the export to. One of csv, csv_utf8, xml, json, yaml

Example request

{
  "query": {
    "fields": [
      "*",
      "*.*"
    ],
    "filter": {
      "<field>": {
        "<operator>": "<value>"
      }
    },
    "sort": [
      "-date_created"
    ],
    "deep": {
      "related_articles": {
        "_limit": 3
      }
    }
  },
  "file": {
    "id": "8cbb43fe-4cdf-4991-8352-c461779cec02",
    "storage": "local",
    "filename_disk": "a88c3b72-ac58-5436-a4ec-b2858531333a.jpg",
    "filename_download": "avatar.jpg",
    "title": "User Avatar",
    "type": "image/jpeg",
    "folder": {
      "id": "0cf0e03d-4364-45df-b77b-ca61f61869d2",
      "name": "New York"
    },
    "uploaded_by": {
      "id": "63716273-0f29-4648-8a2a-2af2948f6f78",
      "first_name": "Admin",
      "last_name": "User",
      "email": "admin@example.com",
      "language": "en-US",
      "status": "active",
      "role": {
        "id": "2f24211d-d928-469a-aea3-3c8f53d4e426",
        "name": "Administrator",
        "icon": "verified_user",
        "description": "Admins have access to all managed data within the system by default"
      },
      "last_access": "2020-05-31T14:32:37Z",
      "last_page": "/my-project/settings/collections/a"
    },
    "created_on": "2019-12-03T00:10:15+00:00",
    "modified_by": {
      "id": "63716273-0f29-4648-8a2a-2af2948f6f78",
      "first_name": "Admin",
      "last_name": "User",
      "email": "admin@example.com",
      "language": "en-US",
      "status": "active",
      "role": {
        "id": "2f24211d-d928-469a-aea3-3c8f53d4e426",
        "name": "Administrator",
        "icon": "verified_user",
        "description": "Admins have access to all managed data within the system by default"
      },
      "last_access": "2020-05-31T14:32:37Z",
      "last_page": "/my-project/settings/collections/a"
    },
    "charset": "binary",
    "filesize": 137862,
    "width": 800,
    "height": 838,
    "uploaded_on": "2019-12-03T00:10:15+00:00"
  }
}

Response

Successful request

Changes