mainframeDatasetRuleset

Get all Mainframe Dataset rulesets

Securityapi_key
Request
query Parameters
environment_id
integer <int32>

The ID of the environment to get all Mainframe Dataset rulesets from

page_number
integer <int64>
Default: 1

The page number for which to get Mainframe Dataset rulesets. This will default to the first page if excluded

page_size
integer <int64>

The maximum number of objects to return. This will default to the DefaultApiPageSize setting if not provided

Responses
default

Successful operation

get/mainframe-dataset-rulesets
Response samples
application/json
{
  • "_pageInfo": {
    },
  • "responseList": [
    ]
}

Create Mainframe Dataset ruleset

Securityapi_key
Request
Request Body schema: application/json
required

The Mainframe Dataset ruleset to create

rulesetName
required
string <= 255 characters

The name of the ruleset. This must be unique within an environment.

mainframeDatasetConnectorId
required
integer <int32>

The ID of the Mainframe Dataset Connector that this ruleset corresponds to. Note that the ruleset will be created on the same environment as its connector.

Responses
default

Successful operation

post/mainframe-dataset-rulesets
Request samples
application/json
{
  • "rulesetName": "Rule123",
  • "mainframeDatasetConnectorId": 1
}
Response samples
application/json
{
  • "rulesetName": "Rule123",
  • "mainframeDatasetConnectorId": 1
}

Get Mainframe Dataset ruleset by ID

Securityapi_key
Request
path Parameters
mainframeDatasetRulesetId
required
integer <int32>

The ID of the Mainframe Dataset ruleset to get

Responses
200

Successful operation

400

Invalid mainframeDatasetRulesetId supplied

403

Forbidden access

404

MainframeDatasetRuleset not found

get/mainframe-dataset-rulesets/{mainframeDatasetRulesetId}
Response samples
application/json
{
  • "rulesetName": "Rule123",
  • "mainframeDatasetConnectorId": 1
}

Delete Mainframe Dataset ruleset by ID

Securityapi_key
Request
path Parameters
mainframeDatasetRulesetId
required
integer <int32>

The ID of the Mainframe Dataset ruleset to delete

Responses
200

Successful operation

400

Invalid mainframeDatasetRulesetId supplied

403

Forbidden access

404

MainframeDatasetRuleset not found

delete/mainframe-dataset-rulesets/{mainframeDatasetRulesetId}

Update the set of mainframe datasets and their attributes associated with a mainframe dataset ruleset in bulk

Securityapi_key
Request
path Parameters
mainframeDatasetRulesetId
required
integer <int32>

The ID of the mainframe dataset ruleset to update the mainframe dataset for

Request Body schema: application/json
required

The exact list of mainframe datasets to put in the ruleset. Note that existing datasets for this ruleset not in this list will be deleted

required
Array of objects (MainframeDatasetMetadata)
Responses
200

Success

400

Bad request

403

Forbidden access

404

Not found

put/mainframe-dataset-rulesets/{mainframeDatasetRulesetId}/bulk-mainframe-dataset-update
Request samples
application/json
{
  • "mainframeDatasetMetadata": [
    ]
}
Response samples
application/json
{
  • "asyncTaskId": 1,
  • "operation": "RULESET_REFRESH",
  • "reference": 13,
  • "status": "RUNNING",
  • "cancellable": false
}

Copy mainframe dataset ruleset by ID

Securityapi_key
Request
path Parameters
mainframeDatasetRulesetId
required
integer <int32>

The ID of the mainframe dataset ruleset to copy

Request Body schema: application/json
required

The name of the ruleset. This must be unique within an environment.

newRulesetName
required
string <= 255 characters

The name of the ruleset. This must be unique within an environment.

Responses
200

Success

400

Bad request

403

Forbidden access

404

Not found

put/mainframe-dataset-rulesets/{mainframeDatasetRulesetId}/copy
Request samples
application/json
{
  • "newRulesetName": "Rule123"
}
Response samples
application/json
{
  • "rulesetName": "Rule123",
  • "mainframeDatasetConnectorId": 1
}
➔ Next to mappingAlgorithm