Service Connection Tools
Overview
Service Connections define external services (e.g. REST APIs) that Logic Flows can call. Logic Assist supports searching, listing, reading, previewing, creating, and updating Service Connections. Requires the Logic Composer product.
ServiceConnectionType values:
| Value | Meaning |
|---|---|
RestApi | A REST API service connection |
search_service_connections
Searches Logic Fabric service connections by name.
| Parameter | Type | Required | Description |
|---|---|---|---|
serviceConnectionName | string | ✓ | The name of the service connection to search for. |
Returns: Matching Service Connections including name, connection type, title, description, and project.
list_service_connections
Lists Logic Fabric service connections.
| Parameter | Type | Required | Description |
|---|---|---|---|
projectId | GUID | The ID of the project to filter service connections by. Optional. | |
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 Service Connections including name, connection type, title, description, and project.
See Pagination for details on iterating through large result sets.
get_service_connection_details
Gets the details for a Logic Fabric service connection by ID.
| Parameter | Type | Required | Description |
|---|---|---|---|
serviceConnectionId | GUID | ✓ | The ID of the service connection. |
Returns: Full Service Connection details including name, connection type, configuration, title, description, and project.
get_service_connection_preview_url
Get a preview URL for a Logic Fabric service connection.
| Parameter | Type | Required | Description |
|---|---|---|---|
serviceConnectionName | string | ✓ | The name of the service connection. |
projectName | string | ✓ | The name of the project for the service connection. |
connectionType | ServiceConnectionType | ✓ | The type of the service connection. |
configuration | string | ✓ | The configuration for the service connection in JSON format. |
title | string | The title for the service connection. Optional. | |
description | string | The description for the service connection. Optional. |
Returns: A preview URL for the service connection record.
create_service_connection
Creates a new Logic Fabric service connection and returns the service connection id.
| Parameter | Type | Required | Description |
|---|---|---|---|
serviceConnectionName | string | ✓ | The name of the service connection to create. |
projectId | GUID | ✓ | The ID of the project to create the service connection in. |
connectionType | ServiceConnectionType | ✓ | The type of the service connection. |
configuration | string | ✓ | The configuration for the service connection in JSON format. |
title | string | The title for the service connection. Optional. | |
description | string | The description for the service connection. Optional. |
Returns: The GUID of the newly created Service Connection and its URL.
Restriction: Cannot be called on projects associated with a managed solution. See Managed Solution Protection.
update_service_connection_configuration
Updates a Logic Fabric service connection configuration.
| Parameter | Type | Required | Description |
|---|---|---|---|
serviceConnectionId | GUID | ✓ | The ID of the service connection to update. |
configuration | string | ✓ | The new configuration for the service connection. |
Returns: Confirmation that the service connection configuration was updated.
Restriction: Cannot be called on projects associated with a managed solution. See Managed Solution Protection.
Best practice: Always call get_service_connection_details first to read the current configuration before updating, to avoid unintentionally overwriting parts of the configuration you did not intend to change.