Overview
This node integrates with the Creatio API, enabling users to perform various operations on Creatio data entities via OData endpoints. It supports fetching metadata about entity fields, retrieving records, creating, updating, and deleting records, as well as listing available tables.
The METADATA operation specifically retrieves the field names for a specified Creatio table (entity). This is useful when you want to dynamically understand the structure of a table before performing further operations such as querying or updating records.
Common scenarios:
- Automatically fetching the schema of a Creatio entity to build dynamic forms or validation rules.
- Inspecting available fields in a Creatio table to configure subsequent data processing steps.
- Integrating Creatio data into workflows where knowledge of entity fields is required.
Example:
- Use the METADATA operation to get all field names of the "Contact" entity, then use those fields to construct queries or map data in later workflow nodes.
Properties
| Name | Meaning |
|---|---|
| Subpath Name or ID | The name or ID of the Creatio entity (table) to operate on. For METADATA, this specifies which entity's field names to retrieve. Options are loaded dynamically from Creatio's OData entities. |
| Specify Input Schema | Boolean flag to indicate whether to specify an input schema for the function. When enabled, the node expects inputs to conform to the defined schema and validates them accordingly. |
| Schema Type | Method to specify the input schema if enabled: either generate it automatically from a JSON example or define it manually using JSON Schema format. |
| JSON Example | An example JSON object used to auto-generate the input schema when "Generate From JSON Example" is selected. |
| Notice | Informational notice that all properties will be required when generating schema from JSON example; to make properties optional, manual JSON Schema definition should be used instead. |
| Input Schema | The JSON Schema definition for the input, used when "Define using JSON Schema" is selected. Supports standard JSON Schema syntax except $ref. |
Output
The output is a JSON array containing the results of the requested operation.
For the METADATA operation, the output is an array of objects, each representing a field in the specified Creatio entity. Each object has the following structure:
[
{
"fieldName": "FieldName1"
},
{
"fieldName": "FieldName2"
}
]
Where "fieldName" is the name of a property/column in the Creatio entity.
No binary data output is produced by this operation.
Dependencies
- Requires valid credentials for the Creatio API, including authentication details (username, password, and URL).
- The node internally authenticates with Creatio and manages cookies for session and CSRF protection.
- Uses Creatio's OData API endpoints to fetch metadata and perform CRUD operations.
- Requires network access to the configured Creatio instance.
Troubleshooting
- Authentication failures: If the node cannot authenticate, ensure the provided credentials (URL, username, password) are correct and that the Creatio instance is reachable.
- Empty or missing metadata: If no fields are returned for a given entity, verify that the entity name (Subpath) is correct and exists in Creatio.
- HTTP errors: Network issues or incorrect URLs can cause request failures. Check connectivity and endpoint correctness.
- Permission issues: The authenticated user must have sufficient permissions to access metadata and data for the specified entities.
- Schema validation errors: If specifying an input schema, ensure the input data matches the schema exactly to avoid validation failures.