Skip to content

Last updated: July 22, 2025

DQOps REST API dictionaries models reference

The references of all objects used by dictionaries REST API operations are listed below.

DataDictionaryListModel

Data dictionary CSV file list model with the basic information about the dictionary.

The structure of this object is described below

 Property name   Description                       Data type 
dictionary_name Dictionary name. It is the name of a file in the dictionaries/ folder inside the DQOps user's home folder. string
can_edit Boolean flag that decides if the current user can update or delete the dictionary file. boolean
can_access_dictionary Boolean flag that decides if the current user see or download the dictionary file. boolean

DataDictionaryModel

Data dictionary CSV full model used to create and update the dictionary file. Contains the content of the CSV file as a text field.

The structure of this object is described below

 Property name   Description                       Data type 
dictionary_name Dictionary name. It is the name of a file in the dictionaries/ folder inside the DQOps user's home folder. string
file_content Dictionary CSV file content as a single file. string