(cloudMigration API) tableMapping resource type

Represents a table mapping in Business Central that can be used to include custom tables or tables that are not included in the cloud migration out of the box. If you provide a table mapping the source table will be copied to the destination table during cloud migration.

Note

For information about enabling APIs for Business Central see guideline.

Methods

Method	Return Type	Description
GET tableMapping	tableMapping	Gets a table mapping object.
DELETE tableMapping	none	Deletes a table mapping object.
POST tableMapping	tableMapping	Creates a table mapping object.
PATCH tableMapping	tableMapping	Updates a table mapping object.

Bound Actions

The tableMapping resource type offers a bound action called deleteAllForExtension which delete all for extensions the corresponding tableMapping batch. This is illustrated in the following example: DELETEALLFOREXTENSION https://<server address>:<server API port>/<server instance name>/api/v1.0/companies({id})/tableMappings({id})/Microsoft.NAV.deleteAllForExtension

The response has no content; the response code is 204.

The tableMapping resource type offers a bound action called restoreDefaults which restore defaultss the corresponding tableMapping batch. This is illustrated in the following example: RESTOREDEFAULTS https://<server address>:<server API port>/<server instance name>/api/v1.0/companies({id})/tableMappings({id})/Microsoft.NAV.restoreDefaults

The response has no content; the response code is 204.

Properties

Property	Type	Description
id	GUID	The unique ID of the table mapping. Non-editable.
tableId	integer	Specifies the destination table ID to be mapped.
tableName	string	Specifies the destination table name.
sourceTableName	string	Specifies the source table name.
extensionName	string	Specifies the extension name that owns the mapped table.
estimatedSize	decimal	Read-Only property representing the approximate size of the On-Prem company. The data migrated will be smaller, since the data will be compressed and not all tables will be included.
created	boolean	Specifies if the company was created. It will not reflect if the setup of the company was correct or not. For this you should check the status property. If the company has been created, however status is different.

JSON representation

Here is a JSON representation of the tableMapping resource.

{
    "id": "GUID",
    "tableId": "integer",
    "tableName": "string",
    "sourceTableName": "string",
    "extensionName": "string"
}

Related information

GET tableMapping
DELETE tableMapping
POST tableMapping
PATCH tableMapping