DCT-TOOLKIT COMMAND TOPIC Generated on: Tue Oct 21 12:26:59 USEDT 2025 Source: dct-toolkit-help-2025.5.txt ================================================================================ DCT-TOOLKIT COMPLETE COMMAND REFERENCE Generated on: Tue Oct 21 12:26:59 USEDT 2025 ======================================== MAIN HELP (dct-toolkit.exe -h): ======================================== Usage: dct-toolkit[-hV] [COMMAND] -h, --help Show this help message and exit. -V, --version Print version information and exit. Commands: ================================================================================ ================================================================================ TOPIC: Reporting ================================================================================ Commands (34): search_storage_savings_summary_report, get_vdb_inventory_report, search_vdb_inventory_report, get_dsource_usage_report, search_dsource_usage_report, get_dsource_consumption_report, search_dsource_consumption_report, get_storage_capacity_data, search_storage_capacity_data, search_dataset_performance_analytics_summary, get_dataset_performance_analytics, get_masking_execution_metrics_report, search_masking_execution_metrics_report, get_engine_global_object_state_report, search_engine_global_object_state_report, get_data_risk_report, search_data_risk_report, get_audit_logs_summary_report, get_virtualization_storage_summary_report, search_virtualization_storage_summary_report, get_api_usage_report, get_reporting_schedules, create_reporting_schedule, search_reporting_schedules, get_reporting_schedule_by_id, update_reporting_schedule, delete_reporting_schedule, get_reporting_schedule_tags, create_reporting_schedule_tags, delete_reporting_schedule_tag, get_engine_performance_analytics_report, search_engine_performance_analytics_report, search_engine_performance_analytic_trends, get_product_info COMMAND: search_storage_savings_summary_report ======================================== Usage: dct-toolkit search_storage_savings_summary_report[-hVw] [limit=] [cursor=] [sort=] [-cs] [-jh] [[[filter_expression=string]] | [--body=PARAM] | [[dsource_id=string] [dependant_vdbs=integer] [engine_name=string] [unvirtualized_space=integer] [current_timeflows_unvirtualized_space=integer] [virtualized_space=integer] [name=string] [estimated_savings=integer] [estimated_savings_perc=number] [estimated_current_timeflows_savings=integer] [estimated_current_timeflows_savings_perc=number] [--[no-]is_replica]]] [-jp= | -ex=] [-A | -c=[, ...] [-c=[,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. limit= Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 10000. cursor= 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= The field to sort results by. A property name with a prepended '-' signifies descending order. filter_expression=string --body=PARAM 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] (https://datatracker.ietf.org/doc/html/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. dsource_id=string Filter by dsource_id dependant_vdbs=integer Filter by dependant_vdbs engine_name=string Filter by engine_name unvirtualized_space=integer Filter by unvirtualized_space current_timeflows_unvirtualized_space=integer Filter by current_timeflows_unvirtualized_space virtualized_space=integer Filter by virtualized_space name=string Filter by name estimated_savings=integer Filter by estimated_savings estimated_savings_perc=number Filter by estimated_savings_perc estimated_current_timeflows_savings=integer Filter by estimated_current_timeflows_savings estimated_current_timeflows_savings_perc=number Filter by estimated_current_timeflows_savings_perc --[no-]is_replica Filter by is_replica -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: get_vdb_inventory_report ======================================== Usage: dct-toolkit get_vdb_inventory_report[-hVw] [-cs] [-jh] [cursor=] [limit=] [sort=] [-jp= | -ex=] [-A | -c=[,...] [-c= [,...]]... | -js] -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. cursor= 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. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -h, --help Show this help message and exit. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. limit= Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 10000. sort= The field to sort results by. A property name with a prepended '-' signifies descending order. -V, --version Print version information and exit. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. ======================================== COMMAND: search_vdb_inventory_report ======================================== Usage: dct-toolkit search_vdb_inventory_report[-hVw] [limit=] [cursor=] [sort=] [-cs] [-jh] [[[filter_expression=string]] | [--body=PARAM] | [[name=string] [type=string] [parent_name=string] [parent_id=string] [creation_date=string] [last_refreshed_date=string] [parent_timeflow_location=string] [parent_timeflow_timestamp=string] [parent_timeflow_timezone=string] [--[no-]enabled] [status=string] [engine_name=string] [storage_size=string]]] [-jp= | -ex=] [-A | -c=[,...] [-c= [,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. limit= Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 10000. cursor= 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= The field to sort results by. A property name with a prepended '-' signifies descending order. filter_expression=string --body=PARAM 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] (https://datatracker.ietf.org/doc/html/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. name=string Filter by name type=string Filter by type parent_name=string Filter by parent_name parent_id=string Filter by parent_id creation_date=string Filter by creation_date last_refreshed_date=string Filter by last_refreshed_date parent_timeflow_location=string Filter by parent_timeflow_location parent_timeflow_timestamp=string Filter by parent_timeflow_timestamp parent_timeflow_timezone=string Filter by parent_timeflow_timezone --[no-]enabled Filter by enabled status=string Filter by status engine_name=string Filter by engine_name storage_size=string Filter by storage_size -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: get_dsource_usage_report ======================================== Usage: dct-toolkit get_dsource_usage_report[-hVw] [-cs] [-jh] [cursor=] [limit=] [sort=] [-jp= | -ex=] [-A | -c=[,...] [-c= [,...]]... | -js] -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. cursor= 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. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -h, --help Show this help message and exit. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. limit= Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 10000. sort= The field to sort results by. A property name with a prepended '-' signifies descending order. -V, --version Print version information and exit. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. ======================================== COMMAND: search_dsource_usage_report ======================================== Usage: dct-toolkit search_dsource_usage_report[-hVw] [limit=] [cursor=] [sort=] [-cs] [-jh] [[[filter_expression=string]] | [--body=PARAM] | [[name=string] [unvirtualized_space=integer] [actual_space=integer] [dependant_vdbs=integer] [engine_name=string]]] [-jp= | -ex=] [-A | -c=[,...] [-c= [,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. limit= Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 10000. cursor= 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= The field to sort results by. A property name with a prepended '-' signifies descending order. filter_expression=string --body=PARAM 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] (https://datatracker.ietf.org/doc/html/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. name=string Filter by name unvirtualized_space=integer Filter by unvirtualized_space actual_space=integer Filter by actual_space dependant_vdbs=integer Filter by dependant_vdbs engine_name=string Filter by engine_name -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: get_dsource_consumption_report ======================================== Usage: dct-toolkit get_dsource_consumption_report[-hVw] [-cs] [-jh] [cursor=] [limit=] [sort=] [-jp= | -ex=] [-A | -c=[,...] [-c= [,...]]... | -js] -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. cursor= 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. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -h, --help Show this help message and exit. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. limit= Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 10000. sort= The field to sort results by. A property name with a prepended '-' signifies descending order. -V, --version Print version information and exit. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. ======================================== COMMAND: search_dsource_consumption_report ======================================== Usage: dct-toolkit search_dsource_consumption_report[-hVw] [limit=] [cursor=] [sort=] [-cs] [-jh] [[[filter_expression=string]] | [--body=PARAM] | [[name=string] [status=string] [database_type=string] [engine_id=string] [engine_name=string] [last_consumption_date=string] [ingested_size=integer]]] [-jp= | -ex=] [-A | -c=[,...] [-c=[, ...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. limit= Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 10000. cursor= 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= The field to sort results by. A property name with a prepended '-' signifies descending order. filter_expression=string --body=PARAM 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] (https://datatracker.ietf.org/doc/html/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. name=string Filter by name status=string Filter by status database_type=string Filter by database_type engine_id=string Filter by engine_id engine_name=string Filter by engine_name last_consumption_date=string Filter by last_consumption_date ingested_size=integer Filter by ingested_size -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: get_storage_capacity_data ======================================== Usage: dct-toolkit get_storage_capacity_data[-hVw] [-cs] [-jh] [cursor=] [engine_id=] [limit=] [sort=] [-jp= | -ex=] [-A | -c=[, ...] [-c=[,...]]... | -js] -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. cursor= 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. engine_id= ID of a registered engine. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -h, --help Show this help message and exit. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. limit= Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. sort= The field to sort results by. A property name with a prepended '-' signifies descending order. -V, --version Print version information and exit. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. ======================================== COMMAND: search_storage_capacity_data ======================================== Usage: dct-toolkit search_storage_capacity_data[-hVw] [engine_id=] [limit=] [cursor=] [sort=] [-cs] [-jh] [[[filter_expression=string]] | [--body=PARAM] | [[dataset_id=string] [captured_timestamp=string] [dataset_type=string] [dataset_name=string] [--[no-]is_replica] [total_size=integer] [base_size=integer] [snapshot_size=integer] [logs_size=integer] [unvirtualized_size=integer] [current_timeflow_unvirtualized_size=integer] [timeflow_unvirtualized_size=integer] [descendant_size=integer] [policy_size=integer] [manual_size=integer] [unowned_snapshot_size=integer] [ingested_size=integer] [tags[=array [object]...]]...]] [-jp= | -ex=] [-A | -c= [,...] [-c=[,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. engine_id= ID of a registered engine. limit= Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. cursor= 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= The field to sort results by. A property name with a prepended '-' signifies descending order. filter_expression=string --body=PARAM 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] (https://datatracker.ietf.org/doc/html/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. dataset_id=string Filter by dataset_id captured_timestamp=string Filter by captured_timestamp dataset_type=string Filter by dataset_type dataset_name=string Filter by dataset_name --[no-]is_replica Filter by is_replica total_size=integer Filter by total_size base_size=integer Filter by base_size snapshot_size=integer Filter by snapshot_size logs_size=integer Filter by logs_size unvirtualized_size=integer Filter by unvirtualized_size current_timeflow_unvirtualized_size=integer Filter by current_timeflow_unvirtualized_size timeflow_unvirtualized_size=integer Filter by timeflow_unvirtualized_size descendant_size=integer Filter by descendant_size policy_size=integer Filter by policy_size manual_size=integer Filter by manual_size unowned_snapshot_size=integer Filter by unowned_snapshot_size ingested_size=integer Filter by ingested_size tags[=array[object]...] Filter by tags -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: search_dataset_performance_analytics_summary ======================================== Usage: dct-toolkit search_dataset_performance_analytics_summary[-hVw] engine_id= [limit=] [cursor=] [sort=] [-cs] [-jh] [[[filter_expression=string]] | [--body=PARAM] | [[dataset_id=string] [dataset_name=string] [dataset_type=string] [--[no-] is_replica] [environment_id=string] [environment_name=string] [average_throughput_of_1_h=number] [average_throughput_of_6_h=number] [average_throughput_of_24_h=number] [current_throughput_of_1_h=number] [current_throughput_of_6_h=number] [current_throughput_of_24_h=number] [percentile=number] [tags[=array[object]...]]...]] [-jp= | -ex=] [-A | -c=[,...] [-c= [,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. engine_id= ID of a registered engine. limit= Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. cursor= 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= The field to sort results by. A property name with a prepended '-' signifies descending order. filter_expression=string --body=PARAM 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] (https://datatracker.ietf.org/doc/html/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. dataset_id=string Filter by dataset_id dataset_name=string Filter by dataset_name dataset_type=string Filter by dataset_type --[no-]is_replica Filter by is_replica environment_id=string Filter by environment_id environment_name=string Filter by environment_name average_throughput_of_1_h=number Filter by average_throughput_of_1_h average_throughput_of_6_h=number Filter by average_throughput_of_6_h average_throughput_of_24_h=number Filter by average_throughput_of_24_h current_throughput_of_1_h=number Filter by current_throughput_of_1_h current_throughput_of_6_h=number Filter by current_throughput_of_6_h current_throughput_of_24_h=number Filter by current_throughput_of_24_h percentile=number Filter by percentile tags[=array[object]...] Filter by tags -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: get_dataset_performance_analytics ======================================== Usage: dct-toolkit get_dataset_performance_analytics[-hVw] [-cs] [-jh] ([interval=integer start=string dataset_ids=array[,array...] [dataset_ids=array[,array...]]... end=string] | [--body=PARAM]) [-jp= | -ex=] [-A | -c=[, ...] [-c=[,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. interval=integer Desired time interval in timestamp format. start=string Start time in UTC from which to fetch analytics data. dataset_ids=array[,array...] List of dataset ids for which dataset performance analytics should be fetched. end=string End time in UTC up to which analytics data will be fetched. --body=PARAM JSON request body payload -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: get_masking_execution_metrics_report ======================================== Usage: dct-toolkit get_masking_execution_metrics_report[-hVw] [-cs] [-jh] [cursor=] [limit=] [sort=] [-jp= | -ex=] [-A | -c=[,...] [-c= [,...]]... | -js] -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. cursor= 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. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -h, --help Show this help message and exit. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. limit= Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 10000. sort= The field to sort results by. A property name with a prepended '-' signifies a descending order. -V, --version Print version information and exit. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. ======================================== COMMAND: search_masking_execution_metrics_report ======================================== Usage: dct-toolkit search_masking_execution_metrics_report[-hVw] [limit=] [cursor=] [sort=] [-cs] [-jh] [[[filter_expression=string]] | [--body=PARAM] | [[id=string] [masking_job_name=string] [masking_job_type=string] [connector_type=string] [--[no-]dct_managed] [ruleset_name=string] [rows_masked=integer] [rows_total=integer] [bytes_masked=integer] [bytes_total=integer] [duration=integer] [tables_files_count=integer] [masked_tables_files_count=integer] [columns_fields_count=integer] [masked_columns_fields_count=integer]]] [-jp= | -ex=] [-A | -c=[,...] [-c=[, ...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. limit= Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 10000. cursor= 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= The field to sort results by. A property name with a prepended '-' signifies a descending order. filter_expression=string --body=PARAM 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] (https://datatracker.ietf.org/doc/html/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. id=string Filter by id masking_job_name=string Filter by masking_job_name masking_job_type=string Filter by masking_job_type connector_type=string Filter by connector_type --[no-]dct_managed Filter by dct_managed ruleset_name=string Filter by ruleset_name rows_masked=integer Filter by rows_masked rows_total=integer Filter by rows_total bytes_masked=integer Filter by bytes_masked bytes_total=integer Filter by bytes_total duration=integer Filter by duration tables_files_count=integer Filter by tables_files_count masked_tables_files_count=integer Filter by masked_tables_files_count columns_fields_count=integer Filter by columns_fields_count masked_columns_fields_count=integer Filter by masked_columns_fields_count -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: get_engine_global_object_state_report ======================================== Usage: dct-toolkit get_engine_global_object_state_report[-hVw] [-cs] [-jh] [cursor=] [limit=] [sort=] [-jp= | -ex=] [-A | -c=[,...] [-c= [,...]]... | -js] -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. cursor= 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. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -h, --help Show this help message and exit. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. limit= Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 10000. sort= The field to sort results by. A property name with a prepended '-' signifies descending order. -V, --version Print version information and exit. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. ======================================== COMMAND: search_engine_global_object_state_report ======================================== Usage: dct-toolkit search_engine_global_object_state_report[-hVw] [limit=] [cursor=] [sort=] [-cs] [-jh] [[[filter_expression=string]] | [--body=PARAM] | [[engine_id=string] [engine_name=string] [jobs_count=integer] [connectors_count=integer] [rulesets_count=integer] [global_object_revision_hash=string]]] [-jp= | -ex=] [-A | -c=[, ...] [-c=[,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. limit= Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 10000. cursor= 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= The field to sort results by. A property name with a prepended '-' signifies descending order. filter_expression=string --body=PARAM 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] (https://datatracker.ietf.org/doc/html/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. engine_id=string Filter by engine_id engine_name=string Filter by engine_name jobs_count=integer Filter by jobs_count connectors_count=integer Filter by connectors_count rulesets_count=integer Filter by rulesets_count global_object_revision_hash=string Filter by global_object_revision_hash -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: get_data_risk_report ======================================== Usage: dct-toolkit get_data_risk_report[-hVw] [-cs] [-jh] [cursor=] [limit=] [sort=] [-jp= | -ex=] [-A | -c=[,...] [-c=[, ...]]... | -js] -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. cursor= 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. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -h, --help Show this help message and exit. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. limit= Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 10000. sort= The field to sort results by. A property name with a prepended '-' signifies descending order. -V, --version Print version information and exit. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. ======================================== COMMAND: search_data_risk_report ======================================== Usage: dct-toolkit search_data_risk_report[-hVw] [limit=] [cursor=] [sort=] [-cs] [-jh] [[[filter_expression=string]] | [--body=PARAM] | [[connector_id=string] [engine_connector_id=integer] [connector_name=string] [connector_type=string] [last_profiled_date=string] [last_masked_date=string] [--[no-]dct_managed] [engine_id=string] [engine_name=string] [--[no-]is_profiled] [--[no-]is_sensitive_data] [-- [no-]is_masked] [--[no-]is_at_risk] [data_elements_total=integer] [data_elements_not_sensitive=integer] [data_elements_sensitive_masked=integer] [data_elements_sensitive_unmasked=integer] [records_total=integer] [records_not_sensitive=integer] [records_sensitive_masked=integer] [records_sensitive_unmasked=integer] [tags[=array[object]...]]...]] [-jp= | -ex=] [-A | -c=[, ...] [-c=[,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. limit= Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 10000. cursor= 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= The field to sort results by. A property name with a prepended '-' signifies descending order. filter_expression=string --body=PARAM 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] (https://datatracker.ietf.org/doc/html/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. connector_id=string Filter by connector_id engine_connector_id=integer Filter by engine_connector_id connector_name=string Filter by connector_name connector_type=string Filter by connector_type last_profiled_date=string Filter by last_profiled_date last_masked_date=string Filter by last_masked_date --[no-]dct_managed Filter by dct_managed engine_id=string Filter by engine_id engine_name=string Filter by engine_name --[no-]is_profiled Filter by is_profiled --[no-]is_sensitive_data Filter by is_sensitive_data --[no-]is_masked Filter by is_masked --[no-]is_at_risk Filter by is_at_risk data_elements_total=integer Filter by data_elements_total data_elements_not_sensitive=integer Filter by data_elements_not_sensitive data_elements_sensitive_masked=integer Filter by data_elements_sensitive_masked data_elements_sensitive_unmasked=integer Filter by data_elements_sensitive_unmasked records_total=integer Filter by records_total records_not_sensitive=integer Filter by records_not_sensitive records_sensitive_masked=integer Filter by records_sensitive_masked records_sensitive_unmasked=integer Filter by records_sensitive_unmasked tags[=array[object]...] Filter by tags -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: get_audit_logs_summary_report ======================================== Usage: dct-toolkit get_audit_logs_summary_report[-hVw] [-cs] [-jh] [cursor=] [limit=] [sort=] [-jp= | -ex=] [-A | -c=[,...] [-c= [,...]]... | -js] -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. cursor= 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. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -h, --help Show this help message and exit. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. limit= Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 10000. sort= The field to sort results by. A property name with a prepended '-' signifies descending order. -V, --version Print version information and exit. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. ======================================== COMMAND: get_virtualization_storage_summary_report ======================================== Usage: dct-toolkit get_virtualization_storage_summary_report[-hVw] [-cs] [-jh] [cursor=] [limit=] [sort=] [-jp= | -ex=] [-A | -c=[,...] [-c= [,...]]... | -js] -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. cursor= 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. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -h, --help Show this help message and exit. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. limit= Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 10000. sort= The field to sort results by. A property name with a prepended '-' signifies descending order. -V, --version Print version information and exit. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. ======================================== COMMAND: search_virtualization_storage_summary_report ======================================== Usage: dct-toolkit search_virtualization_storage_summary_report[-hVw] [limit=] [cursor=] [sort=] [-cs] [-jh] [[[filter_expression=string]] | [--body=PARAM] | [[engine_id=string] [engine_name=string] [engine_hostname=string] [total_capacity=integer] [free_storage=integer] [used_storage=integer] [used_percentage=number] [dsource_count=integer] [vdb_count=integer] [total_object_count=integer] [reserved_storage=integer] [dsource_used_storage=integer] [vdb_used_storage=integer]]] [-jp= | -ex=] [-A | -c=[,...] [-c=[, ...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. limit= Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 10000. cursor= 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= The field to sort results by. A property name with a prepended '-' signifies descending order. filter_expression=string --body=PARAM 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] (https://datatracker.ietf.org/doc/html/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. engine_id=string Filter by engine_id engine_name=string Filter by engine_name engine_hostname=string Filter by engine_hostname total_capacity=integer Filter by total_capacity free_storage=integer Filter by free_storage used_storage=integer Filter by used_storage used_percentage=number Filter by used_percentage dsource_count=integer Filter by dsource_count vdb_count=integer Filter by vdb_count total_object_count=integer Filter by total_object_count reserved_storage=integer Filter by reserved_storage dsource_used_storage=integer Filter by dsource_used_storage vdb_used_storage=integer Filter by vdb_used_storage -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: get_api_usage_report ======================================== Usage: dct-toolkit get_api_usage_report[-hVw] [-cs] [-jh] [api_metric_kind=] [client_name=] [dct_version=] [end_date=] [group_by=] [start_date=] [user_agent=] [-jp= | -ex=] [-A | -c=[,...] [-c=[, ...]]... | -js] -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. api_metric_kind= Restrict the list to API usage metric of the given kind -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. client_name= The Client names to be included in the report. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. dct_version= The DCT versions to be included in the report. end_date= Report end date/time. Defaults to current time. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. group_by= The field to group results by. -h, --help Show this help message and exit. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. start_date= Report start date/time. Defaults to first API request. user_agent= The UserAgent names to be included in the report. -V, --version Print version information and exit. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. ======================================== COMMAND: get_reporting_schedules ======================================== Usage: dct-toolkit get_reporting_schedules[-hVw] [-cs] [-jh] [cursor=] [limit=] [sort=] [-jp= | -ex=] [-A | -c=[,...] [-c=[, ...]]... | -js] -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. cursor= 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. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -h, --help Show this help message and exit. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. limit= Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. sort= The field to sort results by. A property name with a prepended '-' signifies descending order. -V, --version Print version information and exit. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. ======================================== COMMAND: create_reporting_schedule ======================================== Usage: dct-toolkit create_reporting_schedule[-hVw] [-cs] [-jh] ([--[no-] enabled message=string report_type=string file_format=string recipients=array[,array...] [recipients=array[,array...]]... cron_expression=string [time_zone=string] [sort_column=string] [row_count=integer] [--[no-]make_current_account_owner]] | [--body=PARAM]) [-jp= | -ex=] [-A | -c=[, ...] [-c=[,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. --[no-]enabled message=string report_type=string Values: [VIRTUALIZATION_STORAGE_SUMMARY, ENGINE_PERFORMANCE_ANALYTIC, VDB_INVENTORY_DATA, DSOURCE_USAGE_DATA, DSOURCE_CONSUMPTION_DATA, MASKING_EXECUTION_METRICS, AUDIT_LOGS_SUMMARY, STORAGE_SAVINGS_SUMMARY, DATA_RISK_SUMMARY] file_format=string Values: [CSV] recipients=array[,array...] cron_expression=string Standard cron expressions are supported e.g. 0 15 10 L * ? - Schedule at 10:15 AM on the last day of every month, 0 0 2 ? * Mon-Fri - Schedule at 2:00 AM every Monday, Tuesday, Wednesday, Thursday and Friday. For more details kindly refer- "http://www.quartz-scheduler. org/documentation/" time_zone=string Timezones are specified according to the Olson tzinfo database - "https://en.wikipedia. org/wiki/List_of_tz_database_time_zones". sort_column=string Values: [engine_id, engine_name, engine_hostname, total_capacity, free_storage, used_storage, used_percentage, dsource_count, vdb_count, total_object_count, name, unvirtualized_space, actual_space, dependant_vdbs, type, version, parent_id, parent_name, creation_date, parent_timeflow_location, parent_timeflow_timestamp, parent_timeflow_timezone, enabled, status, connector_id, connector_name, connector_type, last_profiled_date, last_masked_date, is_profiled, is_sensitive_data, is_masked, is_at_risk, data_elements_total, data_elements_not_sensitive, data_elements_sensitive_masked, data_elements_sensitive_unmasked, records_total, records_not_sensitive, records_sensitive_masked, records_sensitive_unmasked, -engine_id, -engine_name, -engine_hostname, -total_capacity, -free_storage, -used_storage, -used_percentage, -dsource_count, -vdb_count, -total_object_count, -unvirtualized_space, -actual_space, -dependant_vdbs, -name, -type, -version, -parent_id, -parent_name, -creation_date, -parent_timeflow_location, -parent_timeflow_timestamp, -parent_timeflow_timezone, -enabled, -status, -connector_id, -connector_name, -connector_type, -last_profiled_date, -last_masked_date, -is_profiled, -is_sensitive_data, -is_masked, -is_at_risk, -data_elements_total, -data_elements_not_sensitive, -data_elements_sensitive_masked, -data_elements_sensitive_unmasked, -records_total, -records_not_sensitive, -records_sensitive_masked, -records_sensitive_unmasked] row_count=integer --[no-]make_current_account_owner Whether the account creating this reporting schedule must be configured as owner of the reporting schedule. --body=PARAM The parameters to create a reporting schedule. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: search_reporting_schedules ======================================== Usage: dct-toolkit search_reporting_schedules[-hVw] [limit=] [cursor=] [sort=] [-cs] [-jh] [[[filter_expression=string]] | [--body=PARAM] | [[report_id=integer] [report_type=string] [cron_expression=string] [time_zone=string] [message=string] [file_format=string] [--[no-]enabled] [sort_column=string] [tags[=array[object]...]]...]] [-jp= | -ex=] [-A | -c=[,...] [-c= [,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. limit= Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. cursor= 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= The field to sort results by. A property name with a prepended '-' signifies descending order. filter_expression=string --body=PARAM 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] (https://datatracker.ietf.org/doc/html/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. report_id=integer Filter by report_id report_type=string Filter by report_type cron_expression=string Filter by cron_expression time_zone=string Filter by time_zone message=string Filter by message file_format=string Filter by file_format --[no-]enabled Filter by enabled sort_column=string Filter by sort_column tags[=array[object]...] Filter by tags -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: get_reporting_schedule_by_id ======================================== Usage: dct-toolkit get_reporting_schedule_by_id[-hVw] [-cs] [-jh] report_id= [-jp= | -ex=] [-A | -c=[,...] [-c=[, ...]]... | -js] -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -h, --help Show this help message and exit. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. reportId, report_id= The ID of the report schedule. -V, --version Print version information and exit. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. ======================================== COMMAND: update_reporting_schedule ======================================== Usage: dct-toolkit update_reporting_schedule[-hVw] report_id= [-cs] [-jh] ([--[no-]enabled message=string report_type=string file_format=string recipients=array[,array...] [recipients=array[, array...]]... cron_expression=string [time_zone=string] [tags [=array...]]... [sort_column=string] [row_count=integer]] | [--body=PARAM]) [-jp= | -ex=] [-A | -c=[, ...] [-c=[,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. reportId, report_id= The ID of the report schedule. --[no-]enabled message=string report_type=string Values: [VIRTUALIZATION_STORAGE_SUMMARY, ENGINE_PERFORMANCE_ANALYTIC, VDB_INVENTORY_DATA, DSOURCE_USAGE_DATA, DSOURCE_CONSUMPTION_DATA, MASKING_EXECUTION_METRICS, AUDIT_LOGS_SUMMARY, STORAGE_SAVINGS_SUMMARY, DATA_RISK_SUMMARY] file_format=string Values: [CSV] recipients=array[,array...] cron_expression=string Standard cron expressions are supported e.g. 0 15 10 L * ? - Schedule at 10:15 AM on the last day of every month, 0 0 2 ? * Mon-Fri - Schedule at 2:00 AM every Monday, Tuesday, Wednesday, Thursday and Friday. For more details kindly refer- "http://www.quartz-scheduler. org/documentation/" time_zone=string Timezones are specified according to the Olson tzinfo database - "https://en.wikipedia. org/wiki/List_of_tz_database_time_zones". tags[=array...] sort_column=string Values: [engine_id, engine_name, engine_hostname, total_capacity, free_storage, used_storage, used_percentage, dsource_count, vdb_count, total_object_count, name, unvirtualized_space, actual_space, dependant_vdbs, type, version, parent_id, parent_name, creation_date, parent_timeflow_location, parent_timeflow_timestamp, parent_timeflow_timezone, enabled, status, connector_id, connector_name, connector_type, last_profiled_date, last_masked_date, is_profiled, is_sensitive_data, is_masked, is_at_risk, data_elements_total, data_elements_not_sensitive, data_elements_sensitive_masked, data_elements_sensitive_unmasked, records_total, records_not_sensitive, records_sensitive_masked, records_sensitive_unmasked, -engine_id, -engine_name, -engine_hostname, -total_capacity, -free_storage, -used_storage, -used_percentage, -dsource_count, -vdb_count, -total_object_count, -unvirtualized_space, -actual_space, -dependant_vdbs, -name, -type, -version, -parent_id, -parent_name, -creation_date, -parent_timeflow_location, -parent_timeflow_timestamp, -parent_timeflow_timezone, -enabled, -status, -connector_id, -connector_name, -connector_type, -last_profiled_date, -last_masked_date, -is_profiled, -is_sensitive_data, -is_masked, -is_at_risk, -data_elements_total, -data_elements_not_sensitive, -data_elements_sensitive_masked, -data_elements_sensitive_unmasked, -records_total, -records_not_sensitive, -records_sensitive_masked, -records_sensitive_unmasked] row_count=integer --body=PARAM JSON request body payload -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: delete_reporting_schedule ======================================== Usage: dct-toolkit delete_reporting_schedule[-hVw] [-cs] [-jh] report_id= [-jp= | -ex=] [-A | -c=[,...] [-c=[, ...]]... | -js] -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -h, --help Show this help message and exit. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. reportId, report_id= The ID of the report schedule. -V, --version Print version information and exit. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. ======================================== COMMAND: get_reporting_schedule_tags ======================================== Usage: dct-toolkit get_reporting_schedule_tags[-hVw] [-cs] [-jh] report_id= [-jp= | -ex=] [-A | -c=[,...] [-c=[, ...]]... | -js] -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -h, --help Show this help message and exit. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. reportId, report_id= The ID of the report schedule. -V, --version Print version information and exit. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. ======================================== COMMAND: create_reporting_schedule_tags ======================================== Usage: dct-toolkit create_reporting_schedule_tags[-hVw] report_id= [-cs] [-jh] ([tags[=array...] [tags[=array...]]...] | [--body=PARAM]) [-jp= | -ex=] [-A | -c=[, ...] [-c=[,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. reportId, report_id= The ID of the report schedule. tags[=array...] Array of tags with key value pairs --body=PARAM Tags information for report schedule. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: delete_reporting_schedule_tag ======================================== Usage: dct-toolkit delete_reporting_schedule_tag[-hVw] report_id= [-cs] [-jh] [[[key=string] [value=string] [tags[=array...]]...] | [--body=PARAM]] [-jp= | -ex=] [-A | -c=[, ...] [-c=[,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. reportId, report_id= The ID of the report schedule. key=string Key of the tag value=string Value of the tag tags[=array...] List of tags to be deleted --body=PARAM The parameters to delete tags -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: get_engine_performance_analytics_report ======================================== Usage: dct-toolkit get_engine_performance_analytics_report[-hVw] [-cs] [-jh] [cursor=] [limit=] [sort=] [-jp= | -ex=] [-A | -c=[,...] [-c= [,...]]... | -js] -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. cursor= 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. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -h, --help Show this help message and exit. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. limit= Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 10000. sort= The field to sort results by. A property name with a prepended '-' signifies descending order. -V, --version Print version information and exit. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. ======================================== COMMAND: search_engine_performance_analytics_report ======================================== Usage: dct-toolkit search_engine_performance_analytics_report[-hVw] [limit=] [cursor=] [sort=] [-cs] [-jh] [[[filter_expression=string]] | [--body=PARAM] | [[engine_id=string] [engine_name=string] [engine_type=string] [aggregation_period=integer] [cpu_cores_count=integer] [cpu_utilization=number] [total_memory=integer] [average_disk_latency_read=integer] [average_disk_latency_write=integer] [average_disk_latency_total=integer] [average_disk_throughput_read=integer] [average_disk_throughput_write=integer] [average_disk_throughput_total=integer] [average_disk_iops_read=integer] [average_disk_iops_write=integer] [average_disk_iops_total=integer] [average_nfs_latency_read=integer] [average_nfs_latency_write=integer] [average_nfs_latency_total=integer] [average_nfs_throughput_read=integer] [average_nfs_throughput_write=integer] [average_nfs_throughput_total=integer] [average_nfs_iops_read=integer] [average_nfs_iops_write=integer] [average_nfs_iops_total=integer] [average_iscsi_latency_read=integer] [average_iscsi_latency_write=integer] [average_iscsi_latency_total=integer] [average_iscsi_throughput_read=integer] [average_iscsi_throughput_write=integer] [average_iscsi_throughput_total=integer] [average_iscsi_iops_read=integer] [average_iscsi_iops_write=integer] [average_iscsi_iops_total=integer] [average_network_throughput_transmit=number] [average_network_throughput_receive=number]]] [-jp= | -ex=] [-A | -c=[,...] [-c= [,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. limit= Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 10000. cursor= 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= The field to sort results by. A property name with a prepended '-' signifies descending order. filter_expression=string --body=PARAM 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] (https://datatracker.ietf.org/doc/html/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. engine_id=string Filter by engine_id engine_name=string Filter by engine_name engine_type=string Filter by engine_type aggregation_period=integer Filter by aggregation_period cpu_cores_count=integer Filter by cpu_cores_count cpu_utilization=number Filter by cpu_utilization total_memory=integer Filter by total_memory average_disk_latency_read=integer Filter by average_disk_latency_read average_disk_latency_write=integer Filter by average_disk_latency_write average_disk_latency_total=integer Filter by average_disk_latency_total average_disk_throughput_read=integer Filter by average_disk_throughput_read average_disk_throughput_write=integer Filter by average_disk_throughput_write average_disk_throughput_total=integer Filter by average_disk_throughput_total average_disk_iops_read=integer Filter by average_disk_iops_read average_disk_iops_write=integer Filter by average_disk_iops_write average_disk_iops_total=integer Filter by average_disk_iops_total average_nfs_latency_read=integer Filter by average_nfs_latency_read average_nfs_latency_write=integer Filter by average_nfs_latency_write average_nfs_latency_total=integer Filter by average_nfs_latency_total average_nfs_throughput_read=integer Filter by average_nfs_throughput_read average_nfs_throughput_write=integer Filter by average_nfs_throughput_write average_nfs_throughput_total=integer Filter by average_nfs_throughput_total average_nfs_iops_read=integer Filter by average_nfs_iops_read average_nfs_iops_write=integer Filter by average_nfs_iops_write average_nfs_iops_total=integer Filter by average_nfs_iops_total average_iscsi_latency_read=integer Filter by average_iscsi_latency_read average_iscsi_latency_write=integer Filter by average_iscsi_latency_write average_iscsi_latency_total=integer Filter by average_iscsi_latency_total average_iscsi_throughput_read=integer Filter by average_iscsi_throughput_read average_iscsi_throughput_write=integer Filter by average_iscsi_throughput_write average_iscsi_throughput_total=integer Filter by average_iscsi_throughput_total average_iscsi_iops_read=integer Filter by average_iscsi_iops_read average_iscsi_iops_write=integer Filter by average_iscsi_iops_write average_iscsi_iops_total=integer Filter by average_iscsi_iops_total average_network_throughput_transmit=number Filter by average_network_throughput_transmit average_network_throughput_receive=number Filter by average_network_throughput_receive -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: search_engine_performance_analytic_trends ======================================== Usage: dct-toolkit search_engine_performance_analytic_trends[-hVw] [limit=] [cursor=] [sort=] [-cs] [-jh] [[[filter_expression=string]] | [--body=PARAM] | [[engine_id=string] [trend_type=string] [aggregation_period=integer]]] [-jp= | -ex=] [-A | -c=[,...] [-c= [,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. limit= Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 10000. cursor= 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= The field to sort results by. A property name with a prepended '-' signifies descending order. filter_expression=string --body=PARAM 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] (https://datatracker.ietf.org/doc/html/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. engine_id=string Filter by engine_id trend_type=string Filter by trend_type aggregation_period=integer Filter by aggregation_period -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: get_product_info ======================================== Usage: dct-toolkit get_product_info[-hVw] [-cs] [-jh] [-jp= | -ex=] [-A | -c=[, ...] [-c=[, ...]]... | -js] -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -h, --help Show this help message and exit. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -V, --version Print version information and exit. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. ========================================