Delphix Hyperscale Controller Service
Delphix Hyperscale Controller Service API
Version: v3.12.0
All rights reserved
Access
- APIKey KeyParamName:Authorization KeyInQuery:false KeyInHeader:true
[ Jump to Models ]
Table of Contents
Create a new API key. If no API key exists yet, or all tokens for existing API keys have
been lost, the application container can be TEMPORARILY started with the
API_KEY_CREATE environment variable set to string "true" and the application will
create a new API key when starting and print the corresponding token to the logs.
API keys created using the environment variable mechanism should only be used to
boostrap the creation of other - more secure - API keys and be discarded. (createApiKey)
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"api_key_id" : 0,
"token" : "token"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
Created
ApiKeyToken
400
Invalid Input provided.
Up
delete /api-keys/{apiKeyId}
Delete an API key (deleteApiKey)
Path parameters
apiKeyId (required)
Path Parameter — Numeric ID of the Api key default: null format: int64
Responses
200
OK
404
Object Not Found.
Up
get /api-keys/{apiKeyId}
Get an API key by id (getApiKey)
Path parameters
apiKeyId (required)
Path Parameter — Numeric ID of the Api key default: null format: int64
Return type
Example data
Content-Type: application/json
{
"name" : "name",
"id" : 0
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
ApiKey
404
Object Not Found.
Returns a list of API keys. (listApiKeys)
Return type
Example data
Content-Type: application/json
[ {
"name" : "name",
"id" : 0
}, {
"name" : "name",
"id" : 0
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
Up
put /async-tasks/{id}/cancel
Cancel an Async Task (cancelAsyncTask)
Path parameters
id (required)
Path Parameter — Numeric ID of the Async Task. default: null format: int64
Return type
Example data
Content-Type: application/json
{
"async_task_id" : 1,
"operation" : "SUPPORT_BUNDLE_GENERATE",
"reference" : "hyperscale-support-20240313-13-18-04.tar.gz",
"status" : "SUCCEEDED",
"start_time" : "2024-03-13T13:18:05.366909Z",
"end_time" : "2024-03-13T13:19:05.955041Z",
"cancellable" : true
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
AsyncTask
404
Object Not Found.
500
Internal Service Unavailable.
Up
get /async-tasks/{asyncTaskId}
Returns an Async Task by ID. (getAsyncTaskById)
Path parameters
asyncTaskId (required)
Path Parameter — Numeric ID of the async task. default: null format: int64
Return type
Example data
Content-Type: application/json
{
"async_task_id" : 1,
"operation" : "SUPPORT_BUNDLE_GENERATE",
"reference" : "hyperscale-support-20240313-13-18-04.tar.gz",
"status" : "SUCCEEDED",
"start_time" : "2024-03-13T13:18:05.366909Z",
"end_time" : "2024-03-13T13:19:05.955041Z",
"cancellable" : true
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
AsyncTask
404
Object Not Found.
500
Internal Service Unavailable.
Returns a list of async tasks. (listAllAsyncTask)
Return type
Example data
Content-Type: application/json
[ {
"async_task_id" : 1,
"operation" : "SUPPORT_BUNDLE_GENERATE",
"reference" : "hyperscale-support-20240313-13-18-04.tar.gz",
"status" : "SUCCEEDED",
"start_time" : "2024-03-13T13:18:05.366909Z",
"end_time" : "2024-03-13T13:19:05.955041Z",
"cancellable" : true
}, {
"async_task_id" : 1,
"operation" : "SUPPORT_BUNDLE_GENERATE",
"reference" : "hyperscale-support-20240313-13-18-04.tar.gz",
"status" : "SUCCEEDED",
"start_time" : "2024-03-13T13:18:05.366909Z",
"end_time" : "2024-03-13T13:19:05.955041Z",
"cancellable" : true
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
Create Connector Info for hyperscale compliance. (createConnectorInfo)
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"connectorName" : "connectorName",
"id" : 0,
"source" : {
"key" : ""
},
"target" : {
"key" : ""
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
Created
Connector-Info
400
Invalid Input provided.
500
Internal Service Unavailable.
Up
delete /connector-info/{connectorInfoId}
Delete an existing connector info. (deleteConnectorInfo)
Path parameters
connectorInfoId (required)
Path Parameter — Numeric ID of the connector info. default: null format: int64
Responses
200
OK
404
Object Not Found.
500
Internal Service Unavailable.
Up
get /connector-info/{connectorInfoId}
Returns a connector info by ID. (getByConnectorInfoId)
Path parameters
connectorInfoId (required)
Path Parameter — Numeric ID of the connector info. default: null format: int64
Return type
Example data
Content-Type: application/json
{
"connectorName" : "connectorName",
"id" : 0,
"source" : {
"key" : ""
},
"target" : {
"key" : ""
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
Connector-Info
404
Object Not Found.
500
Internal Service Unavailable.
Returns a list of connector info. (listAllConnectorInfo)
Return type
Example data
Content-Type: application/json
[ {
"connectorName" : "connectorName",
"id" : 0,
"source" : {
"key" : ""
},
"target" : {
"key" : ""
}
}, {
"connectorName" : "connectorName",
"id" : 0,
"source" : {
"key" : ""
},
"target" : {
"key" : ""
}
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
500
Internal Service Unavailable.
Up
put /connector-info/{connectorInfoId}
Update an existing Connector Info. (updateConnectorInfo)
Path parameters
connectorInfoId (required)
Path Parameter — Numeric ID of the connector info. default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"connectorName" : "connectorName",
"id" : 0,
"source" : {
"key" : ""
},
"target" : {
"key" : ""
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
Connector-Info
400
Invalid Input provided.
404
Object Not Found.
500
Internal Service Unavailable.
Create DataSet for hyperscale compliance. (createDataSet)
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"connector_id" : 1,
"mount_filesystem_id" : 1,
"data_info" : [ {
"source" : {
"schema_name" : "SRC_TEST_SCHEMA_1",
"table_name" : "SRC_TEST_TABLE_1",
"filter_key" : "FILTER_KEY",
"unload_split" : 4
},
"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" : "XML_DATA",
"structured_data_format_id" : 1
} ]
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
Created
DataSet
400
Invalid Input provided.
500
Internal Service Unavailable.
Up
post /data-sets/file-upload
Create DataSet for hyperscale compliance using Uploaded File. (createDataSetUsingFile)
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"data_set_id" : 1
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
Created
DataSetFileReadResponse
400
Invalid Input provided.
500
Internal Service Unavailable.
Up
delete /data-sets/{dataSetId}
Delete an existing dataSet. (deleteDataSet)
Path parameters
dataSetId (required)
Path Parameter — Numeric ID of the dataSet. default: null format: int64
Responses
200
OK
404
Object Not Found.
500
Internal Service Unavailable.
Up
get /data-sets/{dataSetId}
Returns a dataSet info by ID. (getDataSet)
Path parameters
dataSetId (required)
Path Parameter — Numeric ID of the dataSet. default: null format: int64
Return type
Example data
Content-Type: application/json
{
"connector_id" : 1,
"mount_filesystem_id" : 1,
"data_info" : [ {
"source" : {
"schema_name" : "SRC_TEST_SCHEMA_1",
"table_name" : "SRC_TEST_TABLE_1",
"filter_key" : "FILTER_KEY",
"unload_split" : 4
},
"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" : "XML_DATA",
"structured_data_format_id" : 1
} ]
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
DataSet
404
Object Not Found.
500
Internal Service Unavailable.
Returns a list of dataSet. (listAllDataSet)
Return type
Example data
Content-Type: application/json
[ {
"connector_id" : 1,
"mount_filesystem_id" : 1,
"data_info" : [ {
"source" : {
"schema_name" : "SRC_TEST_SCHEMA_1",
"table_name" : "SRC_TEST_TABLE_1",
"filter_key" : "FILTER_KEY",
"unload_split" : 4
},
"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" : "XML_DATA",
"structured_data_format_id" : 1
} ]
} ]
}, {
"connector_id" : 1,
"mount_filesystem_id" : 1,
"data_info" : [ {
"source" : {
"schema_name" : "SRC_TEST_SCHEMA_1",
"table_name" : "SRC_TEST_TABLE_1",
"filter_key" : "FILTER_KEY",
"unload_split" : 4
},
"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" : "XML_DATA",
"structured_data_format_id" : 1
} ]
} ]
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
500
Internal Service Unavailable.
Up
put /data-sets/{dataSetId}
Update an existing DataSet. (updateDataSet)
Path parameters
dataSetId (required)
Path Parameter — Numeric ID of the dataSet. default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"connector_id" : 1,
"mount_filesystem_id" : 1,
"data_info" : [ {
"source" : {
"schema_name" : "SRC_TEST_SCHEMA_1",
"table_name" : "SRC_TEST_TABLE_1",
"filter_key" : "FILTER_KEY",
"unload_split" : 4
},
"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" : "XML_DATA",
"structured_data_format_id" : 1
} ]
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
DataSet
400
Invalid Input provided.
404
Object Not Found.
500
Internal Service Unavailable.
Up
put /data-sets/file-upload/{dataSetId}
Update DataSet for hyperscale compliance using Uploaded File. (updateDataSetUsingFile)
Path parameters
dataSetId (required)
Path Parameter — Numeric ID of the dataSet. default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"data_set_id" : 1
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
Created
DataSetFileReadResponse
400
Invalid Input provided.
500
Internal Service Unavailable.
Up
get /engines/{engineId}
Returns a registered engine by ID. (getRegisteredEngine)
Path parameters
engineId (required)
Path Parameter — Numeric ID of the registered engine. default: null format: int64
Return type
Example data
Content-Type: application/json
{
"hashicorp_vault_id" : 6,
"type" : "VIRTUALIZATION",
"ssl" : true,
"hashicorp_vault_username_command_args" : [ "kv", "get", "-field=username", "kv-v2/delphix-secrets/delphixUser" ],
"truststore_filename" : "truststore_filename",
"hashicorp_vault_password_command_args" : [ "kv", "get", "-field=password", "kv-v2/delphix-secrets/delphixUser" ],
"protocol" : "http",
"hostname" : "hostname",
"password" : "password",
"truststore_password" : "truststore_password",
"name" : "name",
"ssl_hostname_check" : true,
"id" : 0,
"username" : "username"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
RegisteredEngine
404
Object Not Found.
500
Internal Service Unavailable.
Returns a list of registered engines. (listRegisteredEngines)
Return type
Example data
Content-Type: application/json
[ {
"hashicorp_vault_id" : 6,
"type" : "VIRTUALIZATION",
"ssl" : true,
"hashicorp_vault_username_command_args" : [ "kv", "get", "-field=username", "kv-v2/delphix-secrets/delphixUser" ],
"truststore_filename" : "truststore_filename",
"hashicorp_vault_password_command_args" : [ "kv", "get", "-field=password", "kv-v2/delphix-secrets/delphixUser" ],
"protocol" : "http",
"hostname" : "hostname",
"password" : "password",
"truststore_password" : "truststore_password",
"name" : "name",
"ssl_hostname_check" : true,
"id" : 0,
"username" : "username"
}, {
"hashicorp_vault_id" : 6,
"type" : "VIRTUALIZATION",
"ssl" : true,
"hashicorp_vault_username_command_args" : [ "kv", "get", "-field=username", "kv-v2/delphix-secrets/delphixUser" ],
"truststore_filename" : "truststore_filename",
"hashicorp_vault_password_command_args" : [ "kv", "get", "-field=password", "kv-v2/delphix-secrets/delphixUser" ],
"protocol" : "http",
"hostname" : "hostname",
"password" : "password",
"truststore_password" : "truststore_password",
"name" : "name",
"ssl_hostname_check" : true,
"id" : 0,
"username" : "username"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
500
Internal Service Unavailable.
Register an engine. (registerEngine)
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"hashicorp_vault_id" : 6,
"type" : "VIRTUALIZATION",
"ssl" : true,
"hashicorp_vault_username_command_args" : [ "kv", "get", "-field=username", "kv-v2/delphix-secrets/delphixUser" ],
"truststore_filename" : "truststore_filename",
"hashicorp_vault_password_command_args" : [ "kv", "get", "-field=password", "kv-v2/delphix-secrets/delphixUser" ],
"protocol" : "http",
"hostname" : "hostname",
"password" : "password",
"truststore_password" : "truststore_password",
"name" : "name",
"ssl_hostname_check" : true,
"id" : 0,
"username" : "username"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
Created
RegisteredEngine
400
Invalid Input provided.
500
Internal Service Unavailable.
Up
delete /engines/{engineId}
Unregister an engine. (unregisterEngine)
Path parameters
engineId (required)
Path Parameter — Numeric ID of the registered engine. default: null format: int64
Responses
200
OK
404
Object Not Found.
500
Internal Service Unavailable.
Up
put /engines/{engineId}
Update a registered engine. (updateRegisteredEngine)
Path parameters
engineId (required)
Path Parameter — Numeric ID of the registered engine. default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"hashicorp_vault_id" : 6,
"type" : "VIRTUALIZATION",
"ssl" : true,
"hashicorp_vault_username_command_args" : [ "kv", "get", "-field=username", "kv-v2/delphix-secrets/delphixUser" ],
"truststore_filename" : "truststore_filename",
"hashicorp_vault_password_command_args" : [ "kv", "get", "-field=password", "kv-v2/delphix-secrets/delphixUser" ],
"protocol" : "http",
"hostname" : "hostname",
"password" : "password",
"truststore_password" : "truststore_password",
"name" : "name",
"ssl_hostname_check" : true,
"id" : 0,
"username" : "username"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
RegisteredEngine
400
Invalid Input provided.
404
Object Not Found.
500
Internal Service Unavailable.
Download Response in file. (fileDownload)
Query parameters
entity_type (required)
Query Parameter — Entity to download response . default: DATASET
id (required)
Query Parameter — id of the entity to download . default: null format: int64
Return type
File
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/octet-streamapplication/json
Responses
200
OK
File
Create a file metadata. (createFileMetadata)
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"delimiter" : ",",
"endOfRecord" : "\n",
"enclosure" : "'",
"enclosureEscapeCharacter" : "'",
"escapeEnclosureEscapeCharacter" : false,
"built_in" : false
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
Created
File-Metadata
400
Invalid Input provided.
500
Internal Service Unavailable.
Up
delete /file-metadata/{fileMetadataId}
Delete an existing file metadata. (deleteFileMetadata)
Path parameters
fileMetadataId (required)
Path Parameter — Numeric ID of the file metadata. default: null format: int64
Responses
200
OK
404
Object Not Found.
500
Internal Service Unavailable.
Up
get /file-metadata/{fileMetadataId}
Returns a file metadata by ID. (getFileMetadataById)
Path parameters
fileMetadataId (required)
Path Parameter — Numeric ID of the file metadata. default: null format: int64
Return type
Example data
Content-Type: application/json
{
"delimiter" : ",",
"endOfRecord" : "\n",
"enclosure" : "'",
"enclosureEscapeCharacter" : "'",
"escapeEnclosureEscapeCharacter" : false,
"built_in" : false
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
File-Metadata
404
Object Not Found.
500
Internal Service Unavailable.
Returns a list of file metadata. (listAllFileMetadata)
Return type
Example data
Content-Type: application/json
[ {
"delimiter" : ",",
"endOfRecord" : "\n",
"enclosure" : "'",
"enclosureEscapeCharacter" : "'",
"escapeEnclosureEscapeCharacter" : false,
"built_in" : false
}, {
"delimiter" : ",",
"endOfRecord" : "\n",
"enclosure" : "'",
"enclosureEscapeCharacter" : "'",
"escapeEnclosureEscapeCharacter" : false,
"built_in" : false
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
500
Internal Service Unavailable.
Up
put /file-metadata/{fileMetadataId}
Update an existing file metadata. (updateFileMetadata)
Path parameters
fileMetadataId (required)
Path Parameter — Numeric ID of the file metadata. default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"delimiter" : ",",
"endOfRecord" : "\n",
"enclosure" : "'",
"enclosureEscapeCharacter" : "'",
"escapeEnclosureEscapeCharacter" : false,
"built_in" : false
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
File-Metadata
400
Invalid Input provided.
404
Object Not Found.
500
Internal Service Unavailable.
upload a file. (fileUpload)
Consumes
This API call consumes the following media types via the request header:
Form parameters
file (required)
Form Parameter — The file to be uploaded. default: null format: binary
Return type
Example data
Content-Type: application/json
{
"file_upload_ref" : "delphix-file://upload/f_XXXX/XXX.txt"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
File uploaded successfully.
FileUploadResponse
400
Invalid Input provided.
500
Internal Service Unavailable.
Up
put /executions/{id}/cancel
Cancel a running execution. (cancelExecution)
Path parameters
id (required)
Path Parameter — Numeric ID of the Job Execution. default: null format: int64
Return type
Example data
Content-Type: application/json
{
"id" : 72,
"job_id" : 5,
"status" : "SUCCEEDED",
"create_time" : "2022-12-18T13:38:43.722917Z",
"end_time" : "2022-12-18T13:43:16.554603Z",
"total_objects" : 4,
"total_rows" : 16,
"tasks" : [ {
"name" : "Unload",
"status" : "SUCCEEDED",
"start_time" : "2022-12-18T13:38:44.184296Z",
"end_time" : "2022-12-18T13:38:54.972883Z",
"received_objects" : 4,
"succeeded_objects" : 4,
"failed_objects" : 0,
"processing_objects" : 0,
"processed_rows" : 16,
"total_rows" : 16
}, {
"name" : "Masking",
"status" : "SUCCEEDED",
"start_time" : "2022-12-18T13:38:51.979725Z",
"end_time" : "2022-12-18T13:42:58.569202Z",
"received_objects" : 4,
"succeeded_objects" : 4,
"failed_objects" : 0,
"processing_objects" : 0,
"processed_rows" : 16,
"total_rows" : 16
}, {
"name" : "Load",
"status" : "SUCCEEDED",
"start_time" : "2022-12-18T13:40:39.350857Z",
"end_time" : "2022-12-18T13:43:12.966492Z",
"received_objects" : 4,
"succeeded_objects" : 4,
"failed_objects" : 0,
"processing_objects" : 0,
"processed_rows" : 16,
"total_rows" : 16
}, {
"name" : "Post Load",
"status" : "SUCCEEDED",
"start_time" : "2022-12-18T13:43:12.981490",
"end_time" : "2022-12-18T13:43:15.764366",
"metadata" : [ {
"type" : "Constraints",
"total" : 20,
"processed" : 20,
"status" : "SUCCESS",
"start_time" : "2022-12-18T13:43:12.981490Z",
"end_time" : "2022-12-18T13:43:15.764366Z"
}, {
"type" : "Indexes",
"total" : 10,
"processed" : 10,
"status" : "SUCCESS",
"start_time" : "2022-12-18T13:43:12.981490Z",
"end_time" : "2022-12-18T13:43:15.764366Z"
}, {
"type" : "Triggers",
"total" : 5,
"processed" : 5,
"status" : "SUCCESS",
"start_time" : "2022-12-18T13:43:12.981490Z",
"end_time" : "2022-12-18T13:43:15.764366Z"
} ]
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
ExecutionSummary
404
Object Not Found.
500
Internal Service Unavailable.
Up
delete /executions/{id}
Clean-up the execution by Id (cleanUpExecution)
Path parameters
id (required)
Path Parameter — Numeric ID of the Job Execution. default: null format: int64
Responses
200
OK
404
Object Not Found.
500
Internal Service Unavailable.
Create an execution of a Hyperscale Job. (createExecution)
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"id" : 72,
"job_id" : 5,
"status" : "SUCCEEDED",
"create_time" : "2022-12-18T13:38:43.722917Z",
"end_time" : "2022-12-18T13:43:16.554603Z",
"total_objects" : 4,
"total_rows" : 16,
"tasks" : [ {
"name" : "Unload",
"status" : "SUCCEEDED",
"start_time" : "2022-12-18T13:38:44.184296Z",
"end_time" : "2022-12-18T13:38:54.972883Z",
"metadata" : [ {
"source_key" : "DB.TEST_3",
"total_rows" : 4,
"status" : "SUCCEEDED",
"unloaded_rows" : 4
}, {
"source_key" : "DB.TEST",
"total_rows" : 4,
"status" : "SUCCEEDED",
"unloaded_rows" : 4
}, {
"source_key" : "DB.TEST_1",
"total_rows" : 4,
"status" : "SUCCEEDED",
"unloaded_rows" : 4
}, {
"source_key" : "DB.TEST_2",
"total_rows" : 4,
"status" : "SUCCEEDED",
"unloaded_rows" : 4
} ]
}, {
"name" : "Masking",
"status" : "SUCCEEDED",
"start_time" : "2022-12-18T13:38:51.979725Z",
"end_time" : "2022-12-18T13:42:58.569202Z",
"metadata" : [ {
"source_key" : "DB.TEST_3",
"total_rows" : 4,
"status" : "SUCCEEDED",
"masked_rows" : 4
}, {
"source_key" : "DB.TEST",
"total_rows" : 4,
"status" : "SUCCEEDED",
"masked_rows" : 4
}, {
"source_key" : "DB.TEST_1",
"total_rows" : 4,
"status" : "SUCCEEDED",
"masked_rows" : 4
}, {
"source_key" : "DB.TEST_2",
"total_rows" : 4,
"status" : "SUCCEEDED",
"masked_rows" : 4
} ]
}, {
"name" : "Load",
"status" : "SUCCEEDED",
"start_time" : "2022-12-18T13:40:39.350857Z",
"end_time" : "2022-12-18T13:43:12.966492Z",
"metadata" : [ {
"source_key" : "DB.TEST_3",
"total_rows" : 4,
"status" : "SUCCEEDED",
"loaded_rows" : 4
}, {
"source_key" : "DB.TEST",
"total_rows" : 4,
"status" : "SUCCEEDED",
"loaded_rows" : 4
}, {
"source_key" : "DB.TEST_1",
"total_rows" : 4,
"status" : "SUCCEEDED",
"loaded_rows" : 4
}, {
"source_key" : "DB.TEST_2",
"total_rows" : 4,
"status" : "SUCCEEDED",
"loaded_rows" : 4
} ]
}, {
"name" : "Post Load",
"status" : "SUCCEEDED",
"start_time" : "2022-12-18T13:43:12.981490Z",
"end_time" : "2022-12-18T13:43:15.764366Z",
"metadata" : [ {
"table_set" : [ "Table1", "Table2" ]
}, {
"object_details" : [ {
"type" : "Constraints",
"total" : 20,
"processed" : 20,
"status" : "SUCCESS",
"start_time" : "2022-12-18T13:43:12.981490Z",
"end_time" : "2022-12-18T13:43:15.764366Z"
}, {
"type" : "Indexes",
"total" : 10,
"processed" : 10,
"status" : "SUCCESS",
"start_time" : "2022-12-18T13:43:12.981490Z",
"end_time" : "2022-12-18T13:43:15.764366Z"
}, {
"type" : "Triggers",
"total" : 5,
"processed" : 5,
"status" : "SUCCESS",
"start_time" : "2022-12-18T13:43:12.981490Z",
"end_time" : "2022-12-18T13:43:15.764366Z"
} ]
} ]
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
Created
Execution
400
Invalid Input provided.
500
Internal Service Unavailable.
Returns the Job Execution Details by ID. (getExecutionById)
Path parameters
id (required)
Path Parameter — Numeric ID of the Job Execution. default: null format: int64
Query parameters
task (required)
Query Parameter — Task for which details are needed in the response. default: ALL
object_status (required)
Query Parameter — Status of the objects i.e. source files or tables whose details are needed in the response. default: ALL
object_details_status (required)
Query Parameter — Status of the post load object details, applicable only for post load task, i.e. constraints, indexes and triggers status. default: ALL
Return type
Example data
Content-Type: application/json
{
"id" : 72,
"job_id" : 5,
"status" : "SUCCEEDED",
"create_time" : "2022-12-18T13:38:43.722917Z",
"end_time" : "2022-12-18T13:43:16.554603Z",
"total_objects" : 4,
"total_rows" : 16,
"tasks" : [ {
"name" : "Unload",
"status" : "SUCCEEDED",
"start_time" : "2022-12-18T13:38:44.184296Z",
"end_time" : "2022-12-18T13:38:54.972883Z",
"metadata" : [ {
"source_key" : "DB.TEST_3",
"total_rows" : 4,
"status" : "SUCCEEDED",
"unloaded_rows" : 4
}, {
"source_key" : "DB.TEST",
"total_rows" : 4,
"status" : "SUCCEEDED",
"unloaded_rows" : 4
}, {
"source_key" : "DB.TEST_1",
"total_rows" : 4,
"status" : "SUCCEEDED",
"unloaded_rows" : 4
}, {
"source_key" : "DB.TEST_2",
"total_rows" : 4,
"status" : "SUCCEEDED",
"unloaded_rows" : 4
} ]
}, {
"name" : "Masking",
"status" : "SUCCEEDED",
"start_time" : "2022-12-18T13:38:51.979725Z",
"end_time" : "2022-12-18T13:42:58.569202Z",
"metadata" : [ {
"source_key" : "DB.TEST_3",
"total_rows" : 4,
"status" : "SUCCEEDED",
"masked_rows" : 4
}, {
"source_key" : "DB.TEST",
"total_rows" : 4,
"status" : "SUCCEEDED",
"masked_rows" : 4
}, {
"source_key" : "DB.TEST_1",
"total_rows" : 4,
"status" : "SUCCEEDED",
"masked_rows" : 4
}, {
"source_key" : "DB.TEST_2",
"total_rows" : 4,
"status" : "SUCCEEDED",
"masked_rows" : 4
} ]
}, {
"name" : "Load",
"status" : "SUCCEEDED",
"start_time" : "2022-12-18T13:40:39.350857Z",
"end_time" : "2022-12-18T13:43:12.966492Z",
"metadata" : [ {
"source_key" : "DB.TEST_3",
"total_rows" : 4,
"status" : "SUCCEEDED",
"loaded_rows" : 4
}, {
"source_key" : "DB.TEST",
"total_rows" : 4,
"status" : "SUCCEEDED",
"loaded_rows" : 4
}, {
"source_key" : "DB.TEST_1",
"total_rows" : 4,
"status" : "SUCCEEDED",
"loaded_rows" : 4
}, {
"source_key" : "DB.TEST_2",
"total_rows" : 4,
"status" : "SUCCEEDED",
"loaded_rows" : 4
} ]
}, {
"name" : "Post Load",
"status" : "SUCCEEDED",
"start_time" : "2022-12-18T13:43:12.981490Z",
"end_time" : "2022-12-18T13:43:15.764366Z",
"metadata" : [ {
"table_set" : [ "Table1", "Table2" ]
}, {
"object_details" : [ {
"type" : "Constraints",
"total" : 20,
"processed" : 20,
"status" : "SUCCESS",
"start_time" : "2022-12-18T13:43:12.981490Z",
"end_time" : "2022-12-18T13:43:15.764366Z"
}, {
"type" : "Indexes",
"total" : 10,
"processed" : 10,
"status" : "SUCCESS",
"start_time" : "2022-12-18T13:43:12.981490Z",
"end_time" : "2022-12-18T13:43:15.764366Z"
}, {
"type" : "Triggers",
"total" : 5,
"processed" : 5,
"status" : "SUCCESS",
"start_time" : "2022-12-18T13:43:12.981490Z",
"end_time" : "2022-12-18T13:43:15.764366Z"
} ]
} ]
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
Execution
404
Object Not Found.
Up
get /executions/{id}/summary
Returns the Job Execution summary by its ID. (getExecutionSummaryById)
Path parameters
id (required)
Path Parameter — Numeric ID of the Job Execution. default: null format: int64
Return type
Example data
Content-Type: application/json
{
"id" : 72,
"job_id" : 5,
"status" : "SUCCEEDED",
"create_time" : "2022-12-18T13:38:43.722917Z",
"end_time" : "2022-12-18T13:43:16.554603Z",
"total_objects" : 4,
"total_rows" : 16,
"tasks" : [ {
"name" : "Unload",
"status" : "SUCCEEDED",
"start_time" : "2022-12-18T13:38:44.184296Z",
"end_time" : "2022-12-18T13:38:54.972883Z",
"received_objects" : 4,
"succeeded_objects" : 4,
"failed_objects" : 0,
"processing_objects" : 0,
"processed_rows" : 16,
"total_rows" : 16
}, {
"name" : "Masking",
"status" : "SUCCEEDED",
"start_time" : "2022-12-18T13:38:51.979725Z",
"end_time" : "2022-12-18T13:42:58.569202Z",
"received_objects" : 4,
"succeeded_objects" : 4,
"failed_objects" : 0,
"processing_objects" : 0,
"processed_rows" : 16,
"total_rows" : 16
}, {
"name" : "Load",
"status" : "SUCCEEDED",
"start_time" : "2022-12-18T13:40:39.350857Z",
"end_time" : "2022-12-18T13:43:12.966492Z",
"received_objects" : 4,
"succeeded_objects" : 4,
"failed_objects" : 0,
"processing_objects" : 0,
"processed_rows" : 16,
"total_rows" : 16
}, {
"name" : "Post Load",
"status" : "SUCCEEDED",
"start_time" : "2022-12-18T13:43:12.981490",
"end_time" : "2022-12-18T13:43:15.764366",
"metadata" : [ {
"type" : "Constraints",
"total" : 20,
"processed" : 20,
"status" : "SUCCESS",
"start_time" : "2022-12-18T13:43:12.981490Z",
"end_time" : "2022-12-18T13:43:15.764366Z"
}, {
"type" : "Indexes",
"total" : 10,
"processed" : 10,
"status" : "SUCCESS",
"start_time" : "2022-12-18T13:43:12.981490Z",
"end_time" : "2022-12-18T13:43:15.764366Z"
}, {
"type" : "Triggers",
"total" : 5,
"processed" : 5,
"status" : "SUCCESS",
"start_time" : "2022-12-18T13:43:12.981490Z",
"end_time" : "2022-12-18T13:43:15.764366Z"
} ]
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
ExecutionSummary
404
Object Not Found.
Returns a list of all the executions of a Hyperscale Job in the detailed format. (listAllExecution)
Query parameters
job_id (required)
Query Parameter — Numeric ID of the Hyperscale Job default: null format: int64
Return type
Example data
Content-Type: application/json
[ {
"id" : 72,
"job_id" : 5,
"status" : "SUCCEEDED",
"create_time" : "2022-12-18T13:38:43.722917Z",
"end_time" : "2022-12-18T13:43:16.554603Z",
"total_objects" : 4,
"total_rows" : 16,
"tasks" : [ {
"name" : "Unload",
"status" : "SUCCEEDED",
"start_time" : "2022-12-18T13:38:44.184296Z",
"end_time" : "2022-12-18T13:38:54.972883Z",
"metadata" : [ {
"source_key" : "DB.TEST_3",
"total_rows" : 4,
"status" : "SUCCEEDED",
"unloaded_rows" : 4
}, {
"source_key" : "DB.TEST",
"total_rows" : 4,
"status" : "SUCCEEDED",
"unloaded_rows" : 4
}, {
"source_key" : "DB.TEST_1",
"total_rows" : 4,
"status" : "SUCCEEDED",
"unloaded_rows" : 4
}, {
"source_key" : "DB.TEST_2",
"total_rows" : 4,
"status" : "SUCCEEDED",
"unloaded_rows" : 4
} ]
}, {
"name" : "Masking",
"status" : "SUCCEEDED",
"start_time" : "2022-12-18T13:38:51.979725Z",
"end_time" : "2022-12-18T13:42:58.569202Z",
"metadata" : [ {
"source_key" : "DB.TEST_3",
"total_rows" : 4,
"status" : "SUCCEEDED",
"masked_rows" : 4
}, {
"source_key" : "DB.TEST",
"total_rows" : 4,
"status" : "SUCCEEDED",
"masked_rows" : 4
}, {
"source_key" : "DB.TEST_1",
"total_rows" : 4,
"status" : "SUCCEEDED",
"masked_rows" : 4
}, {
"source_key" : "DB.TEST_2",
"total_rows" : 4,
"status" : "SUCCEEDED",
"masked_rows" : 4
} ]
}, {
"name" : "Load",
"status" : "SUCCEEDED",
"start_time" : "2022-12-18T13:40:39.350857Z",
"end_time" : "2022-12-18T13:43:12.966492Z",
"metadata" : [ {
"source_key" : "DB.TEST_3",
"total_rows" : 4,
"status" : "SUCCEEDED",
"loaded_rows" : 4
}, {
"source_key" : "DB.TEST",
"total_rows" : 4,
"status" : "SUCCEEDED",
"loaded_rows" : 4
}, {
"source_key" : "DB.TEST_1",
"total_rows" : 4,
"status" : "SUCCEEDED",
"loaded_rows" : 4
}, {
"source_key" : "DB.TEST_2",
"total_rows" : 4,
"status" : "SUCCEEDED",
"loaded_rows" : 4
} ]
}, {
"name" : "Post Load",
"status" : "SUCCEEDED",
"start_time" : "2022-12-18T13:43:12.981490Z",
"end_time" : "2022-12-18T13:43:15.764366Z",
"metadata" : [ {
"table_set" : [ "Table1", "Table2" ]
}, {
"object_details" : [ {
"type" : "Constraints",
"total" : 20,
"processed" : 20,
"status" : "SUCCESS",
"start_time" : "2022-12-18T13:43:12.981490Z",
"end_time" : "2022-12-18T13:43:15.764366Z"
}, {
"type" : "Indexes",
"total" : 10,
"processed" : 10,
"status" : "SUCCESS",
"start_time" : "2022-12-18T13:43:12.981490Z",
"end_time" : "2022-12-18T13:43:15.764366Z"
}, {
"type" : "Triggers",
"total" : 5,
"processed" : 5,
"status" : "SUCCESS",
"start_time" : "2022-12-18T13:43:12.981490Z",
"end_time" : "2022-12-18T13:43:15.764366Z"
} ]
} ]
} ]
}, {
"id" : 72,
"job_id" : 5,
"status" : "SUCCEEDED",
"create_time" : "2022-12-18T13:38:43.722917Z",
"end_time" : "2022-12-18T13:43:16.554603Z",
"total_objects" : 4,
"total_rows" : 16,
"tasks" : [ {
"name" : "Unload",
"status" : "SUCCEEDED",
"start_time" : "2022-12-18T13:38:44.184296Z",
"end_time" : "2022-12-18T13:38:54.972883Z",
"metadata" : [ {
"source_key" : "DB.TEST_3",
"total_rows" : 4,
"status" : "SUCCEEDED",
"unloaded_rows" : 4
}, {
"source_key" : "DB.TEST",
"total_rows" : 4,
"status" : "SUCCEEDED",
"unloaded_rows" : 4
}, {
"source_key" : "DB.TEST_1",
"total_rows" : 4,
"status" : "SUCCEEDED",
"unloaded_rows" : 4
}, {
"source_key" : "DB.TEST_2",
"total_rows" : 4,
"status" : "SUCCEEDED",
"unloaded_rows" : 4
} ]
}, {
"name" : "Masking",
"status" : "SUCCEEDED",
"start_time" : "2022-12-18T13:38:51.979725Z",
"end_time" : "2022-12-18T13:42:58.569202Z",
"metadata" : [ {
"source_key" : "DB.TEST_3",
"total_rows" : 4,
"status" : "SUCCEEDED",
"masked_rows" : 4
}, {
"source_key" : "DB.TEST",
"total_rows" : 4,
"status" : "SUCCEEDED",
"masked_rows" : 4
}, {
"source_key" : "DB.TEST_1",
"total_rows" : 4,
"status" : "SUCCEEDED",
"masked_rows" : 4
}, {
"source_key" : "DB.TEST_2",
"total_rows" : 4,
"status" : "SUCCEEDED",
"masked_rows" : 4
} ]
}, {
"name" : "Load",
"status" : "SUCCEEDED",
"start_time" : "2022-12-18T13:40:39.350857Z",
"end_time" : "2022-12-18T13:43:12.966492Z",
"metadata" : [ {
"source_key" : "DB.TEST_3",
"total_rows" : 4,
"status" : "SUCCEEDED",
"loaded_rows" : 4
}, {
"source_key" : "DB.TEST",
"total_rows" : 4,
"status" : "SUCCEEDED",
"loaded_rows" : 4
}, {
"source_key" : "DB.TEST_1",
"total_rows" : 4,
"status" : "SUCCEEDED",
"loaded_rows" : 4
}, {
"source_key" : "DB.TEST_2",
"total_rows" : 4,
"status" : "SUCCEEDED",
"loaded_rows" : 4
} ]
}, {
"name" : "Post Load",
"status" : "SUCCEEDED",
"start_time" : "2022-12-18T13:43:12.981490Z",
"end_time" : "2022-12-18T13:43:15.764366Z",
"metadata" : [ {
"table_set" : [ "Table1", "Table2" ]
}, {
"object_details" : [ {
"type" : "Constraints",
"total" : 20,
"processed" : 20,
"status" : "SUCCESS",
"start_time" : "2022-12-18T13:43:12.981490Z",
"end_time" : "2022-12-18T13:43:15.764366Z"
}, {
"type" : "Indexes",
"total" : 10,
"processed" : 10,
"status" : "SUCCESS",
"start_time" : "2022-12-18T13:43:12.981490Z",
"end_time" : "2022-12-18T13:43:15.764366Z"
}, {
"type" : "Triggers",
"total" : 5,
"processed" : 5,
"status" : "SUCCESS",
"start_time" : "2022-12-18T13:43:12.981490Z",
"end_time" : "2022-12-18T13:43:15.764366Z"
} ]
} ]
} ]
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
404
Object Not Found.
Up
get /executions/summary
Returns a list of all the Execution summaries of a Hyperscale Job. (listAllExecutionSummaries)
Query parameters
job_id (required)
Query Parameter — Numeric ID of the Hyperscale Job default: null format: int64
Return type
Example data
Content-Type: application/json
[ {
"id" : 72,
"job_id" : 5,
"status" : "SUCCEEDED",
"create_time" : "2022-12-18T13:38:43.722917Z",
"end_time" : "2022-12-18T13:43:16.554603Z",
"total_objects" : 4,
"total_rows" : 16,
"tasks" : [ {
"name" : "Unload",
"status" : "SUCCEEDED",
"start_time" : "2022-12-18T13:38:44.184296Z",
"end_time" : "2022-12-18T13:38:54.972883Z",
"received_objects" : 4,
"succeeded_objects" : 4,
"failed_objects" : 0,
"processing_objects" : 0,
"processed_rows" : 16,
"total_rows" : 16
}, {
"name" : "Masking",
"status" : "SUCCEEDED",
"start_time" : "2022-12-18T13:38:51.979725Z",
"end_time" : "2022-12-18T13:42:58.569202Z",
"received_objects" : 4,
"succeeded_objects" : 4,
"failed_objects" : 0,
"processing_objects" : 0,
"processed_rows" : 16,
"total_rows" : 16
}, {
"name" : "Load",
"status" : "SUCCEEDED",
"start_time" : "2022-12-18T13:40:39.350857Z",
"end_time" : "2022-12-18T13:43:12.966492Z",
"received_objects" : 4,
"succeeded_objects" : 4,
"failed_objects" : 0,
"processing_objects" : 0,
"processed_rows" : 16,
"total_rows" : 16
}, {
"name" : "Post Load",
"status" : "SUCCEEDED",
"start_time" : "2022-12-18T13:43:12.981490",
"end_time" : "2022-12-18T13:43:15.764366",
"metadata" : [ {
"type" : "Constraints",
"total" : 20,
"processed" : 20,
"status" : "SUCCESS",
"start_time" : "2022-12-18T13:43:12.981490Z",
"end_time" : "2022-12-18T13:43:15.764366Z"
}, {
"type" : "Indexes",
"total" : 10,
"processed" : 10,
"status" : "SUCCESS",
"start_time" : "2022-12-18T13:43:12.981490Z",
"end_time" : "2022-12-18T13:43:15.764366Z"
}, {
"type" : "Triggers",
"total" : 5,
"processed" : 5,
"status" : "SUCCESS",
"start_time" : "2022-12-18T13:43:12.981490Z",
"end_time" : "2022-12-18T13:43:15.764366Z"
} ]
} ]
}, {
"id" : 72,
"job_id" : 5,
"status" : "SUCCEEDED",
"create_time" : "2022-12-18T13:38:43.722917Z",
"end_time" : "2022-12-18T13:43:16.554603Z",
"total_objects" : 4,
"total_rows" : 16,
"tasks" : [ {
"name" : "Unload",
"status" : "SUCCEEDED",
"start_time" : "2022-12-18T13:38:44.184296Z",
"end_time" : "2022-12-18T13:38:54.972883Z",
"received_objects" : 4,
"succeeded_objects" : 4,
"failed_objects" : 0,
"processing_objects" : 0,
"processed_rows" : 16,
"total_rows" : 16
}, {
"name" : "Masking",
"status" : "SUCCEEDED",
"start_time" : "2022-12-18T13:38:51.979725Z",
"end_time" : "2022-12-18T13:42:58.569202Z",
"received_objects" : 4,
"succeeded_objects" : 4,
"failed_objects" : 0,
"processing_objects" : 0,
"processed_rows" : 16,
"total_rows" : 16
}, {
"name" : "Load",
"status" : "SUCCEEDED",
"start_time" : "2022-12-18T13:40:39.350857Z",
"end_time" : "2022-12-18T13:43:12.966492Z",
"received_objects" : 4,
"succeeded_objects" : 4,
"failed_objects" : 0,
"processing_objects" : 0,
"processed_rows" : 16,
"total_rows" : 16
}, {
"name" : "Post Load",
"status" : "SUCCEEDED",
"start_time" : "2022-12-18T13:43:12.981490",
"end_time" : "2022-12-18T13:43:15.764366",
"metadata" : [ {
"type" : "Constraints",
"total" : 20,
"processed" : 20,
"status" : "SUCCESS",
"start_time" : "2022-12-18T13:43:12.981490Z",
"end_time" : "2022-12-18T13:43:15.764366Z"
}, {
"type" : "Indexes",
"total" : 10,
"processed" : 10,
"status" : "SUCCESS",
"start_time" : "2022-12-18T13:43:12.981490Z",
"end_time" : "2022-12-18T13:43:15.764366Z"
}, {
"type" : "Triggers",
"total" : 5,
"processed" : 5,
"status" : "SUCCESS",
"start_time" : "2022-12-18T13:43:12.981490Z",
"end_time" : "2022-12-18T13:43:15.764366Z"
} ]
} ]
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
404
Object Not Found.
Up
put /executions/{id}/restart
Restart a failed execution. (restartExecution)
Path parameters
id (required)
Path Parameter — Numeric ID of the Job Execution. default: null format: int64
Return type
Example data
Content-Type: application/json
{
"id" : 72,
"job_id" : 5,
"status" : "SUCCEEDED",
"create_time" : "2022-12-18T13:38:43.722917Z",
"end_time" : "2022-12-18T13:43:16.554603Z",
"total_objects" : 4,
"total_rows" : 16,
"tasks" : [ {
"name" : "Unload",
"status" : "SUCCEEDED",
"start_time" : "2022-12-18T13:38:44.184296Z",
"end_time" : "2022-12-18T13:38:54.972883Z",
"received_objects" : 4,
"succeeded_objects" : 4,
"failed_objects" : 0,
"processing_objects" : 0,
"processed_rows" : 16,
"total_rows" : 16
}, {
"name" : "Masking",
"status" : "SUCCEEDED",
"start_time" : "2022-12-18T13:38:51.979725Z",
"end_time" : "2022-12-18T13:42:58.569202Z",
"received_objects" : 4,
"succeeded_objects" : 4,
"failed_objects" : 0,
"processing_objects" : 0,
"processed_rows" : 16,
"total_rows" : 16
}, {
"name" : "Load",
"status" : "SUCCEEDED",
"start_time" : "2022-12-18T13:40:39.350857Z",
"end_time" : "2022-12-18T13:43:12.966492Z",
"received_objects" : 4,
"succeeded_objects" : 4,
"failed_objects" : 0,
"processing_objects" : 0,
"processed_rows" : 16,
"total_rows" : 16
}, {
"name" : "Post Load",
"status" : "SUCCEEDED",
"start_time" : "2022-12-18T13:43:12.981490",
"end_time" : "2022-12-18T13:43:15.764366",
"metadata" : [ {
"type" : "Constraints",
"total" : 20,
"processed" : 20,
"status" : "SUCCESS",
"start_time" : "2022-12-18T13:43:12.981490Z",
"end_time" : "2022-12-18T13:43:15.764366Z"
}, {
"type" : "Indexes",
"total" : 10,
"processed" : 10,
"status" : "SUCCESS",
"start_time" : "2022-12-18T13:43:12.981490Z",
"end_time" : "2022-12-18T13:43:15.764366Z"
}, {
"type" : "Triggers",
"total" : 5,
"processed" : 5,
"status" : "SUCCESS",
"start_time" : "2022-12-18T13:43:12.981490Z",
"end_time" : "2022-12-18T13:43:15.764366Z"
} ]
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
ExecutionSummary
404
Object Not Found.
500
Internal Service Unavailable.
Create a Hyperscale Compliance Job. (createJob)
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"retain_execution_data" : "NO",
"env_name_prefix" : "env_name_prefix",
"target_configs" : {
"key" : ""
},
"masking_job_config" : {
"feedback_size" : 1,
"min_memory" : 0,
"description" : "Job created by Hyperscale Masking",
"stream_row_limit" : 7,
"max_memory" : 1,
"num_input_streams" : 1
},
"name" : "name",
"masking_engine_ids" : [ 6, 6, 6, 6, 6 ],
"app_name_prefix" : "app_name_prefix",
"id" : 0,
"data_set_id" : 1,
"source_configs" : {
"key" : ""
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
Created
Job
400
Invalid Input provided.
500
Internal Service Unavailable.
Deletes the Job by Id (deleteJob)
Path parameters
id (required)
Path Parameter — Numeric ID of the Job. default: null format: int64
Responses
200
OK
404
Object Not Found.
500
Internal Service Unavailable.
Returns a Job by ID. (getJobById)
Path parameters
id (required)
Path Parameter — Numeric ID of the Job. default: null format: int64
Return type
Example data
Content-Type: application/json
{
"retain_execution_data" : "NO",
"env_name_prefix" : "env_name_prefix",
"target_configs" : {
"key" : ""
},
"masking_job_config" : {
"feedback_size" : 1,
"min_memory" : 0,
"description" : "Job created by Hyperscale Masking",
"stream_row_limit" : 7,
"max_memory" : 1,
"num_input_streams" : 1
},
"name" : "name",
"masking_engine_ids" : [ 6, 6, 6, 6, 6 ],
"app_name_prefix" : "app_name_prefix",
"id" : 0,
"data_set_id" : 1,
"source_configs" : {
"key" : ""
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
Job
404
Object Not Found.
500
Internal Service Unavailable.
Returns a list of Hyperscale Compliance Jobs. (listAllJobs)
Return type
Example data
Content-Type: application/json
[ {
"retain_execution_data" : "NO",
"env_name_prefix" : "env_name_prefix",
"target_configs" : {
"key" : ""
},
"masking_job_config" : {
"feedback_size" : 1,
"min_memory" : 0,
"description" : "Job created by Hyperscale Masking",
"stream_row_limit" : 7,
"max_memory" : 1,
"num_input_streams" : 1
},
"name" : "name",
"masking_engine_ids" : [ 6, 6, 6, 6, 6 ],
"app_name_prefix" : "app_name_prefix",
"id" : 0,
"data_set_id" : 1,
"source_configs" : {
"key" : ""
}
}, {
"retain_execution_data" : "NO",
"env_name_prefix" : "env_name_prefix",
"target_configs" : {
"key" : ""
},
"masking_job_config" : {
"feedback_size" : 1,
"min_memory" : 0,
"description" : "Job created by Hyperscale Masking",
"stream_row_limit" : 7,
"max_memory" : 1,
"num_input_streams" : 1
},
"name" : "name",
"masking_engine_ids" : [ 6, 6, 6, 6, 6 ],
"app_name_prefix" : "app_name_prefix",
"id" : 0,
"data_set_id" : 1,
"source_configs" : {
"key" : ""
}
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
500
Internal Service Unavailable.
Update an existing Job. (updateJob)
Path parameters
id (required)
Path Parameter — Numeric ID of the Job. default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"retain_execution_data" : "NO",
"env_name_prefix" : "env_name_prefix",
"target_configs" : {
"key" : ""
},
"masking_job_config" : {
"feedback_size" : 1,
"min_memory" : 0,
"description" : "Job created by Hyperscale Masking",
"stream_row_limit" : 7,
"max_memory" : 1,
"num_input_streams" : 1
},
"name" : "name",
"masking_engine_ids" : [ 6, 6, 6, 6, 6 ],
"app_name_prefix" : "app_name_prefix",
"id" : 0,
"data_set_id" : 1,
"source_configs" : {
"key" : ""
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
Job
400
Invalid Input provided.
404
Object Not Found.
500
Internal Service Unavailable.
Up
post /mount-filesystems
Create a File Mount. (createMountFilesystem)
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"mountName" : "mount-123",
"hostAddress" : "mount1.delphix.com",
"mountPath" : "/var/tmp/masking-mount/",
"mountType" : "NFS4",
"options" : "rw"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
Created
MountFileSystem
400
Invalid Input provided.
500
Internal Service Unavailable.
Up
delete /mount-filesystems/{mountFileSystemId}
Delete an existing file mount. (deleteMountFilesystem)
Path parameters
mountFileSystemId (required)
Path Parameter — Numeric ID of the File Mount. default: null format: int64
Responses
200
OK
404
Object Not Found.
500
Internal Service Unavailable.
Up
get /mount-filesystems/{mountFileSystemId}
Returns a File Mount by ID. (getMountFilesystem)
Path parameters
mountFileSystemId (required)
Path Parameter — Numeric ID of the File Mount. default: null format: int64
Return type
Example data
Content-Type: application/json
{
"mountName" : "mount-123",
"hostAddress" : "mount1.delphix.com",
"mountPath" : "/var/tmp/masking-mount/",
"mountType" : "NFS4",
"options" : "rw"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
MountFileSystem
404
Object Not Found.
500
Internal Service Unavailable.
Up
get /mount-filesystems
Returns a list of File Mounts. (listMountFilesystem)
Return type
Example data
Content-Type: application/json
[ {
"mountName" : "mount-123",
"hostAddress" : "mount1.delphix.com",
"mountPath" : "/var/tmp/masking-mount/",
"mountType" : "NFS4",
"options" : "rw"
}, {
"mountName" : "mount-123",
"hostAddress" : "mount1.delphix.com",
"mountPath" : "/var/tmp/masking-mount/",
"mountType" : "NFS4",
"options" : "rw"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
500
Internal Service Unavailable.
Up
put /mount-filesystems/{mountFileSystemId}
Update an existing File Mount. (updateMountFilesystem)
Path parameters
mountFileSystemId (required)
Path Parameter — Numeric ID of the File Mount. default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"mountName" : "mount-123",
"hostAddress" : "mount1.delphix.com",
"mountPath" : "/var/tmp/masking-mount/",
"mountType" : "NFS4",
"options" : "rw"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
MountFileSystem
400
Invalid Input provided.
404
Object Not Found.
500
Internal Service Unavailable.
Up
get /mount-filesystems/{mountFileSystemId}/validate
Validate the permissions for a File Mount. (validateMountFilesystem)
Path parameters
mountFileSystemId (required)
Path Parameter — Numeric ID of the File Mount. default: null format: int64
Return type
Example data
Content-Type: application/json
{
"isValid" : true
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
ValidateMountFileSystemResponse
404
Object Not Found.
500
Internal Service Unavailable.
Up
post /structured-data-format
Create a Structured Data Format for XML/JSON masking. (createStructuredDataFormat)
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"file_upload_ref" : "delphix-file://upload/f_XXXX/XXX.xml",
"doc_type" : "XML",
"masking_inventory_paths" : [ {
"path" : "/catalog/book/author",
"domain_name" : "NULL_SL",
"algorithm_name" : "dlpx-core:FullName"
}, {
"path" : "/catalog/book/isbn",
"domain_name" : "ADDRESS",
"algorithm_name" : "dlpx-core:CM Alpha-Numeric"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
Created
StructuredDataFormat
400
Invalid Input provided.
500
Internal Service Unavailable.
Up
delete /structured-data-format/{structuredDataFormatId}
Delete an existing structured data format. (deleteStructuredDataFormat)
Path parameters
structuredDataFormatId (required)
Path Parameter — Numeric ID of the structured data format. default: null format: int64
Responses
200
OK
404
Object Not Found.
500
Internal Service Unavailable.
Up
get /structured-data-format/{structuredDataFormatId}
Returns a structured data format info by ID. (getStructuredDataFormat)
Path parameters
structuredDataFormatId (required)
Path Parameter — Numeric ID of the structured data format. default: null format: int64
Return type
Example data
Content-Type: application/json
{
"file_upload_ref" : "delphix-file://upload/f_XXXX/XXX.xml",
"doc_type" : "XML",
"masking_inventory_paths" : [ {
"path" : "/catalog/book/author",
"domain_name" : "NULL_SL",
"algorithm_name" : "dlpx-core:FullName"
}, {
"path" : "/catalog/book/isbn",
"domain_name" : "ADDRESS",
"algorithm_name" : "dlpx-core:CM Alpha-Numeric"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
StructuredDataFormat
404
Object Not Found.
500
Internal Service Unavailable.
Up
get /structured-data-format
Returns a list of Structured Data Formats. (listAllStructuredDataFormat)
Return type
Example data
Content-Type: application/json
[ {
"file_upload_ref" : "delphix-file://upload/f_XXXX/XXX.xml",
"doc_type" : "XML",
"masking_inventory_paths" : [ {
"path" : "/catalog/book/author",
"domain_name" : "NULL_SL",
"algorithm_name" : "dlpx-core:FullName"
}, {
"path" : "/catalog/book/isbn",
"domain_name" : "ADDRESS",
"algorithm_name" : "dlpx-core:CM Alpha-Numeric"
} ]
}, {
"file_upload_ref" : "delphix-file://upload/f_XXXX/XXX.xml",
"doc_type" : "XML",
"masking_inventory_paths" : [ {
"path" : "/catalog/book/author",
"domain_name" : "NULL_SL",
"algorithm_name" : "dlpx-core:FullName"
}, {
"path" : "/catalog/book/isbn",
"domain_name" : "ADDRESS",
"algorithm_name" : "dlpx-core:CM Alpha-Numeric"
} ]
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
500
Internal Service Unavailable.
Up
put /structured-data-format/{structuredDataFormatId}
Update an existing structured data format. (updateStructuredDataFormat)
Path parameters
structuredDataFormatId (required)
Path Parameter — Numeric ID of the structured data format. default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"file_upload_ref" : "delphix-file://upload/f_XXXX/XXX.xml",
"doc_type" : "XML",
"masking_inventory_paths" : [ {
"path" : "/catalog/book/author",
"domain_name" : "NULL_SL",
"algorithm_name" : "dlpx-core:FullName"
}, {
"path" : "/catalog/book/isbn",
"domain_name" : "ADDRESS",
"algorithm_name" : "dlpx-core:CM Alpha-Numeric"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
StructuredDataFormat
400
Invalid Input provided.
404
Object Not Found.
500
Internal Service Unavailable.
Up
delete /support-bundle/{asyncTaskId}
Delete an existing support-bundle. (deleteSupportBundleById)
Path parameters
asyncTaskId (required)
Path Parameter — Numeric ID of the async task. default: null format: int64
Responses
200
OK
Generates support bundle (generateSupportBundle)
Generates support bundle
Return type
Example data
Content-Type: application/json
{
"async_task_id" : 1,
"operation" : "SUPPORT_BUNDLE_GENERATE",
"reference" : "hyperscale-support-20240313-13-18-04.tar.gz",
"status" : "SUCCEEDED",
"start_time" : "2024-03-13T13:18:05.366909Z",
"end_time" : "2024-03-13T13:19:05.955041Z",
"cancellable" : true
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
Success
AsyncTask
400
Invalid Input provided.
500
Internal Service Unavailable.
Import Connectors and Data Set. (importDataSet)
Consumes
This API call consumes the following media types via the request header:
Request body
Request headers
passphrase (optional)
Header Parameter — to decrypt the bundle. default: null
Return type
Example data
Content-Type: application/json
{
"data_set_id" : 1,
"message" : "Dataset created/updated successfully"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
Created
DataSetImportResponse
400
Invalid Input provided.
500
Internal Service Unavailable.
Up
post /sync-compliance-engines
Import Global Settings to sync the Compliance Engines. (importGlobalSettings)
Consumes
This API call consumes the following media types via the request header:
Request body
Request headers
passphrase (optional)
Header Parameter — to decrypt the bundle. default: null
Return type
String
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
String
400
Invalid Input provided.
500
Internal Service Unavailable.
Up
put /import/{dataSetId}
Update imported Data Set and Connectors. (updateImportDataSet)
Path parameters
dataSetId (required)
Path Parameter — ID of the DataSet to be updated default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Request headers
passphrase (optional)
Header Parameter — to decrypt the bundle. default: null
Query parameters
update_connector_info (optional)
Query Parameter — The flag to determine whether the connector info is also required to be updated. default: false
Return type
Example data
Content-Type: application/json
{
"data_set_id" : 1,
"message" : "Dataset created/updated successfully"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
DataSetImportResponse
400
Invalid Input provided.
500
Internal Service Unavailable.
Up
post /vaults/hashicorp
Configure a new Hashicorp Vault (createHashicorpVault)
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"env_variables" : {
"VAULT_ADDR" : "https://vault.company.co:8200"
},
"id" : 0
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
Created
HashicorpVaultResponse
400
Invalid Input provided.
500
Internal Service Unavailable.
Up
delete /vaults/hashicorp/{vaultId}
Delete a Hashicorp vault by id (deleteHashicorpVault)
Path parameters
vaultId (required)
Path Parameter — Numeric ID of the Hashicorp vault default: null format: int64
Responses
200
OK
404
Object Not Found.
500
Internal Service Unavailable.
Up
get /vaults/hashicorp/{vaultId}
Get a Hashicorp vault by id (getHashicorpVault)
Path parameters
vaultId (required)
Path Parameter — Numeric ID of the Hashicorp vault default: null format: int64
Return type
Example data
Content-Type: application/json
{
"env_variables" : {
"VAULT_ADDR" : "https://vault.company.co:8200"
},
"id" : 0
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
HashicorpVaultResponse
404
Object Not Found.
500
Internal Service Unavailable.
Returns a list of configured Hashicorp vaults. (listHashicorpVaults)
Return type
Example data
Content-Type: application/json
[ {
"env_variables" : {
"VAULT_ADDR" : "https://vault.company.co:8200"
},
"id" : 0
}, {
"env_variables" : {
"VAULT_ADDR" : "https://vault.company.co:8200"
},
"id" : 0
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
500
Internal Service Unavailable.
[ Jump to Methods ]
Table of Contents
ApiKey - ApiKeyApiKeyToken - ApiKeyTokenAsyncTask - CommonExecutionResponse - CommonExecutionResponseConnector-Info - ConnectorInfoDataInfoSettings - DataInfoSettingsDataInfo_inner - DataSet - DataSetDataSetFileReadResponse - DataSetFileReadResponseDataSetImportBundle - DataSetImportBundleDataSetImportResponse - DataSetImportResponseError - ErrorExecution - ExecutionExecutionRequest - ExecutionRequestExecutionSummary - ExecutionSummaryExecutionSummaryMetadata - ExecutionSummaryMetadataExecutionSummaryTask - ExecutionSummaryTaskExecutionTask - ExecutionTaskFile-Metadata - FileMetadataFileRead - File Upload Format for creating Hyperscale ObjectsFileUploadResponse - fileUploadResponseGlobalSettingsImportBundle - GlobalSettingsImportBundleHashicorpVault - HashicorpVaultHashicorpVaultResponse - HashicorpVaultResponseJob - JobMaskingInventory - MaskingInventoryMaskingJobConfig - MaskingJobConfigMountFileSystem - MountFileSystemRegisteredEngine - RegisteredEngineStructuredDataFormat - StructuredDataFormatStructuredFieldMetaData - StructuredFieldMetaDataValidateMountFileSystemResponse - MountFileSystemCheck
Information of the Authorization Key required to access the APIs.
id (optional)
Long The numeric id of the API key information. format: int64
name
String The name of the API key.
The Token to be used to access the APIs.
api_key_id (optional)
Long The numeric id of the newly created API key. format: int64
token (optional)
String The opaque token to use to authenticate for other API calls. The token must be included in all HTTP API calls
in a request header named "Authorization", and prefixed with "apk " to denote that it is a proprietary API key format.
For instance, if the token is "abc123", request must contain the following HTTP request header:
"Authorization: apk abc123".
async_task_id (optional)
Long The ID of the AsyncTask. This field will be generated by the Hyperscale. format: int32
operation (optional)
String The type of operation that the AsyncTask is performing.
SUPPORT_BUNDLE_GENERATE
reference (optional)
String The reference for the AsyncTask.
status (optional)
String The status of the AsyncTask in regard to its completion.
CANCELLED
FAILED
RUNNING
SUCCEEDED
PARTIAL_SUCCEEDED
start_time (optional)
Date The date and time that this AsyncTask was started. format: date-time
end_time (optional)
Date The date and time that this AsyncTask completed. format: date-time
cancellable (optional)
Boolean True if the AsyncTask can be cancelled, false otherwise.
errors (optional)
Execution information of a Hyperscale Job which is common to both the detailed and summarized response.
id (optional)
Long The ID number of the hyperscale masking job execution. This field is auto-generated by the Hyperscale Application. format: int64
job_id
Long The ID number of the hyperscale masking job for which the execution is created. format: int64
status (optional)
String The status of the execution regarding its completion.
CANCEL_INITIATED
CANCELLED
FAILED
RUNNING
SUCCEEDED
CREATED
create_time (optional)
Date The time when the execution is created. format: date-time
start_time (optional)
Date The time when the execution is started. format: date-time
end_time (optional)
Date The time when the execution is completed. format: date-time
total_objects (optional)
Integer Total number of source files/tables which need to be processed in this execution.
total_rows (optional)
Long Total number of rows from all the objects(source files/tables) which need to be processed in this execution. This value is calculated by accessing source objects, so will be calulcated only for those source objects which are accessible. format: int64
processed_bytes (optional)
String The number of input bytes masked so far by this execution. This is only applicable for JSON file type.
message (optional)
String The message describing response.
ConnectorInfo model for data source and target connection information.
id (optional)
Long The ConnectorInfo object entity ID. This field is auto-generated by the Hyperscale Compliance. format: int64
connectorName (optional)
String The name of the connector. This should be unique.
source
target
prop_key
String The key of additional property.
prop_value
String The value of additional property.
apply_to
String Defines this additional property is applicable to which Data Set, SOURCE or TARGET or BOTH.
SOURCE
TARGET
BOTH
source
target
masking_inventory (optional)
DataSet model for data source and target dataSet information.
id (optional)
Long The DataSet object entity ID. This field is auto-generated by the Hyperscale Compliance. format: int64
connector_id
Long The ID of connector-info. format: int64
mount_filesystem_id
Long The ID of MountFileSystems. format: int64
data_info
data_set_id (optional)
Long ID of the updated DataSet format: int64
Bundle information to import Connectors and Data Set.
exportResponseMetadata
blob
String Export package containing data representing Compliance object.
signature
String Cryptographic signature of the blob.
publicKey
String Public version of the key used to generate the signature.
mount_filesystem_id (optional)
Long ID of the Mount FileSystem object created on Hyperscale Engine. Mandatory for POST /import API format: int64
data_info_settings (optional)
array[DataInfoSettings] Array of additional properties to be configured for Source and Target Data Set. Each property can be configured either for SOURCE or TARGET or BOTH Data Sets.
Response of Data Set Import request.
data_set_id
Long ID of the Data Set created from exported objects. format: int64
message (optional)
String Message providing more detail about the response status.
The Error object contains information of a failure.
message (optional)
String Message providing more detail about the error that occurred, if available.
object_name (optional)
String Name of the object affected by the error.
Execution information of a Hyperscale Job in a detailed format.
id (optional)
Long The ID number of the hyperscale masking job execution. This field is auto-generated by the Hyperscale Application. format: int64
job_id
Long The ID number of the hyperscale masking job for which the execution is created. format: int64
status (optional)
String The status of the execution regarding its completion.
CANCEL_INITIATED
CANCELLED
FAILED
RUNNING
SUCCEEDED
CREATED
create_time (optional)
Date The time when the execution is created. format: date-time
start_time (optional)
Date The time when the execution is started. format: date-time
end_time (optional)
Date The time when the execution is completed. format: date-time
total_objects (optional)
Integer Total number of source files/tables which need to be processed in this execution.
total_rows (optional)
Long Total number of rows from all the objects(source files/tables) which need to be processed in this execution. This value is calculated by accessing source objects, so will be calulcated only for those source objects which are accessible. format: int64
processed_bytes (optional)
String The number of input bytes masked so far by this execution. This is only applicable for JSON file type.
message (optional)
String The message describing response.
tasks (optional)
Request for Execution creation.
job_id
Long The ID number of the hyperscale masking job for which the execution need to be created. format: int64
Execution information of a Hyperscale Job in a summarized format.
id (optional)
Long The ID number of the hyperscale masking job execution. This field is auto-generated by the Hyperscale Application. format: int64
job_id
Long The ID number of the hyperscale masking job for which the execution is created. format: int64
status (optional)
String The status of the execution regarding its completion.
CANCEL_INITIATED
CANCELLED
FAILED
RUNNING
SUCCEEDED
CREATED
create_time (optional)
Date The time when the execution is created. format: date-time
start_time (optional)
Date The time when the execution is started. format: date-time
end_time (optional)
Date The time when the execution is completed. format: date-time
total_objects (optional)
Integer Total number of source files/tables which need to be processed in this execution.
total_rows (optional)
Long Total number of rows from all the objects(source files/tables) which need to be processed in this execution. This value is calculated by accessing source objects, so will be calulcated only for those source objects which are accessible. format: int64
processed_bytes (optional)
String The number of input bytes masked so far by this execution. This is only applicable for JSON file type.
message (optional)
String The message describing response.
tasks (optional)
type (optional)
String Post load task component type, like constraints, indexes and triggers etc.
total (optional)
Long Total count of post load task components, like total constraints, indexes and triggers etc. format: int64
processed (optional)
Long Total processed count of post load task components which either success or failed. format: int64
status (optional)
String The final status of the post load task components regarding its completion.
CANCELLED
FAILED
RUNNING
SUCCEEDED
start_time (optional)
Date The time when the post load task components is started. format: date-time
end_time (optional)
Date The time when the post load task components is completed. format: date-time
name
status (optional)
String The status of the task regarding its completion.
CANCELLED
CANCEL_INITIATED
FAILED
RUNNING
SUCCEEDED
start_time (optional)
Date The time when the task is started. format: date-time
end_time (optional)
Date The time when the task is completed. format: date-time
received_objects (optional)
Integer Number of objects i.e. source files or tables received by this task to process. For this task, received_objects = succeeded_objects + failed_objects + processing_objects. The number received_objects is a runtime information, it might change while the task is still in process.
succeeded_objects (optional)
Integer Number of source files/tables which are successfully processed by this task. The number succeeded_objects is a runtime information, it might change while the task is still in process.
failed_objects (optional)
Integer Number of source files/tables whose processing failed at this task. The number failed_objects is a runtime information, it might change while the task is still in process.
processing_objects (optional)
Integer Number of source files/tables which are currently in process by this task. This number includes both the objects which are in Hyperscale Queue waiting for assignment and are running or queued on Compliance Engines. The number processing_objects is a runtime information, it will change while the task is still in process.
processed_rows (optional)
Long Total number of rows from multiple objects(source files/tables) which are successfully processed by this task. This will include the rows of all the succeeded_objects and the partially processed rows of all the failed_objects. This number is a runtime information, it might change while the task is still in process. format: int64
total_rows (optional)
Long Total number of rows which are received by this task to process. This should be the total rows of all the received_objects. This number is a runtime information, it might change while the task is still in process. format: int64
metadata (optional)
name
status (optional)
String The status of the task regarding its completion.
CANCELLED
CANCEL_INITIATED
FAILED
RUNNING
SUCCEEDED
start_time (optional)
Date The time when the task is started. format: date-time
end_time (optional)
Date The time when the task is completed. format: date-time
metadata (optional)
errors (optional)
FileMetadata model for file metadata related information.
id (optional)
Long The FileMetadata object entity ID. This field is auto-generated by the Hyperscale Engine. format: int64
delimiter
String The delimiter used for exporting data source to the delimited file.
endOfRecord
String The string of characters that delineates the end-of-record for a file. Note that, for linux this is \n, and for windows it is \r\n.
enclosure (optional)
String The text enclosure used for exporting data source to the delimited file.
enclosureEscapeCharacter (optional)
String The character used to escape a literal enclosure character within an enclosed value. By default, this is equal to the enclosure value itself, so doubling the enclosure character escape it.
escapeEnclosureEscapeCharacter (optional)
Boolean This flag indicates whether the enclosure escape character also escapes itself. For example, if the enclosure escape character is *, then the sequence ** would be treated as a single * character, rather than an escape.
built_in (optional)
Boolean This flag indicates whether created by customers or internal service. For example, if true, then the file metadata is created by unload service and false for the one created by customer through controller service.
File Upload Format for creating Hyperscale Objects
file_upload_ref
String The blob Id generated during file upload
Response of file-upload.
file_upload_ref
String ID of upload file for further use.
Bundle information to import Global Settings.
exportResponseMetadata
blob
String Export package containing data representing Compliance object.
signature
String Cryptographic signature of the blob.
publicKey
String Public version of the key used to generate the signature.
compliance_engine_ids
array[Long] Array of Compliance Engine IDs on which data need to be imported. format: int64
Configuration required to connect and authenticate with an Hashicorp Vault which stores engines username and passwords.
id (optional)
env_variables
map[String, String] Environment variables to set when invoking the Vault CLI tool. The environment variables will be used both
to login to the vault (if this step is required) and to retrieve engine username and passwords.
login_command_args (optional)
array[String] Arguments to the "vault" CLI tool to be used to fetch a client token (or "login").
If supporting files, such as TLS certificates, must be used to authenticate, they can be
mounted to the /etc/config directory.
This property must not be set when using the TOKEN authentication method as login is not required.
Configuration required to connect and authenticate with an Hashicorp Vault which stores engines username and passwords.
id
env_variables
map[String, String] Environment variables to set when invoking the Vault CLI tool. The environment variables will be used both
to login to the vault (if this step is required) and to retrieve engine username and passwords.
Hyperscale Compliance Job
id (optional)
Long The ID number of the job. This field is auto-generated by the Hyperscale Compliance. format: int64
name
String Name of the Job. This should be unique.
masking_engine_ids
data_set_id
Long ID of the registered Data Set model to be used for this job. format: int64
app_name_prefix
String Prefix of the name of the application to be created on masking engine. A new application with the name appNamePrefix_hyperscale will be created on masking engines.
env_name_prefix
String Prefix of the name of the environment to be created on masking engine. A new environment with the name envNamePrefix_hyperscale will be created on masking engines.
retain_execution_data (optional)
String Defines whether execution data will be stored after execution is complete. Enum having values- NO, ON_ERROR, ALWAYS.
NO
ON_ERROR
ALWAYS
source_configs (optional)
target_configs (optional)
masking_job_config (optional)
field_name
domain_name (optional)
String The name of the domain assigned to this field.
algorithm_name (optional)
String The name of the algorithm assigned to this field.
date_format (optional)
String The format of the date assigned to this field. The format has to be a valid Java date format.
algorithm_field_name (optional)
String The name of the algorithm field that is associated with this algorithm.
algorithm_group_no (optional)
Long The group number of the algorithm to identify a set of columns associated with one instance of algorithm. format: int64
structured_data_format_id (optional)
Long The ID of structured data format created by masking XML/JSON fields format: int64
Configuration details for the Masking Engine job. If not provided default ME job configuration will be used.
max_memory (optional)
Integer Maximum memory to be allocated for each Masking job. format: int32
min_memory (optional)
Integer Minimum memory to be allocated for each Masking job. format: int32
description (optional)
String Description of Masking job.
feedback_size (optional)
Integer Feedback Size for each Masking job. format: int32
stream_row_limit (optional)
Integer Stream Row Limit for each Masking job.Setting this value to 0 allows unlimited rows into each stream, while leaving it blank will select a default limit based on job type. format: int32
num_input_streams (optional)
Integer Number of input streams to be configured for Masking Job. format: int32
Mount Information.
id (optional)
Long The ID number of the mount. This field is auto-generated by the Hyperscale Engine. format: int64
mountName
String Name of the mount. This should be unique. This name will be used as a directory name by Hyperscale Engine.
hostAddress
String The host address of the server.
mountPath
String The path to the directory on the filesystem to mount.
mountType
String The type of filesystem. Enum having values- CIFS, NFS3, NFS4.
CIFS
NFS3
NFS4
options (optional)
String The options for mount. The endpoint will return all default options and user specified options.
status (optional)
String The connection status for mount.
ACTIVE
INACTIVE
DISCONNECTED
A registered engine's connection and authentication settings.
id (optional)
name
type (optional)
String The type of this engine.
VIRTUALIZATION
MASKING
protocol (optional)
String The parameter to indicate http or https communication for Masking Engine.
http
https
hostname
username (optional)
hashicorp_vault_username_command_args (optional)
array[String] Arguments to pass to the Vault CLI tool to retrieve the username for the engine.
hashicorp_vault_id (optional)
Long Reference to the Hashicorp vault to use to retrieve engine credentials. format: int64
ssl (optional)
Boolean Allow connections to the engine over HTTPs with or without validating the TLS certificate. Even though
the connection to the engine might be performed over HTTPs, setting this property false eliminates
the protection against a man-in-the-middle attack for connections to this engine. Instead,
consider creating a truststore with a Certificate Authority to validate the engine's certificate,
and set the truststore_path property. If no value of ssl is provided when protocol is HTTPS,
value will be set to true.
ssl_hostname_check (optional)
Boolean Ignore validation of the name associated to the TLS certificate when connecting to the engine over HTTPs.
Setting this value false must only be done if the TLS certificate of the engine does not match the hostname,
and the TLS configuration of the engine cannot be fixed. Setting this property reduces the protection
against a man-in-the-middle attack for connections to this engine.
This is ignored if ssl flag is set to false. If no value of ssl_hostname_check is provided when protocol
is HTTPS, value will be set to true.
truststore_filename (optional)
String File name of a truststore which can be used to validate the TLS certificate of the engine. The truststore
must be available at /etc/config/cert/<truststore_filename>
password (optional)
hashicorp_vault_password_command_args (optional)
array[String] Arguments to pass to the Vault CLI tool to retrieve the password for the engine.
truststore_password (optional)
String Password to read the truststore.
Information of structured data format.
id (optional)
Long The ID of the StructuredDataFormat. This field is auto-generated by the Hyperscale Compliance. format: int64
file_upload_ref (optional)
String ID of uploaded XML/JSON format file for further use.
doc_type (optional)
String The type of structured document.
XML
JSON
masking_inventory_paths
Information of the field metadata for structured file format.
path (optional)
String Path (XML/JSON) of field to be masked.
domain_name (optional)
String The name of the domain assigned to this field.
algorithm_name (optional)
String The name of the algorithm assigned to this field.
algorithm_field_name (optional)
String The name of the algorithm field that is associated with this algorithm.
algorithm_group_no (optional)
Long The group number of the algorithm to identify a set of columns associated with one instance of algorithm. format: int64
date_format (optional)
String The format of the date assigned to this field. The format has to be a valid Java date format.
Mount File system permissions validation.
isValid (optional)
Boolean The flag to validate whether a file mount is valid.
error (optional)