REST API
Projects
Projects are objects used to contain everything needed to anonymize data in one place. Projects contain connection information for both the source and destination as well as information about which datasets to process and details about direct and indirect identifiers that should be handled.
The project model
The project model contains all the information needed to anonymize datasets. Optional information can be added to customize the treatment of direct and indirect identifiers.
Properties
- Name
title
- Type
- string
- Description
A friendly name for the project, i.e., the display name.
- Name
auto_create_job_definitions
- Type
- boolean
- Description
Determines whether or not tables added to the source database in the future are automatically anonymized. If enabled, all new tables in the source location will be anonymizd and written to the destination location.
- Name
schedule
- Type
- string
- Description
A schedule upon which to run the project, defined in cron syntax.
- Name
did_default_treatment_method
- Type
- string
- Description
The default treatment method for Direct Identifiers (DIDs). Treatment options include
hide
,mask
, andfake
.
- Name
qid_anonymize
- Type
- boolean
- Description
A Boolean option that tells the system to anonymize Quasi-identifiers (QIDs). The default behavior is to anonymize them.
- Name
default_job_run_type
- Type
- Description
A property when a project is created that indicates if the project is treated. Currently this value cannot be changed. Values include
load_treat_write
orload_assess
.
Get projects
List projects
Request
Response
Get a project
Get project
Request
Response
Update a project
Updates an existing project, except for its connections or default_job_run_type (currently).