Customer Integration Status

post

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

The view shows all the client integration statuses. The data has been retrieved from each client to be presented in a single view.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

integrationInstituteId

int32

The IntegrationInstituteId field in the ClientIntegrationStatusAll table is of data type integer and is used to uniquely identify the integration institute associated with the client's integration status. This field is vital in tracking and managing the integration process for clients and ensuring that all integration tasks are correctly assigned and completed in a timely manner. It allows for a seamless and efficient coordination between the client and the integration institute, resulting in a successful integration process.

clientEnvironmentId

int32

The ClientEnvironmentId field is the primary key of the ClientIntegrationStatusAll table and is of data type int. This field uniquely identifies each client environment within the integration status database. It is automatically generated and assigned to each client environment, ensuring that there are no duplicate values. The ClientEnvironmentId field is essential for efficient data retrieval and management of client integration status information. It serves as the main reference point for tracking the current status and progress of all client integration processes.

operationStatus

string | null

The OperationStatus field in the ClientIntegrationStatusAll table is a data type of nvarchar, which enables the storage of alphanumeric characters. This field serves as a record of the current status of integration operations for clients. It may contain information such as 'processing,' 'successful,' 'failed,' or other indicators of the progress or outcome of integration tasks. The OperationStatus field is an important component in tracking and managing the integration process for clients and ensuring successful data management.

instituteName

string

required

length ≥ 1

The InstituteName field in the ClientIntegrationStatusAll table is a text-based data type, specifically nvarchar, which stores the name of the institute associated with a particular client integration status. This field can be used to identify the organization or institution that a client is associated with, providing important context and information for the integration process. It is an essential piece of information for accurately tracking and managing client integrations.

instituteLogoImage

string | null

The InstituteLogoImage field in the ClientIntegrationStatusAll table is an nvarchar data type that can hold a string of up to 611 characters. This field is used to store the image of the institute's logo for the purpose of client integration. The logo image can be accessed and displayed by the client integration system to provide visual branding and identification for the institute. The length limitation of 611 characters ensures the efficient storage and retrieval of the logo image.

integrationCategoryId

string

required

length between 1 and 450

The IntegrationCategoryId field in the ClientIntegrationStatusAll table is a nvarchar data type with a maximum length of 450 characters. This field stores the unique identifier for the integration category that a client is currently assigned to. This information is crucial for tracking and organizing the various integration categories that the clients are associated with. With a generous maximum length of 450 characters, this field allows for detailed and comprehensive integration category descriptions to be stored. This field plays a vital role in tracking and managing client integration status, making it an essential aspect of the ClientIntegrationStatusAll table.

environmentId

string

required

length between 1 and 256

The EnvironmentId field in the ClientIntegrationStatusAll table is a nvarchar data type with a maximum length of 256 characters. This field stores the unique identifier for the environment in which the client integration status is being tracked. It is useful for differentiating and organizing data from multiple environments within a single table. The data in this field can include letters, numbers, and other special characters.

integrationName

string

required

length between 1 and 128

The IntegrationName field in the ClientIntegrationStatusAll table is a nvarchar data type with a maximum length of 128 characters. It is used to store the name of the integration associated with a particular client's status. This field is important for tracking and managing the integrations of various clients and providing valuable insights into the state of each integration. With its 128-character limit, it allows for descriptive and informative integration names to be easily stored and referenced.

name

string | null

The 'Name' field in the table 'ClientIntegrationStatusAll' is a data type of nvarchar, meaning it stores variable-length character data up to a maximum of 4,000 characters. This field is used to store the client's name, providing a unique identifier for each entry in the table. The nvarchar data type allows for flexibility in data entry, accommodating various lengths and types of names. The 'Name' field plays a crucial role in the client integration process, serving as a key component in tracking and organizing data within the table.

comment

string | null

Miscellaneous notes and information for the entry or record.

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!