(automation API) Create configurationPackage
Creates a configuration package in Dynamics 365 Business Central.
Bound Actions
| Actions | Return Type | Description |
|---|---|---|
| Microsoft.NAV.import | none | Imports a configurationPackage. |
| Microsoft.NAV.apply | none | Applies a configurationPackage. |
HTTP requests
Replace the URL prefix for Business Central depending on environment following the guideline.
Insert configurationPackage
POST /microsoft/automation/v2.0/companies({companyId})/configurationPackages
Content-type: application/json
{
"code":"YourPackageCode",
"packageName": "YourPackageName"
}
Response
If successful, this method returns 201 Created response code and a configurationPackage object in the response body.
Request headers
| Header | Value |
|---|---|
| Authorization | Bearer {token}. Required. |
| Content-Type | application/json |
Request body
In the request body, supply a JSON representation of a configurationPackage object.
Import configurationPackage
POST /microsoft/automation/v2.0/companies({companyId})/configurationPackages({packageId})/Microsoft.NAV.import
Apply configurationPackage
POST /microsoft/automation/v2.0/companies({companyId})/configurationPackages({packageId})/Microsoft.NAV.apply
Request headers
| Header | Value |
|---|---|
| Authorization | Bearer {token}. Required. |
Request body
Do not supply a request body for this method.
Response
If successful, this method returns 204 No Content response code.
Example
Request
Here is an example of the request.
POST https://api.businesscentral.dynamics.com/v2.0/{environment name}/api/microsoft/automation/v2.0/companies({companyId})/configurationPackages
Content-type: application/json
{
"code":"YourPackageCode",
"packageName": "YourPackageName"
}
Response
Here is an example of the response.
Note
The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call.
HTTP/1.1 201 Created
Content-type: application/json
{
"id": "b6d25c66-f33d-eb11-846f-0022482037e2",
"code": "YourPackageCode",
"packageName": "YourPackageName",
"languageId": 0,
"productVersion": "",
"processingOrder": 0,
"excludeConfigurationTables": false,
"numberOfTables": 12,
"numberOfRecords": 3,
"numberOfErrors": 3,
"importStatus": "Completed",
"applyStatus": "Completed",
"applyError": "",
"importError": ""
}