Sync Policies

post

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

Defines a policy for synchronising data between the primary reference system and customer systems.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

syncPolicyId

string

required

length between 1 and 32

SyncPolicyId is a primary key field in the SyncPolicy table of data type nvarchar with a maximum length of 32. This is a unique identifier field which is used to identify each individual sync policy specified in the SyncPolicy table.

description

string | null

Description: The SyncPolicy table stores the description of up to 128 characters of the data type nvarchar, which is used to describe a specific synchronization policy.

comment

string | null

Miscellaneous notes and information for the entry or record.

queueSyncFrom

date-time

required

The QueueSyncFrom field of data type datetime2 in the SyncPolicy table stores when the queue synchronization process should start from; i.e. when it should begin syncing data from a specific queue. The value of QueueSyncFrom is updated whenever changes are made to the synchronization policy, so that the application knows when to begin processing the queue.

queueSyncTo

date-time

required

The QueueSyncTo field of the SyncPolicy table stores a datetime2 value of the latest synchronization time for a queue. When a synchronization is complete on the queue, this field is updated with the time of the synchronization.

interval

int32

Interval is an int field in the SyncPolicy table that defines an elapsed time in seconds between consecutive synchronisation tasks.

dbSync

boolean

If this box is ticked the entities with this policy will be synchronised at the database level using Elastic Queries. Each entity with this policy will have an external table created with the name 'App_{EntityName}' and it will be possible to query the master table in the app database from the client tenant.

Response

200

Language

URL

Loading…

Response

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