REST API Reference

REST API Reference

Rules

Rules

The rules request lists all policies, masking rules, generation rules, preferred generation rules, and additional rules, in a project.

Resource URL

/tdm/v1/projects/{projectId}/rules

HTTP Request

GET http(s)://
<host>
:
<port>
/api/public/tdm/v1/projects/<project ID>/rules

Request Header

The request header includes the following headers:
Header
Description
accept
Use the following value:
application/json
Authorization
Required. Use the following value:
Basic <user name>

Request Path Parameters

The request includes the following path parameter:
Parameter
Description
projectId
Required. ID of the project that contains the rules.

Sample Request

GET http://<host>:6605/api/public/tdm/v1/projects/5/rules

Sample Response

{ "projPolicies": [ { "id": 0, "version": 0, "name": "MASKINGPROJECT1543326669270 - CI_Entity_Policy", "description": null, "assign_status": "STARTED", "project_object_type": "policy" }, { "id": 0, "version": 0, "name": "MASKINGPROJECT1543326669270 - CI_TestPolicyForUpdateRuleAssignment", "description": null, "assign_status": "STARTED", "project_object_type": "policy" }, { "id": 0, "version": 0, "name": "MASKINGPROJECT1543326669270 - custom_Policy", "description": null, "assign_status": "STARTED", "project_object_type": "policy" } ], "projRules": [ { "id": 73, "version": 0, "name": "CreditCard1543327375165", "description": null, "overideAble": false, "active": true, "type": "prule", "instruction": null, "domains": null, "projects": null, "masking_type": "CREDITCARD", "data_type": "String", "created_by": 2, "creation_date": 1543327375166, "creation_date_str": "11/27/2018 07:32:55 PM", "last_updated_by": 2, "last_updated_date": 1543327375166, "last_updated_date_str": "11/27/2018 07:32:55 PM", "associated_data_domains": null, "masking_mapplet": null, "rule_parameters": null, "rule_ports": null, "associated_rule_port": null, "rule_assignments": null, "rule_assignment_groups": null, "param_map": {}, "rule_type": "STANDARD" }, "prefGenRules": [], "additional_rules": [ { "id": 171, "version": 0, "name": "NumericShuffle1", "description": "Standard", "overideAble": false, "active": true, "type": "rule", "instruction": null, "domains": null, "projects": null, "masking_type": "SHUFFLE", "data_type": "Numeric", "created_by": 2, "creation_date": 1543328205391, "creation_date_str": "11/27/2018 07:46:45 PM", "last_updated_by": 2, "last_updated_date": 1543328205391, "last_updated_date_str": "11/27/2018 07:46:45 PM", "associated_data_domains": null, "masking_mapplet": null, "rule_parameters": null, "rule_ports": null, "associated_rule_port": null, "rule_assignments": null, "rule_assignment_groups": null, "param_map": {}, "rule_type": "STANDARD" }, { "id": 95, "version": 2, "name": "Rul_DOB", "description": null, "overideAble": false, "active": true, "type": "rule", "instruction": null, "domains": null, "projects": null, "masking_type": "RANDOM", "data_type": "Date", "created_by": 2, "creation_date": 1543328201727, "creation_date_str": "11/27/2018 07:46:41 PM", "last_updated_by": 2, "last_updated_date": 1543328344064, "last_updated_date_str": "11/27/2018 07:49:04 PM", "associated_data_domains": null, "masking_mapplet": null, "rule_parameters": null, "rule_ports": null, "associated_rule_port": null, "rule_assignments": null, "rule_assignment_groups": null, "param_map": {}, "rule_type": "STANDARD" }, { "id": 81, "version": 0, "name": "RUL_EXP_MASKING_KEY", "description": null, "overideAble": false, "active": true, "type": "rule", "instruction": null, "domains": null, "projects": null, "masking_type": "KEY", "data_type": "String", "created_by": 2, "creation_date": 1543327567255, "creation_date_str": "11/27/2018 07:36:07 PM", "last_updated_by": 2, "last_updated_date": 1543327567255, "last_updated_date_str": "11/27/2018 07:36:07 PM", "associated_data_domains": null, "masking_mapplet": null, "rule_parameters": null, "rule_ports": null, "associated_rule_port": null, "rule_assignments": null, "rule_assignment_groups": null, "param_map": {}, "rule_type": "STANDARD" }, { "id": 60, "version": 0, "name": "Rul_Rlational_file1543326731964", "description": null, "overideAble": false, "active": true, "type": "rule", "instruction": null, "domains": null, "projects": null, "masking_type": "KEY", "data_type": "String", "created_by": 2, "creation_date": 1543326731995, "creation_date_str": "11/27/2018 07:22:11 PM", "last_updated_by": 2, "last_updated_date": 1543326731995, "last_updated_date_str": "11/27/2018 07:22:11 PM", "associated_data_domains": null, "masking_mapplet": null, "rule_parameters": null, "rule_ports": null, "associated_rule_port": null, "rule_assignments": null, "rule_assignment_groups": null, "param_map": {}, "rule_type": "STANDARD" }, { "id": 76, "version": 0, "name": "RUL_Value_Cascade11543327433270", "description": "For CI Test", "overideAble": false, "active": true, "type": "rule", "instruction": null, "domains": null, "projects": null, "masking_type": "KEY", "data_type": "String", "created_by": 2, "creation_date": 1543327433271, "creation_date_str": "11/27/2018 07:33:53 PM", "last_updated_by": 2, "last_updated_date": 1543327433271, "last_updated_date_str": "11/27/2018 07:33:53 PM", "associated_data_domains": null, "masking_mapplet": null, "rule_parameters": null, "rule_ports": null, "associated_rule_port": null, "rule_assignments": null, "rule_assignment_groups": null, "param_map": {}, "rule_type": "STANDARD" }, { "id": 89, "version": 0, "name": "RUL_Value_Cascade21543327936616", "description": "For CI Test", "overideAble": false, "active": true, "type": "rule", "instruction": null, "domains": null, "projects": null, "masking_type": "KEY", "data_type": "String", "created_by": 2, "creation_date": 1543327936617, "creation_date_str": "11/27/2018 07:42:16 PM", "last_updated_by": 2, "last_updated_date": 1543327936617, "last_updated_date_str": "11/27/2018 07:42:16 PM", "associated_data_domains": null, "masking_mapplet": null, "rule_parameters": null, "rule_ports": null, "associated_rule_port": null, "rule_assignments": null, "rule_assignment_groups": null, "param_map": {}, "rule_type": "STANDARD" }, { "id": 97, "version": 2, "name": "Rul_ZIP", "description": null, "overideAble": false, "active": true, "type": "rule", "instruction": null, "domains": null, "projects": null, "masking_type": "SHUFFLE", "data_type": "String", "created_by": 2, "creation_date": 1543328201900, "creation_date_str": "11/27/2018 07:46:41 PM", "last_updated_by": 2, "last_updated_date": 1543328343898, "last_updated_date_str": "11/27/2018 07:49:03 PM", "associated_data_domains": null, "masking_mapplet": null, "rule_parameters": null, "rule_ports": null, "associated_rule_port": null, "rule_assignments": null, "rule_assignment_groups": null, "param_map": {}, "rule_type": "STANDARD" }, { "id": 90, "version": 0, "name": "SSN1543328058947", "description": null, "overideAble": false, "active": true, "type": "rule", "instruction": null, "domains": null, "projects": null, "masking_type": "SSN", "data_type": "String", "created_by": 2, "creation_date": 1543328058948, "creation_date_str": "11/27/2018 07:44:18 PM", "last_updated_by": 2, "last_updated_date": 1543328058948, "last_updated_date_str": "11/27/2018 07:44:18 PM", "associated_data_domains": null, "masking_mapplet": null, "rule_parameters": null, "rule_ports": null, "associated_rule_port": null, "rule_assignments": null, "rule_assignment_groups": null, "param_map": {}, "rule_type": "STANDARD" }, { "id": 119, "version": 0, "name": "StringCreditCard2", "description": "Standard", "overideAble": true, "active": true, "type": "rule", "instruction": null, "domains": null, "projects": null, "masking_type": "CREDITCARD", "data_type": "String", "created_by": 2, "creation_date": 1543328202678, "creation_date_str": "11/27/2018 07:46:42 PM", "last_updated_by": 2, "last_updated_date": 1543328202678, "last_updated_date_str": "11/27/2018 07:46:42 PM", "associated_data_domains": null, "masking_mapplet": null, "rule_parameters": null, "rule_ports": null, "associated_rule_port": null, "rule_assignments": null, "rule_assignment_groups": null, "param_map": {}, "rule_type": "STANDARD" }, { "id": 134, "version": 0, "name": "StringIPAddress", "description": "Standard", "overideAble": true, "active": true, "type": "rule", "instruction": null, "domains": null, "projects": null, "masking_type": "IPADDRESS", "data_type": "String", "created_by": 2, "creation_date": 1543328203466, "creation_date_str": "11/27/2018 07:46:43 PM", "last_updated_by": 2, "last_updated_date": 1543328203466, "last_updated_date_str": "11/27/2018 07:46:43 PM", "associated_data_domains": null, "masking_mapplet": null, "rule_parameters": null, "rule_ports": null, "associated_rule_port": null, "rule_assignments": null, "rule_assignment_groups": null, "param_map": {}, "rule_type": "STANDARD" }, { "id": 157, "version": 0, "name": "StringKey1", "description": "Standard", "overideAble": true, "active": true, "type": "rule", "instruction": null, "domains": null, "projects": null, "masking_type": "KEY", "data_type": "String", "created_by": 2, "creation_date": 1543328204358, "creation_date_str": "11/27/2018 07:46:44 PM", "last_updated_by": 2, "last_updated_date": 1543328204358, "last_updated_date_str": "11/27/2018 07:46:44 PM", "associated_data_domains": null, "masking_mapplet": null, "rule_parameters": null, "rule_ports": null, "associated_rule_port": null, "rule_assignments": null, "rule_assignment_groups": null, "param_map": {}, "rule_type": "STANDARD" }, { "id": 169, "version": 0, "name": "StringPhone1", "description": "Standard", "overideAble": true, "active": true, "type": "rule", "instruction": null, "domains": null, "projects": null, "masking_type": "PHONE", "data_type": "String", "created_by": 2, "creation_date": 1543328205273, "creation_date_str": "11/27/2018 07:46:45 PM", "last_updated_by": 2, "last_updated_date": 1543328205273, "last_updated_date_str": "11/27/2018 07:46:45 PM", "associated_data_domains": null, "masking_mapplet": null, "rule_parameters": null, "rule_ports": null, "associated_rule_port": null, "rule_assignments": null, "rule_assignment_groups": null, "param_map": {}, "rule_type": "STANDARD" }, { "id": 92, "version": 0, "name": "SubsInvalidSSN1543328060232", "description": null, "overideAble": false, "active": true, "type": "rule", "instruction": null, "domains": null, "projects": null, "masking_type": "SUBSTITUTION", "data_type": "String", "created_by": 2, "creation_date": 1543328060234, "creation_date_str": "11/27/2018 07:44:20 PM", "last_updated_by": 2, "last_updated_date": 1543328060234, "last_updated_date_str": "11/27/2018 07:44:20 PM", "associated_data_domains": null, "masking_mapplet": null, "rule_parameters": null, "rule_ports": null, "associated_rule_port": null, "rule_assignments": null, "rule_assignment_groups": null, "param_map": {}, "rule_type": "STANDARD" } ], "gen_rules": [] }

0 COMMENTS

We’d like to hear from you!