Defines an alternate key. This value is optional. A legacy data set might not have any alternate key defined but if those alternate keys definitions exist, provide them, as some applications will make use of them.
AlternateKey is a JSON Structure definition published by Amazon Mainframe Modernization, describing 4 properties, of which 2 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.
{
"$schema": "https://json-structure.org/meta/core/v0/#",
"$id": "https://raw.githubusercontent.com/api-evangelist/amazon-mainframe-modernization/refs/heads/main/json-structure/amazon-mainframe-modernization-alternate-key-structure.json",
"name": "AlternateKey",
"description": "Defines an alternate key. This value is optional. A legacy data set might not have any alternate key defined but if those alternate keys definitions exist, provide them, as some applications will make use of them.",
"type": "object",
"properties": {
"allowDuplicates": {
"allOf": [
{
"$ref": "#/components/schemas/Boolean"
},
{
"description": "Indicates whether the alternate key values are supposed to be unique for the given data set."
}
]
},
"length": {
"allOf": [
{
"$ref": "#/components/schemas/Integer"
},
{
"description": "A strictly positive integer value representing the length of the alternate key."
}
]
},
"name": {
"allOf": [
{
"$ref": "#/components/schemas/String"
},
{
"description": "The name of the alternate key."
}
]
},
"offset": {
"allOf": [
{
"$ref": "#/components/schemas/Integer"
},
{
"description": "A positive integer value representing the offset to mark the start of the alternate key part in the record byte array."
}
]
}
},
"required": [
"length",
"offset"
]
}
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.