HyperscaleObjects

Returns a list of Hyperscale Mount Points.

SecurityApiKeyAuth
Request
query Parameters
limit
integer [ 1 .. 1000 ]
Default: 100

Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100.

Example: limit=50
cursor
string [ 1 .. 4096 ] characters

Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints.

sort
string or null

The field to sort results by. A property name with a prepended '-' signifies descending order.

Enum: "id" "-id" "name" "-name" "hostname" "-hostname" "mount_type" "-mount_type" "options" "-options" "mount_path" "-mount_path" "staging_storage_type" "-staging_storage_type" "auth_mechanism" "-auth_mechanism" "aws_bucket_name" "-aws_bucket_name" "aws_bucket_region" "-aws_bucket_region" "aws_bucket_prefix" "-aws_bucket_prefix" "aws_bucket_delimiter" "-aws_bucket_delimiter" "hyperscale_instance_id" "-hyperscale_instance_id"
Example: sort=id
Responses
200

OK

get/hyperscale-mount-points
Response samples
application/json
{
  • "items": [
    ],
  • "response_metadata": {
    }
}

Create a Hyperscale Mount Point

SecurityApiKeyAuth
Request
Request Body schema: application/json
required

Request to create a Hyperscale Mount Point.

hyperscale_instance_id
required
string

The ID of the Hyperscale instance of this Mount Point.

name
string

Name of the mount, unique for a hyperscale instance. This name will be used as a directory name by the Hyperscale instance.

hostname
string

The host name of the server.

mount_path
string

The path to the directory on the filesystem to mount.

mount_type
string

The type of mount filesystem. Enum having values- CIFS, NFS3, NFS4.

Enum: "CIFS" "NFS3" "NFS4"
options
string

The options for mount. The endpoint will return all default options and user specified options.

staging_storage_type
string

The type of staging storage.

Enum: "MOUNT" "AWS_S3"
auth_mechanism
string

The authentication mechanism for AWS_S3 storage.

Enum: "AWS_ROLE" "AWS_SECRET"
aws_bucket_name
string

The aws bucket name for AWS_S3 storage.

aws_bucket_region
string

The aws bucket region for AWS_S3 storage.

aws_bucket_prefix
string

The aws bucket prefix for AWS_S3 storage.

aws_bucket_delimiter
string

The aws bucket delimiter for AWS_S3 storage.

Responses
200

OK

post/hyperscale-mount-points
Request samples
application/json
{
  • "hyperscale_instance_id": "string",
  • "name": "string",
  • "hostname": "string",
  • "mount_path": "string",
  • "mount_type": "CIFS",
  • "options": "string",
  • "staging_storage_type": "MOUNT",
  • "auth_mechanism": "AWS_ROLE",
  • "aws_bucket_name": "string",
  • "aws_bucket_region": "string",
  • "aws_bucket_prefix": "string",
  • "aws_bucket_delimiter": "string"
}
Response samples
application/json
{
  • "id": "string",
  • "job": {
    }
}

Get a Hyperscale Mount Points.

SecurityApiKeyAuth
Request
path Parameters
hyperscaleMountPointId
required
string non-empty

The ID of the Hyperscale Mount Point.

Responses
200

OK

get/hyperscale-mount-points/{hyperscaleMountPointId}
Response samples
application/json
{
  • "id": "string",
  • "hyperscale_instance_id": "string",
  • "name": "string",
  • "hostname": "string",
  • "mount_path": "string",
  • "mount_type": "CIFS",
  • "options": "string",
  • "staging_storage_type": "MOUNT",
  • "auth_mechanism": "AWS_ROLE",
  • "aws_bucket_name": "string",
  • "aws_bucket_region": "string",
  • "aws_bucket_prefix": "string",
  • "aws_bucket_delimiter": "string"
}

Update a Hyperscale Mount Point by ID.

SecurityApiKeyAuth
Request
path Parameters
hyperscaleMountPointId
required
string non-empty

The ID of the Hyperscale Mount Point.

Request Body schema: application/json

The new data to update a Hyperscale Mount Point.

name
string

Name of the mount, unique for a hyperscale instance.

hostname
string

The host name of the server.

mount_path
string

The path to the directory on the filesystem to mount.

mount_type
string

The type of filesystem.

Enum: "CIFS" "NFS3" "NFS4"
options
string

The mount options.

Responses
200

OK

patch/hyperscale-mount-points/{hyperscaleMountPointId}
Request samples
application/json
{
  • "name": "string",
  • "hostname": "string",
  • "mount_path": "string",
  • "mount_type": "CIFS",
  • "options": "string"
}
Response samples
application/json
{
  • "job": {
    }
}

Delete a Hyperscale Mount Point.

SecurityApiKeyAuth
Request
path Parameters
hyperscaleMountPointId
required
string non-empty

The ID of the Hyperscale Mount Point.

Responses
200

OK

delete/hyperscale-mount-points/{hyperscaleMountPointId}
Response samples
application/json
{
  • "job": {
    }
}

Search for Hyperscale Mount Points.

SecurityApiKeyAuth
Request
query Parameters
limit
integer [ 1 .. 1000 ]
Default: 100

Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100.

Example: limit=50
cursor
string [ 1 .. 4096 ] characters

Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints.

sort
string or null

The field to sort results by. A property name with a prepended '-' signifies descending order.

Enum: "id" "-id" "name" "-name" "hostname" "-hostname" "mount_type" "-mount_type" "options" "-options" "mount_path" "-mount_path" "staging_storage_type" "-staging_storage_type" "auth_mechanism" "-auth_mechanism" "aws_bucket_name" "-aws_bucket_name" "aws_bucket_region" "-aws_bucket_region" "aws_bucket_prefix" "-aws_bucket_prefix" "aws_bucket_delimiter" "-aws_bucket_delimiter" "hyperscale_instance_id" "-hyperscale_instance_id"
Example: sort=id
Request Body schema: application/json

A request body containing a filter expression. This enables searching for items matching arbitrarily complex conditions. The list of attributes which can be used in filter expressions is available in the x-filterable vendor extension.

Filter Expression Overview

Note: All keywords are case-insensitive

Comparison Operators

Operator Description Example
CONTAINS Substring or membership testing for string and list attributes respectively. field3 CONTAINS 'foobar', field4 CONTAINS TRUE
IN Tests if field is a member of a list literal. List can contain a maximum of 100 values field2 IN ['Goku', 'Vegeta']
GE Tests if a field is greater than or equal to a literal value field1 GE 1.2e-2
GT Tests if a field is greater than a literal value field1 GT 1.2e-2
LE Tests if a field is less than or equal to a literal value field1 LE 9000
LT Tests if a field is less than a literal value field1 LT 9.02
NE Tests if a field is not equal to a literal value field1 NE 42
EQ Tests if a field is equal to a literal value field1 EQ 42

Search Operator

The SEARCH operator filters for items which have any filterable attribute that contains the input string as a substring, comparison is done case-insensitively. This is not restricted to attributes with string values. Specifically SEARCH '12' would match an item with an attribute with an integer value of 123.

Logical Operators

Ordered by precedence.

Operator Description Example
NOT Logical NOT (Right associative) NOT field1 LE 9000
AND Logical AND (Left Associative) field1 GT 9000 AND field2 EQ 'Goku'
OR Logical OR (Left Associative) field1 GT 9000 OR field2 EQ 'Goku'

Grouping

Parenthesis () can be used to override operator precedence.

For example: NOT (field1 LT 1234 AND field2 CONTAINS 'foo')

Literal Values

Literal Description Examples
Nil Represents the absence of a value nil, Nil, nIl, NIL
Boolean true/false boolean true, false, True, False, TRUE, FALSE
Number Signed integer and floating point numbers. Also supports scientific notation. 0, 1, -1, 1.2, 0.35, 1.2e-2, -1.2e+2
String Single or double quoted "foo", "bar", "foo bar", 'foo', 'bar', 'foo bar'
Datetime Formatted according to RFC3339 2018-04-27T18:39:26.397237+00:00
List Comma-separated literals wrapped in square brackets [0], [0, 1], ['foo', "bar"]

Limitations

  • A maximum of 8 unique identifiers may be used inside a filter expression.
filter_expression
string [ 5 .. 2000 ] characters
Responses
200

OK

post/hyperscale-mount-points/search
Request samples
application/json

An example of a nested Object comparison testing that at least one repository has a version which is equal to 19.0.0.

{
  • "filter_expression": "repositories CONTAINS {version eq '19.0.0'}"
}
Response samples
application/json
{
  • "items": [
    ],
  • "response_metadata": {
    }
}

Returns a list of Hyperscale Connectors.

SecurityApiKeyAuth
Request
query Parameters
limit
integer [ 1 .. 1000 ]
Default: 100

Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100.

Example: limit=50
cursor
string [ 1 .. 4096 ] characters

Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints.

sort
string or null

The field to sort results by. A property name with a prepended '-' signifies descending order.

Enum: "id" "-id" "name" "-name" "hyperscale_instance_id" "-hyperscale_instance_id" "data_type" "-data_type" "source_username" "-source_username" "source_jdbc_url" "-source_jdbc_url" "source_mongo_url" "-source_mongo_url" "target_username" "-target_username" "target_jdbc_url" "-target_jdbc_url" "target_mongo_url" "-target_mongo_url"
Example: sort=id
Responses
200

OK

get/hyperscale-connectors
Response samples
application/json
{
  • "items": [
    ],
  • "response_metadata": {
    }
}

Create a Hyperscale Connector.

SecurityApiKeyAuth
Request
Request Body schema: application/json
required
hyperscale_instance_id
string

The ID of the Hyperscale instance of this Connector.

data_type
string (HyperscaleDataTypeEnum)

The data type designation for the hyperscale deployment.

Enum: "ORACLE" "MSSQL" "DELIMITED_FILES" "MONGO_DB"
name
string
source_username
string

The username this Connector will use to connect to the source database.

source_password
string

The password this Connector will use to connect to the source database.

source_jdbc_url
string

The JDBC URL used to connect to the source database.

source_mongo_url
string

The MongoDB URL used to connect to the source database.

source_filesystem_path
string

The path on the filesystem where source files must be read (Delimited files Only).

object
target_username
string

The username this Connector will use to connect to the target database.

target_password
string

The username this Connector will use to connect to the target database.

target_jdbc_url
string

The JDBC URL used to connect to the target database.

target_mongo_url
string

The MongoDB URL used to connect to the target database.

target_filesystem_path
string

The path on the filesystem where target files must be written (Delimited files Only).

object
Array of objects (Tag)
make_current_account_owner
boolean
Default: true

Whether the account creating this Hyperscale Connector must be configured as owner of it.

Responses
200

OK

post/hyperscale-connectors
Request samples
application/json
{
  • "hyperscale_instance_id": "string",
  • "data_type": "ORACLE",
  • "name": "string",
  • "source_username": "string",
  • "source_password": "string",
  • "source_jdbc_url": "string",
  • "source_mongo_url": "mongodb://host:27017",
  • "source_filesystem_path": "string",
  • "source_connection_properties": {
    },
  • "target_username": "string",
  • "target_password": "string",
  • "target_jdbc_url": "string",
  • "target_mongo_url": "mongodb://host:27017",
  • "target_filesystem_path": "string",
  • "target_connection_properties": {
    },
  • "tags": [
    ],
  • "make_current_account_owner": true
}
Response samples
application/json
{
  • "id": "string",
  • "job": {
    }
}

Get a Hyperscale Connector.

SecurityApiKeyAuth
Request
path Parameters
hyperscaleConnectorId
required
string non-empty

The ID of the Hyperscale Connector.

Responses
200

OK

get/hyperscale-connectors/{hyperscaleConnectorId}
Response samples
application/json
{
  • "id": "string",
  • "hyperscale_instance_id": "string",
  • "data_type": "ORACLE",
  • "name": "string",
  • "source_username": "string",
  • "source_password": "string",
  • "source_jdbc_url": "string",
  • "source_mongo_url": "mongodb://host:27017",
  • "source_filesystem_path": "string",
  • "source_connection_properties": {
    },
  • "target_username": "string",
  • "target_password": "string",
  • "target_jdbc_url": "string",
  • "target_mongo_url": "mongodb://host:27017",
  • "target_filesystem_path": "string",
  • "target_connection_properties": {
    },
  • "tags": [
    ]
}

Update a Hyperscale Connector by ID.

SecurityApiKeyAuth
Request
path Parameters
hyperscaleConnectorId
required
string non-empty

The ID of the Hyperscale Connector.

Request Body schema: application/json

The new data to update a Hyperscale Connector.

name
string
source_username
string

The username this Connector will use to connect to the source database.

source_password
string

The password this Connector will use to connect to the source database.

source_jdbc_url
string

The JDBC URL used to connect to the source database.

source_mongo_url
string

The MongoDB URL used to connect to the source database.

source_filesystem_path
string

The path on the filesystem where source files must be read (Delimited files Only).

object
target_username
string

The username this Connector will use to connect to the target database.

target_password
string

The username this Connector will use to connect to the target database.

target_jdbc_url
string

The JDBC URL used to connect to the target database.

target_mongo_url
string

The MongoDB URL used to connect to the target database.

target_filesystem_path
string

The path on the filesystem where target files must be written (Delimited files Only).

object
Responses
200

OK

patch/hyperscale-connectors/{hyperscaleConnectorId}
Request samples
application/json
{
  • "name": "string",
  • "source_username": "string",
  • "source_password": "string",
  • "source_jdbc_url": "string",
  • "source_mongo_url": "mongodb://host:27017",
  • "source_filesystem_path": "string",
  • "source_connection_properties": {
    },
  • "target_username": "string",
  • "target_password": "string",
  • "target_jdbc_url": "string",
  • "target_mongo_url": "mongodb://host:27017",
  • "target_filesystem_path": "string",
  • "target_connection_properties": {
    }
}
Response samples
application/json
{
  • "job": {
    }
}

Delete a Hyperscale Connector.

SecurityApiKeyAuth
Request
path Parameters
hyperscaleConnectorId
required
string non-empty

The ID of the Hyperscale Connector.

Responses
200

OK

delete/hyperscale-connectors/{hyperscaleConnectorId}
Response samples
application/json
{
  • "job": {
    }
}

Create tags for a Hyperscale Connector.

SecurityApiKeyAuth
Request
path Parameters
hyperscaleConnectorId
required
string non-empty

The ID of the Hyperscale Connector.

Request Body schema: application/json
required

Tag information for a Hyperscale Connector.

required
Array of objects (Tag) [ 1 .. 1000 ] items unique

Array of tags with key value pairs

Responses
201

Created

post/hyperscale-connectors/{hyperscaleConnectorId}/tags
Request samples
application/json
{
  • "tags": [
    ]
}
Response samples
application/json
{
  • "tags": [
    ]
}

Get tags for a Hyperscale Connector.

SecurityApiKeyAuth
Request
path Parameters
hyperscaleConnectorId
required
string non-empty

The ID of the Hyperscale Connector.

Responses
200

Ok

get/hyperscale-connectors/{hyperscaleConnectorId}/tags
Response samples
application/json
{
  • "tags": [
    ]
}

Delete tags for a Hyperscale Connector.

SecurityApiKeyAuth
Request
path Parameters
hyperscaleConnectorId
required
string non-empty

The ID of the Hyperscale Connector.

Request Body schema: application/json

The parameters to delete tags

key
string [ 1 .. 4000 ] characters

Key of the tag

value
string [ 1 .. 4000 ] characters

Value of the tag

Array of objects (Tag) [ 1 .. 1000 ] items unique

List of tags to be deleted

Responses
204

No Content

post/hyperscale-connectors/{hyperscaleConnectorId}/tags/delete
Request samples
application/json

Delete all tags for given object - No request body required

{ }

Search for Hyperscale Connectors.

SecurityApiKeyAuth
Request
query Parameters
limit
integer [ 1 .. 1000 ]
Default: 100

Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100.

Example: limit=50
cursor
string [ 1 .. 4096 ] characters

Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints.

sort
string or null

The field to sort results by. A property name with a prepended '-' signifies descending order.

Enum: "id" "-id" "name" "-name" "hyperscale_instance_id" "-hyperscale_instance_id" "data_type" "-data_type" "source_username" "-source_username" "source_jdbc_url" "-source_jdbc_url" "source_mongo_url" "-source_mongo_url" "target_username" "-target_username" "target_jdbc_url" "-target_jdbc_url" "target_mongo_url" "-target_mongo_url"
Example: sort=id
Request Body schema: application/json

A request body containing a filter expression. This enables searching for items matching arbitrarily complex conditions. The list of attributes which can be used in filter expressions is available in the x-filterable vendor extension.

Filter Expression Overview

Note: All keywords are case-insensitive

Comparison Operators

Operator Description Example
CONTAINS Substring or membership testing for string and list attributes respectively. field3 CONTAINS 'foobar', field4 CONTAINS TRUE
IN Tests if field is a member of a list literal. List can contain a maximum of 100 values field2 IN ['Goku', 'Vegeta']
GE Tests if a field is greater than or equal to a literal value field1 GE 1.2e-2
GT Tests if a field is greater than a literal value field1 GT 1.2e-2
LE Tests if a field is less than or equal to a literal value field1 LE 9000
LT Tests if a field is less than a literal value field1 LT 9.02
NE Tests if a field is not equal to a literal value field1 NE 42
EQ Tests if a field is equal to a literal value field1 EQ 42

Search Operator

The SEARCH operator filters for items which have any filterable attribute that contains the input string as a substring, comparison is done case-insensitively. This is not restricted to attributes with string values. Specifically SEARCH '12' would match an item with an attribute with an integer value of 123.

Logical Operators

Ordered by precedence.

Operator Description Example
NOT Logical NOT (Right associative) NOT field1 LE 9000
AND Logical AND (Left Associative) field1 GT 9000 AND field2 EQ 'Goku'
OR Logical OR (Left Associative) field1 GT 9000 OR field2 EQ 'Goku'

Grouping

Parenthesis () can be used to override operator precedence.

For example: NOT (field1 LT 1234 AND field2 CONTAINS 'foo')

Literal Values

Literal Description Examples
Nil Represents the absence of a value nil, Nil, nIl, NIL
Boolean true/false boolean true, false, True, False, TRUE, FALSE
Number Signed integer and floating point numbers. Also supports scientific notation. 0, 1, -1, 1.2, 0.35, 1.2e-2, -1.2e+2
String Single or double quoted "foo", "bar", "foo bar", 'foo', 'bar', 'foo bar'
Datetime Formatted according to RFC3339 2018-04-27T18:39:26.397237+00:00
List Comma-separated literals wrapped in square brackets [0], [0, 1], ['foo', "bar"]

Limitations

  • A maximum of 8 unique identifiers may be used inside a filter expression.
filter_expression
string [ 5 .. 2000 ] characters
Responses
200

OK

post/hyperscale-connectors/search
Request samples
application/json

An example of a nested Object comparison testing that at least one repository has a version which is equal to 19.0.0.

{
  • "filter_expression": "repositories CONTAINS {version eq '19.0.0'}"
}
Response samples
application/json
{
  • "items": [
    ],
  • "response_metadata": {
    }
}

Returns a list of Hyperscale Datasets.

SecurityApiKeyAuth
Request
query Parameters
limit
integer [ 1 .. 1000 ]
Default: 100

Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100.

Example: limit=50
cursor
string [ 1 .. 4096 ] characters

Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints.

sort
string or null

The field to sort results by. A property name with a prepended '-' signifies descending order.

Enum: "id" "-id" "hyperscale_instance_id" "-hyperscale_instance_id" "data_type" "-data_type" "connector_id" "-connector_id" "mount_point_id" "-mount_point_id"
Example: sort=id
Responses
200

OK

get/hyperscale-datasets
Response samples
application/json
{
  • "items": [
    ],
  • "response_metadata": {
    }
}

Get a Hyperscale Dataset.

SecurityApiKeyAuth
Request
path Parameters
hyperscaleDatasetId
required
string non-empty

The ID of the Hyperscale Dataset.

Responses
200

OK

get/hyperscale-datasets/{hyperscaleDatasetId}
Response samples
application/json
{
  • "id": "string",
  • "hyperscale_instance_id": "string",
  • "data_type": "ORACLE",
  • "mount_point_id": "string",
  • "connector_id": "string",
  • "tags": [
    ]
}

Update a Hyperscale Dataset by ID.

SecurityApiKeyAuth
Request
path Parameters
hyperscaleDatasetId
required
string non-empty

The ID of the Hyperscale Dataset.

Request Body schema: application/json

The new data to update a Hyperscale Dataset.

mount_point_id
string

The Id of the Hyperscale Mount Point used for this Dataset.

connector_id
string

Id the Hyperscale Connector used to read sensitive data and write masked data.

Responses
200

OK

patch/hyperscale-datasets/{hyperscaleDatasetId}
Request samples
application/json
{
  • "mount_point_id": "string",
  • "connector_id": "string"
}
Response samples
application/json
{
  • "job": {
    }
}

Create tags for a Hyperscale Dataset.

SecurityApiKeyAuth
Request
path Parameters
hyperscaleDatasetId
required
string non-empty

The ID of the Hyperscale Dataset.

Request Body schema: application/json
required

Tag information for a Hyperscale Dataset.

required
Array of objects (Tag) [ 1 .. 1000 ] items unique

Array of tags with key value pairs

Responses
201

Created

post/hyperscale-datasets/{hyperscaleDatasetId}/tags
Request samples
application/json
{
  • "tags": [
    ]
}
Response samples
application/json
{
  • "tags": [
    ]
}

Get tags for a Hyperscale Dataset.

SecurityApiKeyAuth
Request
path Parameters
hyperscaleDatasetId
required
string non-empty

The ID of the Hyperscale Dataset.

Responses
200

Ok

get/hyperscale-datasets/{hyperscaleDatasetId}/tags
Response samples
application/json
{
  • "tags": [
    ]
}

Delete tags for a Hyperscale Dataset.

SecurityApiKeyAuth
Request
path Parameters
hyperscaleDatasetId
required
string non-empty

The ID of the Hyperscale Dataset.

Request Body schema: application/json

The parameters to delete tags

key
string [ 1 .. 4000 ] characters

Key of the tag

value
string [ 1 .. 4000 ] characters

Value of the tag

Array of objects (Tag) [ 1 .. 1000 ] items unique

List of tags to be deleted

Responses
204

No Content

post/hyperscale-datasets/{hyperscaleDatasetId}/tags/delete
Request samples
application/json

Delete all tags for given object - No request body required

{ }

Get a Hyperscale Dataset table or file by ID.

SecurityApiKeyAuth
Request
path Parameters
hyperscaleDatasetId
required
string non-empty

The ID of the Hyperscale Dataset.

hyperscaleDatasetTableOrFileId
required
string non-empty

The ID of the Hyperscale Dataset table or file.

Responses
200

OK

get/hyperscale-datasets/{hyperscaleDatasetId}/tables-or-files/{hyperscaleDatasetTableOrFileId}
Response samples
application/json
{
  • "id": "string",
  • "schema_name": "string",
  • "table_name": "string",
  • "collection_name": "string",
  • "database_name": "string",
  • "filter_key": "string",
  • "column_array_rows": 0,
  • "unload_split": 0,
  • "stream_size": 0,
  • "end_of_record": "string",
  • "delimiter": "string",
  • "enclosure": "string",
  • "enclosure_escape_character": "string",
  • "escape_enclosure_escape_character": true,
  • "has_headers": true,
  • "unique_source_files_identifier": "string",
  • "source_files": [
    ],
  • "perform_join": true,
  • "masking_inventory": [
    ]
}

Update a Hyperscale Dataset table or file by ID.

SecurityApiKeyAuth
Request
path Parameters
hyperscaleDatasetId
required
string non-empty

The ID of the Hyperscale Dataset.

hyperscaleDatasetTableOrFileId
required
string non-empty

The ID of the Hyperscale Dataset table or file.

Request Body schema: application/json

The new data to update a Hyperscale Dataset table or file.

filter_key
string

The unique database column field to filter the source data. Set this property to an empty string to clear the value.

column_array_rows
integer <int64>

The number of column array rows to be used by the sqlldr oracle utility which determines the number of rows loaded before the stream buffer is built.

unload_split
integer <int64>

The number of unloaded files to be generated from the source database.

stream_size
integer <int64>

Long The stream size to be used by the sqlldr oracle utility which specifies the size (in bytes) of the data stream sent from the client to the server.

end_of_record
string

The end of line character. Support values are \n, \r and \r\n (Delimited files only).

delimiter
string

The single character length delimiter used in source files (Delimited files only).

enclosure
string

The single character length quote character used in the source files (Delimited files only).

enclosure_escape_character
string

The escape character used to escape quote characters (Delimited files only).

escape_enclosure_escape_character
boolean

Whether to escape the enclosure escape character (Delimited files only).

has_headers
boolean

Whether source files have header column names or not (Delimited files only). If set to true, format files with the same column names are created and the same can be used for the masking inventory. If set to false, the column names of pattern f0, f1, f2, and so on are used to create the format files for delimited file masking.

unique_source_files_identifier
string

This is the source key that maps the load-service and masking-service data sets with the unload-service data set (Delimited files only). Please ensure that this value is different for each HyperscaleDatasetTableOrFile.

source_files
Array of strings

List of all source files that need to be masked (Delimited files only). All files should have the same delimiter character and other helper characters. All files should have the same number of columns and same column names if it has a header line.

perform_join
boolean

Whether the split files must be joined (Delimited files only).

Responses
200

OK

patch/hyperscale-datasets/{hyperscaleDatasetId}/tables-or-files/{hyperscaleDatasetTableOrFileId}
Request samples
application/json
{
  • "filter_key": "string",
  • "column_array_rows": 0,
  • "unload_split": 0,
  • "stream_size": 0,
  • "end_of_record": "string",
  • "delimiter": "string",
  • "enclosure": "string",
  • "enclosure_escape_character": "string",
  • "escape_enclosure_escape_character": true,
  • "has_headers": true,
  • "unique_source_files_identifier": "string",
  • "source_files": [
    ],
  • "perform_join": true
}
Response samples
application/json
{
  • "job": {
    }
}

Get the tables or files of a hyperscale dataset

SecurityApiKeyAuth
Request
path Parameters
hyperscaleDatasetId
required
string non-empty

The ID of the Hyperscale Dataset.

query Parameters
limit
integer [ 1 .. 1000 ]
Default: 100

Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100.

Example: limit=50
cursor
string [ 1 .. 4096 ] characters

Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints.

sort
string or null

The field to sort results by. A property name with a prepended '-' signifies descending order.

Enum: "id" "-id" "schema_name" "-schema_name" "table_name" "-table_name" "database_name" "-database_name" "collection_name" "-collection_name" "filter_key" "-filter_key" "column_array_rows" "-column_array_rows" "unload_split" "-unload_split" "stream_size" "-stream_size"
Example: sort=id
Responses
200

OK

get/hyperscale-datasets/{hyperscaleDatasetId}/tables-or-files
Response samples
application/json
{
  • "items": [
    ],
  • "response_metadata": {
    }
}

Search the tables or files of a hyperscale dataset

SecurityApiKeyAuth
Request
path Parameters
hyperscaleDatasetId
required
string non-empty

The ID of the Hyperscale Dataset.

query Parameters
limit
integer [ 1 .. 1000 ]
Default: 100

Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100.

Example: limit=50
cursor
string [ 1 .. 4096 ] characters

Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints.

sort
string or null

The field to sort results by. A property name with a prepended '-' signifies descending order.

Enum: "id" "-id" "schema_name" "-schema_name" "table_name" "-table_name" "database_name" "-database_name" "collection_name" "-collection_name" "filter_key" "-filter_key" "column_array_rows" "-column_array_rows" "unload_split" "-unload_split" "stream_size" "-stream_size"
Example: sort=id
Request Body schema: application/json

A request body containing a filter expression. This enables searching for items matching arbitrarily complex conditions. The list of attributes which can be used in filter expressions is available in the x-filterable vendor extension.

Filter Expression Overview

Note: All keywords are case-insensitive

Comparison Operators

Operator Description Example
CONTAINS Substring or membership testing for string and list attributes respectively. field3 CONTAINS 'foobar', field4 CONTAINS TRUE
IN Tests if field is a member of a list literal. List can contain a maximum of 100 values field2 IN ['Goku', 'Vegeta']
GE Tests if a field is greater than or equal to a literal value field1 GE 1.2e-2
GT Tests if a field is greater than a literal value field1 GT 1.2e-2
LE Tests if a field is less than or equal to a literal value field1 LE 9000
LT Tests if a field is less than a literal value field1 LT 9.02
NE Tests if a field is not equal to a literal value field1 NE 42
EQ Tests if a field is equal to a literal value field1 EQ 42

Search Operator

The SEARCH operator filters for items which have any filterable attribute that contains the input string as a substring, comparison is done case-insensitively. This is not restricted to attributes with string values. Specifically SEARCH '12' would match an item with an attribute with an integer value of 123.

Logical Operators

Ordered by precedence.

Operator Description Example
NOT Logical NOT (Right associative) NOT field1 LE 9000
AND Logical AND (Left Associative) field1 GT 9000 AND field2 EQ 'Goku'
OR Logical OR (Left Associative) field1 GT 9000 OR field2 EQ 'Goku'

Grouping

Parenthesis () can be used to override operator precedence.

For example: NOT (field1 LT 1234 AND field2 CONTAINS 'foo')

Literal Values

Literal Description Examples
Nil Represents the absence of a value nil, Nil, nIl, NIL
Boolean true/false boolean true, false, True, False, TRUE, FALSE
Number Signed integer and floating point numbers. Also supports scientific notation. 0, 1, -1, 1.2, 0.35, 1.2e-2, -1.2e+2
String Single or double quoted "foo", "bar", "foo bar", 'foo', 'bar', 'foo bar'
Datetime Formatted according to RFC3339 2018-04-27T18:39:26.397237+00:00
List Comma-separated literals wrapped in square brackets [0], [0, 1], ['foo', "bar"]

Limitations

  • A maximum of 8 unique identifiers may be used inside a filter expression.
filter_expression
string [ 5 .. 2000 ] characters
Responses
200

OK

post/hyperscale-datasets/{hyperscaleDatasetId}/tables-or-files/search
Request samples
application/json

An example of a nested Object comparison testing that at least one repository has a version which is equal to 19.0.0.

{
  • "filter_expression": "repositories CONTAINS {version eq '19.0.0'}"
}
Response samples
application/json
{
  • "items": [
    ],
  • "response_metadata": {
    }
}

Search for Hyperscale Datasets.

SecurityApiKeyAuth
Request
query Parameters
limit
integer [ 1 .. 1000 ]
Default: 100

Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100.

Example: limit=50
cursor
string [ 1 .. 4096 ] characters

Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints.

sort
string or null

The field to sort results by. A property name with a prepended '-' signifies descending order.

Enum: "id" "-id" "hyperscale_instance_id" "-hyperscale_instance_id" "data_type" "-data_type" "connector_id" "-connector_id" "mount_point_id" "-mount_point_id"
Example: sort=id
Request Body schema: application/json

A request body containing a filter expression. This enables searching for items matching arbitrarily complex conditions. The list of attributes which can be used in filter expressions is available in the x-filterable vendor extension.

Filter Expression Overview

Note: All keywords are case-insensitive

Comparison Operators

Operator Description Example
CONTAINS Substring or membership testing for string and list attributes respectively. field3 CONTAINS 'foobar', field4 CONTAINS TRUE
IN Tests if field is a member of a list literal. List can contain a maximum of 100 values field2 IN ['Goku', 'Vegeta']
GE Tests if a field is greater than or equal to a literal value field1 GE 1.2e-2
GT Tests if a field is greater than a literal value field1 GT 1.2e-2
LE Tests if a field is less than or equal to a literal value field1 LE 9000
LT Tests if a field is less than a literal value field1 LT 9.02
NE Tests if a field is not equal to a literal value field1 NE 42
EQ Tests if a field is equal to a literal value field1 EQ 42

Search Operator

The SEARCH operator filters for items which have any filterable attribute that contains the input string as a substring, comparison is done case-insensitively. This is not restricted to attributes with string values. Specifically SEARCH '12' would match an item with an attribute with an integer value of 123.

Logical Operators

Ordered by precedence.

Operator Description Example
NOT Logical NOT (Right associative) NOT field1 LE 9000
AND Logical AND (Left Associative) field1 GT 9000 AND field2 EQ 'Goku'
OR Logical OR (Left Associative) field1 GT 9000 OR field2 EQ 'Goku'

Grouping

Parenthesis () can be used to override operator precedence.

For example: NOT (field1 LT 1234 AND field2 CONTAINS 'foo')

Literal Values

Literal Description Examples
Nil Represents the absence of a value nil, Nil, nIl, NIL
Boolean true/false boolean true, false, True, False, TRUE, FALSE
Number Signed integer and floating point numbers. Also supports scientific notation. 0, 1, -1, 1.2, 0.35, 1.2e-2, -1.2e+2
String Single or double quoted "foo", "bar", "foo bar", 'foo', 'bar', 'foo bar'
Datetime Formatted according to RFC3339 2018-04-27T18:39:26.397237+00:00
List Comma-separated literals wrapped in square brackets [0], [0, 1], ['foo', "bar"]

Limitations

  • A maximum of 8 unique identifiers may be used inside a filter expression.
filter_expression
string [ 5 .. 2000 ] characters
Responses
200

OK

post/hyperscale-datasets/search
Request samples
application/json

An example of a nested Object comparison testing that at least one repository has a version which is equal to 19.0.0.

{
  • "filter_expression": "repositories CONTAINS {version eq '19.0.0'}"
}
Response samples
application/json
{
  • "items": [
    ],
  • "response_metadata": {
    }
}
➔ Next to Reporting