mainframeDatasetFieldMetadata

Get all Mainframe Dataset field metadata

Securityapi_key
Request
query Parameters
mainframe_dataset_format_id
integer <int32>

The ID of the Mainframe Dataset format to get all Mainframe Dataset field metadata from

is_masked
boolean

Get only masked Mainframe Dataset field metadata when this is true and only unmasked Mainframe Dataset field metadata when this is false

page_number
integer <int64>
Default: 1

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

Success

400

Bad request

403

Forbidden access

404

Not found

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

Get Mainframe Dataset field metadata by ID

Securityapi_key
Request
path Parameters
mainframeDatasetFieldMetadataId
required
integer <int32>

The ID of the Mainframe Dataset field metadata to get

Responses
200

Success

400

Bad request

403

Forbidden access

404

Not found

get/mainframe-dataset-field-metadata/{mainframeDatasetFieldMetadataId}
Response samples
application/json
{
  • "algorithmName": "FirstNameLookup",
  • "domainName": "FIRST_NAME"
}

Update Mainframe Dataset field metadata by ID

Securityapi_key
Request
path Parameters
mainframeDatasetFieldMetadataId
required
integer <int32>

The ID of the Mainframe Dataset field metadata to update

Request Body schema: application/json
required

The updated Mainframe Dataset field metadata

algorithmName
string <= 500 characters

The name of the algorithm assigned to this Mainframe Dataset field. Mainframe Dataset fields that are unmasked should have this property unset, in addition to having 'domainName' unset. If this field is set, then the 'domainName' must also be specified.

algorithmFieldId
integer <int64>

The ID number of the algorithm field that is associated with this column.

algorithmGroupNo
integer <int64>

The group number of algorithm to identify a set of columns associated with one instance of algorithm.

domainName
string <= 20 characters

The name of the domain assigned to this Mainframe Dataset field. Mainframe Dataset fields that are left unmasked should have this property unset. If the 'domainName' is set, but the 'algorithmName' is unset, then the default algorithm corresponding to the 'domainName' will be used.

dateFormat
string <= 50 characters

The date format of the date assigned to this Mainframe Dataset field.

isProfilerWritable
boolean
Default: false

This field indicates whether or not a Mainframe Dataset field (e.g. algorithm or domain assignment) may be modified during the execution of a profile job when there is a profiling match.

Responses
200

Success

400

Bad request

403

Forbidden access

404

Not found

put/mainframe-dataset-field-metadata/{mainframeDatasetFieldMetadataId}
Request samples
application/json
{
  • "algorithmName": "FirstNameLookup",
  • "domainName": "FIRST_NAME"
}
Response samples
application/json
{
  • "algorithmName": "FirstNameLookup",
  • "domainName": "FIRST_NAME"
}