Target tables for storing API Service Graph Connector for Apigee X data

  • Release version: Washingtondc
  • Updated January 30, 2025
  • 3 minutes to read
    • Summarize
    Summarized using AI
    This content was generated using new OpenAI-powered functionality. Results are provided on an as is basis and are not guaranteed to be accurate or complete.

    Summary of Target Tables for Storing API Service Graph Connector for Apigee X Data

    This guide outlines the target tables for storing data collected from the Apigee X application via the API Service Graph Connector. Data is organized into various tables extending from Configuration Item (CMDB) classes and other classes, facilitating efficient data management and integration within ServiceNow.

    Show full answer Show less

    Key Features

    • Cloud Organizations [cmdbcicloudorg]: Stores attributes such as Object ID, Install Status, Name, and Operational Status.
    • Google Organization Folder [cmdbcigcpfolder]: Contains attributes like Parent, Object ID, and Install Status, with relationships to both itself and Cloud Organizations.
    • Google Organization Project [cmdbcigcpproject]: Features attributes including Name, Object ID, and Project ID, maintaining relationships with Cloud Organizations and Google Organization Folders.
    • Apigee API Gateway [cmdbciapigeeapigateway]: Captures essential data like ID, Name, and Install Status, relating to Managed APIs and API Consumers.
    • Managed API [cmdbcimanagedapi]: Holds information on Life Cycle Stage, ID, Version, and Base URL, with relationships to API Frontends and Backends.
    • API Frontend [cmdbciapifrontend]: Records API Version, Method, URL, and operational status, linked to API Backends.
    • API Backend [cmdbciapibackend]: Contains attributes such as URL, Name, and Type.
    • API Product Bundle [cmdbciapiproductbundle]: Includes ID, Creation Date, and Description, utilized by API Consumer Subscriptions.
    • API Consumer Subscription [cmdbciapiconsumersubscription]: Tracks subscriptions with attributes like ID, Creation Date, and API Consumer.
    • Key Value [cmdbkeyvalue]: Manages key-value pairs essential for integrations.
    • API Deployment [apideployment]: Supports tracking of API deployments.
    • API Consumer [apiconsumer]: Maintains API Consumer details including ID and Username.
    • API Consumer Access [apiconsumeraccess]: Documents access relationships between API Consumers and Product Bundles.

    Key Outcomes

    By configuring the integration to pull data from Apigee X, ServiceNow customers can expect streamlined data management across various interconnected components, enhancing visibility and operational efficiency. This structure supports better decision-making and management of API services within their enterprise environment.

    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 classes.

    Cloud Organizations [cmdb_ci_cloud_org]

    The following attributes in the Cloud Organizations [cmdb_ci_cloud_org] table are populated by collected data:
    Attribute label Attribute name
    Object ID object_id
    Install Status install_status
    Name name
    Operational status operational_status
    Time time
    Table 1. Relationship created for Cloud Organizations
    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]

    The following attributes in the Google Organization Folder [cmdb_ci_gcp_folder] table are populated by collected data:
    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
    Table 2. Relationships created for Google Organization Folder
    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]

    Google Organization Project [cmdb_ci_gcp_project]

    The following attributes in the Google Organization Project [cmdb_ci_gcp_project] table are populated by collected data:
    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
    Table 3. Relationships created for Google Organization Project
    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]

    Apigee API Gateway [cmdb_ci_apigee_api_gateway]

    The following attributes in the Apigee API Gateway [cmdb_ci_apigee_api_gateway] table are populated by collected data:
    Attribute label Attribute name
    ID id
    Name name
    Install Status install_status
    Operational status operational_status
    Table 4. Relationships created for Apigee API Gateway
    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]

    The following attributes in the Managed API [cmdb_ci_managed_api] table are populated by collected data:
    Attribute label Attribute name
    Life Cycle Stage life_cycle_stage
    ID id
    Name name
    Version version
    Base URL base_url
    Install Status install_status
    Operational status operational_status
    Model ID model_id
    Correlation ID correlation_id
    Life Cycle Stage Status life_cycle_stage_status
    Table 5. Relationships created for Managed API
    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]

    API Frontend [cmdb_ci_api_frontend]

    The following attributes in the API Frontend [cmdb_ci_api_frontend] table are populated by collected data:
    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
    Table 6. Relationship created for API Frontend
    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]

    The following attributes in the API Backend [cmdb_ci_api_backend] table are populated by collected data:
    Attribute label Attribute name
    URL url
    Name name
    Operational status operational_status
    Type type

    API Product Bundle [cmdb_ci_api_product_bundle]

    The following attributes in the API Product Bundle [cmdb_ci_api_product_bundle] table are populated by collected data:
    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
    Table 7. Relationships created for API Product Bundle
    Parent class Relationship type Child class
    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]

    API Consumer Subscription [cmdb_ci_api_consumer_subscription]

    The following attributes in the API Consumer Subscription [cmdb_ci_api_consumer_subscription] table are populated by collected data:
    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
    Table 8. Relationship created for API Consumer Subscription
    Parent class Relationship type Child class
    API Consumer Subscription [cmdb_ci_api_consumer_subscription] Reference Key Value [cmdb_key_value]

    Key Value [cmdb_key_value]

    The following attributes in the Key Value [cmdb_key_value] table are populated by collected data:
    Attribute label Attribute name
    Key key
    Value value

    API Deployment [api_deployment]

    The following attributes in the API Deployment [api_deployment] table are populated by collected data:
    Attribute label Attribute name
    API api
    Name name

    API Consumer [api_consumer]

    The following attributes in the API Consumer [api_consumer] table are populated by collected data:
    Attribute label Attribute name
    ID id
    API Gateway api_gateway
    Custom ID custom_id
    Email email
    Registration Date registration_date
    Username username

    API Consumer Access [api_consumer_access]

    The following attributes in the API Consumer Access [api_consumer_access] table are populated by collected data:
    Attribute label Attribute name
    API Product Bundle api_product_bundle
    API Consumer Subscription api_consumer_subscription
    API api
    API Consumer api_consumer