mappingAlgorithm

Add mappings for mapping algorithm

Securityapi_key
Request
path Parameters
algorithmName
required
string

The name of the mapping algorithm.

query Parameters
fileReferenceId
required
string

The reference URI of the uploaded file to be installed. This file should have been uploaded via the /fileUpload endpoint.

passphrase
string

The passphrase that an exported CSV mapping file was encrypted with. This is only needed if adding mappings that were previously exported.

mappingFileType
string

The type of the file provided. If PLAINTEXT is chosen, the file is expected to contain newline delimited outputs. If CSV is chosen, the file is expected to conform to RFC4180. Additionally, 2 columns are expected - input and output. The first row of the CSV must be a header.

Enum: "PLAINTEXT" "CSV"
Responses
200

Success

400

Bad request

403

Forbidden access

404

Not found

post/mapping-algorithms/{algorithmName}/add-mappings
Response samples
application/json
{
  • "asyncTaskId": 1,
  • "operation": "RULESET_REFRESH",
  • "reference": 13,
  • "status": "RUNNING",
  • "cancellable": false
}

Irreversibly delete all saved mappings for mapping algorithm.

Securityapi_key
Request
path Parameters
algorithmName
required
string

The name of the mapping algorithm.

Responses
200

Success

400

Bad request

403

Forbidden access

404

Not found

delete/mapping-algorithms/{algorithmName}/delete-mappings

Export mappings for mapping algorithm

Securityapi_key
Request
path Parameters
algorithmName
required
string

The name of the mapping algorithm.

query Parameters
passphrase
required
string

The passphrase to use to encrypt the mappings in the export file.

Responses
200

Success

400

Bad request

403

Forbidden access

404

Not found

post/mapping-algorithms/{algorithmName}/export-mappings
Response samples
application/json
{
  • "asyncTaskId": 1,
  • "operation": "RULESET_REFRESH",
  • "reference": 13,
  • "status": "RUNNING",
  • "cancellable": false
}

Reset mappings for mapping algorithm.

Securityapi_key
Request
path Parameters
algorithmName
required
string

The name of the mapping algorithm.

Responses
200

Success

400

Bad request

403

Forbidden access

404

Not found

post/mapping-algorithms/{algorithmName}/reset

Get stats for mapping algorithm

Securityapi_key
Request
path Parameters
algorithmName
required
string

The name of the mapping algorithm.

Responses
200

Success

400

Bad request

403

Forbidden access

404

Not found

get/mapping-algorithms/{algorithmName}/stats
Response samples
application/json
{
  • "algorithmName": "TestMapping",
  • "totalMappings": 375,
  • "unusedMappings": 42
}
➔ Next to maskingJob