mainframeDatasetMetadata

Get all Mainframe Dataset metadata

Securityapi_key
Request
query Parameters
ruleset_id
integer <int32>

The ID of the ruleset to get all Mainframe Dataset metadata from

page_number
integer <int64>
Default: 1

The page number for which to get Mainframe Dataset metadata. 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-metadata
Response samples
application/json
{
  • "_pageInfo": {
    },
  • "responseList": [
    ]
}

Create Mainframe Dataset metadata

Securityapi_key
Request
Request Body schema: application/json
required

The Mainframe Dataset metadata to create

fileName
required
string <= 255 characters

The name of the Mainframe Dataset metadata. This name must match the name of a file in the ruleset it is created on. This name must be unique for the given ruleset; in other words, the same file cannot be added to a ruleset more than once.

rulesetId
required
integer <int32>

The ID of the ruleset to create the Mainframe Dataset metadata on.

mainframeDatasetFormatId
integer <int32>

The ID of the Mainframe Dataset format corresponding to this Mainframe Dataset metadata. It is used to determine the fields for this file. This field is required.

recordFormat
string
Default: "FIXED_BLOCKED"

The record format type for the mainframe data set. Note that this enum corresponds to the Variable Length checkbox in the UI.

Enum: "FIXED_BLOCKED" "VARIABLE_BLOCKED"
nameIsRegularExpression
boolean
Default: false

Whether or not this file name represents a regular expression.

Responses
default

Successful operation

post/mainframe-dataset-metadata
Request samples
application/json
{
  • "fileName": "file.dat",
  • "rulesetId": 1,
  • "mainframeDatasetFormatId": 2
}
Response samples
application/json
{
  • "fileName": "file.dat",
  • "rulesetId": 1,
  • "mainframeDatasetFormatId": 2
}

Get Mainframe Dataset metadata by ID

Securityapi_key
Request
path Parameters
mainframeDatasetMetadataId
required
integer <int32>

The ID of the Mainframe Dataset metadata to get

Responses
200

Successful operation

400

Invalid mainframeDatasetMetadataId supplied

404

MainframeDatasetMetadata not found

get/mainframe-dataset-metadata/{mainframeDatasetMetadataId}
Response samples
application/json
{
  • "fileName": "file.dat",
  • "rulesetId": 1,
  • "mainframeDatasetFormatId": 2
}

Update Mainframe Dataset metadata by ID

Securityapi_key
Request
path Parameters
mainframeDatasetMetadataId
required
integer <int32>

The ID of the Mainframe Dataset metadata to update

Request Body schema: application/json
required

The updated Mainframe Dataset metadata

fileName
required
string <= 255 characters

The name of the Mainframe Dataset metadata. This name must match the name of a file in the ruleset it is created on. This name must be unique for the given ruleset; in other words, the same file cannot be added to a ruleset more than once.

rulesetId
required
integer <int32>

The ID of the ruleset to create the Mainframe Dataset metadata on.

mainframeDatasetFormatId
integer <int32>

The ID of the Mainframe Dataset format corresponding to this Mainframe Dataset metadata. It is used to determine the fields for this file. This field is required.

recordFormat
string
Default: "FIXED_BLOCKED"

The record format type for the mainframe data set. Note that this enum corresponds to the Variable Length checkbox in the UI.

Enum: "FIXED_BLOCKED" "VARIABLE_BLOCKED"
nameIsRegularExpression
boolean
Default: false

Whether or not this file name represents a regular expression.

Responses
200

Successful operation

400

Invalid mainframeDatasetMetadataId supplied

404

MainframeDatasetMetadata not found

put/mainframe-dataset-metadata/{mainframeDatasetMetadataId}
Request samples
application/json
{
  • "fileName": "file.dat",
  • "rulesetId": 1,
  • "mainframeDatasetFormatId": 2
}
Response samples
application/json
{
  • "fileName": "file.dat",
  • "rulesetId": 1,
  • "mainframeDatasetFormatId": 2
}

Delete Mainframe Dataset metadata by ID

Securityapi_key
Request
path Parameters
mainframeDatasetMetadataId
required
integer <int32>

The ID of the Mainframe Dataset metadata to delete

Responses
200

Successful operation

400

Invalid mainframeDatasetMetadataId supplied

404

MainframeDatasetMetadata not found

delete/mainframe-dataset-metadata/{mainframeDatasetMetadataId}
➔ Next to mainframeDatasetRecordType