Introduction

Overview

Records serve as the backbone for storing and managing structured data within the system. They represent various business entities such as customers, transactions, workflows, or any other relevant objects. The system provides a flexible and dynamic structure that allows workflows to interact with records seamlessly.

If you want to use this functionality, our team needs to prepare the appropriate configuration in coordination with you. If needed, please contact us at [e-mail]

Concept of a Record

A record in the API represents a structured data entry stored within the system. Each record possesses a unique recordId, which serves as its identifier. Records consist of structured data fields relevant to their type, including but not limited to:

• Customer details

• Order history

• Workflow progress

Key Features

• Unique Identification: Each record is uniquely identified by a recordId.

• Structured Data Storage: Records contain fields specific to their type, ensuring data integrity.

• Workflow Integration: Workflows can interact with records by reading data, updating fields, or creating new records dynamically during execution.

• Dynamic Record Creation: Workflows can start for existing records using a recordId or generate new records as part of their execution.

• Configurable Relationships: The structure of records and their interconnections are fully configurable, allowing adaptation to diverse business use cases.

• API Reference: Due to the configurability of records, the exact API reference is dynamically generated and accessible through the dashboard.

Flexibility and Configurability

Records are designed to support dynamic structures and relationships tailored to business requirements. The API dynamically generates documentation based on the current system configuration, ensuring up-to-date reference material is always available.

For further details, refer to the API reference documentation accessible within the dashboard.

Records