Sync Entities

post

https://app.financekey.com/OData/SyncEntities

Stores a collection of entities that are associated to a synchronisation policy. The entities are sequenced in the order in which they should be synchronised.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

syncPolicyId

string | null

SyncPolicyId is an nvarchar field with a maximum length of 32 characters and is used in the SyncEntity table to store the policy identifier associated with a synchronization entity.

entityId

string | null

The SyncEntity table contains a column called EntityId of data type nvarchar with a maximum length of 450. The EntityId column is used to uniquely identify a record within the SyncEntity table. This value is generated either automatically by the database or manually by a user.

sequence

int32

The Sequence field in the SyncEntity table contains an integer value that is used to define the order in which records should be read and processed. It helps organize the data so that it can be easily manipulated, queried, and sorted. The Sequence field is especially useful when records must be processed in a certain order or when a particular order is desirable but not necessary.

comment

string | null

Miscellaneous notes and information for the entry or record.

update

boolean

The Update field of type bit in the SyncEntity table is a flag indicating whether that row has been modified since the last time it was synchronized with a remote data source. A value of 1 indicates that the row has been modified and needs to be synchronized. A value of 0 indicates that the data is unchanged since the last sync.

filter

string | null

The filter that should be applied to items when added to the SyncQueue

Headers

content-type

string

enum

Defaults to application/json;odata.metadata=minimal;odata.streaming=true

Generated from available request content types

Response

200

Language

URL

Loading…

Response

Click Try It! to start a request and see the response here!