Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Represents a cloud migration company in Business Central.
Note
For information about enabling APIs for Business Central see guideline.
Methods
| Method | Return Type | Description |
|---|---|---|
| GET cloudMigrationCompany | cloudMigrationCompany | Gets a cloud migration company object. |
| PATCH cloudMigrationCompany | cloudMigrationCompany | Updates a cloud migration company object. |
Bound Actions
The cloudMigrationCompany resource type offers two bound actions:
The first bound action is called createCompaniesMarkedForReplication which create companies marked for replications the corresponding cloudMigrationCompany batch.
This is illustrated in the following example:
CREATECOMPANIESMARKEDFORREPLICATION https://<server address>:<server API port>/<server instance name>/api/v1.0/companies({id})/cloudMigrationCompanys({id})/Microsoft.NAV.createCompaniesMarkedForReplication
The response has no content; the response code is 204.
The next bound action is called initializeCompany, which is used to initialize the company after cloud migration. It'll invoke the Codeunit2 Company-Initialize to update missing set up records marked for replications in the corresponding cloudMigrationCompany batch. This is illustrated in the following example: INITIALIZECOMPANY https://<server address>:<server API port>/<server instance name>/api/v1.0/companies({id})/cloudMigrationCompanys({id})/Microsoft.NAV.initializeCompany.
The response has no content; the response code is 204.
Properties
| Property | Type | Description |
|---|---|---|
| id | GUID | The unique ID of the cloud migration company. Non-editable. |
| name | string | Represents the cloud migration company's name. |
| replicate | boolean | This property decides if the company should be selected for cloud migration in the current batch. You can include or exclude the companies. |
| displayName | string | Specifies the cloud migration company's name. This name will appear on all sales documents for the cloud migration company. |
| 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. |
| status | string | Specifies the status of the company. Possible values are: - “ “ – initial status or created. Check the created property - “In Progress” – Company creation is in progress - Error – Company creation has failed - "Missing Permission" – User has no permissions to create a company. |
| 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. |
| companyInitializationStatus | string | Specifies the initialization status of the company. Values are Unknown, "Not Initialized", "Initialization Failed", or Initialized. |
| companyInitializationError | boolean | This property returns an error message in case the company initialization fails. |
JSON representation
Here is a JSON representation of the cloudMigrationCompany resource.
{
"id": "GUID",
"name": "string",
"replicate": "boolean",
"displayName": "string",
"estimatedSize": "decimal",
"status": "string",
"created": "boolean"
}