API calls for creating an inventory

Below are examples of requests you might enter and responses you might receive from the Masking API client. For commands specific to your masking engine, work with your interactive client at http://<myMaskingEngine>/masking/api-client/

HTTPS (SSL/TLS) is recommended, but for explanatory purposes these examples use insecure HTTP

In all code examples, replace <> with the hostname or IP address of your virtual machine.

Fetch table names from database connector

Object references you will need:

The ID of the database connector to fetch tables for

This database connector ID (1, in this example) is included in the PATH for this operation, NOT the payload.

REQUEST

CODE

curl -X GET --header 'Accept: application/json' --header 'Authorization:
7c856e3d-5b20-4261-b5fe-cc2ffcee5ae0'
'http://<myMaskingEngine>/masking/api/database-connectors/1/fetch'

RESPONSE

CODE

[ "ALL_COLUMNS", "DBVERIFICATION_TABLE"]

More info

CODE

http://<myMaskingEngine>/masking/api-client/#!/databaseConnector/fetchTableMetadata

Example

See how to use this in the context of a script here.

Create table metadata

Object references you will need:

The name of the table to create the metadata for
The ruleset ID

REQUEST

CODE

curl -X POST --header 'Content-Type: application/json' --header 'Accept:
application/json' --header 'Authorization:
7c856e3d-5b20-4261-b5fe-cc2ffcee5ae0' -d '{ "tableName": "ALL_COLUMNS",
"rulesetId": 2 }'
'http://<myMaskingEngine>/masking/api/table-metadata'

RESPONSE

CODE

{ "tableMetadataId": 2, "tableName": "ALL_COLUMNS", "rulesetId": 2
}

More info

http://<myMaskingEngine>/masking/api-client/#!/tableMetadata/createTableMetadata

Example

See how to use this in the context of a script here.

Get All column metadata belonging to table metadata

Object references you will need:

The table metadata ID to get the columns for

This table metadata ID (2, in this example) is included in the QUERY STRING for this operation, NOT the payload.

REQUEST

CODE

curl -X GET --header 'Accept: application/json' --header 'Authorization:
7c856e3d-5b20-4261-b5fe-cc2ffcee5ae0'
'http://<myMaskingEngine>/masking/api/column-metadata?table_metadata_id=2'

RESPONSE

CODE

[ { "columnMetadataId": 12, "columnName": "schoolnme",
"tableMetadataId": 2, "columnLength": 50, "isMasked": false,
"isPrimaryKey": false, "isIndex": false, "isForeignKey": false }, … ]

Note that the above response has been truncated due to its length for the purposes of this documentation.

More info

http://<myMaskingEngine>/masking/api-client/#!/columnMetadata/getAllColumnMetadata

Example

See how to use this in the context of a script here.

Update column metadata with algorithm assignment

Object references you will need:

Column metadata ID for the column you wish to update

Tip

This column metadata ID (20, in this example) is included in the PATH for this operation, NOT the payload.

Since the names can vary in the API and UI, you should use the names obtained through the API (these may not align with the UI).
Algorithm name
Domain name

REQUEST

CODE

curl -X PUT --header 'Content-Type: application/json' --header 'Accept:
application/json' --header 'Authorization:
7c856e3d-5b20-4261-b5fe-cc2ffcee5ae0' -d '{ "algorithmName":
"AddrLine2Lookup", "domainName": "ADDRESS_LINE2", "isProfilerWritable": false }'
'http://<myMaskingEngine>/masking/api/column-metadata/20'

RESPONSE

CODE

{ "columnMetadataId": 20, "columnName": "l2_address",
"tableMetadataId": 2, "algorithmName": "AddrLine2Lookup", "domainName":
"ADDRESS_LINE2", "columnLength": 512, "isMasked": true, "isProfilerWritable": false, "isPrimaryKey":
false, "isIndex": false, "isForeignKey": false, "domainAssignedBy": "admin_user"
}

More info

http://<myMaskingEngine>/masking/api-client/#!/columnMetadata/updateColumnMetadata

Example

See how to use this in the context of a script here.