(cloudMigration API) subscriptions resource type

Represents a subscriptions in Business Central.

Note

For information about enabling APIs for Business Central see guideline.

Methods

Method	Return Type	Description
GET subscriptions	subscriptions	Gets a subscriptions object.
DELETE subscriptions	none	Deletes a subscriptions object.
POST subscriptions	subscriptions	Creates a subscriptions object.
PATCH subscriptions	subscriptions	Updates a subscriptions object.

Properties

Property	Type	Description
subscriptionId	string	Unique key for the subscription.
notificationUrl	string	URL to which webhook notifications are sent.
resource	string	URL for the resource being subscribed to. Supports relative and absolute URL.
userId	GUID	The ID of user that has created the subscriptions.
lastModifiedDateTime	datetime	The last datetime the subscriptions was modified. Read-Only.
clientState	string	Client state will be delivered with every notification. This can be used as a secret to verify message or for managing state if needed.
expirationDateTime	datetime	Date and time for when the webhook will expire.
systemCreatedAt	datetime	The datetime the company was created.
systemCreatedBy	GUID	The ID of the user who created the company.
systemModifiedAt	datetime	The last datetime the subscriptions was modified.
systemModifiedBy	GUID	The ID of the user who last modified the company.
estimatedSize	decimal	Read-Only property representing the approximate size of the On-Prem company. The data migrated will be smaller, since the data will be compressed and not all tables will be included.
created	boolean	Specifies if the company was created. It will not reflect if the setup of the company was correct or not. For this you should check the status property. If the company has been created, however status is different.

JSON representation

Here is a JSON representation of the subscriptions resource.

{
    "subscriptionId": "string",
    "notificationUrl": "string",
    "resource": "string",
    "userId": "GUID",
    "lastModifiedDateTime": "datetime",
    "clientState": "string",
    "expirationDateTime": "datetime",
    "systemCreatedAt": "datetime",
    "systemCreatedBy": "GUID",
    "systemModifiedAt": "datetime",
    "systemModifiedBy": "GUID"
}

Related information

GET subscriptions
DELETE subscriptions
POST subscriptions
PATCH subscriptions