ServiceNow Component

Create records and incidents within ServiceNow

Component key: servicenow

Description

ServiceNow is platform that helps you manage digital workflows. The ServiceNow component gives you the ability to insert table records and incidents on the platform.

Connections

OAuth 2.0 Authorization Code

Input	Notes	Example
Authorize URL	The OAuth 2.0 Authorization URL for ServiceNow	https://dev12345.service-now.com/oauth_auth.do
Client ID	Client Identifier of your app for ServiceNow
Client Secret	Client Secret of your app for ServiceNow
Scopes	Space separated OAuth 2.0 permission scopes for ServiceNow
Token URL	The OAuth 2.0 Token URL for ServiceNow	https://dev12345.service-now.com/oauth_token.do

Basic Username/Password

Input	Notes	Example
Password	Password
Username	Username

Data Sources

Select Attachment

Select an attachment from a list of attachments. | key: selectAttachment | type: picklist

Input	Notes	Example
API Version	The version of the ServiceNow API file_name, to use	v2
Connection
Instance URL	The URL of the specific ServiceNow instance to use for API requests	https://instance.service-now.com
Sysparm Query	Encoded query used to filter the result set. Syntax: sysparm_query=<col_name><operator><value>.	active=true^ORDERBYnumber^ORDERBYDESCcategory

Select Table

Select a table from the list of tables in ServiceNow. Returns the sys_id of the selected table. | key: selectTable | type: picklist

Input	Notes	Example
Connection
Instance URL	The URL of the specific ServiceNow instance to use for API requests	https://instance.service-now.com
Sysparm Query	Encoded query used to filter the result set. Syntax: sysparm_query=<col_name><operator><value>.	active=true^ORDERBYnumber^ORDERBYDESCcategory

Actions

Create Configuration Item

Creates a single configuration item (CI) with the specified outbound and inbound relations within the specified Configuration Management Database (CMDB) table. | key: createConfigurationItem

Input	Notes	Example
API Version	The version of the ServiceNow API file_name, to use	v2
Class Name	CMDB class name. This is the name of the table that contains the desired CI records	cmdb_ci_linux_server
Configuration Item Attributes	The attributes of the configuration item to create.
Configuration Item Inbound Relations	The inbound relations of the configuration item to create.
Configuration Item Outbound Relations	The outbound relations of the configuration item to create.
Configuration Item Source	Entity that created/updated the information. This must be one of the choice values specified in the discovery_source field in the Configuration Item [cmdb_ci] table.	ServiceNow
Connection
Instance URL	The URL of the specific ServiceNow instance to use for API requests	https://instance.service-now.com

{
  "data": {
    "result": {
      "outbound_relations": [
        {
          "sys_id": "403ff2641b425010593876a61a4bcb4b",
          "type": {
            "display_value": "Depends on::Used by",
            "link": "https://instance.servicenow.com/api/now/table/cmdb_rel_type/1a9cb166f1571100a92eb60da2bce5c5",
            "value": "1a9cb166f1571100a92eb60da2bce5c5"
          },
          "target": {
            "display_value": "PS ORA01",
            "link": "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci/3a307c930a0a0bb400353965d0b8861f",
            "value": "3a307c930a0a0bb400353965d0b8861f"
          }
        },
        {
          "sys_id": "443ff2641b425010593876a61a4bcb4c",
          "type": {
            "display_value": "Exchanges data with::Exchanges data with",
            "link": "https://instance.servicenow.com/api/now/table/cmdb_rel_type/607ad1b2c0a8010e01941856b365af90",
            "value": "607ad1b2c0a8010e01941856b365af90"
          },
          "target": {
            "display_value": "PS ORA01",
            "link": "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci/3a307c930a0a0bb400353965d0b8861f",
            "value": "3a307c930a0a0bb400353965d0b8861f"
          }
        }
      ],
      "attributes": {
        "firewall_status": "Intranet",
        "os_address_width": "",
        "attested_date": "",
        "operational_status": "1",
        "os_service_pack": "",
        "cpu_core_thread": "",
        "cpu_manufacturer": "",
        "sys_updated_on": "2020-07-13 20:27:28",
        "discovery_source": "ServiceNow",
        "first_discovered": "2020-07-13 20:27:28",
        "due_in": "",
        "used_for": "Production",
        "invoice_number": "",
        "gl_account": "",
        "sys_created_by": "dora.gray",
        "warranty_expiration": "",
        "ram": "",
        "cpu_name": "",
        "cpu_speed": "",
        "owned_by": "",
        "checked_out": "",
        "kernel_release": "",
        "sys_domain_path": "/",
        "classification": "Production",
        "disk_space": "",
        "object_id": "",
        "maintenance_schedule": "",
        "cost_center": "",
        "attested_by": "",
        "dns_domain": "",
        "assigned": "",
        "purchase_date": "",
        "life_cycle_stage": "",
        "short_description": "",
        "cd_speed": "",
        "floppy": "",
        "managed_by": "",
        "os_domain": "",
        "last_discovered": "2020-07-13 20:27:28",
        "can_print": "false",
        "sys_class_name": "cmdb_ci_linux_server",
        "manufacturer": "",
        "cpu_count": "",
        "vendor": "",
        "life_cycle_stage_status": "",
        "model_number": "",
        "assigned_to": "",
        "start_date": "",
        "os_version": "",
        "serial_number": "",
        "cd_rom": "false",
        "support_group": "",
        "unverified": "false",
        "correlation_id": "",
        "attributes": "",
        "asset": "",
        "form_factor": "",
        "cpu_core_count": "",
        "skip_sync": "false",
        "attestation_score": "",
        "sys_updated_by": "dora.gray",
        "sys_created_on": "2020-07-13 20:27:28",
        "sys_domain": {
          "display_value": "global",
          "link": "https://instance.servicenow.com/api/now/table/sys_user_group/global",
          "value": "global"
        },
        "cpu_type": "",
        "install_date": "",
        "asset_tag": "",
        "dr_backup": "",
        "hardware_substatus": "",
        "fqdn": "",
        "change_control": "",
        "internet_facing": "true",
        "delivery_date": "",
        "hardware_status": "installed",
        "install_status": "1",
        "supported_by": "",
        "name": "lnux299",
        "subcategory": "Computer",
        "default_gateway": "",
        "chassis_type": "",
        "virtual": "false",
        "assignment_group": "",
        "managed_by_group": "",
        "sys_id": "0c3ff2641b425010593876a61a4bcb39",
        "po_number": "",
        "checked_in": "",
        "sys_class_path": "/!!/!2/!(/!!/!0",
        "mac_address": "",
        "company": "",
        "justification": "",
        "department": "",
        "cost": "",
        "comments": "",
        "os": "",
        "sys_mod_count": "0",
        "monitor": "false",
        "model_id": "",
        "ip_address": "",
        "duplicate_of": "",
        "sys_tags": "",
        "cost_cc": "USD",
        "order_date": "",
        "schedule": "",
        "environment": "",
        "due": "",
        "attested": "false",
        "location": "",
        "category": "Hardware",
        "fault_count": "0",
        "host_name": "",
        "lease_id": ""
      },
      "inbound_relations": [
        {
          "sys_id": "c03ff2641b425010593876a61a4bcb49",
          "type": {
            "display_value": "Depends on::Used by",
            "link": "https://instance.servicenow.com/api/now/table/cmdb_rel_type/1a9cb166f1571100a92eb60da2bce5c5",
            "value": "1a9cb166f1571100a92eb60da2bce5c5"
          },
          "target": {
            "display_value": "PS Apache01",
            "link": "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci/3a27d4370a0a0bb4006316812bf45439",
            "value": "3a27d4370a0a0bb4006316812bf45439"
          }
        }
      ]
    }
  }
}

Create Incident

Creates an Incident with the specified field names and values | key: createIncident

Input	Notes	Example
API Version	The version of the ServiceNow API file_name, to use	v2
Connection
Values	The names of the fields and their values to use when creating a record
Instance URL	The URL of the specific ServiceNow instance to use for API requests	https://instance.service-now.com

Create Table Record

Creates a record in the specified table with the specified field names and values | key: createTableRecord

Input	Notes	Example
API Version	The version of the ServiceNow API file_name, to use	v2
Connection
Values	The names of the fields and their values to use when creating a record
Instance URL	The URL of the specific ServiceNow instance to use for API requests	https://instance.service-now.com
Table	The name of the ServiceNow table in which to create a record	incident

Create User

Creates a User with the specified field names and values | key: createUser

Input	Notes	Example
API Version	The version of the ServiceNow API file_name, to use	v2
Connection
Email	The Email of the User
Values	The names of the fields and their values to use when creating a record
First Name	The User's First Name
Instance URL	The URL of the specific ServiceNow instance to use for API requests	https://instance.service-now.com
Last Name	The User's Last Name
User Id	The Username of the User

Delete Attachment

This method deletes the attachment with a specific sys_id value. | key: deleteAttachment

Input	Notes	Example
API Version	The version of the ServiceNow API file_name, to use	v2
Connection
Instance URL	The URL of the specific ServiceNow instance to use for API requests	https://instance.service-now.com
Sys ID	Sys_id value of the attachment to delete.	d71f7935c0a8016700802b64c67c11c6

{
  "data": ""
}

Delete Configuration Item

Deletes the relation for the specified configuration item (CI). | key: deleteConfigurationItem

Input	Notes	Example
API Version	The version of the ServiceNow API file_name, to use	v2
Class Name	CMDB class name. This is the name of the table that contains the desired CI records	cmdb_ci_linux_server
Connection
Instance URL	The URL of the specific ServiceNow instance to use for API requests	https://instance.service-now.com
Relationship Sys ID	Sys Id of the relation to perform the operation on.	d71f7935c0a8016700802b64c67c11c6
Sys ID	The Sys ID of the record being queried	d71f7935c0a8016700802b64c67c11c6

{
  "data": null
}

Delete Incident

Delete an Incident | key: deleteIncident

Input	Notes	Example
API Version	The version of the ServiceNow API file_name, to use	v2
Connection
Instance URL	The URL of the specific ServiceNow instance to use for API requests	https://instance.service-now.com
Sys ID	The Sys ID of the record being queried	d71f7935c0a8016700802b64c67c11c6

Delete Table Record

Delete a record for a given ID in the specified Table | key: deleteTableRecord

Input	Notes	Example
API Version	The version of the ServiceNow API file_name, to use	v2
Connection
Instance URL	The URL of the specific ServiceNow instance to use for API requests	https://instance.service-now.com
Sys ID	The Sys ID of the record being queried	d71f7935c0a8016700802b64c67c11c6
Table	The name of the ServiceNow table in which to create a record	incident

Delete User

Deletes a User | key: deleteUser

Input	Notes	Example
API Version	The version of the ServiceNow API file_name, to use	v2
Connection
Instance URL	The URL of the specific ServiceNow instance to use for API requests	https://instance.service-now.com
Sys ID	The Sys ID of the record being queried	d71f7935c0a8016700802b64c67c11c6

Get Attachment

Returns the metadata for the attachment file with a specific sys_id value. | key: getAttachment

Input	Notes	Example
API Version	The version of the ServiceNow API file_name, to use	v2
Connection
Instance URL	The URL of the specific ServiceNow instance to use for API requests	https://instance.service-now.com
Sys ID	The Sys ID of the record being queried	d71f7935c0a8016700802b64c67c11c6

{
  "data": {
    "result": {
      "table_sys_id": "5054b6f8c0a800060056addcf551ecf8",
      "size_bytes": "462",
      "download_link": "https://instance.service-now.com/api/now/attachment/615ea769c0a80166001cf5f2367302f5/file",
      "sys_updated_on": "2009-05-21 04:12:21",
      "sys_id": "615ea769c0a80166001cf5f2367302f5",
      "image_height": "",
      "sys_created_on": "2009-05-21 04:12:21",
      "file_name": "blocks.swf",
      "sys_created_by": "glide.maint",
      "compressed": "true",
      "average_image_color": "",
      "sys_updated_by": "glide.maint",
      "sys_tags": "",
      "table_name": "content_block_programmatic",
      "image_width": "",
      "sys_mod_count": "0",
      "content_type": "application/x-shockwave-flash",
      "size_compressed": "485"
    }
  }
}

Get Attachment File

Returns the binary file attachment with a specific sys_id value. | key: getAttachmentFile

Input	Notes	Example
API Version	The version of the ServiceNow API file_name, to use	v2
Connection
Instance URL	The URL of the specific ServiceNow instance to use for API requests	https://instance.service-now.com
Sys ID	The Sys ID of the record being queried	d71f7935c0a8016700802b64c67c11c6

{
  "data": {
    "type": "Buffer",
    "data": [
      102,
      105,
      108,
      101,
      32,
      99,
      111,
      110,
      116,
      101,
      110,
      116,
      115
    ]
  }
}

Get CMDB Class Metadata

Returns the meta data for the specified CMDB class | key: getCMDBClassMetaData

Input	Notes	Example
API Version	The version of the ServiceNow API file_name, to use	v2
Class Name	CMDB class name. This is the name of the table that contains the desired CI records	cmdb_ci_linux_server
Connection
Instance URL	The URL of the specific ServiceNow instance to use for API requests	https://instance.service-now.com

{
  "data": {
    "result": {
      "icon_url": "images/app.ngbsm/computer.svg",
      "is_extendable": true,
      "parent": "cmdb_ci_hardware",
      "children": [
        "cmdb_ci_ucs_blade",
        "cmdb_ci_pc_hardware",
        "cmdb_ci_ucs_rack_unit",
        "cmdb_ci_mainframe_hardware",
        "cmdb_ci_server",
        "cmdb_ci_storage_switch"
      ],
      "name": "cmdb_ci_computer",
      "icon": "c6442dd69fb00200eb3919eb552e7012",
      "attributes": [
        {
          "is_inherited": "false",
          "is_mandatory": "false",
          "is_read_only": "false",
          "default_value": null,
          "label": "OS Address Width (bits)",
          "type": "integer",
          "element": "os_address_width",
          "max_length": "40",
          "is_display": "false"
        },
        {
          "is_inherited": "true",
          "is_mandatory": "false",
          "is_read_only": "true",
          "default_value": "false",
          "label": "Skip sync",
          "type": "boolean",
          "element": "skip_sync",
          "max_length": "40",
          "is_display": "false"
        },
        {
          "is_inherited": "true",
          "is_mandatory": "false",
          "is_read_only": "false",
          "default_value": null,
          "label": "DNS Domain",
          "type": "string",
          "element": "dns_domain",
          "max_length": "255",
          "is_display": "false"
        },
        {
          "is_inherited": "true",
          "is_mandatory": "false",
          "is_read_only": "false",
          "default_value": null,
          "label": "Purchased",
          "type": "glide_date",
          "element": "purchase_date",
          "max_length": "40",
          "is_display": "false"
        },
        {
          "is_inherited": "true",
          "is_mandatory": "false",
          "is_read_only": "false",
          "default_value": null,
          "label": "Lease contract",
          "type": "string",
          "element": "lease_id",
          "max_length": "40",
          "is_display": "false"
        }
      ],
      "relationship_rules": [
        {
          "parent": "cmdb_ci_computer",
          "relation_type": "cb5592603751200032ff8c00dfbe5d17",
          "child": "dscy_route_next_hop"
        },
        {
          "parent": "cmdb_ci_computer",
          "relation_type": "cb5592603751200032ff8c00dfbe5d17",
          "child": "dscy_router_interface"
        },
        {
          "parent": "cmdb_ci_computer",
          "relation_type": "cb5592603751200032ff8c00dfbe5d17",
          "child": "dscy_route_interface"
        },
        {
          "parent": "cmdb_ci_computer",
          "relation_type": "55c95bf6c0a8010e0118ec7056ebc54d",
          "child": "cmdb_ci_storage_pool"
        },
        {
          "parent": "cmdb_ci_computer",
          "relation_type": "55c95bf6c0a8010e0118ec7056ebc54d",
          "child": "cmdb_ci_disk_partition"
        },
        {
          "parent": "cmdb_ci_computer",
          "relation_type": "55c95bf6c0a8010e0118ec7056ebc54d",
          "child": "cmdb_ci_storage_volume"
        },
        {
          "parent": "cmdb_ci_computer",
          "relation_type": "55c95bf6c0a8010e0118ec7056ebc54d",
          "child": "cmdb_ci_storage_device"
        }
      ],
      "label": "Computer",
      "identification_rules": {
        "related_rules": [
          {
            "condition": "",
            "exact_count_match": false,
            "referenced_field": "installed_on",
            "active": true,
            "attributes": "name",
            "allow_fallback": false,
            "table": "cmdb_print_queue_instance",
            "order": 100,
            "allow_null_attribute": false
          }
        ],
        "applies_to": "cmdb_ci_hardware",
        "identifiers": [
          {
            "condition": "valid=true^absent=false^EQ",
            "exact_count_match": true,
            "referenced_field": "cmdb_ci",
            "active": true,
            "attributes": "serial_number,serial_number_type",
            "allow_fallback": false,
            "table": "cmdb_serial_number",
            "order": 100,
            "allow_null_attribute": false
          },
          {
            "condition": null,
            "exact_count_match": false,
            "referenced_field": null,
            "active": true,
            "attributes": "serial_number",
            "allow_fallback": false,
            "table": null,
            "order": 200,
            "allow_null_attribute": false
          },
          {
            "condition": null,
            "exact_count_match": false,
            "referenced_field": null,
            "active": true,
            "attributes": "name",
            "allow_fallback": false,
            "table": null,
            "order": 300,
            "allow_null_attribute": false
          },
          {
            "condition": "install_status!=100^EQ",
            "exact_count_match": true,
            "referenced_field": "cmdb_ci",
            "active": true,
            "attributes": "ip_address,mac_address",
            "allow_fallback": false,
            "table": "cmdb_ci_network_adapter",
            "order": 400,
            "allow_null_attribute": false
          }
        ],
        "name": "Hardware Rule",
        "description": "Identifier for hardware.",
        "active": true,
        "is_independent": true
      }
    }
  }
}

Get Configuration Item Attributes

Returns attributes and relationship information for a specified configuration item (CI) record | key: getConfigurationItemAttributes

Input	Notes	Example
API Version	The version of the ServiceNow API file_name, to use	v2
Class Name	CMDB class name. This is the name of the table that contains the desired CI records	cmdb_ci_linux_server
Connection
Instance URL	The URL of the specific ServiceNow instance to use for API requests	https://instance.service-now.com
Sys ID	The Sys ID of the record being queried	d71f7935c0a8016700802b64c67c11c6

{
  "data": {
    "result": {
      "outbound_relations": [
        {
          "sys_id": "3a62e64ac0a8ce0100aead1e3fd5439f",
          "type": {
            "display_value": "Depends on::Used by",
            "link": "https://instance.servicenow.com/api/now/table/cmdb_rel_type/1a9cb166f1571100a92eb60da2bce5c5",
            "value": "1a9cb166f1571100a92eb60da2bce5c5"
          },
          "target": {
            "display_value": "PS ORA01",
            "link": "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci/3a307c930a0a0bb400353965d0b8861f",
            "value": "3a307c930a0a0bb400353965d0b8861f"
          }
        },
        {
          "sys_id": "3a67513fc0a8ce0100914a76cea11b02",
          "type": {
            "display_value": "Exchanges data with::Exchanges data with",
            "link": "https://instance.servicenow.com/api/now/table/cmdb_rel_type/607ad1b2c0a8010e01941856b365af90",
            "value": "607ad1b2c0a8010e01941856b365af90"
          },
          "target": {
            "display_value": "PS ORA01",
            "link": "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci/3a307c930a0a0bb400353965d0b8861f",
            "value": "3a307c930a0a0bb400353965d0b8861f"
          }
        }
      ],
      "attributes": {
        "firewall_status": "Intranet",
        "os_address_width": "",
        "attested_date": "",
        "operational_status": "1",
        "os_service_pack": "",
        "cpu_core_thread": "",
        "cpu_manufacturer": "",
        "sys_updated_on": "2020-07-08 11:16:51",
        "discovery_source": "",
        "first_discovered": "",
        "due_in": "",
        "used_for": "Production",
        "invoice_number": "",
        "gl_account": "",
        "sys_created_by": "glide.maint",
        "warranty_expiration": "",
        "ram": "2048",
        "cpu_name": "",
        "cpu_speed": "2800",
        "owned_by": "",
        "checked_out": "",
        "kernel_release": "",
        "sys_domain_path": "/",
        "classification": "Production",
        "disk_space": "40",
        "object_id": "",
        "maintenance_schedule": "",
        "cost_center": "",
        "attested_by": "",
        "dns_domain": "",
        "assigned": "2020-01-04 07:00:00",
        "purchase_date": "",
        "life_cycle_stage": "",
        "short_description": "",
        "cd_speed": "",
        "floppy": "",
        "managed_by": {
          "display_value": "Lynda Caraway",
          "link": "https://instance.service-now.com/api/now/table/sys_user/8a826bf03710200044e0bfc8bcbe5d72",
          "value": "8a826bf03710200044e0bfc8bcbe5d72"
        },
        "os_domain": "",
        "last_discovered": "",
        "can_print": "false",
        "sys_class_name": "cmdb_ci_linux_server",
        "manufacturer": {
          "display_value": "Iris",
          "link": "https://instance.servicenow.com/api/now/table/core_company/c115c2f737e3100044e0bfc8bcbe5d46",
          "value": "c115c2f737e3100044e0bfc8bcbe5d46"
        },
        "cpu_count": "1",
        "vendor": {
          "display_value": "Cloudward Inc",
          "link": "https://instance.servicenow.com/api/now/table/core_company/3efe8c4c37423000158bbfc8bcbe5d7d",
          "value": "3efe8c4c37423000158bbfc8bcbe5d7d"
        },
        "life_cycle_stage_status": "",
        "model_number": "",
        "assigned_to": "",
        "start_date": "",
        "os_version": "2.6.9-22.0.1.ELsmp",
        "serial_number": "",
        "cd_rom": "false",
        "support_group": "",
        "unverified": "false",
        "correlation_id": "",
        "attributes": "",
        "asset": {
          "display_value": "P1000091 - Iris 5875",
          "link": "https://instance.servicenow.com/api/now/table/alm_asset/0bc1ba8837f3100044e0bfc8bcbe5dbb",
          "value": "0bc1ba8837f3100044e0bfc8bcbe5dbb"
        },
        "form_factor": "",
        "cpu_core_count": "",
        "skip_sync": "false",
        "attestation_score": "",
        "sys_updated_by": "system",
        "sys_created_on": "2008-10-26 17:17:28",
        "sys_domain": {
          "display_value": "global",
          "link": "https://instance.servicenow.com/api/now/table/sys_user_group/global",
          "value": "global"
        },
        "cpu_type": "Intel",
        "install_date": "2019-08-18 08:00:00",
        "asset_tag": "P1000091",
        "dr_backup": "",
        "hardware_substatus": "",
        "fqdn": "",
        "change_control": "",
        "internet_facing": "false",
        "delivery_date": "",
        "hardware_status": "",
        "install_status": "1",
        "supported_by": "",
        "name": "PS LinuxApp01",
        "subcategory": "",
        "default_gateway": "",
        "chassis_type": "",
        "virtual": "false",
        "assignment_group": "",
        "managed_by_group": "",
        "sys_id": "3a290cc60a0a0bb400000bdb386af1cf",
        "po_number": "",
        "checked_in": "",
        "sys_class_path": "/!!/!2/!(/!!/!0",
        "mac_address": "",
        "company": {
          "display_value": "ACME Corporation",
          "link": "https://instance.servicenow.com/api/now/table/core_company/e7c1f3d53790200044e0bfc8bcbe5deb",
          "value": "e7c1f3d53790200044e0bfc8bcbe5deb"
        },
        "justification": "",
        "department": "",
        "cost": "45557.5",
        "comments": "",
        "os": "Linux Red Hat",
        "sys_mod_count": "24",
        "monitor": "false",
        "model_id": {
          "display_value": "Iris 5875",
          "link": "https://instance.servicenow.com/api/now/table/cmdb_model/5f5fbcc3c0a8010e00f3b27814f3b96b",
          "value": "5f5fbcc3c0a8010e00f3b27814f3b96b"
        },
        "ip_address": "",
        "duplicate_of": "",
        "sys_tags": "",
        "cost_cc": "USD",
        "order_date": "",
        "schedule": "",
        "environment": "",
        "due": "",
        "attested": "false",
        "location": {
          "display_value": "322 West 52nd Street, New York,NY",
          "link": "https://instance.servicenow.com/api/now/table/cmn_location/25ab9f690a0a0bb3001c5fec1d0d7bcb",
          "value": "25ab9f690a0a0bb3001c5fec1d0d7bcb"
        },
        "category": "Do not migrate to asset",
        "fault_count": "0",
        "host_name": "",
        "lease_id": ""
      },
      "inbound_relations": [
        {
          "sys_id": "3a5e4d8ac0a8ce010005145afb730818",
          "type": {
            "display_value": "Depends on::Used by",
            "link": "https://instance.servicenow.com/api/now/table/cmdb_rel_type/1a9cb166f1571100a92eb60da2bce5c5",
            "value": "1a9cb166f1571100a92eb60da2bce5c5"
          },
          "target": {
            "display_value": "PS Apache01",
            "link": "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci/3a27d4370a0a0bb4006316812bf45439",
            "value": "3a27d4370a0a0bb4006316812bf45439"
          }
        },
        {
          "sys_id": "3a5e4d9cc0a8ce010097f2f5c2f65fd8",
          "type": {
            "display_value": "Depends on::Used by",
            "link": "https://instance.servicenow.com/api/now/table/cmdb_rel_type/1a9cb166f1571100a92eb60da2bce5c5",
            "value": "1a9cb166f1571100a92eb60da2bce5c5"
          },
          "target": {
            "display_value": "PS Apache02",
            "link": "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci/3a27f1520a0a0bb400ecd6ff7afcf036",
            "value": "3a27f1520a0a0bb400ecd6ff7afcf036"
          }
        },
        {
          "sys_id": "3a5e4d9fc0a8ce0100a3754fac26fe56",
          "type": {
            "display_value": "Depends on::Used by",
            "link": "https://instance.servicenow.com/api/now/table/cmdb_rel_type/1a9cb166f1571100a92eb60da2bce5c5",
            "value": "1a9cb166f1571100a92eb60da2bce5c5"
          },
          "target": {
            "display_value": "PS Apache03",
            "link": "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci/3a2810c20a0a0bb400268337d6e942ca",
            "value": "3a2810c20a0a0bb400268337d6e942ca"
          }
        }
      ]
    }
  }
}

Get Incident

Gets an Incident by ID | key: getIncident

Input	Notes	Example
API Version	The version of the ServiceNow API file_name, to use	v2
Connection
Instance URL	The URL of the specific ServiceNow instance to use for API requests	https://instance.service-now.com
Sys ID	The Sys ID of the record being queried	d71f7935c0a8016700802b64c67c11c6

Get Knowledge Article

Returns specific knowledge article content and its field values. | key: getKnowledgeArticle

Input	Notes	Example
API Version	The version of the ServiceNow API file_name, to use	v2
Article ID	Sys_id or knowledge base (KB) number of a knowledge article in the Knowledge [kb_knowledge] table.	KB0012345
Connection
Fields	Comma-separated list of fields from the Knowledge [kb_knowledge] table to show details in results.	active,sys_id
Instance URL	The URL of the specific ServiceNow instance to use for API requests	https://instance.service-now.com
Language	List of comma-separated languages in two-letter ISO 639-1 language code format to restrict results to. Alternatively type 'all' to search in all valid installed languages on an instance.	en
Search ID	Optional unless using the 'Search Rank' input. Unique identifier of search that returned this article. You can retrieve this value (articles.id element) using the 'List Knowledge Articles' action.	kb_knowledge:3b0fccee0a0a0b9b00d34b36ea41a43e
Search Rank	Optional unless using the 'Search ID' input. Article search rank by click-rate (articles.rank) that you can retrieve using the 'List Knowledge Articles' action.	1
Update View	Update view count and record an entry for the article in the Knowledge Use [kb_use] table.	false

Get Knowledge Article Attachment

Returns a knowledge article attachment as a file. | key: getKnowledgeArticleAttachment

Input	Notes	Example
API Version	The version of the ServiceNow API file_name, to use	v2
Article Sys ID	Sys_id of the knowledge article with the attachment you intend to retrieve. Located in the Knowledge Bases [kb_knowledge] table.	f2765f9fc0a8011b0120ec1b352bf09b
Attachment Sys ID	Sys_id of record to which the attachment belongs.	f2765f9fc0a8011b0120ec1b352bf09b
Connection
Instance URL	The URL of the specific ServiceNow instance to use for API requests	https://instance.service-now.com

Get Table Record

Get a record for a given ID in the specified Table | key: getTableRecord

Input	Notes	Example
API Version	The version of the ServiceNow API file_name, to use	v2
Connection
Instance URL	The URL of the specific ServiceNow instance to use for API requests	https://instance.service-now.com
Sys ID	The Sys ID of the record being queried	d71f7935c0a8016700802b64c67c11c6
Table	The name of the ServiceNow table in which to create a record	incident

Get User by Id

Gets a User by their Id | key: getUser

Input	Notes	Example
API Version	The version of the ServiceNow API file_name, to use	v2
Connection
Instance URL	The URL of the specific ServiceNow instance to use for API requests	https://instance.service-now.com
Sys ID	The Sys ID of the record being queried	d71f7935c0a8016700802b64c67c11c6

Get User by Username

Get a record for a given ID in the specified Table | key: getUserByUsername

Input	Notes	Example
API Version	The version of the ServiceNow API file_name, to use	v2
Connection
Instance URL	The URL of the specific ServiceNow instance to use for API requests	https://instance.service-now.com
User Id	The Username of the User

List Attachments

Returns the metadata for multiple attachments. | key: listAttachments

Input	Notes	Example
API Version	The version of the ServiceNow API file_name, to use	v2
Connection
Instance URL	The URL of the specific ServiceNow instance to use for API requests	https://instance.service-now.com
Sysparm Limit	Limit to be applied on pagination. Default is 1000. Unusually large values can impact system performance.	100
Sysparm Offset	Starting record index for which to begin retrieving records. This functionality enables the retrieval of all records, regardless of the number of records, in small manageable chunks. For example, the first time you call this endpoint, sysparm_offset is set to '0'. To simply page through all available records, use sysparm_offset=sysparm_offset+sysparm_limit, until you reach the end of all records.	0
Sysparm Query	Encoded query used to filter the result set. Syntax: sysparm_query=<col_name><operator><value>.	active=true^ORDERBYnumber^ORDERBYDESCcategory

{
  "data": {
    "result": [
      {
        "table_sys_id": "5054b6f8c0a800060056addcf551ecf8",
        "size_bytes": "462",
        "download_link": "https://instance.service-now.com/api/now/attachment/615ea769c0a80166001cf5f2367302f5/file",
        "sys_updated_on": "2009-05-21 04:12:21",
        "sys_id": "615ea769c0a80166001cf5f2367302f5",
        "image_height": "",
        "sys_created_on": "2009-05-21 04:12:21",
        "file_name": "blocks.swf",
        "sys_created_by": "glide.maint",
        "compressed": "true",
        "average_image_color": "",
        "sys_updated_by": "glide.maint",
        "sys_tags": "",
        "table_name": "content_block_programmatic",
        "image_width": "",
        "sys_mod_count": "0",
        "content_type": "application/x-shockwave-flash",
        "size_compressed": "485"
      }
    ]
  }
}

List Configuration Items

Returns the available configuration items (CI) for a specified Configuration Management Database (CMDB) class (table) | key: listConfigurationItems

Input	Notes	Example
API Version	The version of the ServiceNow API file_name, to use	v2
Class Name	CMDB class name. This is the name of the table that contains the desired CI records	cmdb_ci_linux_server
Connection
Instance URL	The URL of the specific ServiceNow instance to use for API requests	https://instance.service-now.com
Sysparm Limit	Maximum number of records to return. For requests that exceed this number of records, use the sysparm_offset parameter to paginate record retrieval. Allows numbers from 0 to 100.	100
Sysparm Offset	Starting record index for which to begin retrieving records. Use this value to paginate record retrieval. This functionality enables the retrieval of all records, regardless of the number of records, in small manageable chunks.For example, the first time you call this endpoint, sysparm_offset is set to '0'. To simply page through all available records, use sysparm_offset=sysparm_offset+sysparm_limit, until you reach the end of all records.Don't pass a negative number in the sysparm_offset parameter.	0
Sysparm Query	All parameters are case-sensitive. Queries can contain more than one entry, such as sysparm_query=<col_name><operator><value>[<operator><col_name><operator><value>]. Refer to https://www.servicenow.com/docs/bundle/yokohama-api-reference/page/integrate/inbound-rest/concept/cmdb-instance-api.html#title_cmdb-GET-instance-classname for more information.	ORDERBY<col_name>

{
  "data": {
    "result": [
      {
        "sys_id": "3a290cc60a0a0bb400000bdb386af1cf",
        "name": "PS LinuxApp01"
      }
    ]
  }
}

List Featured Knowledge Articles

Returns a list of the most-viewed knowledge articles and featured knowledge articles. | key: listFeaturedKnowledgeArticles

Input	Notes	Example
API Version	The version of the ServiceNow API file_name, to use	v2
Connection
Fields	Comma-separated list of fields from the Knowledge [kb_knowledge] table to show details in results.	active,sys_id
Instance URL	The URL of the specific ServiceNow instance to use for API requests	https://instance.service-now.com
Knowledge Base Sys ID's	Comma-separated list of knowledge base sys_ids from the Knowledge Bases [kb_knowledge_base] table to restrict results to.	a7e8a78bff0221009b20ffffffffff17,a7e8a78bff0221009b20ffffffffff18
Language	List of comma-separated languages in two-letter ISO 639-1 language code format to restrict results to. Alternatively type 'all' to search in all valid installed languages on an instance.	en
Limit	Maximum number of records to return. Unusually large limit values can impact system performance. For requests that exceed this number of records, use the Offset input to paginate record retrieval.	100
Offset	Starting record index for which to begin retrieving records. Use this value to paginate record retrieval. This functionality enables the retrieval of all records, regardless of the number of records, in small manageable chunks. For example, the first time this endpoint is called, offset is set to '0'.	0

List Incidents

Gets a list of all Incidents | key: listIncidents

Input	Notes	Example
API Version	The version of the ServiceNow API file_name, to use	v2
Connection
Instance URL	The URL of the specific ServiceNow instance to use for API requests	https://instance.service-now.com
Sysparm Limit	Max number of records to return. Large values can impact performance. For pagination with large data sets include the Sysparm Offset	100
Sysparm Offset	Starting record index for which to begin retrieving records. This functionality enables the retrieval of all records, regardless of the number of records, in small manageable chunks. For example, the first time you call this endpoint, sysparm_offset is set to '0'. To simply page through all available records, use sysparm_offset=sysparm_offset+sysparm_limit, until you reach the end of all records.	0
Sysparm Query	Encoded query used to filter the result set. Syntax: sysparm_query=<col_name><operator><value>.	active=true^ORDERBYnumber^ORDERBYDESCcategory

List Knowledge Articles

Returns a list of knowledge base (KB) articles which can be searched and filtered using various parameters. | key: listKnowledgeArticles

Input	Notes	Example
API Version	The version of the ServiceNow API file_name, to use	v2
Connection
Fields	Comma-separated list of fields from the Knowledge [kb_knowledge] table to show details in results.	active,sys_id
Filter	Encoded query to use to filter the result set.	score=-1.0^ORDERBYnumber
Instance URL	The URL of the specific ServiceNow instance to use for API requests	https://instance.service-now.com
Knowledge Base Sys ID's	Comma-separated list of knowledge base sys_ids from the Knowledge Bases [kb_knowledge_base] table to restrict results to.	a7e8a78bff0221009b20ffffffffff17,a7e8a78bff0221009b20ffffffffff18
Language	List of comma-separated languages in two-letter ISO 639-1 language code format to restrict results to. Alternatively type 'all' to search in all valid installed languages on an instance.	en
Limit	Maximum number of records to return. Unusually large limit values can impact system performance. For requests that exceed this number of records, use the Offset input to paginate record retrieval.	100
Offset	Starting record index for which to begin retrieving records. Use this value to paginate record retrieval. This functionality enables the retrieval of all records, regardless of the number of records, in small manageable chunks. For example, the first time this endpoint is called, offset is set to '0'.	0
Query	Text to search for, can be empty.	incident

List Most Viewed Knowledge Articles

Returns a list of knowledge articles prioritized by most-viewed. | key: listMostViewedKnowledgeArticles

Input	Notes	Example
API Version	The version of the ServiceNow API file_name, to use	v2
Connection
Fields	Comma-separated list of fields from the Knowledge [kb_knowledge] table to show details in results.	active,sys_id
Instance URL	The URL of the specific ServiceNow instance to use for API requests	https://instance.service-now.com
Knowledge Base Sys ID's	Comma-separated list of knowledge base sys_ids from the Knowledge Bases [kb_knowledge_base] table to restrict results to.	a7e8a78bff0221009b20ffffffffff17,a7e8a78bff0221009b20ffffffffff18
Language	List of comma-separated languages in two-letter ISO 639-1 language code format to restrict results to. Alternatively type 'all' to search in all valid installed languages on an instance.	en
Limit	Maximum number of records to return. Unusually large limit values can impact system performance. For requests that exceed this number of records, use the Offset input to paginate record retrieval.	100
Offset	Starting record index for which to begin retrieving records. Use this value to paginate record retrieval. This functionality enables the retrieval of all records, regardless of the number of records, in small manageable chunks. For example, the first time this endpoint is called, offset is set to '0'.	0

List Table Records

Lists records in the specified table | key: listTableRecords

Input	Notes	Example
API Version	The version of the ServiceNow API file_name, to use	v2
Connection
Instance URL	The URL of the specific ServiceNow instance to use for API requests	https://instance.service-now.com
Sysparm Limit	Max number of records to return. Large values can impact performance. For pagination with large data sets include the Sysparm Offset	100
Sysparm Offset	Starting record index for which to begin retrieving records. This functionality enables the retrieval of all records, regardless of the number of records, in small manageable chunks. For example, the first time you call this endpoint, sysparm_offset is set to '0'. To simply page through all available records, use sysparm_offset=sysparm_offset+sysparm_limit, until you reach the end of all records.	0
Sysparm Query	Encoded query used to filter the result set. Syntax: sysparm_query=<col_name><operator><value>.	active=true^ORDERBYnumber^ORDERBYDESCcategory
Table	The name of the ServiceNow table in which to create a record	incident

List Tables

Retrieve a list of all tables | key: listTables

Input	Notes	Example
Connection
Instance URL	The URL of the specific ServiceNow instance to use for API requests	https://instance.service-now.com
Sysparm Fields	Comma-separated list of fields to return. If not specified, all fields are returned.	sys_id,label
Sysparm Limit	Max number of records to return. Large values can impact performance. For pagination with large data sets include the Sysparm Offset	100
Sysparm Offset	Starting record index for which to begin retrieving records. This functionality enables the retrieval of all records, regardless of the number of records, in small manageable chunks. For example, the first time you call this endpoint, sysparm_offset is set to '0'. To simply page through all available records, use sysparm_offset=sysparm_offset+sysparm_limit, until you reach the end of all records.	0
Sysparm Query	Encoded query used to filter the result set. Syntax: sysparm_query=<col_name><operator><value>.	active=true^ORDERBYnumber^ORDERBYDESCcategory

List Users

Gets a list of all Users | key: listUsers

Input	Notes	Example
API Version	The version of the ServiceNow API file_name, to use	v2
Connection
Instance URL	The URL of the specific ServiceNow instance to use for API requests	https://instance.service-now.com
Sysparm Limit	Max number of records to return. Large values can impact performance. For pagination with large data sets include the Sysparm Offset	100
Sysparm Offset	Starting record index for which to begin retrieving records. This functionality enables the retrieval of all records, regardless of the number of records, in small manageable chunks. For example, the first time you call this endpoint, sysparm_offset is set to '0'. To simply page through all available records, use sysparm_offset=sysparm_offset+sysparm_limit, until you reach the end of all records.	0
Sysparm Query	Encoded query used to filter the result set. Syntax: sysparm_query=<col_name><operator><value>.	active=true^ORDERBYnumber^ORDERBYDESCcategory

Multipart Upload Attachment

Uploads a multipart file attachment. | key: multipartUploadAttachment

Input	Notes	Example
API Version	The version of the ServiceNow API file_name, to use	v2
Connection
File	The file to attach to the record.
File Name	Name to give the attachment.	issue_screenshot
Instance URL	The URL of the specific ServiceNow instance to use for API requests	https://instance.service-now.com
Sys ID	Sys_id of the record on the specified table to which you want to attach the file.	d71f7935c0a8016700802b64c67c11c6
Table	Name of the table to which you want to attach the file.	incident

{
  "data": {
    "result": {
      "table_sys_id": "d71f7935c0a8016700802b64c67c11c6",
      "size_bytes": "36597",
      "download_link": "https://instance.service-now.com/api/now/attachment/994adbc64f511200adf9f8e18110c796/file",
      "sys_updated_on": "2016-02-02 14:00:21",
      "sys_id": "994adbc64f511200adf9f8e18110c796",
      "image_height": "",
      "sys_created_on": "2016-02-02 14:00:21",
      "file_name": "banner-CS0001345_v1_1.jpeg",
      "sys_created_by": "admin",
      "compressed": "true",
      "average_image_color": "",
      "sys_updated_by": "admin",
      "sys_tags": "",
      "table_name": "incident",
      "image_width": "",
      "sys_mod_count": "0",
      "content_type": "image/jpeg",
      "size_compressed": "25130"
    }
  }
}

Raw Request

Send raw HTTP request to ServiceNow | key: rawRequest

Input	Notes	Example
API Version	The version of the ServiceNow API file_name, to use	v2
Connection
Data	The HTTP body payload to send to the URL.	{"exampleKey": "Example Data"}
File Data	File Data to be sent as a multipart form upload.	[{key: "example.txt", value: "My File Contents"}]
File Data File Names	File names to apply to the file data inputs. Keys must match the file data keys above.
Form Data	The Form Data to be sent as a multipart form upload.	[{"key": "Example Key", "value": new Buffer("Hello World")}]
Header	A list of headers to send with the request.	User-Agent: curl/7.64.1
Instance URL	The URL of the specific ServiceNow instance to use for API requests	https://instance.service-now.com
Max Retry Count	The maximum number of retries to attempt. Specify 0 for no retries.	0
Method	The HTTP method to use.
Query Parameter	A list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2.
Response Type	The type of data you expect in the response. You can request json, text, or binary data.	json
Retry On All Errors	If true, retries on all erroneous responses regardless of type. This is helpful when retrying after HTTP 429 or other 3xx or 4xx errors. Otherwise, only retries on HTTP 5xx and network errors.	false
Retry Delay (ms)	The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled.	0
Sys ID	The Sys ID of the record being queried	d71f7935c0a8016700802b64c67c11c6
Table	The name of the ServiceNow table in which to create a record	incident
Timeout	The maximum time that a client will await a response to its request	2000
Use Exponential Backoff	Specifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored.	false

Update Configuration Item

Updates a single configuration item (CI) with the specified outbound and inbound relations within the specified Configuration Management Database (CMDB) table. | key: updateConfigurationItem

Input	Notes	Example
API Version	The version of the ServiceNow API file_name, to use	v2
Class Name	CMDB class name. This is the name of the table that contains the desired CI records	cmdb_ci_linux_server
Configuration Item Attributes	The attributes of the configuration item to create.
Configuration Item Source	Entity that created/updated the information. This must be one of the choice values specified in the discovery_source field in the Configuration Item [cmdb_ci] table.	ServiceNow
Connection
Instance URL	The URL of the specific ServiceNow instance to use for API requests	https://instance.service-now.com
Sys ID	The Sys ID of the record being queried	d71f7935c0a8016700802b64c67c11c6

Update Incident

Updates an Incident with the specified field names and values | key: updateIncident

Input	Notes	Example
API Version	The version of the ServiceNow API file_name, to use	v2
Connection
Values	The names of the fields and their values to use when creating a record
Instance URL	The URL of the specific ServiceNow instance to use for API requests	https://instance.service-now.com
Sys ID	The Sys ID of the record being queried	d71f7935c0a8016700802b64c67c11c6

Update Table Record

Updates a record in the specified table with the specified field names and values | key: updateTableRecord

Input	Notes	Example
API Version	The version of the ServiceNow API file_name, to use	v2
Connection
Values	The names of the fields and their values to use when creating a record
Instance URL	The URL of the specific ServiceNow instance to use for API requests	https://instance.service-now.com
Sys ID	The Sys ID of the record being queried	d71f7935c0a8016700802b64c67c11c6
Table	The name of the ServiceNow table in which to create a record	incident

Update User

Updates a User with the specified field names and values | key: updateUser

Input	Notes	Example
API Version	The version of the ServiceNow API file_name, to use	v2
Connection
Email	The Email of the User
Values	The names of the fields and their values to use when creating a record
First Name	The User's First Name
Instance URL	The URL of the specific ServiceNow instance to use for API requests	https://instance.service-now.com
Last Name	The User's Last Name
Sys ID	The Sys ID of the record being queried	d71f7935c0a8016700802b64c67c11c6
User Id	The Username of the User

Upload Attachment

Uploads a specified binary file as an attachment to a specified record. | key: uploadAttachment

Input	Notes	Example
API Version	The version of the ServiceNow API file_name, to use	v2
Connection
File	The file to attach to the record.
File Name	Name to give the attachment.	issue_screenshot
Instance URL	The URL of the specific ServiceNow instance to use for API requests	https://instance.service-now.com
Sys ID	Sys_id of the record in the table specified in table_name that you want to attach the file to.	d71f7935c0a8016700802b64c67c11c6
Table	Name of the table to attach the file to.	incident

{
  "data": {
    "result": {
      "average_image_color": "String",
      "compressed": "String",
      "content_type": "String",
      "created_by_name": "String",
      "download_link": "String",
      "file_name": "String",
      "image_height": "String",
      "image_width": "String",
      "size_bytes": "String",
      "size_compressed": "String",
      "sys_created_by": "String",
      "sys_created_on": "String",
      "sys_id": "String",
      "sys_mod_count": "String",
      "sys_tags": "String",
      "sys_updated_by": "String",
      "sys_updated_on": "String",
      "table_name": "String",
      "table_sys_id": "String",
      "updated_by_name": "String"
    }
  }
}

Changelog

2025-09-24

Added inline data sources for attachments

2025-07-22

Added CMDB (Configuration Management Database) actions for comprehensive IT asset and configuration management.

Create records and incidents within ServiceNow

Description​

Connections​

OAuth 2.0 Authorization Code​

Basic Username/Password​

Data Sources​

Select Attachment​

Select Table​

Actions​

Create Configuration Item​

Create Incident​

Create Table Record​

Create User​

Delete Attachment​

Delete Configuration Item​

Delete Incident​

Delete Table Record​

Delete User​

Get Attachment​

Get Attachment File​

Get CMDB Class Metadata​

Get Configuration Item Attributes​

Get Incident​

Get Knowledge Article​

Get Knowledge Article Attachment​

Get Table Record​

Get User by Id​

Get User by Username​

List Attachments​

List Configuration Items​

List Featured Knowledge Articles​

List Incidents​

List Knowledge Articles​

List Most Viewed Knowledge Articles​

List Table Records​

List Tables​

List Users​

Multipart Upload Attachment​

Raw Request​

Update Configuration Item​

Update Incident​

Update Table Record​

Update User​

Upload Attachment​

Changelog​

2025-09-24​

2025-07-22​