Delete defaultDimensions from entities

11/11/2020
2 minutes to read

Important: Currently all requests to API v2.0 must append $schemaversion=2.0 to the request URL to work properly. This is to uptake the new improved $metadata model avaliable from Business Central 17. An update will be applied shortly to apply the schemaversion automatically to API v2.0. For all other APIs $schemaversion=1.0 will be the default, unless specified in the request URL with $schemaversion=2.0. A solution is being worked on, where the schemaversion will be defined in the extension.

Deletes the default dimensions of the item in Dynamics 365 Business Central.

HTTP request

Replace the URL prefix for Dynamics 365 Business Central depending on environment following the guideline.

DELETE businesscentralPrefix/companies({id})/defaultDimensions({id})
DELETE businesscentralPrefix/companies({id})/items({id})/defaultDimensions({id})
DELETE businesscentralPrefix/companies({id})/customers({id})/defaultDimensions({id})
DELETE businesscentralPrefix/companies({id})/vendors({id})/defaultDimensions({id})
DELETE businesscentralPrefix/companies({id})/employees({id})/defaultDimensions({id})

Request headers

Header	Value
Authorization	Bearer {token}. Required.
If-Match	Required. When this request header is included and the eTag provided does not match the current tag on the specific entity, the entity will not be updated.

Request body

Do not supply a request body for this method.

Response

If successful, this method returns a 204 No Content response code and it deletes the default dimensions for the entity and corresponding dimension.

Example

Request

Here is an example of the request.

DELETE https://{businesscentralPrefix}/api/v2.0/companies({companyId})/items({itemId})/defaultDimensions({itemId},{dimensionId})

Response

No Content.