DriveLock API icon

DriveLock API

Consume DriveLock API

Entity → Export

AI-generated

Summary

Export entities from DriveLock in CSV or JSON format, applying filters, selection, sorting, and other options to tailor the exported data.

Inputs

  • Entity Name (required) — Select the type of entity to export, such as Computers, Users, Devices, etc.
  • Properties Mode — Choose to select properties using a builder UI or provide a raw property select string.
  • Properties to Include — When using builder mode, select specific properties to include; if none selected, all fields are returned.
  • Raw Properties — When using raw mode, provide a comma-separated list of properties to select; 'id' is always included automatically.
  • Filter Mode — Choose between a visual query builder or raw RQL expression to filter which entities to export.
  • Top-Level Combinator — In builder filter mode, determines whether all groups (AND) or any group (OR) must match.
  • Filter Groups — In builder filter mode, define groups of conditions to filter the entities.
  • Raw Query (RQL) — In raw filter mode, provide the raw DriveLock RQL filter expression to apply.
  • Sort Mode — Choose between a builder UI or raw order by string to sort the exported entities.
  • Sort Fields — In builder sort mode, define one or more fields and their directions to sort by.
  • Raw Order By — In raw sort mode, provide the raw sort string, e.g. '+name,-createdAt'.
  • Additional Fields — Additional options such as pagination (skip, take), grouping, inclusion of linked objects, full object data, flattening the output, and masking computer or user properties.
  • Export Format (required) — Choose the export format: CSV or JSON.
  • Export Options — Specific options for CSV export such as readability (raw or human readable), separator character, and language for headers/values.

Output shape

a binary file containing the exported entities in the chosen format (CSV or JSON)

The exported file contents are returned as a raw (non-JSON) response. Pagination is controlled by 'skip' and 'take' parameters. Filtering, property selection, sorting, and other options affect the exported data. Masking flags can anonymize certain properties in the export.

Links

Discussion