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
Method | Return Type | Description |
---|---|---|
GET configurationPackage | configurationPackage | Gets a configuration package object. |
DELETE configurationPackage | none | Deletes a configuration package object. |
POST configurationPackage | configurationPackage | Creates a configuration package object. |
PATCH configurationPackage | configurationPackage | Updates 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
Property | Type | Description |
---|---|---|
id | GUID | The unique ID of the item. Non-editable. |
code | string | The code of the configuration package. |
packageName | string | Name of the configuration package. |
languageId | integer | Id of the language. |
productVersion | string | Version of the product. |
processingOrder | integer | Specifies the order of processing. |
excludeConfigurationTables | boolean | Specifies whether to exclude configuration tables. |
numberOfTables | integer | Number of tables. |
numberOfRecords | integer | Number of records. |
numberOfErrors | integer | Number of errors. |
importStatus | string | The status of the import. |
importError | string | The error of an import failure. |
applyStatus | string | Status of configuration package to apply. |
applyError | string | Error 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"
}
See Also
GET configurationPackage
DELETE configurationPackage
POST configurationPackage
PATCH configurationPackage
Commentaires
https://aka.ms/ContentUserFeedback.
Bientôt disponible : Tout au long de 2024, nous allons supprimer progressivement GitHub Issues comme mécanisme de commentaires pour le contenu et le remplacer par un nouveau système de commentaires. Pour plus d’informations, consultezEnvoyer et afficher des commentaires pour