Skip to main content

Configuration Item Relationship

Sync Type: Incremental

Overview​

The ServiceNow Configuration Item Relationship input fetches data from ServiceNow Table API. ServiceNow uses CMDB (Configuration Management Database) application to build logical representation of assets, Services, and the relationships between them that comprise the infrastructure of your organization. CI relationship is an association between the service and the CIs (Configuration Items) that make up the service. This input accesess data from cmdb_rel_ci table.

Prerequisites​

Portal setup​

  1. Login to your ServiceNow Instance.
  2. Navigate to Users
    • Click on All option and type Users. Select Users option from under System Security > Users and Groups.
  3. Create a New User
    • Fill out the details, most importantly First name, Last name and Email. Click Submit to save the info.
    • Click on New button to add a new User record.
  4. Locate the new user
    • Find the newly created user in the users list.
    • Click on the UserID to open the user record details.
  5. Assign Roles
    • In the user record details, a new "Roles" tab will appear at the bottom.
    • Click on "Edit" under the Roles tab, which will open a new page with all available roles.
    • For the Table API, you can either add all admin roles for the tables you want to retrieve data from or add the "general" admin role to give access to all tables.
    • Save the changes.
  6. Set Password
    • Return to the user record.
    • You will see a "Set Password" button next to the update and delete button.
    • Click the Set Password button, which will open a popup.
    • Click the "Generate" button inside the popup to create a password, then click "Save Password".
  7. Instance Name
    • Note the instance name of the ServiceNow instance for use in later steps. For example, if the URL to your ServiceNow instance is https://test-demo.service-now.com, the instance name will be test-demo.

OAuth Setup​

⚠️ Important: Before setting up OAuth make sure you have security_admin role.

  1. Navigate to System OAuth > Application Registry.
  2. Click New and then click Create an OAuth API endpoint for external clients.
  3. Enter the name of the client and click the Submit button to generate Client Secret.
  4. Once generated note down Client ID and Client Secret.

Configuration​

SettingTypeRequiredDescription
Instance namestringtrueInstance name found in URL of your ServiceNow instance
UsernamestringtrueYour ServiceNow instance username.
PasswordstringtrueYour ServiceNow instance password.
Client IDstringtrueClient ID of the application created in the Application Registry while setting up OAuth.
Client SecretstringtrueClient ID of the application created in the Application Registry while setting up OAuth.
Backfill start timestringNoThe date to start fetching data from. If not specified, no past records will be fetched.

Sample Record​

{
    "child": {
        "link": "https://testxyz.service-now.com/api/now/table/cmdb_ci/339badd1-e4f5-eb3b-cfc4-ee6d66354ecd",
        "value": "54bec76a-4559-31a7-e4a1-57f6ee983ea4"
    },
    "connection_strength": "always",
    "parent": {
        "link": "https://testxyz.service-now.com/api/now/table/cmdb_ci/a02f5d4b-2422-8311-7c01-df89863f73a0",
        "value": "b09fd984-208d-ef69-f277-13f8731df2fb"
    },
    "percent_outage": "",
    "port": "",
    "sys_created_by": "admin",
    "sys_created_on": "2025-10-10T08:23:25.231Z",
    "sys_id": "9e71f9dd-808e-8f94-0ef9-be83d4a1dfb0",
    "sys_mod_count": "0",
    "sys_tags": "",
    "sys_updated_by": "admin",
    "sys_updated_on": "2025-10-10T08:23:25.231Z",
    "type": {
        "link": "https://testxyz.service-now.com/api/now/table/cmdb_rel_type/fc13398c-014f-8fc4-710a-ccc5c0e75e2b",
        "value": "ec66305a-fded-0483-2508-55cdf51532ec"
    }
}