API - Ext Sys Sync Rec.
Represents a list of External System Sync Records in Business Central.
A filter on systemCode must be set. The number of entries returned is configured on the External System, in the field Synchronization Count.
It's recommended that you do these calls in a loop. The first call should be done without a filter on fetchId and the following calls should be done with a filter on fetchId returned from the previous call. Loop until no more entries are returned.
When a fetchId is supplied, all sync records with that fetchId will be archived and new sync records is returned.
If you omit the fetchId in the subsequent calls, the same records will be returned but with a new fetchId.
Object Definition
| Object Type | Page |
| Object ID | 70314184 |
| Object Name | QWESR API - Ext Sys Sync Rec. |
| Source Table | QWESR EXT Sync Record |
| Read-only | Yes |
API Definition
| APIPublisher | smartApps |
| APIGroup | spider |
| APIVersion | v1.0 |
| EntitySetName | externalSystemSyncRecords |
| EntityName | externalSystemSyncRecord |
Example
Read
Get a list of External System Sync Records. All returned records will be marked with a new fetchId.
GET businesscentralPrefix/companies({id})/externalSystemSyncRecords?$filter=systemCode eq '{System Code}'&$schemaversion=2.0
Get a list of External System Sync Records and archive the records fetched in the previous call. All returned records will be marked with a new fetchId.
GET businesscentralPrefix/companies({id})/externalSystemSyncRecords?$filter=systemCode eq '{System Code} and fetchId eq {Fetch ID}'&$schemaversion=2.0
Controls
| Type | Name | Data Type | Read-only |
|---|---|---|---|
| Field | id | Guid | Yes |
| Field | systemCode | Code[20] | Yes |
| Field | fetchId | Guid | Yes |
| Field | tableNo | Integer | Yes |
| Field | recordSystemId | Guid | Yes |
| Field | changeType | Enum "QWESR Ext. Sys. Change Type" | Yes |
| Field | lastModifiedDateTime | DateTime | Yes |
This documentation is generated from Spider v25.1.232043.0