Connect a digital interface with the CMDB API in the EA Workspace

task brazil Updated Sep 10, 2026 2 min read eaw-relate-dig-interface-api.md
Raw file servicenow.com

Create a relationship between a digital interface and a CMDB API. The relationship shows which digital integration uses which API and which APIs are built from the digital interface design specs. You can also see what environments are deployed and group the deployed APIs.

Before you begin

Activate the CMDB CI Class Models [app-cmdb-content] store app (version 1.49.0 or later). For instructions, see CMDB CI Class Models app.

Role required: sn_apm.apm_analyst

About this task

One digital interface can be connected to one or more APIs. One API can be connected to only one digital interface.

Procedure

  1. Navigate to All > Workspaces > Enterprise Architecture Workspace.

  2. In the left navigation, open the Portfolio List view by selecting the Portfolio icon ([Omitted image "portfolio-icon.png"] Alt text: Portfolio icon).

  3. Select the expand row icon ([Omitted image "ExpandIcon.png"] Alt text: Expand Row icon) next to Application Portfolio.

  4. Select Digital Interfaces.

  5. Select an existing digital interface.

  6. Select the APIs tab.

  7. Select New.

  8. On the Digital Interface to API form, fill in the fields.

    For field descriptions, see Digital interface to API form. Information for the fields Environment, Lifecycle Stage, and Lifecycle Stage Status are derived from the API. [Omitted image "eaw-dig-interface-to-api.png"] Alt text: Connect digital interface to API

  9. Select Save.

Parent Topic:Working with digital interfaces

Related topics

View all digital interfaces

Relate an SDLC component to a digital interface

Manage architectural artifacts of a digital interface

Add or edit a digital interface in the EA Workspace

Relate credentials to a digital interface

Relate an information object to a digital interface

Search documentation
Search document titles and file paths on the brazil branch