Creates an address table from an address table template.
This request creates an address table associated with a new database, created using parameters defined by the template property, and overwrites any existing address table associated with the same database.
This request creates an address table associated with a new database, created using parameters defined by templatefile.json, and overwrites any existing address table associated with the same database.
This request creates an address table associated with a new database, created using parameters defined by Business Mailing List With Route Information.mwt, and overwrites any existing address table associated with the same database.
{
"$schema":"http://json-schema.org/draft-04/schema#",
"description":"Creates an address table from a template.",
"type":"object",
"oneOf":[
{
"required":[
"addressTable",
"templateName"
]
},
{
"required":[
"addressTable",
"template"
]
}
],
"properties":{
"addressTable":{
"title":"Address Table",
"description":"Address table parameters.",
"type":"object",
"required":[
"classId",
"connection"
],
"properties":{
"classId":{
"title":"Class ID",
"description":"Database class ID.",
"type":"string",
"enum":[
"dbf"
],
"enumValues":[
{
"value":"dbf",
"displayValue":"dBASE/FoxPro",
"description":"dBASE or FoxPro table."
}
]
},
"connection":{
"title":"Connection",
"description":"Database connection parameters.",
"type":"string",
"minLength":1
},
"schema":{
"title":"Schema",
"description":"Table schema.",
"type":"object",
"properties":{
"dbaseLevel":{
"title":"dBASE Level",
"description":"File format version of the dBASE file.",
"default":5,
"enum":[
5,
7
],
"enumValues":[
{
"value":5,
"displayValue":"dBASE IV/dBASE 5/Visual dBASE 5",
"description":"File format compatible with dBASE IV, dBASE 5 and Visual dBASE 5."
},
{
"value":7,
"displayValue":"Visual dBASE 7",
"description":"File format compatible with Visual dBASE 7."
}
]
}
},
"additionalProperties":false
},
"name":{
"title":"Name",
"description":"Address table name.",
"type":"string",
"minLength":1
}
},
"additionalProperties":false
},
"overwrite":{
"title":"Overwrite",
"description":"Indicates whether or not to overwrite an existing address table with the same Class ID and Connection.",
"default":false,
"type":"boolean"
},
"template":{
"title":"Template",
"oneOf":[
{
"description":"Name of the template file; path and extension are optional.",
"type":"string",
"minLength":1
},
{
"description":"Defines a template without requiring a template file.",
"type":"object",
"required":[
"fields"
],
"properties":{
"fields":{
"title":"Fields",
"description":"Definitions of the fields in the table schema.",
"type":"array",
"minItems":1,
"items":{
"type":"object",
"required":[
"fieldName",
"fieldType"
],
"properties":{
"fieldName":{
"title":"Field Name",
"description":"Name of the field in the table schema.",
"type":"string",
"minLength":1
},
"fieldType":{
"title":"Field Type",
"description":"Type of the field in the table schema.",
"type":"string",
"enum":[
"autoInc",
"boolean",
"currency",
"date",
"dateTime",
"float",
"integer",
"memo",
"smallInt",
"string",
"word"
],
"enumValues":[
{
"value":"autoInc",
"displayValue":"Auto-Increment",
"description":"Auto-incrementing 32-bit signed integer value."
},
{
"value":"boolean",
"displayValue":"Boolean",
"description":"Boolean value."
},
{
"value":"currency",
"displayValue":"Currency",
"description":"Currency value."
},
{
"value":"date",
"displayValue":"Date",
"description":"Date value."
},
{
"value":"dateTime",
"displayValue":"Date/Time",
"description":"Date/time (timestamp) value."
},
{
"value":"float",
"displayValue":"Floating Point",
"description":"Floating point numeric value."
},
{
"value":"integer",
"displayValue":"Integer",
"description":"32-bit signed integer value."
},
{
"value":"memo",
"displayValue":"Memo",
"description":"Binary value."
},
{
"value":"smallInt",
"displayValue":"Small Integer",
"description":"16-bit signed integer value."
},
{
"value":"string",
"displayValue":"String",
"description":"String value."
},
{
"value":"word",
"displayValue":"Word",
"description":"16-bit unsigned integer value."
}
]
},
"fieldSize":{
"title":"Field Size",
"description":"Size, or length, of the field in the table schema.",
"type":"integer",
"minimum":0,
"maximum":65535
}
},
"additionalProperties":false
}
},
"indexes":{
"title":"Indexes",
"description":"Defines the indexes.",
"type":"array",
"items":{
"title":"Index",
"description":"Defines an index by its object representation, excluding the `id` property.",
"type":"object",
"required":[
"name",
"expression"
],
"properties":{
"name":{
"title":"Name",
"description":"Name of the index",
"type":"string",
"minLength":1
},
"expression":{
"title":"Expression",
"description":"Database expression.",
"type":"string",
"minLength":1
},
"unique":{
"title":"Unique",
"description":"`true` if the index is unique, `false` if it allows non-unique values.",
"type":"boolean"
},
"descending":{
"title":"Descending",
"description":"`true` if the index is ascending, `false` if the index is descending.",
"type":"boolean"
}
},
"additionalProperties":false
},
"additionalItems":false
},
"layouts":
{
"title":"Layouts",
"description":"Defines the layouts.",
"type":"array",
"items":
{
"description":"Defines a layout.",
"type":"object",
"properties":{
"fields":{
"title":"Fields",
"description":"Defines the fields in the layout.",
"type":"array",
"items":{
"type":"object",
"required":[
"addressGroup",
"dataType"
],
"properties":{
"name":{
"title":"Name",
"description":"Name of the field.",
"type":"string",
"minLength":1
},
"displayName":{
"title":"Display Name",
"description":"Display name of the field.",
"type":"string",
"minLength":1
},
"addressGroup":{
"title":"Address Group",
"description":"Address group of the field.",
"oneOf":[
{
"type":"integer",
"minimum":1,
"maximum":255
},
{
"type":"string",
"minLength":1
}
]
},
"dataType":{
"title":"Data Type",
"description":"Data type of the field.",
"oneOf":[
{
"type":"integer",
"minimum":1,
"maximum":255
},
{
"type":"string",
"minLength":1
}
]
}
},
"additionalProperties":false
}
}
},
"additionalProperties":false
}
},
"selectivities":{
"title":"Selectivities",
"description":"Defines the selecivities.",
"type":"array",
"items":
{
"description":"Defines a selectivity by its object representation, excluding the `id` property.",
"type":"object",
"properties":{
"name":{
"title":"Name",
"description":"Name of the selectivity.",
"type":"string",
"minLength":1
},
"expression":{
"title":"Expression",
"description":"Expression defining the condition that a record must satisfy to be sampled.",
"default":null,
"oneOf":[
{
"type":"string",
"minLength":1
},
{
"type":"null"
}
]
},
"sampleInterval":{
"title":"Interval Sample",
"description":"Interval at which to sample records; if negative, the sample is inverted.",
"default":null,
"oneOf":[
{
"type":"integer"
},
{
"type":"null"
}
]
},
"sampleRandom":{
"title":"Random Sample",
"description":"Probability of a record being sampled at random.",
"default":null,
"oneOf":[
{
"type":"number",
"minimum":0,
"maximum":1
},
{
"type":"null"
}
]
},
"sampleMaximum":{
"title":"Maximum Sample",
"description":"The maximum number of records to be sampled.",
"default":null,
"oneOf":[
{
"type":"integer",
"minimum":0
},
{
"type":"null"
}
]
}
},
"additionalProperties":false
},
"additionalItems":false
}
},
"additionalProperties":false
}
]
},
"templateName":{
"title":"Template Name",
"description":"Name of the binary template file; path and extension are optional.",
"type":"string",
"minLength":1
},
"useIndexes":{
"title":"Use Indexes",
"description":"Indicates whether or not to use the indexes defined in the template.",
"default":false,
"type":"boolean"
}
},
"additionalProperties":false
}
