extension resource type
Represents an extension 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 extension | extension | Gets a extension object. |
Bound Actions
The extension resource type offers a bound action called install which installs the corresponding extension batch.
This is illustrated in the following example:
POST https://<server address>:<server API port>/<server instance name>/api/v2.0/companies({id})/extensions({id})/Microsoft.NAV.install
The response has no content; the response code is 204.
The extension resource type offers a bound action called uninstall which uninstalls the corresponding extension batch.
This is illustrated in the following example:
POST https://<server address>:<server API port>/<server instance name>/api/v2.0/companies({id})/extensions({id})/Microsoft.NAV.uninstall
The response has no content; the response code is 204.
The extension resource type offers a bound action called uninstallAndDeleteExtensionData which uninstalls the corresponding extension batch and deletes the tables that contain data owned by the extension on uninstall. This action cannot be undone.
This is illustrated in the following example:
POST https://<server address>:<server API port>/<server instance name>/api/v2.0/companies({id})/extensions({id})/Microsoft.NAV.uninstallAndDeleteExtensionData
The response has no content; the response code is 204.
Properties
| Property | Type | Description |
|---|---|---|
| packageId | GUID | The unique ID of the package. Read-Only. |
| id | GUID | The unique ID of the item. Non-editable. |
| displayName | string | Specifies the extension's name. This name will appear on all sales documents for the extension. |
| publisher | string | Specifies the publisher of the extension. |
| versionMajor | integer | Major version of the extension. |
| versionMinor | integer | Minor version of the extension. |
| versionBuild | integer | The version of the build. |
| versionRevision | integer | The version revision of the extension. |
| isInstalled | boolean | Specifies the installation status. |
| publishedAs | string | Specifies how the compiled extension was published. |
JSON representation
Here is a JSON representation of the extension resource.
{
"packageId": "GUID",
"id": "GUID",
"displayName": "string",
"publisher": "string",
"versionMajor": "integer",
"versionMinor": "integer",
"versionBuild": "integer",
"versionRevision": "integer",
"isInstalled": "boolean",
"publishedAs": "string"
}