---
title: "View Integration Details"
slug: "view-integration-details"
description: "This document illustrates how to use Integration Details for entities in Decisions.  The integration Details page contains information on different ways to integrate with the selected entity."
tags: ["REST Service", "Web Integration"]
updated: 2026-05-07T18:33:43Z
published: 2026-05-07T18:33:43Z
---

> ## Documentation Index
> Fetch the complete documentation index at: https://documentation.decisions.com/llms.txt
> Use this file to discover all available pages before exploring further.

# View Integration Details

## Overview

**View Integration Details** enables Users to seamlessly integrate designer elements of their workflow, such as Flows, Rules, Reports, and other Designer Elements, with external systems or services. This integration enables the exchange of data between Decisions and other software applications, allowing seamless sending and retrieval of information.

The following table represents the three available options under the View Integration Details:

| Integration Type | Settings |
| --- | --- |
| API Service | This Integration type allows Users to configure GET or POST calls for Flows, Rules, and Reports. |
| [User Interface](https://documentation.decisions.com/v9/docs/user-interface-integration) | This Integration type allows Users to configure how UI elements will be configured via URL. Note that this Integration Type is not available for Rules. |
| [Webhook](https://documentation.decisions.com/v9/docs/creating-webhooks) | This Integration type configures the Designer to use this Integration's capabilities. Note that this Integration Type is only available for Flows. |

There is no direct API integration for Page/Dashboards, but it can still be integrated through **Folder Integration** (mentioned below in this article) or by embedding it in an [iFrame](https://documentation.decisions.com/v9/docs/decisions-platform-in-an-iframe).

Version 9 Endpoints for SAML, OpenID, and OAuth

- LoginURL - [base]:[port]/Login
- LogoutURL - [base]:[port]/Logout
- SAML - [base]:[port]/SAML/AssertionConsumer
- TokenHandler - [base]:[port]/HandleTokenResponse

An example of an endpoint would appear in the address bar as > **localhost:81/Logout**.****  
The port number is ONLY needed if Decisions is installed on a non-standard port, which would be anything other than **port 80 for HTTP** or **port 443 for HTTPS**.

---

| **Feature Modification** |
| --- |
| **Introduced in Version** | -- |
| **Modified in Version** | 9.25 |

## Configure Integration Type

Designer Elements has integration disabled by default, and this can be enabled via SERVICE SETTINGS located at:

- **Configure Integration** located at the top right corner within the Designer Entities
- **Service Settings**located in the Properties Panel of the Designer Entities.

Both settings are identical and include the following settings to configure.

| Setting | Description |
| --- | --- |
| Integration Type | Configures what type of Integration will be allowed on this Designer Element |
| Data Format | Allows setting the type of Data Format to be output. - All - JSON - RAW - Rawjson - RawXml - XML |
|  | Ignore Null Values in JSON Output | Will eliminate the fields with "null" values in its JSON responses. This is to create a more generic data structure as a response. |
| Reference Type | Allows Users to configure the reference method for the Integration call by either ID, URL, or Path |
| Override Service URL | Allows Users to create a custom service URL Endpoint. Services generated using this setting can be found either at `http://localhost/decisions/Primary/apidoc for IIS-hosted environments` or `http://localhost/Primary/apidoc for Self-Hosted environments`. Learn more about custom URLs in [URL Slugs](https://documentation.decisions.com/docs/url-slugs). |
| Configure HTTP Methods | Allows Users to permit which HTTP Methods can be used for Integration: GET, POST, PUT. |

![](https://cdn.document360.io/6ef8bcc1-6489-4486-9ad1-83acff7e5df0/Images/Documentation/image-1749575202522.png)

After configuring the Integration Settings, click VIEW to open the **Integration****Details**Page.

For more information on running Flows via Integration, review the [Running Flows as a URL](https://documentation.decisions.com/v9/docs/running-a-flow-from-a-url) to learn more.

![](https://cdn.document360.io/6ef8bcc1-6489-4486-9ad1-83acff7e5df0/Images/Documentation/2024-08-07_16h01_54.png)

![](https://cdn.document360.io/6ef8bcc1-6489-4486-9ad1-83acff7e5df0/Images/Documentation/2026-05-06_10h38_35(1).png)

In **v9.25**, the **Call via GET** URL displayed on the Integrations page has been updated to allow Flows and Rules with a single input variable to utilize the same format as those with multiple inputs. The original displayed URL will still function.

---

## Integration Details for Folder Entity

Integration of Page/DashboardsUsers can configure the Integration for the Page/Dashboards by enabling the **Select Page** option from the View Integration Details for a Folder Entity. Refer to the following section for detailed information.

To view the Integration Details of a Folder Entity:

1. Right-click on a Folder.
2. From the Folder Actions, click **Manage > Integrations > View Integration Details**.![](https://cdn.document360.io/6ef8bcc1-6489-4486-9ad1-83acff7e5df0/Images/Documentation/2024-08-20_14h17_44.png)
3. The View Integration Details For Folder Page will open in a new window. The following tables represent the options available to configure a Folder's Integration.  

| Setup | Description |
| --- | --- |
| Setup | Option to choose the user authentication type. |

| Additional Options | Description |
| --- | --- |
| Call Folder By | Allows calling the URL by either the Folder **ID**or **Path**. |
| Select Page | Provides the option to **Enable Page Selection;**toggling this enables****the Pages option. |
| Pages | Allows the ability to select how the Folder will display its contents. Options include **Folder****View**, **List**, **Tiles**, **Columns**, and **Unit****Test****Results**. |

| Display Settings | Description |
| --- | --- |
| Display Type | Option to pick Portal****Type to display Folder; options include HTML, Mobile, or Tablet. |
| Chrome | Breadcrumbs setting. Options include: - None - Off - Small - TopBarOnly - TopBarFolderTreeCollapsed - NoTopBarHasFolderTree - NoTopBarFolderTreeCollapsed |
4. Select and define the desired settings. After configuring the Integration, copy the **URL**on the right. Adjusting the settings will alter the URL on the right automatically. This URL can now be used to integrate with the Folder outside of Decisions.

![](https://cdn.document360.io/6ef8bcc1-6489-4486-9ad1-83acff7e5df0/Images/Documentation/2024-08-07_16h19_23.png)

---

## API Call Authentication Types

The following table represents the API Call Authentication options available to Users when creating an **Integration**in Decisions.

Decisions RecommendationUse the Named Sessions for the API calls authentication type when applicable. These are more secure than other options.

| **Authentication Type Options** | Description |
| --- | --- |
| Login | Uses the Login credentials of the User for calling this Decisions Element. Upon execution, the user will be brought to a Login Page before proceeding with the Integration. |
| Guest | Uses the Guest Account, when [enabled](/v9/docs/enabling-a-guest-account) before Integration, for the REST call. |
| [Named Sessions](/v9/docs/named-session) | Uses User-configured Named Sessions that are associated with a Decisions account. This is configured in the **System > Security > Named Session** Folder. |
| SessionID | Uses the current Login's SessionID for API call authentication. |
| Specify Session ID | Allows a User to specify a SessionId for call authentication. This is set in the SessionId box and stored via the STORE SESSION ID button. |
| Specify User Credentials | Allows the User to specify Constant User credentials to be used for Integration. |

---

## Using Settings.XML

From **v9.2 to v9.12**, the settings.xml file contains a property that can be edited to enable API access. The property will be displayed as follows, depending on whether access is enabled or disabled:

<AllowApiDocAccess>true</AllowApiDocAccess> OR <AllowApiDocAccess>false</AllowApiDocAccess>

With /apidoc, two types of services are shown- System Services and Flow Services. When <AllowApiDocAccess> is set to False, Users will only see Flow Services. If set to True, both System Services and Flow Services are exposed.

Users performing a clean install will find <AllowApiDocAccess> set to False in the settings.xml file by default.

For Users who are upgrading from an older version, the settings.xml file will not be updated with the new property. It will need to be added manually.

In **v9.13+**, Users can disable the APIDoc endpoint. If API access is needed, Users must ensure the property mentioned above is set to true in the Settings.XML file. If the property is set to false (as it is by default), System Services and Flow Services will not be visible.

---

## Using Swagger

[Swagger docs](https://swagger.io/) can be created to help manage a customer's API design in Decisions. Any Decisions environment can generate a Swagger doc. Add /apidoc to the end of the Decisions [baseportalurl] - `https://baseportalurl/apidoc`.

---

## Testing Integration

To test Integration behavior at any time:

1. Click the **TEST**tab on the right-hand side of the **INTEGRATION DETAILS** screen.
2. Select the desired method (ex: POST, GET), then click **RUN**. ![](https://cdn.document360.io/6ef8bcc1-6489-4486-9ad1-83acff7e5df0/Images/Documentation/2024-08-07_16h25_18.png)
3. Once the Integration runs, confirm the Post or Get Results to match the specified outputtype (ex: JSON)**.** 

![](https://cdn.document360.io/6ef8bcc1-6489-4486-9ad1-83acff7e5df0/Images/Documentation/2021-04-28_14h57_53.png)

---

## Type Serialization Helper

Navigating to the TEST page and selecting TYPE SERIALIZATION HELPER will display a serialized String for a Decisions Data Type in either XML or JSON format.![](https://cdn.document360.io/6ef8bcc1-6489-4486-9ad1-83acff7e5df0/Images/Documentation/2021-04-19_15h09_43.png)  
To view this serialized String: 

1. Search for the desired Data Type****in the **Select****Type**box.
2. Under Output Type, select either **XML**or **JSON**.![](https://cdn.document360.io/6ef8bcc1-6489-4486-9ad1-83acff7e5df0/Images/Documentation/image-1696939946447.png)

---

## Feature Changes

| Description | Version | Date | Developer Task |
| --- | --- | --- | --- |
| Settings.xml was updated with API exposing properties. | [9.2](https://documentation.decisions.com/v99/docs/version-92x-release-notes) | August 2024 | [DT-041834] |
| Users can now disable full access to the API doc endpoint. | [9.13](https://documentation.decisions.com/v99/docs/version-913x-release-notes?highlight=DT-044506) | March 2026 | [DT-044506] |
| The "Call via GET" URL displayed on the Integrations page has been updated to allow Flows and Rules with a single input variable to utilize the same format as those with multiple inputs. | 9.25 | May 2026 | [DT-045887] |
