addressTableCreatePackage

Description

Creates a package from an address table.

Remarks

addressTable must be one of the following.

• The ID of an address table. The ID of an address table is guaranteed to be unique.
• The name$ prefix plus the name of an address table. The name of an address table is not required to be unique. However, if you use the name$ prefix to reference an address table with a name that is not unique, there is an error. In this case, you must refer to the address table by its ID.
• The file$ prefix plus the name of a JSON file representing an address table, excluding extension. The file name must be lower case and have an extension of .json. The file must be in the addresstables/ folder.

Request Example

This request creates a package from an address table with the file name MyList.mpl, overwriting any existing file.

{
  "addressTable": "7112661645",
  "packageName": "MyList.mpl",
  "overwrite": true
}

Example

Reply

packageName is the fully-qualified file name of the new address table package.

{
  "packageName": "C:\\Integratec\\addresstables\\packages\\MyList.mpl"
}

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":"Resource item identifying the address table.",
      "type":"string",
      "pattern":"(?i)^([0-9]{10}|name\\$.+|file\\$[a-z]+)$"
    },
    "packageName":{
      "title":"Package Name",
      "description":"Name of the package file.",
      "type":"string",
      "minLength":1
    },
    "overwrite":{
      "title":"Overwrite",
      "description":"Indicates whether or not to overwrite an existing package.",
      "default":false,
      "type":"boolean"
    }
  },
  "additionalProperties":false
}

Reply Schema

{
  "$schema":"http://json-schema.org/draft-04/schema#",
  "type":"object",
  "required":[
    "packageName"
  ],
  "properties":{
    "packageName":{
      "title":"Package Name",
      "description":"Fully-qualified name of the package file.",
      "type":"string",
      "minLength":1
    }
  },
  "additionalProperties":false
}