The RuleSets API from Delphix — 14 operation(s) for rulesets.
openapi: 3.0.0
info:
title: Delphix DCT Algorithms RuleSets API
version: 3.28.0
description: Delphix DCT API
contact:
name: Delphix Support
url: https://portal.perforce.com/s/
email: support@delphix.com
servers:
- url: /dct/v3
security:
- ApiKeyAuth: []
tags:
- name: RuleSets
paths:
/rule-sets:
post:
tags:
- RuleSets
summary: Create a Rule Set.
operationId: create_rule_set
requestBody:
content:
application/json:
schema:
x-body-name: rule_set_create_request
$ref: '#/components/schemas/RuleSetCreateRequest'
required: true
responses:
'201':
description: Rule Set creation initiated.
content:
application/json:
schema:
type: object
title: RuleSetCreateResponse
properties:
id:
type: string
description: The ID of the created rule set.
job:
$ref: '#/components/schemas/Job'
description: The initiated job.
get:
tags:
- RuleSets
summary: Retrieve the list of Rule Sets.
operationId: get_rule_sets
parameters:
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/cursor'
- $ref: '#/components/parameters/ruleSetsSortParam'
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: RuleSetsListResponse
properties:
items:
type: array
items:
$ref: '#/components/schemas/RuleSet'
response_metadata:
$ref: '#/components/schemas/PaginatedResponseMetadata'
/rule-sets/search:
post:
tags:
- RuleSets
summary: Search for Rule Sets.
operationId: search_rule_sets
x-filterable:
fields:
id:
type: string
name:
type: string
type:
type: string
platform:
type: string
connector_id:
type: string
connector_name:
type: string
engine_id:
type: string
engine_name:
type: string
data_elements_total:
type: integer
data_elements_sensitive:
type: integer
records_total:
type: integer
records_sensitive:
type: integer
creation_date:
type: string
account_id:
type: integer
account_name:
type: string
dct_managed:
type: boolean
job_orchestrator_id:
type: string
job_orchestrator_name:
type: string
last_attempted_refresh_status:
type: string
last_attempted_refresh_time:
type: string
last_refresh_time:
type: string
tags:
type: array[object]
fields:
key:
type: string
value:
type: string
parameters:
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/cursor'
- $ref: '#/components/parameters/ruleSetsSortParam'
requestBody:
$ref: '#/components/requestBodies/SearchBody'
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: RuleSetsSearchResponse
properties:
items:
type: array
items:
$ref: '#/components/schemas/RuleSet'
response_metadata:
$ref: '#/components/schemas/PaginatedResponseMetadata'
/rule-sets/{ruleSetId}:
parameters:
- $ref: '#/components/parameters/ruleSetIdParam'
get:
tags:
- RuleSets
summary: Get a Rule Set by ID.
operationId: get_rule_set_by_id
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/RuleSet'
patch:
tags:
- RuleSets
summary: Update a Rule Set.
operationId: update_rule_set
requestBody:
content:
application/json:
schema:
x-body-name: rule_set_update_request
$ref: '#/components/schemas/RuleSetUpdateRequest'
required: true
responses:
'200':
description: Rule Set update initiated.
content:
application/json:
schema:
type: object
title: RuleSetUpdateResponse
properties:
job:
$ref: '#/components/schemas/Job'
description: The initiated job.
delete:
tags:
- RuleSets
summary: Delete a Rule Set.
operationId: delete_rule_set
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: RuleSetDeleteResponse
properties:
job:
$ref: '#/components/schemas/Job'
description: The completed job.
/rule-sets/{ruleSetId}/refresh:
parameters:
- $ref: '#/components/parameters/ruleSetIdParam'
post:
tags:
- RuleSets
summary: Refresh a Rule Set.
operationId: refresh_rule_set
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: RefreshRuleSetResponse
properties:
job:
$ref: '#/components/schemas/Job'
description: The completed job.
/rule-sets/{ruleSetId}/bulk-table-delta-update:
parameters:
- $ref: '#/components/parameters/ruleSetIdParam'
post:
tags:
- RuleSets
summary: Update the set of tables and their attributes associated with a database rule set in bulk in a delta fashion.
operationId: bulk_table_delta_update_rule_set
requestBody:
content:
application/json:
schema:
x-body-name: rule_set_bulk_table_delta_update_request
$ref: '#/components/schemas/RuleSetBulkTableDeltaUpdateRequest'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: RuleSetBulkTableDeltaUpdateResponse
properties:
job:
$ref: '#/components/schemas/Job'
description: The completed job.
/rule-sets/{ruleSetId}/database-table-metadata:
parameters:
- $ref: '#/components/parameters/ruleSetIdParam'
patch:
tags:
- RuleSets
summary: Update multiple database table metadata objects for a rule set.
operationId: patch_database_table_metadata_for_rule_set
requestBody:
content:
application/json:
schema:
x-body-name: database_table_metadata_patch_request
$ref: '#/components/schemas/DatabaseTableMetadataBulkPatchRequest'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: DatabaseTableMetadataBulkPatchResponse
properties:
job:
$ref: '#/components/schemas/Job'
'400':
description: Invalid request (e.g. duplicate table names or table not found).
'404':
description: Rule set not found.
/rule-sets/{ruleSetId}/tags:
parameters:
- $ref: '#/components/parameters/ruleSetIdParam'
get:
tags:
- RuleSets
summary: Get tags for a Rule Set.
operationId: get_rule_set_tags
responses:
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/TagsResponse'
post:
tags:
- RuleSets
summary: Create tags for a Rule Set.
operationId: create_rule_set_tags
requestBody:
content:
application/json:
schema:
x-body-name: rule_set_tags
$ref: '#/components/schemas/TagsRequest'
description: Tags information for Rule Set.
required: true
responses:
'201':
description: Rule Set tags created
content:
application/json:
schema:
$ref: '#/components/schemas/TagsResponse'
/rule-sets/{ruleSetId}/tags/delete:
parameters:
- $ref: '#/components/parameters/ruleSetIdParam'
post:
tags:
- RuleSets
summary: Delete tags for a Rule Set.
operationId: delete_rule_set_tags
requestBody:
$ref: '#/components/requestBodies/DeleteTags'
responses:
'204':
description: No Content
/database-table-metadata:
get:
tags:
- RuleSets
summary: Retrieve table metadata.
operationId: get_database_table_metadata
parameters:
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/cursor'
- $ref: '#/components/parameters/databaseTableMetadataSortParam'
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: DatabaseTableMetadataListResponse
properties:
items:
type: array
items:
$ref: '#/components/schemas/DatabaseTableMetadata'
response_metadata:
$ref: '#/components/schemas/PaginatedResponseMetadata'
/database-table-metadata/search:
post:
tags:
- RuleSets
summary: Search table metadata.
operationId: search_database_table_metadata
x-filterable:
fields:
id:
type: string
table_name:
type: string
rule_set_id:
type: string
rule_set_name:
type: string
custom_sql:
type: string
where_clause:
type: string
having_clause:
type: string
key_column:
type: string
is_sensitive:
type: boolean
row_count:
type: integer
last_refresh_time:
type: string
last_row_count_time:
type: string
filter_key:
type: string
unload_split:
type: integer
auto_calculate_unload_split:
type: boolean
max_parallel_connections_per_table:
type: integer
max_records_per_split:
type: integer
max_split_per_connection:
type: integer
stream_size:
type: integer
column_array_rows:
type: integer
parameters:
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/cursor'
- $ref: '#/components/parameters/databaseTableMetadataSortParam'
requestBody:
$ref: '#/components/requestBodies/SearchBody'
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: DatabaseTableMetadataSearchResponse
properties:
items:
type: array
items:
$ref: '#/components/schemas/DatabaseTableMetadata'
response_metadata:
$ref: '#/components/schemas/PaginatedResponseMetadata'
/database-table-metadata/{databaseTableMetadataId}:
parameters:
- $ref: '#/components/parameters/databaseTableMetadataIdParam'
get:
tags:
- RuleSets
summary: Retrieve a database table metadata by ID.
operationId: get_database_table_metadata_by_id
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/DatabaseTableMetadata'
/database-column-metadata:
get:
tags:
- RuleSets
summary: Retrieve column metadata.
operationId: get_database_column_metadata
parameters:
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/cursor'
- $ref: '#/components/parameters/databaseColumnMetadataSortParam'
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: DatabaseColumnMetadataListResponse
properties:
items:
type: array
items:
$ref: '#/components/schemas/DatabaseColumnMetadata'
response_metadata:
$ref: '#/components/schemas/PaginatedResponseMetadata'
/database-column-metadata/search:
post:
tags:
- RuleSets
summary: Search column metadata.
operationId: search_database_column_metadata
x-filterable:
fields:
id:
type: integer
column_name:
type: string
database_table_metadata_id:
type: integer
table_name:
type: string
engine_id:
type: string
engine_name:
type: string
rule_set_id:
type: string
rule_set_name:
type: string
algorithm_id:
type: string
algorithm_name:
type: string
data_class_id:
type: string
data_class_name:
type: string
data_type:
type: string
date_format:
type: string
column_length:
type: integer
is_sensitive:
type: boolean
is_profiler_writable:
type: boolean
is_primary_key:
type: boolean
is_identity:
type: boolean
is_index:
type: boolean
is_foreign_key:
type: boolean
document_store_type:
type: string
parameters:
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/cursor'
- $ref: '#/components/parameters/databaseColumnMetadataSortParam'
requestBody:
$ref: '#/components/requestBodies/SearchBody'
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: DatabaseColumnMetadataSearchResponse
properties:
items:
type: array
items:
$ref: '#/components/schemas/DatabaseColumnMetadata'
response_metadata:
$ref: '#/components/schemas/PaginatedResponseMetadata'
/database-column-metadata/{databaseColumnMetadataId}:
parameters:
- $ref: '#/components/parameters/databaseColumnMetadataIdParam'
get:
tags:
- RuleSets
summary: Retrieve a database column metadata by ID.
operationId: get_database_column_metadata_by_id
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/DatabaseColumnMetadata'
patch:
tags:
- RuleSets
summary: Update a database column metadata
operationId: update_database_column_metadata
requestBody:
content:
application/json:
schema:
x-body-name: database_column_metadata_update_request
$ref: '#/components/schemas/DatabaseColumnMetadataUpdateRequest'
required: true
responses:
'200':
description: Database column metadata update initiated.
content:
application/json:
schema:
type: object
title: DatabaseColumnMetadataUpdateResponse
properties:
job:
$ref: '#/components/schemas/Job'
description: The initiated job.
components:
schemas:
ConnectorTypeEnum:
type: string
enum:
- DATABASE
- FILE
- MAINFRAME_DATASET
example: DATABASE
DatabaseTableMetadataParameters:
description: An object describe a database table of a rule set with some settings.
type: object
required:
- table_name
properties:
table_name:
description: The name of the table.
type: string
example: my table
custom_sql:
description: Custom SQL for the table.
type: string
where_clause:
description: SQL where clause for the table.
type: string
having_clause:
description: SQL having clause for the table.
type: string
key_column:
description: Key Column for the table.
type: string
Tag:
type: object
required:
- key
- value
properties:
key:
description: Key of the tag
type: string
minLength: 1
maxLength: 4000
example: key-1
value:
description: Value of the tag
type: string
minLength: 1
maxLength: 4000
example: value-1
RuleSetUpdateRequest:
description: Parameters used to update a rule set.
type: object
properties:
name:
description: The name of this rule set.
type: string
refresh_drops_tables:
description: This applies when table metadata exists in DCT, but the corresponding table no longer exists in the external database. In that event, true will cause the refresh operation to delete the invalid table metadata, whereas false will fail the refresh instead.
type: boolean
DatabaseTableMetadataUpdateParameters:
x-jackson-optional-nullable-helpers: true
description: Parameters to update a database table metadata object. Fields not provided are left unchanged (subject to HyperscaleInstance backfill when applicable).
type: object
required:
- table_name
properties:
table_name:
description: The name of the table, used to identify which record to update.
type: string
example: my table
custom_sql:
description: Custom SQL for the table.
type: string
nullable: true
x-is-jackson-optional-nullable: true
where_clause:
description: SQL where clause for the table.
type: string
nullable: true
x-is-jackson-optional-nullable: true
having_clause:
description: SQL having clause for the table.
type: string
nullable: true
x-is-jackson-optional-nullable: true
key_column:
description: Key Column for the table.
type: string
nullable: true
x-is-jackson-optional-nullable: true
filter_key:
description: Filter key column for the table. Only applicable for Hyperscale.
type: string
nullable: true
x-is-jackson-optional-nullable: true
unload_split:
description: Number of parallel unload splits. Only applicable for Hyperscale.
type: integer
minimum: 1
maximum: 32767
x-is-jackson-optional-nullable: true
auto_calculate_unload_split:
description: Whether to automatically calculate the unload split. Only applicable for Hyperscale.
type: boolean
x-is-jackson-optional-nullable: true
max_parallel_connections_per_table:
description: Maximum number of parallel connections per table. Only applicable for Hyperscale.
type: integer
minimum: 1
maximum: 32767
x-is-jackson-optional-nullable: true
max_records_per_split:
description: Maximum number of records per split. Only applicable for Hyperscale.
type: integer
format: int64
minimum: 1
x-is-jackson-optional-nullable: true
max_split_per_connection:
description: Maximum number of splits per connection. Only applicable for Hyperscale.
type: integer
minimum: 1
maximum: 32767
x-is-jackson-optional-nullable: true
stream_size:
description: Stream size in bytes. Only applicable for Hyperscale.
type: integer
format: int64
minimum: 1
x-is-jackson-optional-nullable: true
column_array_rows:
description: Number of column array rows. Only applicable for Hyperscale.
type: integer
format: int64
minimum: 1
x-is-jackson-optional-nullable: true
VirtualizationTaskEvent:
deprecated: true
properties:
message_details:
type: string
Engine:
properties:
engine_id:
type: string
minLength: 1
maxLength: 4000
engine_name:
type: string
minLength: 1
maxLength: 4000
DatabaseColumnMetadata:
description: An object describing a database column metadata with some settings.
type: object
properties:
id:
description: The id of this column metadata.
type: string
minLength: 1
example: '30'
column_name:
description: The name of the column.
type: string
example: my_column
database_table_metadata_id:
description: The id of the database table metadata that this column belongs to.
type: string
minLength: 1
example: '30'
table_name:
description: The name of the table that this column belongs to.
type: string
example: profile
rule_set_id:
description: The id of the rule set that this column metadata belongs to.
type: string
example: 4ed2357d-f1a7-410c-b951-90f0edc1a0f6
rule_set_name:
description: The name of the rule set that this table metadata belongs to.
type: string
example: my rule set
engine_id:
description: The id of the engine associated with this column.
type: string
example: 5ff0dab4-368c-4d57-8b61-9a09b6e80f42
engine_name:
description: The name of the engine associated with this column.
type: string
example: my engine
algorithm_id:
description: The id of the algorithm associated with this column.
type: string
example: 7a1b2c3d-e4f5-4a6b-8c7d-9e0f1a2b3c4d
algorithm_name:
description: The name of the algorithm associated with this column.
type: string
example: My Secure Lookup
algorithm_field_id:
description: The id of the algorithm field that is associated with this algorithm.
type: string
example: 1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d
algorithm_field_name:
description: The name of the algorithm field that is associated with this column.
type: string
example: string1
readOnly: true
algorithm_group_no:
description: The group number of algorithm to identify a set of columns associated with one instance of algorithm.
type: integer
format: int32
data_class_id:
description: The id of the data class associated with this column.
type: string
example: 6b5c4d3e-2a1b-4c3d-5e6f-7a8b9c0d1e2f
data_class_name:
description: The name of the data class associated with this column.
type: string
example: My Domain
data_type:
description: The data type of the column.
type: string
example: VARCHAR
date_format:
description: The format of the date stored in the column.
type: string
example: YYYY-MM-DD
column_length:
description: The length of the column.
type: integer
format: int32
example: 255
is_sensitive:
description: This field indicates whether or not a column has sensitive data.
type: boolean
is_profiler_writable:
description: Indicates whether this column is writable by the profiler.
type: boolean
is_primary_key:
description: Indicates whether this column is a primary key.
type: boolean
is_identity:
description: Indicates whether this column is an identity column.
type: boolean
is_index:
description: Indicates whether this column is indexed.
type: boolean
is_foreign_key:
description: Indicates whether this column is a foreign key.
type: boolean
file_format_id:
description: The id of the file format associated with this column.
type: string
readOnly: true
dct_managed:
description: Whether this data class is managed by DCT or not.
type: boolean
readOnly: true
document_store_type:
type: string
readOnly: true
enum:
- JSON
- XML
description: 'Indicates that this column contains an embedded structured document. When set, the masking engine traverses and masks fields within the document rather than masking the column value directly.
'
is_document_store_supported:
type: boolean
readOnly: true
nullable: true
description: 'Whether this column''s data type supports document store masking. Null when data type is unknown.
'
PaginatedResponseMetadata:
type: object
properties:
prev_cursor:
description: Pointer to the previous page of results. Use this value as a cursor query parameter in a subsequent request, along with limit, to navigate through the collection by virtual page.
type: string
next_cursor:
description: Pointer to the next page of results. Use this value as a cursor query parameter in a subsequent request, along with limit, to navigate through the collection by virtual page.
type: string
total:
description: The total number of results. This value may not be provided.
type: integer
format: int_64
RuleSet:
description: A masking rule set.
type: object
properties:
id:
description: The rule set ID.
type: string
example: a638d976-6b7e-43f4-9212-90f4dc6d405c
name:
description: The name of this rule set.
type: string
type:
description: The rule set connector type.
nullable: true
$ref: '#/components/schemas/ConnectorTypeEnum'
platform:
description: The rule set connector platform.
type: string
nullable: true
example: Oracle
connector_id:
description: The ID of the connector this rule set uses.
type: string
nullable: true
connector_name:
description: The name of the connector this rule set uses.
type: string
nullable: true
engine_id:
description: The ID of the engine this rule set originated from.
type: string
nullable: true
engine_name:
description: The name of the engine this rule set originated from.
type: string
nullable: true
data_elements_total:
description: The total number of data elements in this rule set.
type: integer
format: int64
nullable: true
data_elements_sensitive:
description: The number of sensitive data elements in this rule set.
type: integer
format: int64
nullable: true
records_total:
description: The total number of records in this rule set.
type: integer
format: int64
nullable: true
records_sensitive:
description: The number of sensitive records in this rule set.
type: integer
format: int64
nullable: true
creation_date:
description: The date this rule set was created.
type: string
format: date-time
readOnly: true
example: '2022-11-30T08:51:34.148000+00:00'
account_id:
description: The ID of the account who created this rule set.
type: integer
format: int64
readOnly: true
example: 1
account_name:
description: The username of the account who created this rule set.
type: string
readOnly: true
example: John Doe
dct_managed:
description: Whether or not this rule set is managed by DCT.
type: boolean
readOnly: true
refresh_drops_tables:
description: This applies when table metadata exists in DCT, but the corresponding table no longer exists in the external database. In that event, true will cause the refresh operation to delete the invalid table metadata, whereas false will fail the refresh instead.
type: boolean
example: false
tags:
description: The tags of this rule set.
type: array
items:
$ref: '#/components/schemas/Tag'
job_orchestrator_id:
type: string
readOnly: true
job_orchestrator_name:
type: string
readOnly: true
last_attempted_refresh_status:
description: The status of the last attempted rule set refresh.
type: string
enum:
- PENDING
- STARTED
- TIMEDOUT
- RUNNING
- CANCELED
- FAILED
- SUSPENDED
- WAITING
- COMPLETED
- ABANDONED
last_attempted_refresh_time:
description: The date and time of the last attempted rule set refresh.
type: string
format: date-time
readOnly: true
last_refresh_time:
description: The date and time of the last successful rule set refresh.
type: string
format: date-time
readOnly: true
JobTaskEvent:
properties:
message_details:
type: string
DatabaseTableMetadataBulkPatchRequest:
description: A request to update multiple database table metadata objects for a rule set.
type: object
properties:
database_table_metadata:
description: List of database table metadata update parameters.
type: array
items:
$ref: '#/components/schemas/DatabaseTableMetadataUpdateParameters'
set_hyperscale_defaults_for_other_objects:
description: 'If true, apply HyperscaleInstance default values to all tables in the rule set that are NOT present in the database_table_metadata list. For tables that ARE in the payload, explicitly provided hyperscale values take effect and any unset hyperscale fields are backfilled from the HyperscaleInstance. Non-hyperscale fields are never defaulted for non-payload tables. When true, an empty or absent database_table_metadata list is allowed (all tables receive HyperscaleInstance defaults).
'
type: boolean
default: fals
# --- truncated at 32 KB (58 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/delphix/refs/heads/main/openapi/delphix-rulesets-api-openapi.yml