mainframeDatasetFormat

Get all Mainframe Dataset formats

Securityapi_key
Request
query Parameters
page_number
integer <int64>
Default: 1

The page number for which to get Mainframe Dataset formats. 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
200

Success

403

Forbidden access

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

Create Mainframe Dataset format

WARNING: The generated curl command is incorrect, so please refer to the Masking API guide for instructions on how to upload Mainframe Dataset files through the API

Securityapi_key
Request
Request Body schema: multipart/form-data
required
mainframeDatasetFormat
required
string <binary>

The Mainframe Dataset format to be uploaded. The logical name of the Mainframe Dataset format will be exactly the name of this uploaded Mainframe Dataset file

Responses
201

Success

403

Forbidden access

409

Conflict

post/mainframe-dataset-formats
Response samples
application/json
{
  • "mainframeDatasetFormatId": "3",
  • "mainframeDatasetFormatName": "MainframeDatasetFormat.txt"
}

Get Mainframe Dataset format by ID

Securityapi_key
Request
path Parameters
mainframeDatasetFormatId
required
integer <int32>

The ID of the Mainframe Dataset format to get

Responses
200

Success

400

Bad request

403

Forbidden access

404

Not found

get/mainframe-dataset-formats/{mainframeDatasetFormatId}
Response samples
application/json
{
  • "mainframeDatasetFormatId": "3",
  • "mainframeDatasetFormatName": "MainframeDatasetFormat.txt"
}

Delete Mainframe Dataset format by ID

Securityapi_key
Request
path Parameters
mainframeDatasetFormatId
required
integer <int32>

The ID of the Mainframe Dataset format to delete

Responses
200

Success

400

Bad request

403

Forbidden access

404

Not found

delete/mainframe-dataset-formats/{mainframeDatasetFormatId}
➔ Next to mainframeDatasetMetadata