configurationPackage resource type

Represents a configuration package in Dynamics 365 Business Central.

Note

For information about enabling APIs for Business Central see Enabling the APIs for Dynamics 365 Business Central.

Methods

MethodReturn TypeDescription
GET configurationPackageconfigurationPackageGets a configuration package object.
DELETE configurationPackagenoneDeletes a configuration package object.
POST configurationPackageconfigurationPackageCreates a configuration package object.
PATCH configurationPackageconfigurationPackageUpdates a configuration package object.

Bound Actions

The configurationPackage resource type offers a bound action called import which imports the corresponding configurationPackage batch. This is illustrated in the following example: POST https://<server address>:<server API port>/<server instance name>/api/microsoft/automation/v2.0/companies({id})/configurationPackages({id})/Microsoft.NAV.import

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

The configurationPackage resource type offers a bound action called apply which applys the corresponding configurationPackage batch. This is illustrated in the following example: POST https://<server address>:<server API port>/<server instance name>/api/microsoft/automation/v2.0/companies({id})/configurationPackages({id})/Microsoft.NAV.apply

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

Properties

PropertyTypeDescription
idGUIDThe unique ID of the item. Non-editable.
codestringThe code of the configuration package.
packageNamestringName of the configuration package.
languageIdintegerId of the language.
productVersionstringVersion of the product.
processingOrderintegerSpecifies the order of processing.
excludeConfigurationTablesbooleanSpecifies whether to exclude configuration tables.
numberOfTablesintegerNumber of tables.
numberOfRecordsintegerNumber of records.
numberOfErrorsintegerNumber of errors.
importStatusstringThe status of the import.
importErrorstringThe error of an import failure.
applyStatusstringStatus of configuration package to apply.
applyErrorstringError to apply.

JSON representation

Here is a JSON representation of the configurationPackage resource.

{
    "id": "GUID",
    "code": "string",
    "packageName": "string",
    "languageId": "integer",
    "productVersion": "string",
    "processingOrder": "integer",
    "excludeConfigurationTables": "boolean",
    "numberOfTables": "integer",
    "numberOfRecords": "integer",
    "numberOfErrors": "integer",
    "importStatus": "string",
    "importError": "string",
    "applyStatus": "string",
    "applyError": "string"
}

GET configurationPackage
DELETE configurationPackage
POST configurationPackage
PATCH configurationPackage