Client Integration Timetables

Defines the execution scheduling to be applied to the integration instance.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
int32

The ClientIntegrationTimetableId is an identity field in the ClientIntegrationTimetable table that stores an integer value. This field serves as a unique identifier for a specific integration timetable set up for a client. Each time a new timetable is created for a client, a new and distinct ClientIntegrationTimetableId will be automatically assigned to it. This allows for efficient and accurate tracking and management of multiple integration timetables for different clients. The database can easily retrieve and reference a specific timetable using its unique ClientIntegrationTimetableId, making it a crucial component in the overall structure of the ClientIntegrationTimetable table.

int32

The ClientIntegrationId field in the ClientIntegrationTimetable table is used to uniquely identify each client's integration activity within the system. It is of the data type int, which stands for integer, meaning it stores whole numbers without decimal points. This field is crucial for organizing and tracking the integration processes of different clients, allowing for efficient management and monitoring of their integration timelines. It serves as a crucial identifier for data retrieval and analysis purposes, ensuring accurate data management and reporting.

string
required
length between 1 and 64

The CalendarTypeId field in the ClientIntegrationTimetable table is a string data type that can hold up to 64 characters. This field is used to specify the type of calendar that is being referenced in the integration timetable for the client. It allows for easy organization and identification of calendars and ensures seamless integration between different systems and platforms. The values in this field could include options such as Gregorian, Lunar, Fiscal, etc. This field is crucial in maintaining accurate and efficient scheduling for clients.

string
required

The time after which the timetable will not operate.

string
required

The Start field in the ClientIntegrationTimetable table represents the designated time at which the data integration process begins for a specific client. This field is of the data type time and allows for accurate tracking and synchronization of data between the client's systems and the integrated system. By setting a start time, the integration process can be initiated at a specific point, ensuring timely and efficient data exchange. This field is critical for maintaining the smooth operation and successful integration of data for clients, making it a vital component of the ClientIntegrationTimetable table.

string
required

The Frequency field in the ClientIntegrationTimetable table stores data related to time intervals for the integration of clients into a system. It is used to track the time period at which clients are integrated, providing important information for effective scheduling and planning. This field includes data in the form of time, such as hours, minutes, and seconds, and can be customized to suit the specific needs of the system. The Frequency field allows for accurate tracking and monitoring of client integration, ensuring efficient and timely processes.

string | null

Miscellaneous notes and information for the entry or record.

string
required
length between 1 and 128

The Name field in the ClientIntegrationTimetable table is a data type of nvarchar with a maximum length of 128 characters. This field is designed to store the name or title of a client's integration timetable. The nvarchar data type allows for the storage of both alphanumeric and special characters, making it suitable for a variety of name types. With a maximum length of 128, this field enables efficient and concise storage of integrated timetable names without taking up excessive space in the table. This field will help identify and organize client integration timetables, making it an essential component of the ClientIntegrationTimetable table.

string
required
length between 1 and 64

The TimeZoneId field in the ClientIntegrationTimetable table is of data type nvarchar, with a maximum length of 64 characters. This field is designed to store the identifier for the time zone applicable to the client, allowing for accurate scheduling and integration of time-sensitive data. The TimeZoneId enables the system to account for regional time differences, daylight saving adjustments, and ensures that timestamps are correctly interpreted and displayed according to the client’s local time.

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

Generated from available request content types

Response
200

OK

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here!