Description
Creates an address table from an address table package.
Remarks
packageName
is the file name of the address table package. If the extension is not specified, it uses .mpl
. If the path is relative, it is relative to the path to the addresstables/packages/
folder.
addresstable
object
The addresstable
object defines the address table to create.
classId
must be dbf
.
connection
is the dBASE or FoxPro file name associated with the address table. If the extension is not specified, it uses .dbf
. If the path is relative, it is relative to the path to the addresstables/
folder.
name
is the name of the address table.
Example
Request
This request creates an address table associated with a new database created with content defined by MyList.mpl
and overwrites any existing address table associated with the same database.
{
"addressTable": {
"classId": "dbf",
"connection": "MyNewList.dbf",
"name": "My List"
},
"packageName": "MyList.mpl",
"overwrite": true
}
Reply
id
is the ID of the new address table.
Request Schema
{
"$schema":"http://json-schema.org/draft-04/schema#",
"description":"Creates an address table from a package.",
"type":"object",
"required":[
"addressTable",
"packageName"
],
"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
},
"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"
},
"packageName":{
"title":"Package Name",
"description":"Name of the package file; path and extension are optional.",
"type":"string",
"minLength":1
}
},
"additionalProperties":false
}
Reply Schema
{
"$schema":"http://json-schema.org/draft-04/schema#",
"type":"object",
"required":[
"id"
],
"properties":{
"id":{
"title":"ID",
"description":"Identifies the newly created address table.",
"type":"string",
"minLength":1
}
},
"additionalProperties":false
}