How You Integrate Connectors

You can return configuration selections and items related by connectors to hosting applications.

REST Resources

You can use the connectedItems REST resource to return the connected items from a specified configuration. The connectedItems resource is a child of the configurations resource.

• A hosting application can call Configurator REST services to retrieve connected items as independent lines.

• Connected items can be retrieved through the configurations resource for integration purposes in other applications, such as a quoting or Order Management.

• You can retrieve an individual connected item's runtime attributes, such as item number, unit of measure or quantity ordered.

Example

The following sample URL uses the connectedItems child resource of the configurations resource to obtain an output payload containing all of the connected items included in the specified configuration. In this example, there are two connected items in the configuration.

Copyhttps://vision.com/fscmRestApi/resources/11.13.18.05/configurations/300100185429818_300100185429819/child/connectedItemsThese are the objects of our main interest in the output payload:

Example value	Object name	Description
300100185429818	ConfigHeaderId	Configuration header ID.
300100185429819	ConfigRevisionId	Configuration revision ID.
300100185429818_300100185429819	ConfigurationId	ID of the configuration, composed of the configuration header ID and the configuration revision ID. You pass this to the resource to return the connected items.
First example connected item	-	-
300100185429862	ConnectedItemId	Connected item ID of the first connected item.
300100181203985	InventoryItemId	ID of the first connected item.
7YR_PTRAIN_WARR	InventoryItemNumber	Item name of the first connected item.
Second example connected item	-	-
300100185429864	ConnectedItemId	Connected item ID of the second connected item.
300100181204014	InventoryItemId	ID of the second connected item.
WM_UTIL_TRLR	InventoryItemNumber	Item name of the second connected item.

Here is the JSON output payload returned for the connected items:

Copy{
  "items": [
    {
      "ConfigHeaderId": 300100185429818,
      "ConfigRevisionId": 300100185429819,
      "ConnectedItemId": 300100185429862,
      "ParentConfigLineId": 300100185429821,
      "InventoryItemId": 300100181203985,
      "InventoryItemNumber": "7YR_PTRAIN_WARR",
      "InventoryOrganizationId": 204,
      "InventoryOrganizationCode": "V1",
      "UomCode": "Ea",
      "InventoryItemType": 4,
      "Quantity": 1,
      "links": [
        {
          "rel": "self",
          "href": "https://vision.com:443/fscmRestApi/resources/11.13.18.05/configurations/300100185429818_300100185429819/child/connectedItems/300100185429862",
          "name": "connectedItems",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "https://vision.com:443/fscmRestApi/resources/11.13.18.05/configurations/300100185429818_300100185429819/child/connectedItems/300100185429862",
          "name": "connectedItems",
          "kind": "item"
        },
        {
          "rel": "parent",
          "href": "https://vision.com:443/fscmRestApi/resources/11.13.18.05/configurations/300100185429818_300100185429819",
          "name": "configurations",
          "kind": "item"
        }
      ]
    },
    {
      "ConfigHeaderId": 300100185429818,
      "ConfigRevisionId": 300100185429819,
      "ConnectedItemId": 300100185429864,
      "ParentConfigLineId": 300100185429821,
      "InventoryItemId": 300100181204014,
      "InventoryItemNumber": "WM_UTIL_TRLR",
      "InventoryOrganizationId": 204,
      "InventoryOrganizationCode": "V1",
      "UomCode": "Ea",
      "InventoryItemType": 4,
      "Quantity": 1,
      "links": [
        {
          "rel": "self",
          "href": "https://vision.com:443/fscmRestApi/resources/11.13.18.05/configurations/300100185429818_300100185429819/child/connectedItems/300100185429864",
          "name": "connectedItems",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "https://vision.com:443/fscmRestApi/resources/11.13.18.05/configurations/300100185429818_300100185429819/child/connectedItems/300100185429864",
          "name": "connectedItems",
          "kind": "item"
        },
        {
          "rel": "parent",
          "href": "https://vision.com:443/fscmRestApi/resources/11.13.18.05/configurations/300100185429818_300100185429819",
          "name": "configurations",
          "kind": "item"
        }
      ]
    }
  ],
  "count": 2,
  "hasMore": false,
  "limit": 25,
  "offset": 0,
  "links": [
    {
      "rel": "self",
      "href": "https://vision.com:443/fscmRestApi/resources/11.13.18.05/configurations/300100185429818_300100185429819/child/connectedItems",
      "name": "connectedItems",
      "kind": "collection"
    }
  ]
}