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
This document outlines the target tables designed for storing data collected via the API Service Graph Connector for Apigee X. After establishing the connection, the integration allows for periodic data retrieval from Apigee X applications, saving this data in specific tables that extend from Configuration Item (CI) classes and other non-CMDB tables.
Show less
Key Features
- Google Organization Project [cmdbcigcpproject]: Captures key attributes including parent, name, object ID, install status, and operational status.
- Apigee API Gateway [cmdbciapigeeapigateway]: Records attributes such as ID, name, install status, and operational status.
- Managed API [cmdbcimanagedapi]: Stores details like description, lifecycle stage, base URL, and operational status.
- API Deployment [apideployment]: Contains attributes related to the API name.
- API Consumer [apiconsumer]: Tracks attributes like custom ID, email, and registration date.
- API Frontend [cmdbciapifrontend]: Captures attributes including API version, host, method, and operational status.
- API Backend [cmdbciapibackend]: Records URL, name, and operational status.
- API Product Bundle [cmdbciapiproductbundle]: Stores data about access types and operational status.
- API Consumer Subscription [cmdbciapiconsumersubscription]: Contains subscription-related attributes and operational status.
- Cloud Organizations [cmdbcicloudorg]: Captures organization-related attributes including object ID and operational status.
- Google Organization Folder [cmdbcigcpfolder]: Stores organizational folder details including parent ID and operational status.
- DNS Alias [cmdbcidnsalias]: Captures name and operational status of DNS aliases.
Key Outcomes
By utilizing these tables, ServiceNow customers can efficiently manage and track Apigee X data, enabling better insights into their API ecosystem. This structured data storage facilitates improved visibility, reporting, and operational management within the ServiceNow platform.
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 |