Target tables for storing API Service Graph Connector for Apigee X data
Summarize
Summary of Target Tables for Storing API Service Graph Connector for Apigee X Data
The integration with Apigee X allows users to configure data collection that populates specific tables within ServiceNow. These tables extend from Configuration Item (CMDB) classes and include attributes relevant to managing Apigee X data effectively.
Show less
Key Features
- Google Organization Project [cmdbcigcpproject]: Stores attributes related to the Google Organization projects, including parent-child relationships with Cloud Organizations and Google Organization Folders.
- Apigee API Gateway [cmdbciapigeeapigateway]: Captures details about the API Gateway, including relationships with Managed APIs and API Consumers.
- Managed API [cmdbcimanagedapi]: Includes attributes such as description, lifecycle stage, and relationships with API Frontends and Backends.
- API Deployment [apideployment]: Records deployment specifics for APIs, linked with API Consumers and Managed APIs.
- API Frontend [cmdbciapifrontend]: Details API endpoint characteristics, including operational status and method used.
- API Backend [cmdbciapibackend]: Stores backend API information, including URL and operational status.
- API Product Bundle [cmdbciapiproductbundle]: Contains bundle information for APIs and their relationships with subscriptions and key values.
- API Consumer Subscription [cmdbciapiconsumersubscription]: Manages subscription data for API consumers, including operational status and discovery state.
- Cloud Organizations [cmdbcicloudorg]: Maintains cloud organization data and its relationships with Google Organization Folders.
- DNS Alias [cmdbcidnsalias]: Records DNS alias attributes relevant to the operational status of APIs.
Key Outcomes
By implementing the API Service Graph Connector for Apigee X, ServiceNow customers can efficiently manage and visualize data related to their API ecosystem. This integration enhances visibility into relationships among various components, facilitating better decision-making and operational oversight. Customers can expect improved management of API resources and streamlined data flows within their organization.
When you complete setting up the connection, you can configure the integration to periodically pull data from an Apigee X application. The data is saved in tables that extend from the Configuration item [cmdb_ci] classes and other non-CMDB tables.
Google Organization Project [cmdb_ci_gcp_project]
| Attribute label | Attribute name |
|---|---|
| Parent | parent_ci |
| Name | name |
| Object ID | object_id |
| Install Status | install_status |
| Operational status | operational_status |
| Parent Id | parent_id |
| Parent Type | parent_type |
| Project Id | project_id |
| Time | time |
| Parent class | Relationship type | Child class |
|---|---|---|
| Google Organization Project [cmdb_ci_gcp_project] | Reference | Cloud Organizations [cmdb_ci_cloud_org] |
| Google Organization Project [cmdb_ci_gcp_project] | Reference | Google Organization Folder [cmdb_ci_gcp_folder] |
| Google Organization Project [cmdb_ci_gcp_project] | Contains::Contained by | Apigee API Gateway [cmdb_ci_apigee_api_gateway] |
Apigee API Gateway [cmdb_ci_apigee_api_gateway]
| Attribute label | Attribute name |
|---|---|
| ID | id |
| Name | name |
| Install Status | install_status |
| Operational status | operational_status |
| Parent class | Relationship type | Child class |
|---|---|---|
| APIgee API Gateway [cmdb_ci_apigee_api_gateway] | Provides::Provided by | Managed API [cmdb_ci_managed_api] |
| APIgee API Gateway [cmdb_ci_apigee_api_gateway] | Reference | API Consumer [api_consumer] |
| Apigee API Gateway [cmdb_ci_apigee_api_gateway] | Provides::Provided by | API Consumer Subscription [cmdb_ci_api_consumer_subscription] |
| Apigee API Gateway [cmdb_ci_apigee_api_gateway] | Provides::Provided by | API Product Bundle [cmdb_ci_api_product_bundle] |
Managed API [cmdb_ci_managed_api]
| Attribute label | Attribute name |
|---|---|
| Description | short_description |
| Life Cycle Stage | life_cycle_stage |
| ID | id |
| Name | name |
| Version | version |
| Base URL | base_url |
| Model ID | model_id |
| Correlation ID | correlation_id |
| Life Cycle Stage Status | life_cycle_stage_status |
| Operational status | operational_status |
| Parent class | Relationship type | Child class |
|---|---|---|
| Managed API [cmdb_ci_managed_api] | Uses::Used by | API Frontend [cmdb_ci_api_frontend] |
| Managed API [cmdb_ci_managed_api] | Uses::Used by | API Backend [cmdb_ci_api_backend] |
| Managed API [cmdb_ci_managed_api] | Reference | API Deployment [api_deployment] |
| Managed API [cmdb_ci_managed_api] | Uses::Used by | DNS Alias [cmdb_ci_dns_alias] |
API Deployment [api_deployment]
| Attribute label | Attribute name |
|---|---|
| API | api |
| Name | name |
API Consumer [api_consumer]
| Attribute label | Attribute name |
|---|---|
| ID | id |
| API Gateway | api_gateway |
| Custom ID | custom_id |
| Registration Date | registration_date |
| Username | username |
API Frontend [cmdb_ci_api_frontend]
| Attribute label | Attribute name |
|---|---|
| API Version | api_version |
| Host | host |
| Method | method |
| Path | path |
| URL | url |
| Description | short_description |
| Name | name |
| Operational status | operational_status |
| Protocol | protocol |
| Parent class | Relationship type | Child class |
|---|---|---|
| API Frontend [cmdb_ci_api_frontend] | Use End Point To::Use End Point From | API Backend [cmdb_ci_api_backend] |
API Backend [cmdb_ci_api_backend]
| Attribute label | Attribute name |
|---|---|
| URL | url |
| Name | name |
| Operational status | operational_status |
| Type | type |
API Product Bundle [cmdb_ci_api_product_bundle]
| Attribute label | Attribute name |
|---|---|
| ID | id |
| Creation Date | creation_date |
| Description | short_description |
| Discovered Access Type | discovered_access_type |
| Discovered Approval Type | discovered_approval_type |
| Last Modified Date | last_modified_date |
| Name | name |
| Operational status | operational_status |
| Parent class | Relationship type | Child class |
|---|---|---|
| API Product Bundle [cmdb_ci_api_product_bundle] | Contains::Contained by | API [cmdb_ci_api] |
| API Product Bundle [cmdb_ci_api_product_bundle] | Used by::Uses | API Consumer Subscription [cmdb_ci_api_consumer_subscription] |
| API Product Bundle [cmdb_ci_api_product_bundle] | Reference | Key Value [cmdb_key_value] |
Key Value [cmdb_key_value]
| Attribute label | Attribute name |
|---|---|
| Tag | tag |
| Configuration item | configuration_item |
| Key | key |
| Value | value |
API Consumer Subscription [cmdb_ci_api_consumer_subscription]
| Attribute label | Attribute name |
|---|---|
| ID | id |
| Creation Date | creation_date |
| API Consumer | api_consumer |
| Discovered State | discovered_state |
| Last Modified Date | last_modified_date |
| Name | name |
| Operational status | operational_status |
| Parent class | Relationship type | Child class |
|---|---|---|
| API Consumer Subscription [cmdb_ci_api_consumer_subscription] | Reference | Key Value [cmdb_key_value] |
API Consumer Access [api_consumer_access]
| Attribute label | Attribute name |
|---|---|
| Auth Method | access_type |
| State | state |
| Valid to | valid_to |
| API Product Bundle | api_product_bundle |
| API Consumer Subscription | api_consumer_subscription |
| API | api |
| API Consumer | api_consumer |
Cloud Organizations [cmdb_ci_cloud_org]
| Attribute label | Attribute name |
|---|---|
| Object ID | object_id |
| Install Status | install_status |
| Name | name |
| Operational status | operational_status |
| Time | time |
| Parent class | Relationship type | Child class |
|---|---|---|
| Cloud Organizations [cmdb_ci_cloud_org] | Contains::Contained by | Google Organization Folder [cmdb_ci_gcp_folder] |
Google Organization Folder [cmdb_ci_gcp_folder]
| Attribute label | Attribute name |
|---|---|
| Parent | parent_ci |
| Object ID | object_id |
| Install Status | install_status |
| Name | name |
| Operational status | operational_status |
| Parent Id | parent_id |
| Parent Type | parent_type |
| Time | time |
| Parent class | Relationship type | Child class |
|---|---|---|
| Google Organization Folder [cmdb_ci_gcp_folder] | Reference | Google Organization Folder [cmdb_ci_gcp_folder] |
| Google Organization Folder [cmdb_ci_gcp_folder] | Reference | Cloud Organizations [cmdb_ci_cloud_org] |
DNS Alias [cmdb_ci_dns_alias]
| Attribute label | Attribute name |
|---|---|
| Name | name |
| Operational status | operational_status |