Configuration Tools
Overview
Configuration tools provide full lifecycle management for Flowon Configuration records. Configurations are named key-value pairs that store environment-specific settings accessible at runtime by Logic Blocks and Logic Flows. They support caching strategies and time-to-live settings to control how frequently values are refreshed from the database.
list_all_configurations
Lists All Flowon configurations.
| Parameter | Type | Required | Description |
|---|---|---|---|
pageNumber | int | The page number for pagination. If not provided, defaults to the first page. Optional. | |
pagingCookie | string | The paging cookie for pagination. This should be provided if pageNumber is provided and there are more records to retrieve. Optional. |
Returns: A paginated list of Configurations including name, title, description, and project.
See Pagination for details on iterating through large result sets.
list_configurations_by_project_name
Lists Flowon configurations by project name.
| Parameter | Type | Required | Description |
|---|---|---|---|
projectName | string | ✓ | The name of the project to filter configurations by name. |
Returns: A list of Configurations within the specified project.
list_configurations_by_project_id
Lists Flowon configurations by project ID.
| Parameter | Type | Required | Description |
|---|---|---|---|
projectId | GUID | ✓ | The ID of the project to filter configurations by. |
Returns: A list of Configurations within the specified project.
get_configuration_details_by_name
Gets the details for a Flowon Configuration by configuration name.
| Parameter | Type | Required | Description |
|---|---|---|---|
configurationName | string | ✓ | The name of the configuration. |
projectName | string | ✓ | The name of the project the configuration belongs to. |
Returns: Full Configuration details including name, value, type, cache strategy, time-to-live, title, description, and project.
get_configuration_details_by_id
Gets the details for a Flowon Configuration by configuration id.
| Parameter | Type | Required | Description |
|---|---|---|---|
configurationId | GUID | ✓ | The ID of the configuration. |
Returns: Full Configuration details including name, value, type, cache strategy, time-to-live, title, description, and project.
get_configuration_preview_url
Get preview url for Flowon configuration.
| Parameter | Type | Required | Description |
|---|---|---|---|
configurationName | string | ✓ | The name of the configuration. |
projectName | string | ✓ | The name of the project for the configuration. |
value | string | ✓ | The value for the configuration. |
cacheEntryStrategy | CacheEntryStrategy | ✓ | The cache entry strategy for the configuration. |
timeToLive | int | ✓ | The time to live for the configuration cache entry in minutes. |
title | string | The title for the configuration. Optional. | |
description | string | The description for the configuration. Optional. |
Returns: A preview URL for the configuration record.
create_configuration
Creates a new Flowon configuration and returns the configuration id.
| Parameter | Type | Required | Description |
|---|---|---|---|
configurationName | string | ✓ | The name of the configuration to create. |
projectName | string | ✓ | The name of the project to create the configuration in. |
type | TypeCode | ✓ | The type of the configuration value. |
value | string | ✓ | The value for the configuration. |
cacheEntryStrategy | CacheEntryStrategy | ✓ | The cache entry strategy for the configuration. |
timeToLive | int | ✓ | The time to live for the configuration cache entry in minutes. |
title | string | The title for the configuration. Optional. | |
description | string | The description for the configuration. Optional. |
Returns: The GUID of the newly created Configuration and its URL.
Restriction: Cannot be called on projects associated with a managed solution. See Managed Solution Protection.
update_configuration_value
Updates Flowon configuration metadata.
| Parameter | Type | Required | Description |
|---|---|---|---|
configurationName | string | ✓ | The name of the configuration to update. |
projectName | string | ✓ | The name of the project the configuration belongs to. |
value | string | ✓ | The new value for the configuration. |
Returns: Confirmation that the configuration value was updated.
Restriction: Cannot be called on projects associated with a managed solution.