/SyncBFBean/synchronizeEvents

post

https://rz3.aeb.de/test4ce/rest/SyncBFBean/synchronizeEvents

Poll the next events for the client system.
This method requires the client system to persist the synchronisation state itself and passing a proper value for {@link SyncEventsRequestDTO#syncId}
See {@link #getNotAcknowledgedEvents(SyncEventsRequestDTO)} for a version of the method, were the syncronisation state is kept within the Engine.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Request DTO for synchronizing events.

clientSystemId

string

Id of the sending client system.

e.g. Installation ID of the sending host or ERP system.

Maximum length: 20

clientIdentCode

string

Client identification code.

Maximum length: 10

userName

string

User who initiated the request from the client system.

If the user is found either in the system's user management or in a connected LDAP directory, the request runs under this user's roles.

If the user is not found, the request is only granted the basic 'I_EVERYONE' role. The user name may be used for logging purposes in this case.

Actual authentication is handled separately via the request's headers, so no password is required in the request's data.

resultLanguageIsoCodes

array of strings

2-letter ISO codes of the languages in which texts will be returned.

English ('en') and German ('de') are typically supported by default. Other languages may be supported.

Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.

resultLanguageIsoCodes

syncId

string

Synchronization ID for delta-transmission.

In calls to SyncBFBean/synchronizeEvents:
Pass this field with the value returned in syncId with the last call to SyncBFBean/synchronizeEvents.
For initializing of delta-transmissions pass simply null.

In calls to SyncBFBean/getNotAcknowledgedEvents this field is not used.

length=20

businessObjectType

string

Optional parameter to resctrict the events to be polled to that business object type. May be null to get all subscribed events of all business object types.
Since XNSG 4.0, Nov. FP, 2017
length=20

ageInDays

int32

Only for the initializing of delta-transmissions (if syncId == null)

Start the initializing of delta transmission with with this age. Older events will not be synchronized.

blockSize

int32

For defining the block size. Can be null. If empty the default block size of 100 is used.

returnTotalCount

boolean

If set, the total number of available events is returned in the response.

Note that requiring the total number of events may lead to substantial performance penalties in the service.

Response

200The operation result.