Integration Parameters

post

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

Defines the parameters that can be set on a Client Integration Instance, the panel control associated with the parameter and, if the value is mandatory or not. These parameters are defined in App, and the records are synchronised to the client tenants.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

integrationParameterId

int32

IntegrationParameterId: An identity field of type integer that uniquely identifies each record in the IntegrationParameter table. This field automatically increments with each new entry, ensuring that each integration parameter is assigned a distinct identifier for efficient referencing and management of data within the database.

integrationId

int32

IntegrationId (int): A unique identifier for each integration parameter, serving as the primary key for the IntegrationParameter table. This field is used to associate specific integration configurations with corresponding data processing workflows and operations.

mandatory

boolean

The 'Mandatory' field is a bit data type that indicates whether a particular integration parameter is required (true) or optional (false) for processing. This field ensures that necessary parameters are validated and present before executing integration tasks, thereby maintaining data integrity and operational efficiency.

panelControlId

int32 | null

PanelControlId: An integer identifier that uniquely represents the control panel associated with the integration parameter, facilitating the management and configuration of related settings within the system.

sequence

int32

The 'Sequence' field in the IntegrationParameter table is of data type int and is used to define the order in which integration parameters are processed or applied. This numeric value indicates the relative position of each parameter, allowing for organized and sequential handling of multiple parameters in integration workflows. It ensures that parameters can be prioritized and executed in a specific sequence, facilitating streamlined and efficient data integration operations.

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!