Incident

Allows you to perform create, read and update operations on the incident table in ServiceNow.

More information: https://it.byu.edu
Contact Info: api@byu.edu

Base URL: domains/servicenow/incident/

Version: v1

Schemes: https

Summary

Path Operation Description
/ POST

Create a record

/{sysId}* GET

Retrieve a record

PUT

Modify a record

Paths

Create a record

POST /

incidents: object[]

Incident requests may be submitted

object
u_other_source: string

Other Source Notes

u_potential_risk_choice: string

Potential Risk Choice

u_solution_kb: string

The Solution KB

u_represented_by: string

Represented By

u_resolution_source: string

Other Source

u_isparent: boolean

Parent flag

u_action: string

The Resolution Action

u_work_phone: string

Contact Number

u_incident_watchlist: string

The OIT Watch List

vip: boolean

Net ID

u_confirmation_method: string

Confirmation Method

u_resource_affected: string

Resource Affected

priority: integer

The Priority of the Incident

description: string

This is the description field on the Incident

u_work_status: string

Work Status

u_feedback: string (up to 1000 chars)

Customer Feedback

closed_at: string (dateTime)

Closed

u_date_of_incident: string (date)

Date of Incident

sys_updated_on: string (dateTime)

Updated

parent: string

The Parent request which the Incident stems from

closed_by: string

Closed By

u_monitoring_check: string

The Monitoring Check

u_email: string

Email

due_date: string (dateTime)

Due Date

u_information_breached_exfiltrated: boolean

Information Breached (exfiltrated)

assignment_group: string

The Assignment Group which has been assigned to the Incident

u_owner_contract: string

Owner/Contract

u_quick_facts_description: string (up to 1000 chars)

Quick Facts Description

caller_id: string

The person who opened the Incident

u_building: string

Building of Incident

u_link_to_full_report: string

Link to full Report

u_actual_risk_choice: string

Actual Risk Choice

u_financial_impact_descriptions: string (up to 100 chars)

Financial Impact Descriptions

state: integer

The current State of the Incident

u_method_used: string

Method Used to Gain Access

u_reach: string

Reach

u_overall_risk_impact: string (up to 1000 chars)

Overall Risk Impact to the University

u_resolution_service: string

The Resolution Service

u_info_breached: string

Info Breached

u_closure_code: string

The reason Incident was closed

opened_at: string (dateTime)

Opened Date

short_description: string (1 to 160 chars)

This is the short description of the Incident

sys_updated_by: string

Updated By

u_resource_purpose: string

Resource Purpose

problem_id: string

The Problem ID

u_how_discovered: string

How Discovered

u_prioritization: integer

The Rank of the Incident

u_follow_up_notes: string (up to 1000 chars)

Customer Feedback Follow Up Notes

caused_by: string

Caused by Change

u_qualtrics_response_id: string

Customer Feedback Qualtircs Response ID

u_subcategory: string

Subcategory

u_service: string (date)

The Service which the Incident belongs to

assigned_to: string

Individual in the Assignment Group the Incident has been assigned to

cmdb_ci: string

The Configuration Item

u_room: string

Room of Incident

u_source: string

Source

u_undocumented_change: boolean

Undocumented Change

opened_by: string

Opened By

u_data_classification: string

Data Classification

watch_list: string

The Caller Watch List

u_severity: string

Severity

u_sensitivity: string

Sensitivity

200 OK

OK

The values on the Incident form

result: object[]
object
u_other_source: string

Other Source Notes

u_potential_risk_choice: string

Potential Risk Choice

u_solution_kb: string

Solution KB

u_represented_by: string

Representd By

u_resolution_source: string

Other Source

u_isparent: boolean

Parent Flag

u_action: string

Resolution Action

u_work_phone: string

Contact Number

u_incident_watchlist: string

OIT Watch List

vip: boolean

VIP

u_confirmation_method: string

Confirmation Method

u_resource_affected: string

Resource Affected

priority: integer

Priority

description: string

Description

u_work_status: string

Work Status

u_feedback: string (up to 1000 chars)

Customer Feedback

closed_at: string (dateTime)

Closed

u_date_of_incident: string

Date of Incident

sys_updated_on: string (dateTime)

Updated

parent: string

Parent

number: string

Incident Number

closed_by: string

Closed by

u_monitoring_check: string

Monitoring Check

u_email: string

Email

due_date: string (dateTime)

Due Date

u_information_breached_exfiltrated: boolean

Inormation Breached (exfiltrated)

assignment_group: string

Assignment Group

u_owner_contract: string

Owner/Contract

u_quick_facts_description: string (up to 1000 chars)

Quick Facts Description

caller_id: string

Caller

u_building: string

Building

u_link_to_full_report: string

Link to Full Report

u_actual_risk_choice: string

Actual Risk Choice

u_financial_impact_descriptions: string (up to 100 chars)

Financial Impact Descriptions

state: integer

State

u_method_used: string

Method Used to Gain Access

u_reach: string

Reach

u_overall_risk_impact: string (up to 1000 chars)

Overall Risk Impact to the University

u_resolution_service: string

Resolution Service

u_info_breached: string

Info Breached

u_closure_code: integer

Closure Code

opened_at: string (dateTime)

Opened Date

short_description: string

Short Description

sys_updated_by: string

Updated by

u_resource_purpose: string

Resource Purpose

problem_id: string

Problem ID

u_how_discovered: string

How Discovered

u_prioritization: integer

Rank

u_follow_up_notes: string (up to 1000 chars)

Customer Feedback Follow Up Notes

caused_by: string

Caused by Change

u_qualtrics_response_id: string

Customer Feedback Qualtrics Response ID

u_subcategory: string

Subcategory

assigned_to: string

Assigned To

u_service: string

Symptom Service

cmdb_ci: string

Configuration Item

u_room: string

Room

u_source: string

Source

u_undocumented_change: boolean

Undocumented Change

opened_by: string

Opened by

u_data_classification: string

Data Classification

watch_list: string

Caller Watch List

u_severity: string

Severity

u_sensitivity: string

Sensitivity

Retrieve a record

GET /{sysId}*

Retrieves one incident per call based on the unique system identifier. The 4 query parameters will modify the response.

sysId

The unique idenitifer

path string
sysparm_display_value

Return the display value (true), actual value (false), or both (all) for reference fields (default: false)

query string
sysparm_exclude_reference_link

True to exclude Table API links for reference fields (default: false)

query string
sysparm_fields

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

query string
sysparm_view

Render the response according to the specified UI view (overridden by sysparm_fields)

query string
200 OK

OK

The values on the Incident form

result: object[]
object
u_other_source: string

Other Source Notes

u_potential_risk_choice: string

Potential Risk Choice

u_solution_kb: string

Solution KB

u_represented_by: string

Representd By

u_resolution_source: string

Other Source

u_isparent: boolean

Parent Flag

u_action: string

Resolution Action

u_work_phone: string

Contact Number

u_incident_watchlist: string

OIT Watch List

vip: boolean

VIP

u_confirmation_method: string

Confirmation Method

u_resource_affected: string

Resource Affected

priority: integer

Priority

description: string

Description

u_work_status: string

Work Status

u_feedback: string (up to 1000 chars)

Customer Feedback

closed_at: string (dateTime)

Closed

u_date_of_incident: string

Date of Incident

sys_updated_on: string (dateTime)

Updated

parent: string

Parent

number: string

Incident Number

closed_by: string

Closed by

u_monitoring_check: string

Monitoring Check

u_email: string

Email

due_date: string (dateTime)

Due Date

u_information_breached_exfiltrated: boolean

Inormation Breached (exfiltrated)

assignment_group: string

Assignment Group

u_owner_contract: string

Owner/Contract

u_quick_facts_description: string (up to 1000 chars)

Quick Facts Description

caller_id: string

Caller

u_building: string

Building

u_link_to_full_report: string

Link to Full Report

u_actual_risk_choice: string

Actual Risk Choice

u_financial_impact_descriptions: string (up to 100 chars)

Financial Impact Descriptions

state: integer

State

u_method_used: string

Method Used to Gain Access

u_reach: string

Reach

u_overall_risk_impact: string (up to 1000 chars)

Overall Risk Impact to the University

u_resolution_service: string

Resolution Service

u_info_breached: string

Info Breached

u_closure_code: integer

Closure Code

opened_at: string (dateTime)

Opened Date

short_description: string

Short Description

sys_updated_by: string

Updated by

u_resource_purpose: string

Resource Purpose

problem_id: string

Problem ID

u_how_discovered: string

How Discovered

u_prioritization: integer

Rank

u_follow_up_notes: string (up to 1000 chars)

Customer Feedback Follow Up Notes

caused_by: string

Caused by Change

u_qualtrics_response_id: string

Customer Feedback Qualtrics Response ID

u_subcategory: string

Subcategory

assigned_to: string

Assigned To

u_service: string

Symptom Service

cmdb_ci: string

Configuration Item

u_room: string

Room

u_source: string

Source

u_undocumented_change: boolean

Undocumented Change

opened_by: string

Opened by

u_data_classification: string

Data Classification

watch_list: string

Caller Watch List

u_severity: string

Severity

u_sensitivity: string

Sensitivity

Modify a record

PUT /{sysId}*

incidents: object[]

Incident requests may be submitted

object
u_other_source: string

Other Source Notes

u_potential_risk_choice: string

Potential Risk Choice

u_solution_kb: string

The Solution KB

u_represented_by: string

Represented By

u_resolution_source: string

Other Source

u_isparent: boolean

Parent flag

u_action: string

The Resolution Action

u_work_phone: string

Contact Number

u_incident_watchlist: string

The OIT Watch List

vip: boolean

Net ID

u_confirmation_method: string

Confirmation Method

u_resource_affected: string

Resource Affected

priority: integer

The Priority of the Incident

description: string

This is the description field on the Incident

u_work_status: string

Work Status

u_feedback: string (up to 1000 chars)

Customer Feedback

closed_at: string (dateTime)

Closed

u_date_of_incident: string (date)

Date of Incident

sys_updated_on: string (dateTime)

Updated

parent: string

The Parent request which the Incident stems from

closed_by: string

Closed By

u_monitoring_check: string

The Monitoring Check

u_email: string

Email

due_date: string (dateTime)

Due Date

u_information_breached_exfiltrated: boolean

Information Breached (exfiltrated)

assignment_group: string

The Assignment Group which has been assigned to the Incident

u_owner_contract: string

Owner/Contract

u_quick_facts_description: string (up to 1000 chars)

Quick Facts Description

caller_id: string

The person who opened the Incident

u_building: string

Building of Incident

u_link_to_full_report: string

Link to full Report

u_actual_risk_choice: string

Actual Risk Choice

u_financial_impact_descriptions: string (up to 100 chars)

Financial Impact Descriptions

state: integer

The current State of the Incident

u_method_used: string

Method Used to Gain Access

u_reach: string

Reach

u_overall_risk_impact: string (up to 1000 chars)

Overall Risk Impact to the University

u_resolution_service: string

The Resolution Service

u_info_breached: string

Info Breached

u_closure_code: string

The reason Incident was closed

opened_at: string (dateTime)

Opened Date

short_description: string (1 to 160 chars)

This is the short description of the Incident

sys_updated_by: string

Updated By

u_resource_purpose: string

Resource Purpose

problem_id: string

The Problem ID

u_how_discovered: string

How Discovered

u_prioritization: integer

The Rank of the Incident

u_follow_up_notes: string (up to 1000 chars)

Customer Feedback Follow Up Notes

caused_by: string

Caused by Change

u_qualtrics_response_id: string

Customer Feedback Qualtircs Response ID

u_subcategory: string

Subcategory

u_service: string (date)

The Service which the Incident belongs to

assigned_to: string

Individual in the Assignment Group the Incident has been assigned to

cmdb_ci: string

The Configuration Item

u_room: string

Room of Incident

u_source: string

Source

u_undocumented_change: boolean

Undocumented Change

opened_by: string

Opened By

u_data_classification: string

Data Classification

watch_list: string

The Caller Watch List

u_severity: string

Severity

u_sensitivity: string

Sensitivity

sysId path string
200 OK

OK

The values on the Incident form

result: object[]
object
u_other_source: string

Other Source Notes

u_potential_risk_choice: string

Potential Risk Choice

u_solution_kb: string

Solution KB

u_represented_by: string

Representd By

u_resolution_source: string

Other Source

u_isparent: boolean

Parent Flag

u_action: string

Resolution Action

u_work_phone: string

Contact Number

u_incident_watchlist: string

OIT Watch List

vip: boolean

VIP

u_confirmation_method: string

Confirmation Method

u_resource_affected: string

Resource Affected

priority: integer

Priority

description: string

Description

u_work_status: string

Work Status

u_feedback: string (up to 1000 chars)

Customer Feedback

closed_at: string (dateTime)

Closed

u_date_of_incident: string

Date of Incident

sys_updated_on: string (dateTime)

Updated

parent: string

Parent

number: string

Incident Number

closed_by: string

Closed by

u_monitoring_check: string

Monitoring Check

u_email: string

Email

due_date: string (dateTime)

Due Date

u_information_breached_exfiltrated: boolean

Inormation Breached (exfiltrated)

assignment_group: string

Assignment Group

u_owner_contract: string

Owner/Contract

u_quick_facts_description: string (up to 1000 chars)

Quick Facts Description

caller_id: string

Caller

u_building: string

Building

u_link_to_full_report: string

Link to Full Report

u_actual_risk_choice: string

Actual Risk Choice

u_financial_impact_descriptions: string (up to 100 chars)

Financial Impact Descriptions

state: integer

State

u_method_used: string

Method Used to Gain Access

u_reach: string

Reach

u_overall_risk_impact: string (up to 1000 chars)

Overall Risk Impact to the University

u_resolution_service: string

Resolution Service

u_info_breached: string

Info Breached

u_closure_code: integer

Closure Code

opened_at: string (dateTime)

Opened Date

short_description: string

Short Description

sys_updated_by: string

Updated by

u_resource_purpose: string

Resource Purpose

problem_id: string

Problem ID

u_how_discovered: string

How Discovered

u_prioritization: integer

Rank

u_follow_up_notes: string (up to 1000 chars)

Customer Feedback Follow Up Notes

caused_by: string

Caused by Change

u_qualtrics_response_id: string

Customer Feedback Qualtrics Response ID

u_subcategory: string

Subcategory

assigned_to: string

Assigned To

u_service: string

Symptom Service

cmdb_ci: string

Configuration Item

u_room: string

Room

u_source: string

Source

u_undocumented_change: boolean

Undocumented Change

opened_by: string

Opened by

u_data_classification: string

Data Classification

watch_list: string

Caller Watch List

u_severity: string

Severity

u_sensitivity: string

Sensitivity

Service Path: 
domains/servicenow/incident/
Domain or University API: 
domains/servicenow/incident/

Community

 

Don't see your question listed here? Ask!