{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/financekey/json-schema/financekey-finance-key-entity-consent-pkg-v-client-integration-status-all-schema.json",
  "title": "FinanceKey.Entity.ConsentPkg.v_ClientIntegrationStatusAll",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/financekey-consents-api-openapi.yml#/components/schemas/FinanceKey.Entity.ConsentPkg.v_ClientIntegrationStatusAll",
  "required": [
    "environmentId",
    "instituteName",
    "integrationCategoryId",
    "integrationName"
  ],
  "type": "object",
  "properties": {
    "integrationInstituteId": {
      "type": "integer",
      "description": "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.",
      "format": "int32"
    },
    "clientEnvironmentId": {
      "type": "integer",
      "description": "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.",
      "format": "int32"
    },
    "operationStatus": {
      "type": [
        "string",
        "null"
      ],
      "description": "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": {
      "minLength": 1,
      "type": "string",
      "description": "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": {
      "maxLength": 611,
      "type": [
        "string",
        "null"
      ],
      "description": "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": {
      "maxLength": 450,
      "minLength": 1,
      "type": "string",
      "description": "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": {
      "maxLength": 256,
      "minLength": 1,
      "type": "string",
      "description": "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": {
      "maxLength": 128,
      "minLength": 1,
      "type": "string",
      "description": "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": {
      "type": [
        "string",
        "null"
      ],
      "description": "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": {
      "type": [
        "string",
        "null"
      ],
      "description": "Miscellaneous notes and information for the entry or record."
    },
    "createdById": {
      "type": [
        "integer",
        "null"
      ],
      "description": "The identity of the account that created the initial record.",
      "format": "int32",
      "readOnly": true
    },
    "createdOn": {
      "type": "string",
      "description": "The date and time the record was initially created.",
      "format": "date-time",
      "readOnly": true
    },
    "updatedById": {
      "type": [
        "integer",
        "null"
      ],
      "description": "The identity of the account that last modified the record.",
      "format": "int32",
      "readOnly": true
    },
    "updateOn": {
      "type": "string",
      "description": "The date and time the record was last modified.",
      "format": "date-time",
      "readOnly": true
    },
    "closedById": {
      "type": [
        "integer",
        "null"
      ],
      "description": "The identity of the account that deactivated and closed the record.",
      "format": "int32",
      "readOnly": true
    },
    "closedOn": {
      "type": "string",
      "description": "The date and time the record is to be considered as inactive and closed.",
      "format": "date-time",
      "readOnly": true
    },
    "rowVersion": {
      "type": [
        "string",
        "null"
      ],
      "description": "A unique version stamp of the record.",
      "format": "byte",
      "readOnly": true
    },
    "sessionId": {
      "type": [
        "string",
        "null"
      ],
      "description": "The identity of the session that last modified the record.",
      "readOnly": true
    },
    "active": {
      "type": "boolean",
      "description": "A flag that shows if the record is currently active. This values is calculated based on the current date and the record closed date.",
      "readOnly": true
    }
  },
  "additionalProperties": false
}