ServiceNow (version v1.*.*)

Type: string

sysparm_avg_fields#

List of fields on which to perform the avg operation

Type: array

[ "string" ]

sysparm_count#

Flag that determines whether to return the number of records returned by the query.

Type: boolean

sysparm_display_value#

Data retrieval operation for reference and choice fields. Based on this value, retrieves the display value and/or the actual value from the database. Valid values: true: returns the display values for all fields. false: returns the actual values from the database. all: returns both actual and display values. Default: false Note: There is no preferred method for setting this parameter. However, specifying the display value may cause performance issues since it is not reading directly from the database and may include referencing other fields and records. For more information on display values and actual values, see Table API FAQs (KB0534905).

Type: string

Potential values: true, false, all

sysparm_group_by#

Fields by which to group the returned data.

Type: array

[ "string" ]

sysparm_having#

Additional query that enables you to filter the data based on an aggregate operation. The value for this parameter must follow the syntax aggregate^field^operator^value, such as count^priority^>^3 to obtain the number of records within the query results with a priority greater than 3. You can specify multiple queries by separating each with a comma, such ascount^state^=^1,avg^priority^>^3.

Type: string

sysparm_max_fields#

List of fields on which to perform the max operation

Type: array

[ "string" ]

sysparm_min_fields#

List of fields on which to perform the min operation

Type: array

[ "string" ]

sysparm_orderby#

List of values by which to order grouped results. You can specify an order using a field or an aggregate. For example, if you specify sysparm_orderby=AVG^state, groups of results with lower average state values are returned first. You can also order by COUNT to arrange groups of records by the number of records in each group. When you specify an order, groups are ordered in ascending order by default. Use ^DESC to sort in descending order, such as sysparm_orderby=state^DESC.

Type: string

sysparm_query#

An encoded query. For example: (sysparm_query=active=true)(sysparm_query=caller_id=javascript:gs.getUserID()^active=true)

Type: string

sysparm_sum_fields#

List of fields on which to perform the sum operation

Type: array

[ "string" ]

associate_ci_with_change_request#

Creates the association between a change request and CMDB CIs. The creation of the association is done asynchronously, which means that a response is provided immediately and contains details for the worker. The worker does the actual work after the response.

Parameters

change_request_id (required)#

Unique identifier of the change request to retrieve from the [change_request] table.

Type: string

$body#

Type: object

{
  "refresh_impacted_services" : "Flag used when association_type=affected to populate impacted services based on the list of affected CIs.",
  "cmdb_ci_sys_ids" : [ "string" ],
  "association_type" : "Type of association between the CMDB CI and the change request."
}

data#

Fields to modify when creating the request. The key is the field name within the template and the value is the information to populate in the field.

Type: object

{ }

create_ci#

Create a single CI with associated outbound and inbound relations. If the class has a dependent identification rule defined,then the input payload must contain the sys_id of the parent CI.

Parameters

class_name (required)#

The CMDB class name.

Type: string

$body#

Type: object

{
  "depends_on" : {
    "inbound_relation" : {
      "relation_type" : "string",
      "target" : "string"
    }
  },
  "outbound_relations" : [ {
    "rel_type" : "string",
    "target" : "string"
  } ],
  "attributes" : { },
  "inbound_relations" : [ {
    "rel_type" : "string",
    "target" : "string"
  } ],
  "source" : "string"
}

create_commit_for_tool#

Creates a Commit object in the Commit [sn_devops_commit] table for the specified DevOps tool and code commit.

Parameters

toolId (required)#

Sys ID of the DevOps tool to associate with the commit. The Sys ID is located in the Code Tool [sn_devops_code_tool] table.

Type: string

$body#

Type: object

{
  "revert" : "Flag that indicates whether code was reverted during the commit.",
  "message" : "Message included with the commit.",
  "repository" : {
    "name" : "Name of the repository.",
    "url" : "URL of the repository in the source DevOps tool."
  },
  "branch" : {
    "path" : "string",
    "name" : "string",
    "repository" : {
      "name" : "string",
      "description" : "string",
      "id" : "string",
      "url" : "string"
    }
  },
  "url" : "URL of the commit.",
  "apiURL" : "API URL of the commit.",
  "committer" : {
    "name" : "string",
    "id" : "string",
    "userName" : "string",
    "email" : "string"
  },
  "committedDate" : "Date/time on which the code was committed in source DevOps tool.",
  "merge" : "Flag that indicates whether the code was merged when it was committed.",
  "aggregates" : {
    "totalAdditions" : "Total number of files that were added in the commit.",
    "totalDeletions" : "Total number of files that were deleted in the commit.",
    "totalFiles" : "Total number of files that were added, deleted, or changed by the commit.",
    "totalChanges" : "Total number of files that were modified."
  },
  "details" : {
    "file" : "Path of the file that was modified relative to the branch.",
    "additions" : "integer",
    "deletions" : "integer",
    "changes" : "integer",
    "action" : "string",
    "totalChanges" : "integer"
  },
  "id" : "Commit ID from the source coding tool.",
  "nativeId" : "Identifier of the task associated with the commit, such as a JIRA Story or defect number. This field is used to map a commit to a planning tool work item.",
  "planningToolId" : "Sys ID of the planning tool associated with the code tool. This field is used to map a commit to a planning tool work item."
}

dryRun#

Flag that indicates whether to only validate the request body parameters - record is not actually saved to the table.

Type: boolean

create_csm_case#

You can create different types of CSM cases depending on whether you are working in a business-to-business (B2B) or business-to-consumer (B2C) environment, or creating a case for an order or product.

Parameters

$body#

Type: object

{
  "parent" : "Unique identifier (sys_id) of the parent case to which this case (child) is associated; Task [task] table.",
  "made_sla" : "Flag that indicates whether the case was resolved in alignment with the associated service level agreement.",
  "caused_by" : "Unique identifier (sys_id) of the change request that caused the case to be created; Change Request [change_request] table.Data",
  "watch_list" : "List of unique identifiers (sys_id) of the users who receive notifications about this case when additional comments are added or if the state of a case is changed to Resolved or Closed; User [sys_user] table.",
  "active_escalation" : "Unique identifier (sys_id) of the active account escalation record associated with the case; Escalation [sn_customerservice_escalation] table.",
  "upon_reject" : "Action to take if the case is rejected.",
  "support_manager" : "Unique identifier (sys_id) of the CSM manager assigned to the case; User [sys-user] table.",
  "social_channel" : "Type of social media channel such as Twitter, Facebook, or Instagram.Data",
  "skills" : "List of the unique identifiers (sys_id) of the skills needed to complete the case; Skill [cmn_skill] table.",
  "number" : "Case number.",
  "resolved_by" : "Unique identifier (sys_id) of the person that resolved the case; User [sys_user] table.",
  "social_post_url" : "URL of the social message from which the case is being generated.",
  "problem" : "Unique identifier (sys_id) of the issue that the customer is encountering; Problem [problem] table.",
  "opened_by" : "Unique identifier (sys_id) of the person that initially opened the case; User [sys_user] table.",
  "user_input" : "Additional user input.",
  "contact" : "Business-to-business based cases only. Unique identifier (sys_id) of the person to contact regarding this case; Contact [customer_contact] table.",
  "state" : "Current state of the case. Possible values are 1: new, 2: open, 3: awaiting info, 4: resolved, 5: closed",
  "knowledge" : "Flag that indicates if there is a knowledge base article available for the specified issue.",
  "order" : "Order of the case.",
  "closed_at" : "Date and time that the case was closed.",
  "cmdb_ci" : "Unique identifier (sys_id) of the configuration item associated with the case; Configuration Item [cmdb_ci] table.",
  "delivery_plan" : "Unique identifier (sys_id) of the parent execution plan for this case; Execution Plan [sc_cat_item_delivery_plan] table.",
  "contract" : "Unique identifier (sys_id) of the contract associated with the case; Contract [ast_contract] table. This contract contains information about the type of support that is provided to the company associated to the case. A contract can include a company and contact and the specific assets that are covered. A contract can also include multiple service entitlements and SLAs.",
  "impact" : "Impact on customer. Possible values are 1-high, 2-medium, 3-low",
  "active" : "Flag that indicates whether the case is open andactive.",
  "follow_the_sun" : "Flag that indicates whether the case should be handed-off for global follow-up. If a customer enters additional comments on a Priority 1 - Critical or a Priority 2 - High case, or if the case is escalated, the flag is automatically set to true.",
  "work_notes_list" : "List of unique identifiers (sys_id) of the internal users who receive notifications about this case when work notes are added; User [sys_user] table.",
  "business_service" : "Unique identifier (sys_id) of the business service record associated with the case; Business Service [cmdb_ci_service] table.",
  "entitlement" : "Unique identifier (sys_id) of the entitlement record associated with the case; Entitlement [service_entitlement] table. Entitlements define the type of support that a customer receives as well as the supported communication channels. An entitlement can be associated with a product, an asset, an account, or a contract.",
  "auto_created_case" : "Flag that indicates whether the case was automatically generated by another action/event.",
  "business_impact" : "Impact of the issue on the associated customer.",
  "priority" : "Priority of the case. Possible values are 1- critical, 2- high, 3- moderate, 4- low",
  "sys_domain_path" : "Domain path.",
  "time_worked" : "Total amount of time worked on the case.",
  "expected_start" : "Date and time when work is scheduled to begin on the case.",
  "rejection_goto" : "Unique identifier of the task to execute if the case is rejected; Task [task] table.",
  "opened_at" : "Date and time that the case was opened.",
  "business_duration" : "Length in calendar work hours, work days, and work weeks that it took to complete the case.",
  "first_response_time" : "Date and time when the first action was taken on the case.",
  "group_list" : "List of unique identifiers (sys_id) of the group records associated with the case; Group [sys_user_group] table.",
  "child_case_creation_progress" : "Flag that indicates whether the case is a child case that was created from a major case.",
  "work_end" : "Date and time work ended on the case.",
  "resolved_at" : "Date and time that the case was resolved.",
  "sync_driver" : "Flag that indicates whether there is driver synchronization.",
  "social_handle_url" : "URL of the user's social media handle.",
  "subcategory" : "Case subcategory.Value is 0- question",
  "wf_activity" : "Unique identifier (sys_id) of the workflow activity record associated with the case; Workflow Activity [wf_activity] table.",
  "short_description" : "Concise description of the case.",
  "correlation_display" : "Correlation display.",
  "delivery_task" : "Unique identifier (sys_id) of the execution plan task; Execution Plan Task [sc_cat_item_delivery_task] table.",
  "work_start" : "Date and time that work started on the case.",
  "assignment_group" : "Unique identifier (sys_id) of the customer service agent group assigned to the case; Group [sys_user_group] table.",
  "social_handle_type" : "Type of case to associate the social media profile.",
  "additional_assignee_list" : [ "string" ],
  "recipient_list" : "Unique identifier (sys_id) of the record that contains the list of recipients for communications about this case; Recipients List [sn_publications_recipients_list] table.",
  "cause" : "Details about the cause of the problem.",
  "description" : "Detailed description of the problem associated with the case.",
  "close_notes" : "Notes made when the case was closed.",
  "notify" : "Method to use to notify contact/consumer. Possible values are 1- do not notify, 2- send email, 3- telephone",
  "closed_by" : "Unique identifier (sys_id) of the user that closed the case; User [sys_user] table.",
  "contact_type" : "Method in which the case was initially reported.",
  "resolution_code" : "Resolution state for the case, such as \"Solved - Fixed by Support/Guidance provided\".",
  "probable_cause" : "Possible cause of the issue associated with the case.",
  "urgency" : "Urgency of the case.Possible values are 1- high, 2- medium, 3- low",
  "company" : "Unique identifier (sys_id) of the company associated with the case; Company [core_company] table.",
  "reassignment_count" : "Number of times that the case was reassigned to a person that is responsible for moving the case forward.",
  "contact_time_zone" : "Time zone of the contact associated with the case.",
  "notes_to_comments" : "Flag that indicates whether to the add resolution notes to the comments.",
  "activity_due" : "Date for which the associated date is expected to be completed.",
  "consumer" : "Business-to-consumer cases only. Unique identifier (sys_id) of the person to contact with regards to this case; Consumer [csm_consumer] table.",
  "major_case_state" : "Current state of the major case. Possible values are proposed- initial state when an agent or manager creates or proposes a candidate case, accepted- initial state when a manager creates a major case or when a manager promotes a candidate case, rejected- manager rejected candidate case, canceled- case is canceled.",
  "assigned_to" : "Unique identifier (sys_id) of the person assigned to the case; User [sys_user] table.",
  "product" : "Unique identifier (sys_id) of the product model of the asset associated to the case; Product Model [cmdb_model] table. A model is a specific version or configuration of an asset (for example, Apple Mac Book Pro).",
  "variables" : "Name/value pairs of variables associated with the case.",
  "comments" : "Additional comments about the case.",
  "approval" : "String that describes the type of approval required.",
  "sla_due" : "Date/time at which the case must be closed based on the associated service level agreement.",
  "change" : "Unique identifier (sys_id) of the change request that caused the case to be created; Change Request [change_request] table.",
  "due_date" : "Date that the case is due to be closed.",
  "social_handle" : "User handle on the channel.",
  "partner" : "Unique identifier (sys_id) of the partner associated with the case; Account [customer_account] table.",
  "escalation" : "Current escalation level. Possible values are 0-normal, 1-moderate, 2-high, 3-overdue",
  "upon_approval" : "Action to take if the case is approved.",
  "partner_contact" : "Unique identifier (sys_id) of the partner contact associated with the case; Contact [customer_contact] table.",
  "correlation_id" : "Correlation identifier.",
  "active_account_escalation" : "Unique identifier (sys_id) of the active account escalation record associated with the case; Escalation [sn_customerservice_escalation] table.",
  "location" : "Unique identifier (sys_id) of the record describing the company location; Location [cmn_location] table.",
  "category" : "Case category. Possible values are 0-question, 1-issue, 2-feature",
  "account" : "Unique identifier (sys_id) of the account associated with the case; located in the Account [customer_account] table."
}

create_csm_consumer#

Creates a new CSM consumer.

Parameters

$body#

Type: object

{
  "country" : "Country in which the consumer resides.",
  "notes" : "Notes on consumer.",
  "gender" : "Gender of the consumer.",
  "city" : "City in which the consumer resides.",
  "prefix" : "Consumer name prefix such as, Dr., Mr., Mrs., or Ms.",
  "suffix" : "Consumer name suffix such as Jr., Sr., or II.",
  "title" : "Consumer business title such as Manager, Software Developer, or Contractor.",
  "social_channel" : "Social media channel to which the consumer is associated such as Twitter, Facebook, or Instagram.",
  "notification" : "Indicates whether the consumer should receive notifications. Valid values are 1: disabled, 2: enabled",
  "business_phone" : "Business phone number of the consumer.",
  "mobile_phone" : "Consumer mobile phone number.",
  "street" : "Consumer street address.",
  "state" : "State in which the consumer resides.",
  "fax" : "Fax number of the consumer.",
  "first_name" : "Consumer first name.",
  "email" : "Email address of the consumer.",
  "preferred_language" : "Consumer primary language.",
  "zip" : "Consumer zip code.",
  "home_phone" : "Home phone number of the consumer.",
  "time_format" : "Format in which to display time.",
  "social_handle" : "User handle on the social media channel.",
  "active" : "Flag that indicates whether the consumer is active.",
  "last_name" : "Consumer last name.",
  "photo" : "Photo of the consumer.",
  "middle_name" : "Consumer middle name.",
  "time_zone" : "Consumer time zone, such as Canada/Central or US/Eastern.",
  "name" : "Consumer full name; first_name+middle_name+last_name.",
  "household" : "Unique identifier (sys_id) of the record that describes the household characteristics; Household [csm_household] table.",
  "date_format" : "Format in which to display dates.",
  "social_handle_url" : "URL to the consumer's social channel handle.",
  "user" : "Unique identifier (sys_id) of the consumer user; Consumer User [csm_consumer_user] table.",
  "primary" : "Flag that indicates whether this is the primary consumer."
}

create_devops_tool#

Creates a planning, coding, or task execution DevOps tool record within your ServiceNow instance.

Parameters

$body#

Type: object

{
  "name" : "Display name of the DevOps tool.",
  "type" : "Type of DevOps tool.",
  "url" : "URL to use to access the DevOps tool."
}

dryRun#

Flag that indicates whether to only validate the request body parameters - record is not actually saved to the table.

Type: boolean

create_email#

This method creates the email record specified in the request body.

Parameters

$body#

Type: object

{
  "cc" : "Specifies the copied recipients of the email message. Maps to the copied field. You can only specify up to 100 addresses in this field.",
  "headers" : "Specify an array of custom headers you want to include in the email message. Custom headers must begin with an X- prefix. These custom headers are reserved for ServiceNow only and produce a 400 status code error: X-ServiceNow X-Service-Now",
  "bcc" : "Specifies the blind copied recipients of the email message. Maps to the blind_copied field. You can only specify up to 100 addresses in this field.",
  "subject" : "Specifies the subject of the email message. Maps to the subject field.",
  "importance" : "Specifies the importance of the email message. Maps to the importance field.",
  "html" : "Specifies the HTML-enabled body of the email message. Maps to the body field.",
  "to" : "Specifies the direct recipients of the email message. Maps to the recipients field. You can only specify up to 100 addresses in this field.",
  "text" : "Specifies the text-only body of the email message. Maps to the body_text field.",
  "table_record_id" : "Specifies the target-related record to which the email applies. Use this parameter to associate an email message to a particular related record elsewhere in the system. This parameter also requires specifying the table_name parameter.",
  "table_name" : "Specifies the table of the related record to which the email applies. Use this parameter to associate an email message to a particular related record elsewhere in the system. This parameter also requires specifying the table_record_id parameter."
}

create_emergency_change_request#

Creates one emergency change request based on the default emergency change request record. Multiple emergency change request creations within a single call is not supported.

Parameters

data#

Fields to modify when creating the request. The key is the field name within the template and the value is the information to populate in the field.

Type: object

{ }

create_execution_entry#

Creates an orchestration task execution entry in the Task Execution [sn_devops_task_execution] table.

Parameters

toolId (required)#

Sys ID of the DevOps tool to associate with the commit. The Sys ID is located in the Code Tool [sn_devops_code_tool] table.

Type: string

$body#

Type: object

{
  "result" : "Execution result of the task execution.",
  "number" : "Task execution number.",
  "startDateTime" : "Date/time that the task execution started.",
  "upstream" : {
    "url" : "string"
  },
  "orchestrationTaskDetails" : {
    "name" : "string",
    "url" : "string"
  },
  "changes" : "Total number of changes that were made.",
  "triggerType" : "Required string. Possible values: upstream | user | scm",
  "endDateTime" : "Name of the orchestration task.",
  "url" : "URL of the associated orchestration tool's orchestration task."
}

dryRun#

Flag that indicates whether to only validate the request body parameters - record is not actually saved to the table.

Type: boolean

create_normal_change_request#

Creates one normal change request based on the default normal change request record. Multiple normal change request creations within a single call is not supported.

Parameters

data#

Fields to modify when creating the request. The key is the field name within the template and the value is the information to populate in the field.

Type: object

{ }

create_orchestration_task#

Creates an orchestration task in the Orchestration Task [sn_devops_orchestration_task] table.

Parameters

toolId (required)#

Sys ID of the DevOps tool to associate with the commit. The Sys ID is located in the Code Tool [sn_devops_code_tool] table.

Type: string

$body#

Type: object

{
  "name" : "Name of the orchestration task.",
  "url" : "URL of the associated orchestration tool's orchestration task."
}

dryRun#

Flag that indicates whether to only validate the request body parameters - record is not actually saved to the table.

Type: boolean

create_record#

Creates a record and returns the Table API relative path and redirect URL to access the created record.

Parameters

item_id (required)#

Unique identifier (sys_id) of the catalog item to return.

Type: string

$body#

Type: object

{
  "variables" : { }
}

sysparm_fields#

A comma-separated list of fields to return in the response.

Type: array

[ "string" ]

sysparm_view#

Device on which the item can display. If you also specify the sysparm_fields parameter, it takes precedent.

Type: string

Potential values: mobile, desktop, both

create_record_in_table#

Inserts one record in the specified table. Multiple record insertion is not supported by this method.

Parameters

table_name (required)#

Name of the table.

Type: string

$body#

Field name and the associated value for each parameter to define in the specified record. All fields within a record may not be available for update. For example, fields that have a prefix of "sys_" are typically system parameters that are automatically generated and cannot be updated. Fields that are not specified and not auto generated by the system are set to the associated data type's null value.

Type: object

{ }

sysparm_display_value#

Type: string

Potential values: true, false, all

sysparm_fields#

A comma-separated list of fields to return in the response.

Type: array

[ "string" ]

sysparm_input_display_value#

Flag that indicates whether to set field values using the display value or the actual value. If this parameter is set to true, pay attention to input values, especially date values, as these are interpreted as being supplied via the user time zone preference and are transformed into UTC format. To set the value of an encrypted field, you must set this parameter to true. If this parameter is not set to true, values submitted to encrypted fields are not saved. Additionally, the requesting user must have the appropriate encryption context prior to submitting the request. Encrypted fields are hidden for users without the appropriate encryption context. For more information on display values and actual values, see Table API FAQs (KB0534905).

Type: boolean

sysparm_view#

Device on which the item can display. If you also specify the sysparm_fields parameter, it takes precedent.

Type: string

Potential values: mobile, desktop, both

create_repository_for_tool#

Creates a Repository object in the Repository [sn_devops_repository] table for the specified DevOps tool.

Parameters

toolId (required)#

Sys ID of the DevOps tool to associate with the commit. The Sys ID is located in the Code Tool [sn_devops_code_tool] table.

Type: string

$body#

Type: object

{
  "name" : "Name of the repository.",
  "url" : "URL of the repository."
}

dryRun#

Flag that indicates whether to only validate the request body parameters - record is not actually saved to the table.

Type: boolean

create_standard_change_request#

Type: string

$body#

Type: object

{
  "document_sys_id" : "Unique ID of the document to be routed to the queue",
  "document_table" : "Name of the table associated with the document, e.g., incident"
}

create_version#

Creates a version or release for an application within the App Version [sn_devops_app_version] table. This endpoint automatically creates any missing parent objects if they do not exist.

Parameters

toolId (required)#

Sys ID of the planning tool to associate with the application. The Sys ID is located in the Planning Tool [sn_devops_planning_tool] table.

Type: string

$body#

Type: object

{
  "app" : {
    "createdBy" : {
      "name" : "string",
      "id" : "string",
      "userName" : "string",
      "email" : "string"
    },
    "parentAppId" : "Unique identifier of the application's parent application. Generated by the source planning tool. If not available, you can use the parent application name.",
    "createdDateTime" : "Date/time the application was created in the source DevOps tool.",
    "id" : "Unique identifier of the application. Generated by the source planning tool.",
    "lastUpdatedDateTime" : "Date/time the application was last updated in the source DevOps tool.",
    "shortDescription" : "Brief description of the associated application.",
    "state" : "State of the application as generated by the source planning tool, such as \"Approved\".",
    "type" : "Type of application as specified by the source planning tool, such as \"Mobile-Innovation\".",
    "url" : "URL of the application on the source planning tool site."
  },
  "parentReleaseId" : "Unique identifier of the version's parent version. Generated by the source planning tool. If not available, you can use the parent version name.",
  "createdBy" : {
    "name" : "string",
    "createdDateTime" : "Date/time the application was created in the source DevOps tool.",
    "id" : "string",
    "userName" : "string",
    "email" : "string"
  },
  "id" : "Unique identifier of the version. Generated by the source planning tool.",
  "lastUpdatedDateTime" : "Date/time the version was last updated in the source DevOps tool.",
  "shortDescription" : "Brief description of the associated version.",
  "state" : "State of the version as generated by the source planning tool, such as \"Complete\".",
  "type" : "Type of version as specified by the source planning tool, such as \"Mobile-Innovation\".",
  "url" : "URL of the version on the source planning tool site."
}

[ "string" ]

sysparm_view#

Device on which the item can display. If you also specify the sysparm_fields parameter, it takes precedent.

Type: string

Potential values: mobile, desktop, both

get_category#

Retrieves the available information for a specified category.

Parameters

category_id (required)#

Unique identifier (sys_id) of the category to retrieve.

Type: string

sysparm_fields#

A comma-separated list of fields to return in the response.

Type: array

[ "string" ]

sysparm_view#

Device on which the item can display. If you also specify the sysparm_fields parameter, it takes precedent.

Returns the available DevOps tools in the DevOps Tool [sn_devops_tool] table based on the passed in query. If no query parameters are passed in, the endpoint returns all active DevOps tools.

Parameters

id (required)#

Type: string

name#

Name of the DevOps tool to return.

Type: string

type#

Type of DevOps tool records to return.

This method retrieves the specified import staging record and resulting transformation result.

Parameters

import_staging_record_id (required)#

Type: string

Specify the value to use when sorting results.

sysparm_view#

sysparm_exclude_reference_link#

Flag that indicates whether to exclude Table API links for reference fields.

Type: boolean

sysparm_fields#

A comma-separated list of fields to return in the response.

Type: array

[ "string" ]

sysparm_include_available_aggregates#

Set to true to return all available aggregates for an indicator when no aggregate has been applied. If a value is not specified, this parameter defaults to false and returns no aggregates.

Type: boolean

sysparm_query_no_domain#

Type: boolean

sysparm_view#

Device on which the item can display. If you also specify the sysparm_fields parameter, it takes precedent.

Type: string

Potential values: mobile, desktop, both

get_record_in_cmdb_class#

Get attributes and relationship information for a specific record.

Parameters

class_name (required)#

The CMDB class name.

Type: string

record_id (required)#

The record sys_id.

Type: string

sysparm_fields#

A comma-separated list of fields to return in the response.

Type: array

[ "string" ]

sysparm_relation_limit#

The maximum number of relations to return.

Type: integer

sysparm_relation_offset#

A number of records to exclude from the relations query.

Type: integer

get_records_for_incident#

This method retrieves records for communication cards. The cards include total count of each card.

Parameters

incident_id (required)#

Sys id of the incident.

Type: string

get_roles_for_user#

Returns a specified user's granted and inherited roles.

Parameters

insert_import_staging_record#

This method inserts incoming data into a specified staging table and triggers transformation based on predefined transform maps in the import set table.

Parameters

table_name (required)#

Type: string

$body#

Type: object

{ }

insert_update_interaction#

Insert or update a record on the interaction table.

Parameters

$body#

Type: object

{
  "context_table" : "The context table you want to use to store interaction context for. The default is interaction_json_blob. If you define the context table, you also need to define the context ID.",
  "channel" : "The sys_id for the interaction connector you want to create an interaction for.",
  "context" : "A Map or a table/sys_id pair. By default, interactions have a record in the interaction_json_blob table that stores context data as a JSON object. You can point an interaction to a different record for context. Use context or context_table/context_id to define the context for an interaction.",
  "channel_metadata_table" : "The table you want to use to store channel metadata. The default is the live_group_profile table. If you define the channel metadata table, you also need to define the channel metadata ID.",
  "context_id" : "The document ID for a record you want to use to store context. The default is a new record in the insteraction_json_blob table. If you define the contex ID, you also need to define the table.",
  "channel_metadata" : "A Map or a table/sys_id pair. Channel metadata contains information that a connector can use to communicate through the associated channel. Use",
  "queue" : "The sys_id for the queue you want to associate with the interaction.",
  "channel_metadata_id" : "The document ID for a record you want to use to store channel metadata. The default is a new record in the live_group_profile table. If you define the channel metadata ID, you also need to define the table."
}

is_ci_action_allowed_for_state#

For a type of CI, determine if a CI action is not allowed for an operational state.

Parameters

actionName#

A CI action name

Type: string

ciClass#

The CI type

Type: string

opsLabel#

The operational state

Type: string

Retrieves a list of catalogs to which the user has access based on the passed in parameters.

Parameters

sysparm_fields#

A comma-separated list of fields to return in the response.

Type: array

[ "string" ]

sysparm_text#

Keyword to search for in the "title" field of the available service catalogs.

Type: string

sysparm_view#

Device on which the item can display. If you also specify the sysparm_fields parameter, it takes precedent.

Type: string

Potential values: mobile, desktop, both

list_categories_for_catalog#

Retrieves the list of available categories for the specified catalog.

Parameters

catalog_id (required)#

Unique identifier (sys_id) of the catalog to retrieve.

Type: string

sysparm_fields#

A comma-separated list of fields to return in the response.

Type: array

[ "string" ]

sysparm_top_level_only#

Only return those categories whose parent is a catalog.

Type: boolean

sysparm_view#

Device on which the item can display. If you also specify the sysparm_fields parameter, it takes precedent.

Type: string

Potential values: mobile, desktop, both

list_change_request_tasks#

Retrieves one or more change request tasks based on the specified criteria.

Parameters

change_request_id (required)#

Unique identifier of the change request to retrieve from the [change_request] table.

Type: string

order#

Field by which to sort the returned change requests.

Type: string

sysparm_limit#

Type: integer

Type of association between the CMDB CI and the change request.

Type: string

Potential values: affected, impacted, offering

sysparm_limit#

Type: integer

sysparm_offset#

Type: integer

Type: string

sysparm_limit#

Type: integer

sysparm_offset#

Type: integer

Category sys_id of the item. Use this parameter to locate catalog items in a specific category.

Type: string

sysparm_fields#

A comma-separated list of fields to return in the response.

Type: array

[ "string" ]

Retrieves a list of items based on the needs described for an order guide.

Parameters

guide_id (required)#

Unique identifier of the order guide whose items are to be retrieved [from sc_cat_item_guide table].

Type: string

$body#

Type: object

{
  "variables" : { }
}

list_items_in_wishlist#

Retrieves a list of items from the logged in user's wish list.

This operation has no parameters

list_nlu_models#

Returns all published NLU models.

This operation has no parameters

list_normal_change_requests#

Retrieves one or more normal change requests based on the specified criteria.

Parameters

order#

Field by which to sort the returned change requests.

Type: string

sysparm_limit#

Type: integer

sysparm_offset#

Type: integer

A comma-separated list of fields to return in the response.

Type: array

[ "string" ]

sysparm_query#

Encoded query used to filter the result set. For example, (sysparm_query=caller_id=javascript:gs.getUserID()^active=true). The encoded query supports order by. To sort responses based on certain fields, use the ORDERBY and ORDERBYDESC clauses in sysparm_query. For example, sysparm_query=active=true^ORDERBYnumber^ORDERBYDESCcategory filters all active records and orders the results in ascending order by number first, and then in descending order by category.If part of the query is invalid, such as by specifying an invalid field name, the instance ignores the invalid part.

Type: string

sysparm_query_no_domain#

Type: boolean

sysparm_view#

Device on which the item can display. If you also specify the sysparm_fields parameter, it takes precedent.

Type: string

Potential values: mobile, desktop, both

list_standard_change_requests#

Retrieves one or more standard change requests based on the specified criteria.

Parameters

order#

Field by which to sort the returned change requests.

Type: string

sysparm_query#

Type: string

textSearch#

String to use to search all standard change request record fields. This search uses ServiceNow full text search platform functionality and defaults to IR_AND_OR_QUERY.

Type: string

list_standard_change_templates#

Retrieves one or more standard change templates based on the specified criteria.

Parameters

order#

Field by which to sort the returned change requests.

Type: string

sysparm_query#

Parameters

solution_name (required)#

The name of solution to use for predictions.

Type: string

solution_definition#

Enter the name of the solution input field as a key-value pair. For example, enter the key short_description and the value 'Unable to connect to VPN'.

Type: object

{ }

predict_intents#

Predicts NLU intents from an utterance.

Parameters

$body#

Type: object

{
  "model_id" : "ID of an published ServiceNow NLU model or available IBM-Watson model.",
  "utterance" : "Text string."
}

sysIds#

list of CI sys_ids

Type: array

[ "string" ]

remove_push_notification_token#

Deactivates the tokens that enable mobile devices to receive push notifications from the specified application.

Parameters

application_name (required)#

Type: string

$body#

Type: object

{
  "platform" : "Platform on which to remove the push notification. This parameter must be the Name value from the Push Platform [sys_push_platform] table."
}

$body#

Payload is defined by the source code tool.

Type: object

{ }

send_tool_notification#

Use this endpoint to send a code tool related notification or a Webhook call to the ServiceNowDevOps instance.

Parameters

toolId (required)#

Sys ID of the DevOps tool to associate with the commit. The Sys ID is located in the Code Tool [sn_devops_code_tool] table.

Type: string

$body#

Payload is defined by the source code tool.

Type: object

{ }

sysIds (required)#

A comma separated list of CI sys_ids.

Type: array

[ "string" ]

oldOpsLabels#

A comma separated list of old CI states that all CIs should be in.

Type: array

[ "string" ]

submit_order_for_cart#

Checks out the user cart, based on the current check-out type (one-step or two-step).

This operation has no parameters

test_reconcile_items#

Determines the operation (insert/update) that will be performed with the specified payload without committing the operation in the database.

Parameters

$body#

Type: object

{
  "relations" : [ {
    "parent" : "index of the parent item in the dependency relation",
    "type" : "the relationship type. This is one of the name field values from the cmdb_rel_type table.",
    "child" : "index of the child item in the dependency relation"
  } ],
  "items" : [ {
    "lookup" : [ { } ],
    "values" : { },
    "className" : "the sys_class_name of the CI to be created or updated."
  } ]
}

[ "string. Possible values: avg | sum | add | mul | resample | top | label" ]

$body#

Name-value pairs for the field(s) to update in the associated change request task.

Type: object

{ }

data#

Name-value pairs for the fields to update. Request body parameters override URL parameters. However, required parameters must be specified in the URL.

Type: object

{ }

update_csm_case#

Updates the specified existing CSM case with the passed-in parameters.

Parameters

case_id (required)#

Unique identifier (sys_id) of the case to retrieve; located in the Case [sn_customerservice_case] table.

Type: string

$body#

Type: object

{
  "parent" : "Unique identifier (sys_id) of the parent case to which this case (child) is associated; Task [task] table.",
  "made_sla" : "Flag that indicates whether the case was resolved in alignment with the associated service level agreement.",
  "caused_by" : "Unique identifier (sys_id) of the change request that caused the case to be created; Change Request [change_request] table.Data",
  "watch_list" : "List of unique identifiers (sys_id) of the users who receive notifications about this case when additional comments are added or if the state of a case is changed to Resolved or Closed; User [sys_user] table.",
  "active_escalation" : "Unique identifier (sys_id) of the active account escalation record associated with the case; Escalation [sn_customerservice_escalation] table.",
  "upon_reject" : "Action to take if the case is rejected.",
  "support_manager" : "Unique identifier (sys_id) of the CSM manager assigned to the case; User [sys-user] table.",
  "social_channel" : "Type of social media channel such as Twitter, Facebook, or Instagram.Data",
  "skills" : "List of the unique identifiers (sys_id) of the skills needed to complete the case; Skill [cmn_skill] table.",
  "number" : "Case number.",
  "resolved_by" : "Unique identifier (sys_id) of the person that resolved the case; User [sys_user] table.",
  "social_post_url" : "URL of the social message from which the case is being generated.",
  "problem" : "Unique identifier (sys_id) of the issue that the customer is encountering; Problem [problem] table.",
  "opened_by" : "Unique identifier (sys_id) of the person that initially opened the case; User [sys_user] table.",
  "user_input" : "Additional user input.",
  "contact" : "Business-to-business based cases only. Unique identifier (sys_id) of the person to contact regarding this case; Contact [customer_contact] table.",
  "state" : "Current state of the case. Possible values are 1: new, 2: open, 3: awaiting info, 4: resolved, 5: closed",
  "knowledge" : "Flag that indicates if there is a knowledge base article available for the specified issue.",
  "order" : "Order of the case.",
  "closed_at" : "Date and time that the case was closed.",
  "cmdb_ci" : "Unique identifier (sys_id) of the configuration item associated with the case; Configuration Item [cmdb_ci] table.",
  "delivery_plan" : "Unique identifier (sys_id) of the parent execution plan for this case; Execution Plan [sc_cat_item_delivery_plan] table.",
  "contract" : "Unique identifier (sys_id) of the contract associated with the case; Contract [ast_contract] table. This contract contains information about the type of support that is provided to the company associated to the case. A contract can include a company and contact and the specific assets that are covered. A contract can also include multiple service entitlements and SLAs.",
  "impact" : "Impact on customer. Possible values are 1-high, 2-medium, 3-low",
  "active" : "Flag that indicates whether the case is open andactive.",
  "follow_the_sun" : "Flag that indicates whether the case should be handed-off for global follow-up. If a customer enters additional comments on a Priority 1 - Critical or a Priority 2 - High case, or if the case is escalated, the flag is automatically set to true.",
  "work_notes_list" : "List of unique identifiers (sys_id) of the internal users who receive notifications about this case when work notes are added; User [sys_user] table.",
  "business_service" : "Unique identifier (sys_id) of the business service record associated with the case; Business Service [cmdb_ci_service] table.",
  "entitlement" : "Unique identifier (sys_id) of the entitlement record associated with the case; Entitlement [service_entitlement] table. Entitlements define the type of support that a customer receives as well as the supported communication channels. An entitlement can be associated with a product, an asset, an account, or a contract.",
  "auto_created_case" : "Flag that indicates whether the case was automatically generated by another action/event.",
  "business_impact" : "Impact of the issue on the associated customer.",
  "priority" : "Priority of the case. Possible values are 1- critical, 2- high, 3- moderate, 4- low",
  "sys_domain_path" : "Domain path.",
  "time_worked" : "Total amount of time worked on the case.",
  "expected_start" : "Date and time when work is scheduled to begin on the case.",
  "rejection_goto" : "Unique identifier of the task to execute if the case is rejected; Task [task] table.",
  "opened_at" : "Date and time that the case was opened.",
  "business_duration" : "Length in calendar work hours, work days, and work weeks that it took to complete the case.",
  "first_response_time" : "Date and time when the first action was taken on the case.",
  "group_list" : "List of unique identifiers (sys_id) of the group records associated with the case; Group [sys_user_group] table.",
  "child_case_creation_progress" : "Flag that indicates whether the case is a child case that was created from a major case.",
  "work_end" : "Date and time work ended on the case.",
  "resolved_at" : "Date and time that the case was resolved.",
  "sync_driver" : "Flag that indicates whether there is driver synchronization.",
  "social_handle_url" : "URL of the user's social media handle.",
  "subcategory" : "Case subcategory.Value is 0- question",
  "wf_activity" : "Unique identifier (sys_id) of the workflow activity record associated with the case; Workflow Activity [wf_activity] table.",
  "short_description" : "Concise description of the case.",
  "correlation_display" : "Correlation display.",
  "delivery_task" : "Unique identifier (sys_id) of the execution plan task; Execution Plan Task [sc_cat_item_delivery_task] table.",
  "work_start" : "Date and time that work started on the case.",
  "assignment_group" : "Unique identifier (sys_id) of the customer service agent group assigned to the case; Group [sys_user_group] table.",
  "social_handle_type" : "Type of case to associate the social media profile.",
  "additional_assignee_list" : [ "string" ],
  "recipient_list" : "Unique identifier (sys_id) of the record that contains the list of recipients for communications about this case; Recipients List [sn_publications_recipients_list] table.",
  "cause" : "Details about the cause of the problem.",
  "description" : "Detailed description of the problem associated with the case.",
  "close_notes" : "Notes made when the case was closed.",
  "notify" : "Method to use to notify contact/consumer. Possible values are 1- do not notify, 2- send email, 3- telephone",
  "closed_by" : "Unique identifier (sys_id) of the user that closed the case; User [sys_user] table.",
  "contact_type" : "Method in which the case was initially reported.",
  "resolution_code" : "Resolution state for the case, such as \"Solved - Fixed by Support/Guidance provided\".",
  "probable_cause" : "Possible cause of the issue associated with the case.",
  "urgency" : "Urgency of the case.Possible values are 1- high, 2- medium, 3- low",
  "company" : "Unique identifier (sys_id) of the company associated with the case; Company [core_company] table.",
  "reassignment_count" : "Number of times that the case was reassigned to a person that is responsible for moving the case forward.",
  "contact_time_zone" : "Time zone of the contact associated with the case.",
  "notes_to_comments" : "Flag that indicates whether to the add resolution notes to the comments.",
  "activity_due" : "Date for which the associated date is expected to be completed.",
  "consumer" : "Business-to-consumer cases only. Unique identifier (sys_id) of the person to contact with regards to this case; Consumer [csm_consumer] table.",
  "major_case_state" : "Current state of the major case. Possible values are proposed- initial state when an agent or manager creates or proposes a candidate case, accepted- initial state when a manager creates a major case or when a manager promotes a candidate case, rejected- manager rejected candidate case, canceled- case is canceled.",
  "assigned_to" : "Unique identifier (sys_id) of the person assigned to the case; User [sys_user] table.",
  "product" : "Unique identifier (sys_id) of the product model of the asset associated to the case; Product Model [cmdb_model] table. A model is a specific version or configuration of an asset (for example, Apple Mac Book Pro).",
  "variables" : "Name/value pairs of variables associated with the case.",
  "comments" : "Additional comments about the case.",
  "approval" : "String that describes the type of approval required.",
  "sla_due" : "Date/time at which the case must be closed based on the associated service level agreement.",
  "change" : "Unique identifier (sys_id) of the change request that caused the case to be created; Change Request [change_request] table.",
  "due_date" : "Date that the case is due to be closed.",
  "social_handle" : "User handle on the channel.",
  "partner" : "Unique identifier (sys_id) of the partner associated with the case; Account [customer_account] table.",
  "escalation" : "Current escalation level. Possible values are 0-normal, 1-moderate, 2-high, 3-overdue",
  "upon_approval" : "Action to take if the case is approved.",
  "partner_contact" : "Unique identifier (sys_id) of the partner contact associated with the case; Contact [customer_contact] table.",
  "correlation_id" : "Correlation identifier.",
  "active_account_escalation" : "Unique identifier (sys_id) of the active account escalation record associated with the case; Escalation [sn_customerservice_escalation] table.",
  "location" : "Unique identifier (sys_id) of the record describing the company location; Location [cmn_location] table.",
  "category" : "Case category. Possible values are 0-question, 1-issue, 2-feature",
  "account" : "Unique identifier (sys_id) of the account associated with the case; located in the Account [customer_account] table."
}

update_emergency_change_request#

Update a emergency change request.

Parameters

change_request_id (required)#

Unique identifier of the change request to retrieve from the [change_request] table.

Type: string

$body#

Name-value pairs for the field(s) to update in the associated change request.

Type: object

{ }

data#

Name-value pairs for the fields to update. Request body parameters override URL parameters. However, required parameters must be specified in the URL.

Type: object

{ }

update_item_in_cart#

Updates the specified item in the logged in user's cart.

Parameters

cart_item_id (required)#

Unique identifier of the item in the current cart.

Type: string

$body#

Type: object

{
  "variables" : { },
  "sysparm_quantity" : "Quantity of the item to update the cart."
}

update_normal_change_request#

Update a normal change request.

Parameters

change_request_id (required)#

Unique identifier of the change request to retrieve from the [change_request] table.

Type: string

$body#

Name-value pairs for the field(s) to update in the associated change request.

Type: object

{ }

data#

Name-value pairs for the fields to update. Request body parameters override URL parameters. However, required parameters must be specified in the URL.

Type: object

{ }

[ "string" ]

sysparm_input_display_value#

Type: boolean

sysparm_query_no_domain#

Type: boolean

sysparm_view#

Device on which the item can display. If you also specify the sysparm_fields parameter, it takes precedent.

Type: string

Potential values: mobile, desktop, both

update_standard_change_request#

Updates the standard change request identified by the specified sys_id with the parameters in the request body or in the URL.

Parameters

change_request_id (required)#

Unique identifier of the change request to retrieve from the [change_request] table.

Type: string

$body#

Name-value pairs for the field(s) to update in the associated change request.

Type: object

{ }

data#

Name-value pairs for the fields to update. Request body parameters override URL parameters. However, required parameters must be specified in the URL.

Type: object

{ }