DataSets

Create DataSet for hyperscale compliance.

SecurityApiKeyAuth

Request

Request Body schema: application/json
required

The parameters to create a dataSet.

connector_id required	integer <int64> The ID of connector-info.
required	Array of objects (DataInfo) [ 1 .. 10000 ] items The information of dataSet.

Responses

201

Created

400

Invalid Input provided.

500

Internal Service Unavailable.

post/data-sets

Request samples

Payload

application/json

{"connector_id": 1,
"data_info": [{"source": {"schema_name": "SRC_TEST_SCHEMA_1",
"table_name": "SRC_TEST_TABLE_1",
"filter_key": "FILTER_KEY",
"unload_split": 4,
"where_clause": "SRC_TEST_TABLE_1.COL_A = 'ValueA'"
},
"target": {"schema_name": "TGT_TEST_SCHEMA_1",
"table_name": "TGT_TEST_TABLE_1",
"stream_size": 65536
},
"masking_inventory": [{"field_name": "user_name",
"domain_name": "NULL_SL",
"algorithm_name": "dlpx-core:FullName"
},
{"field_name": "address",
"domain_name": "ADDRESS",
"algorithm_name": "dlpx-core:CM Alpha-Numeric"
},
{"field_name": "XmlData",
"structured_data_format_id": 1
}
]
}
]
}

Response samples

201

application/json

{"connector_id": 1,
"data_info": [{"source": {"schema_name": "SRC_TEST_SCHEMA_1",
"table_name": "SRC_TEST_TABLE_1",
"filter_key": "FILTER_KEY",
"unload_split": 4,
"where_clause": "SRC_TEST_TABLE_1.COL_A = 'ValueA'"
},
"target": {"schema_name": "TGT_TEST_SCHEMA_1",
"table_name": "TGT_TEST_TABLE_1",
"stream_size": 65536
},
"masking_inventory": [{"field_name": "user_name",
"domain_name": "NULL_SL",
"algorithm_name": "dlpx-core:FullName"
},
{"field_name": "address",
"domain_name": "ADDRESS",
"algorithm_name": "dlpx-core:CM Alpha-Numeric"
},
{"field_name": "XmlData",
"structured_data_format_id": 1
}
]
}
]
}

Returns a list of dataSet.

SecurityApiKeyAuth

Responses

200

OK

500

Internal Service Unavailable.

get/data-sets

Response samples

200

application/json

{"connector_id": 1,
"data_info": [{"source": {"schema_name": "SRC_TEST_SCHEMA_1",
"table_name": "SRC_TEST_TABLE_1",
"filter_key": "FILTER_KEY",
"unload_split": 4,
"where_clause": "SRC_TEST_TABLE_1.COL_A = 'ValueA'"
},
"target": {"schema_name": "TGT_TEST_SCHEMA_1",
"table_name": "TGT_TEST_TABLE_1",
"stream_size": 65536
},
"masking_inventory": [{"field_name": "user_name",
"domain_name": "NULL_SL",
"algorithm_name": "dlpx-core:FullName"
},
{"field_name": "address",
"domain_name": "ADDRESS",
"algorithm_name": "dlpx-core:CM Alpha-Numeric"
},
{"field_name": "XmlData",
"structured_data_format_id": 1
}
]
}
]
}

Returns a dataSet info by ID.

SecurityApiKeyAuth

Request

path Parameters

dataSetId

required

integer <int64> >= 1

Numeric ID of the dataSet.

Responses

200

OK

404

Object Not Found.

500

Internal Service Unavailable.

get/data-sets/{dataSetId}

Response samples

200

application/json

{"connector_id": 1,
"data_info": [{"source": {"schema_name": "SRC_TEST_SCHEMA_1",
"table_name": "SRC_TEST_TABLE_1",
"filter_key": "FILTER_KEY",
"unload_split": 4,
"where_clause": "SRC_TEST_TABLE_1.COL_A = 'ValueA'"
},
"target": {"schema_name": "TGT_TEST_SCHEMA_1",
"table_name": "TGT_TEST_TABLE_1",
"stream_size": 65536
},
"masking_inventory": [{"field_name": "user_name",
"domain_name": "NULL_SL",
"algorithm_name": "dlpx-core:FullName"
},
{"field_name": "address",
"domain_name": "ADDRESS",
"algorithm_name": "dlpx-core:CM Alpha-Numeric"
},
{"field_name": "XmlData",
"structured_data_format_id": 1
}
]
}
]
}

Update an existing DataSet.

SecurityApiKeyAuth

Request

path Parameters

dataSetId

required

integer <int64> >= 1

Numeric ID of the dataSet.

Request Body schema: application/json
required

The updated dataset information.

connector_id required	integer <int64> The ID of connector-info.
required	Array of objects (DataInfo) [ 1 .. 10000 ] items The information of dataSet.

Responses

200

OK

400

Invalid Input provided.

404

Object Not Found.

500

Internal Service Unavailable.

put/data-sets/{dataSetId}

Request samples

Payload

application/json

{"connector_id": 1,
"data_info": [{"source": {"schema_name": "SRC_TEST_SCHEMA_1",
"table_name": "SRC_TEST_TABLE_1",
"filter_key": "FILTER_KEY",
"unload_split": 4,
"where_clause": "SRC_TEST_TABLE_1.COL_A = 'ValueA'"
},
"target": {"schema_name": "TGT_TEST_SCHEMA_1",
"table_name": "TGT_TEST_TABLE_1",
"stream_size": 65536
},
"masking_inventory": [{"field_name": "user_name",
"domain_name": "NULL_SL",
"algorithm_name": "dlpx-core:FullName"
},
{"field_name": "address",
"domain_name": "ADDRESS",
"algorithm_name": "dlpx-core:CM Alpha-Numeric"
},
{"field_name": "XmlData",
"structured_data_format_id": 1
}
]
}
]
}

Response samples

200

application/json

{"connector_id": 1,
"data_info": [{"source": {"schema_name": "SRC_TEST_SCHEMA_1",
"table_name": "SRC_TEST_TABLE_1",
"filter_key": "FILTER_KEY",
"unload_split": 4,
"where_clause": "SRC_TEST_TABLE_1.COL_A = 'ValueA'"
},
"target": {"schema_name": "TGT_TEST_SCHEMA_1",
"table_name": "TGT_TEST_TABLE_1",
"stream_size": 65536
},
"masking_inventory": [{"field_name": "user_name",
"domain_name": "NULL_SL",
"algorithm_name": "dlpx-core:FullName"
},
{"field_name": "address",
"domain_name": "ADDRESS",
"algorithm_name": "dlpx-core:CM Alpha-Numeric"
},
{"field_name": "XmlData",
"structured_data_format_id": 1
}
]
}
]
}

Delete an existing dataSet.

SecurityApiKeyAuth

Request

path Parameters

dataSetId

required

integer <int64> >= 1

Numeric ID of the dataSet.

Responses

200

OK

404

Object Not Found.

500

Internal Service Unavailable.

delete/data-sets/{dataSetId}

Create DataSet for hyperscale compliance using Uploaded File.

SecurityApiKeyAuth

Request

Request Body schema: application/json
required

The File Upload Id to create a dataSet.

file_upload_ref

required

string non-empty

The blob Id generated during file upload

Responses

201

Created

400

Invalid Input provided.

500

Internal Service Unavailable.

post/data-sets/file-upload

Request samples

Payload

application/json

{"file_upload_ref": "delphix-file://upload/f_630d5d41c7c747afb02e14c167c30878/blank.txt"
}

Response samples

201

application/json

{"data_set_id": 1
}

Update DataSet for hyperscale compliance using Uploaded File.

SecurityApiKeyAuth

Request

path Parameters

dataSetId

required

integer <int64> >= 1

Numeric ID of the dataSet.

Request Body schema: application/json
required

The File Upload Id to create a dataSet.

file_upload_ref

required

string non-empty

The blob Id generated during file upload

Responses

201

Created

400

Invalid Input provided.

500

Internal Service Unavailable.

put/data-sets/file-upload/{dataSetId}

Request samples

Payload

application/json

{"file_upload_ref": "delphix-file://upload/f_630d5d41c7c747afb02e14c167c30878/blank.txt"
}

Response samples

201

application/json

{"data_set_id": 1
}

DataSets

Create DataSet for hyperscale compliance.

Request Body schema: application/jsonrequired

Returns a list of dataSet.

Returns a dataSet info by ID.

path Parameters

Update an existing DataSet.

path Parameters

Request Body schema: application/jsonrequired

Delete an existing dataSet.

path Parameters

Create DataSet for hyperscale compliance using Uploaded File.

Request Body schema: application/jsonrequired

Update DataSet for hyperscale compliance using Uploaded File.

path Parameters

Request Body schema: application/jsonrequired

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required