Change Request API

Interact with Change Request records in ServiceNow through the ServiceNow Table API.

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

Base URL: /domains/servicenow/changerequest

Version: v1.1

Schemes: https

Summary

Path Operation Description
/change-request* GET

returns a list of Change Request records

POST

creates a new Change Request record

/change-request/{sys_id}* GET

returns a single Change Request record

PUT

updates a single Change Request record

Paths

returns a list of Change Request records

GET /change-request*

sysparm_query

An encoded query string used to filter the results. To generate an encoded query for the results you want, go to the list view of the table in ServiceNow and create your filter. Then right click on the last filter in the breadcrumb style filter list and select 'Copy Query'. That is the query to use here. On most tables, passing 'active=true' will return only active records.

query string
sysparm_display_value

Pass 'true' to return the display value of the record, pass 'false' to get the sys_id of the record, or pass 'all' to get both for reference fields.

query string false
sysparm_exclude_reference_link

True to exclude Table API links for reference fields.

query string
sysparm_suppress_pagination_header

True to supress pagination header.

query string true
sysparm_fields

A comma-separated list of fields to return in the response. Defaults to a list that will just get form fields

query string number,cmdb_ci,start_date,end_date,requested_by,type,risk,impact,short_description,description,priority,state,assignment_group,assigned_to,watch_list,u_planned_down_time,work_start,work_end,u_actual_down_time,u_completion_rating,comments,u_template,u_emergency_type_override,u_requested_date,u_testing,u_change_history,u_coordination,u_critical_services_affected,u_end_user_experience,u_campus_organizations,u_verification_plan,u_contingency_plan,u_service,u_service_manager,u_service_manager_approval,cab_required,cab_delegate,sys_created_on,sys_updated_on,requested_by_date,closed_at,sys_created_by,sys_updated_by,closed_by,u_approved,u_peer_reviewed_by,u_number_of_people,u_notify_network,u_notify_mybyu,u_notify_mybyu_date,u_notify_mybyu_task,u_notify_campus,u_notify_campus_date,u_notify_campus_task,u_notify_message_relay,u_notify_message_relay_date,u_notify_message_relay_task,u_notify_affected,u_notify_affected_date,u_notify_affected_task,u_notify_oit,u_notify_oit_date,u_notify_oit_task,u_notify_csr_list,u_notify_csr_date,u_notify_csr_task,u_notify_ycloud,u_notify_ycloud_date,u_notify_ycloud_task,u_osc_contacted,u_failure_start,u_failure_end,cab_date,cab_recommendation,close_code,close_notes,u_monitoring_verification,u_monitoring_task,u_security_verification,u_security_task,u_backup_verification,u_backup_task,u_directions,u_testing_verification,u_testing_task,approval,category
sysparm_limit

The maximum number of results returned per page.

query string 10,000
sysparm_view

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

query string

application/json

200 OK

Success with response body.

result: object[]
object
{
"approval": "Not Yet Requested",
"assigned_to": "John Payne",
"assignment_group": "IS-Platform",
"cab_date": "",
"cab_delegate": "",
"cab_recommendation": "",
"cab_required": "false",
"category": "Other",
"close_notes": "",
"closed_at": "2014-05-28 16:04:31",
"closed_by": "John Payne",
"cmdb_ci": "",
"comments": "",
"description": "Semiannual Linux system updates. Schedule will follow the established pattern. Non-clustered systems will be patched on May 15 @ 12:01 am. Not included in this change are any ESX hosts, SAN patches, or Exadata patching. A more detailed description of the patch process, issues, and procedures being executed will be available at https://developer.byu.edu/wiki/pages/viewpage.action?pageId=48956666 in Mid-April.",
"end_date": "2014-05-18 03:00:00",
"impact": "3 - Low",
"number": "RFC0000002",
"priority": "Medium - B",
"requested_by": "John Payne",
"requested_by_date": "2014-02-06 15:06:06",
"risk": "Moderate",
"short_description": "Semiannual Linux system updates",
"start_date": "2014-05-12 09:00:00",
"state": "Finished",
"sys_created_by": "jjp",
"sys_created_on": "2014-02-06 14:51:52",
"sys_updated_by": "dlb44",
"sys_updated_on": "2015-07-16 17:11:56",
"type": "Request for Change",
"u_actual_down_time": "",
"u_approved": "2014-05-27 09:49:38",
"u_backup_task": "",
"u_backup_verification": "false",
"u_campus_organizations": "High",
"u_change_history": "Low",
"u_completion_rating": "4 - Poor",
"u_contingency_plan": "Patches can be backed out, as necessary. We will be patching all non-production systems before this change, and expect to find any issues in the course of those updates, rather than find them in the process of executing the production updates.",
"u_coordination": "Medium",
"u_critical_services_affected": "Medium",
"u_directions": "",
"u_emergency_type_override": "false",
"u_end_user_experience": "Low",
"u_failure_end": "",
"u_failure_start": "",
"u_monitoring_task": "",
"u_monitoring_verification": "false",
"u_notify_affected": "false",
"u_notify_affected_date": "",
"u_notify_affected_task": "",
"u_notify_campus": "true",
"u_notify_campus_date": "2014-05-13",
"u_notify_campus_task": "CTASK0000915",
"u_notify_csr_date": "2014-05-09",
"u_notify_csr_list": "true",
"u_notify_csr_task": "CTASK0000916",
"u_notify_message_relay": "false",
"u_notify_message_relay_date": "",
"u_notify_message_relay_task": "",
"u_notify_mybyu": "false",
"u_notify_mybyu_date": "",
"u_notify_mybyu_task": "",
"u_notify_network": "false",
"u_notify_oit": "false",
"u_notify_oit_date": "",
"u_notify_oit_task": "",
"u_notify_ycloud": "false",
"u_notify_ycloud_date": "",
"u_notify_ycloud_task": "",
"u_number_of_people": "",
"u_osc_contacted": "false",
"u_peer_reviewed_by": "",
"u_planned_down_time": "1 Hour",
"u_requested_date": "",
"u_security_task": "",
"u_security_verification": "false",
"u_service": "",
"u_service_manager": "John Payne",
"u_service_manager_approval": "Yes",
"u_template": "",
"u_testing": "Medium",
"u_testing_task": "",
"u_testing_verification": "false",
"u_verification_plan": "This change will be executed in conjunction with the NOC staff. We will look to the NOC staff to help us validate that services are up, alerts have cleared, and they do not have issues as we execute this change.",
"watch_list": "John Payne",
"work_end": "2014-05-28 16:04:31",
"work_start": "2014-05-12 10:15:00"
}
number: string

Number field from the change_request form

cmdb_ci: string (32 to 32 chars)

Affected CI field from the change_request form

start_date: string (date-time)

Planned Start Date field from the change_request form

end_date: string (date-time)

Planned End Date field from the change_request form

requested_by: string (32 to 32 chars)

Submitted by field from the change_request form

type: string

Type field from the change_request form

risk: integer (int32)

Risk field from the change_request form

impact: integer (int32)

Impact field from the change_request form

short_description: string

Short Description field from the change_request form

description: string

Description field from the change_request form

priority: integer (int32)

Priority field from the change_request form

state: integer (int32)

Status field from the change_request form

assignment_group: string (32 to 32 chars)

Assignment group field from the change_request form

assigned_to: string (32 to 32 chars)

Assigned To field from the change_request form

watch_list: string

Watch list field from the change_request form

u_planned_down_time: string (date-time)

Planned Down Time field from the change_request form

work_start: string (date-time)

Actual Start field from the change_request form

work_end: string (date-time)

Actual End field from the change_request form

u_actual_down_time: string (date-time)

Actual Down Time field from the change_request form

u_completion_rating: string

Completion Rating field from the change_request form

comments: string

Work Log field from the change_request form

u_template: string (32 to 32 chars)

Template field from the change_request form

u_emergency_type_override: boolean

Emergency Override field from the change_request form

u_requested_date: string (date)

Requested Date field from the change_request form

u_testing: string

Risk Based on Testing field from the change_request form

u_change_history: string

Risk Based on Change History field from the change_request form

u_coordination: string

Level of Coordinating Groups field from the change_request form

u_critical_services_affected: string

Potential Impact to Critical Services field from the change_request form

u_end_user_experience: string

Impact to End User Experience field from the change_request form

u_campus_organizations: string

Potential Reach of Change field from the change_request form

u_verification_plan: string

Verification Plan field from the change_request form

u_contingency_plan: string

Contingency Plan field from the change_request form

u_service: string (32 to 32 chars)

Primary Affected Service field from the change_request form

u_service_manager: string (32 to 32 chars)

Service/Product Manager field from the change_request form

u_service_manager_approval: string

Service/Product Manager Approval field from the change_request form

cab_required: boolean

CAB required field from the change_request form

cab_delegate: string (32 to 32 chars)

CAB delegate field from the change_request form

sys_created_on: string (date-time)

Created field from the change_request form

sys_updated_on: string (date-time)

Updated field from the change_request form

requested_by_date: string (date-time)

Submitted field from the change_request form

closed_at: string (date-time)

Closed field from the change_request form

sys_created_by: string

Created by field from the change_request form

sys_updated_by: string

Updated by field from the change_request form

closed_by: string (32 to 32 chars)

Closed by field from the change_request form

u_approved: string (date-time)

Approved field from the change_request form

u_peer_reviewed_by: string (32 to 32 chars)

Peer Reviewed by field from the change_request form

u_number_of_people: integer (int32)

Number of People field from the change_request form

u_notify_network: boolean

Notify Network field from the change_request form

u_notify_mybyu: boolean

Notify MyBYU field from the change_request form

u_notify_mybyu_date: string (date)

Date to Send field from the change_request form

u_notify_mybyu_task: string (32 to 32 chars)

Task field from the change_request form

u_notify_campus: boolean

Notify Campus field from the change_request form

u_notify_campus_date: string (date)

Date to Send field from the change_request form

u_notify_campus_task: string (32 to 32 chars)

Task field from the change_request form

u_notify_message_relay: boolean

Message Relay field from the change_request form

u_notify_message_relay_date: string (date)

Date to Send field from the change_request form

u_notify_message_relay_task: string (32 to 32 chars)

Task field from the change_request form

u_notify_affected: boolean

Notify Affected field from the change_request form

u_notify_affected_date: string (date)

Date to Send field from the change_request form

u_notify_affected_task: string (32 to 32 chars)

Task field from the change_request form

u_notify_oit: boolean

Notify OIT field from the change_request form

u_notify_oit_date: string (date)

Date to Send field from the change_request form

u_notify_oit_task: string (32 to 32 chars)

Task field from the change_request form

u_notify_csr_list: boolean

Notify CSR List field from the change_request form

u_notify_csr_date: string (date)

Date to Send field from the change_request form

u_notify_csr_task: string (32 to 32 chars)

Task field from the change_request form

u_notify_ycloud: boolean

Notify YCloud Admins field from the change_request form

u_notify_ycloud_date: string (date)

Date to Send field from the change_request form

u_notify_ycloud_task: string (32 to 32 chars)

Task field from the change_request form

u_osc_contacted: boolean

OSC Contacted field from the change_request form

u_failure_start: string (date-time)

Failure Start field from the change_request form

u_failure_end: string (date-time)

Failure End field from the change_request form

cab_date: string (date)

Cab date field from the change_request form

cab_recommendation: string

Cab recommendation field from the change_request form

close_notes: string

Close notes field from the change_request form

u_monitoring_verification: boolean

Monitoring Verification field from the change_request form

u_monitoring_task: string (32 to 32 chars)

Monitoring Task field from the change_request form

u_security_verification: boolean

Security Verification field from the change_request form

u_security_task: string (32 to 32 chars)

Security Task field from the change_request form

u_backup_verification: boolean

Backup Verification field from the change_request form

u_backup_task: string (32 to 32 chars)

Backup Task field from the change_request form

u_directions: string

Directions field from the change_request form

u_testing_verification: boolean

Testing Verification field from the change_request form

u_testing_task: string (32 to 32 chars)

Testing Task field from the change_request form

approval: string

Approval field from the change_request form

category: string

Category field from the change_request form

201 Created

Success with response body

result: object
{
"approval": "Not Yet Requested",
"assigned_to": "John Payne",
"assignment_group": "IS-Platform",
"cab_date": "",
"cab_delegate": "",
"cab_recommendation": "",
"cab_required": "false",
"category": "Other",
"close_notes": "",
"closed_at": "2014-05-28 16:04:31",
"closed_by": "John Payne",
"cmdb_ci": "",
"comments": "",
"description": "Semiannual Linux system updates. Schedule will follow the established pattern. Non-clustered systems will be patched on May 15 @ 12:01 am. Not included in this change are any ESX hosts, SAN patches, or Exadata patching. A more detailed description of the patch process, issues, and procedures being executed will be available at https://developer.byu.edu/wiki/pages/viewpage.action?pageId=48956666 in Mid-April.",
"end_date": "2014-05-18 03:00:00",
"impact": "3 - Low",
"number": "RFC0000002",
"priority": "Medium - B",
"requested_by": "John Payne",
"requested_by_date": "2014-02-06 15:06:06",
"risk": "Moderate",
"short_description": "Semiannual Linux system updates",
"start_date": "2014-05-12 09:00:00",
"state": "Finished",
"sys_created_by": "jjp",
"sys_created_on": "2014-02-06 14:51:52",
"sys_updated_by": "dlb44",
"sys_updated_on": "2015-07-16 17:11:56",
"type": "Request for Change",
"u_actual_down_time": "",
"u_approved": "2014-05-27 09:49:38",
"u_backup_task": "",
"u_backup_verification": "false",
"u_campus_organizations": "High",
"u_change_history": "Low",
"u_completion_rating": "4 - Poor",
"u_contingency_plan": "Patches can be backed out, as necessary. We will be patching all non-production systems before this change, and expect to find any issues in the course of those updates, rather than find them in the process of executing the production updates.",
"u_coordination": "Medium",
"u_critical_services_affected": "Medium",
"u_directions": "",
"u_emergency_type_override": "false",
"u_end_user_experience": "Low",
"u_failure_end": "",
"u_failure_start": "",
"u_monitoring_task": "",
"u_monitoring_verification": "false",
"u_notify_affected": "false",
"u_notify_affected_date": "",
"u_notify_affected_task": "",
"u_notify_campus": "true",
"u_notify_campus_date": "2014-05-13",
"u_notify_campus_task": "CTASK0000915",
"u_notify_csr_date": "2014-05-09",
"u_notify_csr_list": "true",
"u_notify_csr_task": "CTASK0000916",
"u_notify_message_relay": "false",
"u_notify_message_relay_date": "",
"u_notify_message_relay_task": "",
"u_notify_mybyu": "false",
"u_notify_mybyu_date": "",
"u_notify_mybyu_task": "",
"u_notify_network": "false",
"u_notify_oit": "false",
"u_notify_oit_date": "",
"u_notify_oit_task": "",
"u_notify_ycloud": "false",
"u_notify_ycloud_date": "",
"u_notify_ycloud_task": "",
"u_number_of_people": "",
"u_osc_contacted": "false",
"u_peer_reviewed_by": "",
"u_planned_down_time": "1 Hour",
"u_requested_date": "",
"u_security_task": "",
"u_security_verification": "false",
"u_service": "",
"u_service_manager": "John Payne",
"u_service_manager_approval": "Yes",
"u_template": "",
"u_testing": "Medium",
"u_testing_task": "",
"u_testing_verification": "false",
"u_verification_plan": "This change will be executed in conjunction with the NOC staff. We will look to the NOC staff to help us validate that services are up, alerts have cleared, and they do not have issues as we execute this change.",
"watch_list": "John Payne",
"work_end": "2014-05-28 16:04:31",
"work_start": "2014-05-12 10:15:00"
}
number: string

Number field from the change_request form

cmdb_ci: string (32 to 32 chars)

Affected CI field from the change_request form

start_date: string (date-time)

Planned Start Date field from the change_request form

end_date: string (date-time)

Planned End Date field from the change_request form

requested_by: string (32 to 32 chars)

Submitted by field from the change_request form

type: string

Type field from the change_request form

risk: integer (int32)

Risk field from the change_request form

impact: integer (int32)

Impact field from the change_request form

short_description: string

Short Description field from the change_request form

description: string

Description field from the change_request form

priority: integer (int32)

Priority field from the change_request form

state: integer (int32)

Status field from the change_request form

assignment_group: string (32 to 32 chars)

Assignment group field from the change_request form

assigned_to: string (32 to 32 chars)

Assigned To field from the change_request form

watch_list: string

Watch list field from the change_request form

u_planned_down_time: string (date-time)

Planned Down Time field from the change_request form

work_start: string (date-time)

Actual Start field from the change_request form

work_end: string (date-time)

Actual End field from the change_request form

u_actual_down_time: string (date-time)

Actual Down Time field from the change_request form

u_completion_rating: string

Completion Rating field from the change_request form

comments: string

Work Log field from the change_request form

u_template: string (32 to 32 chars)

Template field from the change_request form

u_emergency_type_override: boolean

Emergency Override field from the change_request form

u_requested_date: string (date)

Requested Date field from the change_request form

u_testing: string

Risk Based on Testing field from the change_request form

u_change_history: string

Risk Based on Change History field from the change_request form

u_coordination: string

Level of Coordinating Groups field from the change_request form

u_critical_services_affected: string

Potential Impact to Critical Services field from the change_request form

u_end_user_experience: string

Impact to End User Experience field from the change_request form

u_campus_organizations: string

Potential Reach of Change field from the change_request form

u_verification_plan: string

Verification Plan field from the change_request form

u_contingency_plan: string

Contingency Plan field from the change_request form

u_service: string (32 to 32 chars)

Primary Affected Service field from the change_request form

u_service_manager: string (32 to 32 chars)

Service/Product Manager field from the change_request form

u_service_manager_approval: string

Service/Product Manager Approval field from the change_request form

cab_required: boolean

CAB required field from the change_request form

cab_delegate: string (32 to 32 chars)

CAB delegate field from the change_request form

sys_created_on: string (date-time)

Created field from the change_request form

sys_updated_on: string (date-time)

Updated field from the change_request form

requested_by_date: string (date-time)

Submitted field from the change_request form

closed_at: string (date-time)

Closed field from the change_request form

sys_created_by: string

Created by field from the change_request form

sys_updated_by: string

Updated by field from the change_request form

closed_by: string (32 to 32 chars)

Closed by field from the change_request form

u_approved: string (date-time)

Approved field from the change_request form

u_peer_reviewed_by: string (32 to 32 chars)

Peer Reviewed by field from the change_request form

u_number_of_people: integer (int32)

Number of People field from the change_request form

u_notify_network: boolean

Notify Network field from the change_request form

u_notify_mybyu: boolean

Notify MyBYU field from the change_request form

u_notify_mybyu_date: string (date)

Date to Send field from the change_request form

u_notify_mybyu_task: string (32 to 32 chars)

Task field from the change_request form

u_notify_campus: boolean

Notify Campus field from the change_request form

u_notify_campus_date: string (date)

Date to Send field from the change_request form

u_notify_campus_task: string (32 to 32 chars)

Task field from the change_request form

u_notify_message_relay: boolean

Message Relay field from the change_request form

u_notify_message_relay_date: string (date)

Date to Send field from the change_request form

u_notify_message_relay_task: string (32 to 32 chars)

Task field from the change_request form

u_notify_affected: boolean

Notify Affected field from the change_request form

u_notify_affected_date: string (date)

Date to Send field from the change_request form

u_notify_affected_task: string (32 to 32 chars)

Task field from the change_request form

u_notify_oit: boolean

Notify OIT field from the change_request form

u_notify_oit_date: string (date)

Date to Send field from the change_request form

u_notify_oit_task: string (32 to 32 chars)

Task field from the change_request form

u_notify_csr_list: boolean

Notify CSR List field from the change_request form

u_notify_csr_date: string (date)

Date to Send field from the change_request form

u_notify_csr_task: string (32 to 32 chars)

Task field from the change_request form

u_notify_ycloud: boolean

Notify YCloud Admins field from the change_request form

u_notify_ycloud_date: string (date)

Date to Send field from the change_request form

u_notify_ycloud_task: string (32 to 32 chars)

Task field from the change_request form

u_osc_contacted: boolean

OSC Contacted field from the change_request form

u_failure_start: string (date-time)

Failure Start field from the change_request form

u_failure_end: string (date-time)

Failure End field from the change_request form

cab_date: string (date)

Cab date field from the change_request form

cab_recommendation: string

Cab recommendation field from the change_request form

close_notes: string

Close notes field from the change_request form

u_monitoring_verification: boolean

Monitoring Verification field from the change_request form

u_monitoring_task: string (32 to 32 chars)

Monitoring Task field from the change_request form

u_security_verification: boolean

Security Verification field from the change_request form

u_security_task: string (32 to 32 chars)

Security Task field from the change_request form

u_backup_verification: boolean

Backup Verification field from the change_request form

u_backup_task: string (32 to 32 chars)

Backup Task field from the change_request form

u_directions: string

Directions field from the change_request form

u_testing_verification: boolean

Testing Verification field from the change_request form

u_testing_task: string (32 to 32 chars)

Testing Task field from the change_request form

approval: string

Approval field from the change_request form

category: string

Category field from the change_request form

204 No Content

Success with no response body

400 Bad Request

The request URI does not match the APIs in the system, or the operation failed for unknown reasons. Invalid headers can also cause this error.

401 Unauthorized

The user is not authorized to use the API.

403 Forbidden

The requested operation is not permitted for the user. This error can also be caused by ACL failures, or business rule or data policy constraints.

404 Not Found

The requested resource was not found. This can be caused by an ACL constraint or if the resource does not exist.

405 Method Not Allowed

The HTTP action is not allowed for the requested REST API, or it is not supported by any API.

406 Not Acceptable

The endpoint does not support the response format specified in the request Accept header.

415 Unsupported Media Type

The endpoint does not support the format of the request body.

creates a new Change Request record

POST /change-request*

The body to pass or that is received in a response

{
"approval": "Not Yet Requested",
"assigned_to": "John Payne",
"assignment_group": "IS-Platform",
"cab_date": "",
"cab_delegate": "",
"cab_recommendation": "",
"cab_required": "false",
"category": "Other",
"close_notes": "",
"closed_at": "2014-05-28 16:04:31",
"closed_by": "John Payne",
"cmdb_ci": "",
"comments": "",
"description": "Semiannual Linux system updates. Schedule will follow the established pattern. Non-clustered systems will be patched on May 15 @ 12:01 am. Not included in this change are any ESX hosts, SAN patches, or Exadata patching. A more detailed description of the patch process, issues, and procedures being executed will be available at https://developer.byu.edu/wiki/pages/viewpage.action?pageId=48956666 in Mid-April.",
"end_date": "2014-05-18 03:00:00",
"impact": "3 - Low",
"number": "RFC0000002",
"priority": "Medium - B",
"requested_by": "John Payne",
"requested_by_date": "2014-02-06 15:06:06",
"risk": "Moderate",
"short_description": "Semiannual Linux system updates",
"start_date": "2014-05-12 09:00:00",
"state": "Finished",
"sys_created_by": "jjp",
"sys_created_on": "2014-02-06 14:51:52",
"sys_updated_by": "dlb44",
"sys_updated_on": "2015-07-16 17:11:56",
"type": "Request for Change",
"u_actual_down_time": "",
"u_approved": "2014-05-27 09:49:38",
"u_backup_task": "",
"u_backup_verification": "false",
"u_campus_organizations": "High",
"u_change_history": "Low",
"u_completion_rating": "4 - Poor",
"u_contingency_plan": "Patches can be backed out, as necessary. We will be patching all non-production systems before this change, and expect to find any issues in the course of those updates, rather than find them in the process of executing the production updates.",
"u_coordination": "Medium",
"u_critical_services_affected": "Medium",
"u_directions": "",
"u_emergency_type_override": "false",
"u_end_user_experience": "Low",
"u_failure_end": "",
"u_failure_start": "",
"u_monitoring_task": "",
"u_monitoring_verification": "false",
"u_notify_affected": "false",
"u_notify_affected_date": "",
"u_notify_affected_task": "",
"u_notify_campus": "true",
"u_notify_campus_date": "2014-05-13",
"u_notify_campus_task": "CTASK0000915",
"u_notify_csr_date": "2014-05-09",
"u_notify_csr_list": "true",
"u_notify_csr_task": "CTASK0000916",
"u_notify_message_relay": "false",
"u_notify_message_relay_date": "",
"u_notify_message_relay_task": "",
"u_notify_mybyu": "false",
"u_notify_mybyu_date": "",
"u_notify_mybyu_task": "",
"u_notify_network": "false",
"u_notify_oit": "false",
"u_notify_oit_date": "",
"u_notify_oit_task": "",
"u_notify_ycloud": "false",
"u_notify_ycloud_date": "",
"u_notify_ycloud_task": "",
"u_number_of_people": "",
"u_osc_contacted": "false",
"u_peer_reviewed_by": "",
"u_planned_down_time": "1 Hour",
"u_requested_date": "",
"u_security_task": "",
"u_security_verification": "false",
"u_service": "",
"u_service_manager": "John Payne",
"u_service_manager_approval": "Yes",
"u_template": "",
"u_testing": "Medium",
"u_testing_task": "",
"u_testing_verification": "false",
"u_verification_plan": "This change will be executed in conjunction with the NOC staff. We will look to the NOC staff to help us validate that services are up, alerts have cleared, and they do not have issues as we execute this change.",
"watch_list": "John Payne",
"work_end": "2014-05-28 16:04:31",
"work_start": "2014-05-12 10:15:00"
}
number: string

Number field from the change_request form

cmdb_ci: string (32 to 32 chars)

Affected CI field from the change_request form

start_date: string (date-time)

Planned Start Date field from the change_request form

end_date: string (date-time)

Planned End Date field from the change_request form

requested_by: string (32 to 32 chars)

Submitted by field from the change_request form

type: string

Type field from the change_request form

risk: integer (int32)

Risk field from the change_request form

impact: integer (int32)

Impact field from the change_request form

short_description: string

Short Description field from the change_request form

description: string

Description field from the change_request form

priority: integer (int32)

Priority field from the change_request form

state: integer (int32)

Status field from the change_request form

assignment_group: string (32 to 32 chars)

Assignment group field from the change_request form

assigned_to: string (32 to 32 chars)

Assigned To field from the change_request form

watch_list: string

Watch list field from the change_request form

u_planned_down_time: string (date-time)

Planned Down Time field from the change_request form

work_start: string (date-time)

Actual Start field from the change_request form

work_end: string (date-time)

Actual End field from the change_request form

u_actual_down_time: string (date-time)

Actual Down Time field from the change_request form

u_completion_rating: string

Completion Rating field from the change_request form

comments: string

Work Log field from the change_request form

u_template: string (32 to 32 chars)

Template field from the change_request form

u_emergency_type_override: boolean

Emergency Override field from the change_request form

u_requested_date: string (date)

Requested Date field from the change_request form

u_testing: string

Risk Based on Testing field from the change_request form

u_change_history: string

Risk Based on Change History field from the change_request form

u_coordination: string

Level of Coordinating Groups field from the change_request form

u_critical_services_affected: string

Potential Impact to Critical Services field from the change_request form

u_end_user_experience: string

Impact to End User Experience field from the change_request form

u_campus_organizations: string

Potential Reach of Change field from the change_request form

u_verification_plan: string

Verification Plan field from the change_request form

u_contingency_plan: string

Contingency Plan field from the change_request form

u_service: string (32 to 32 chars)

Primary Affected Service field from the change_request form

u_service_manager: string (32 to 32 chars)

Service/Product Manager field from the change_request form

u_service_manager_approval: string

Service/Product Manager Approval field from the change_request form

cab_required: boolean

CAB required field from the change_request form

cab_delegate: string (32 to 32 chars)

CAB delegate field from the change_request form

sys_created_on: string (date-time)

Created field from the change_request form

sys_updated_on: string (date-time)

Updated field from the change_request form

requested_by_date: string (date-time)

Submitted field from the change_request form

closed_at: string (date-time)

Closed field from the change_request form

sys_created_by: string

Created by field from the change_request form

sys_updated_by: string

Updated by field from the change_request form

closed_by: string (32 to 32 chars)

Closed by field from the change_request form

u_approved: string (date-time)

Approved field from the change_request form

u_peer_reviewed_by: string (32 to 32 chars)

Peer Reviewed by field from the change_request form

u_number_of_people: integer (int32)

Number of People field from the change_request form

u_notify_network: boolean

Notify Network field from the change_request form

u_notify_mybyu: boolean

Notify MyBYU field from the change_request form

u_notify_mybyu_date: string (date)

Date to Send field from the change_request form

u_notify_mybyu_task: string (32 to 32 chars)

Task field from the change_request form

u_notify_campus: boolean

Notify Campus field from the change_request form

u_notify_campus_date: string (date)

Date to Send field from the change_request form

u_notify_campus_task: string (32 to 32 chars)

Task field from the change_request form

u_notify_message_relay: boolean

Message Relay field from the change_request form

u_notify_message_relay_date: string (date)

Date to Send field from the change_request form

u_notify_message_relay_task: string (32 to 32 chars)

Task field from the change_request form

u_notify_affected: boolean

Notify Affected field from the change_request form

u_notify_affected_date: string (date)

Date to Send field from the change_request form

u_notify_affected_task: string (32 to 32 chars)

Task field from the change_request form

u_notify_oit: boolean

Notify OIT field from the change_request form

u_notify_oit_date: string (date)

Date to Send field from the change_request form

u_notify_oit_task: string (32 to 32 chars)

Task field from the change_request form

u_notify_csr_list: boolean

Notify CSR List field from the change_request form

u_notify_csr_date: string (date)

Date to Send field from the change_request form

u_notify_csr_task: string (32 to 32 chars)

Task field from the change_request form

u_notify_ycloud: boolean

Notify YCloud Admins field from the change_request form

u_notify_ycloud_date: string (date)

Date to Send field from the change_request form

u_notify_ycloud_task: string (32 to 32 chars)

Task field from the change_request form

u_osc_contacted: boolean

OSC Contacted field from the change_request form

u_failure_start: string (date-time)

Failure Start field from the change_request form

u_failure_end: string (date-time)

Failure End field from the change_request form

cab_date: string (date)

Cab date field from the change_request form

cab_recommendation: string

Cab recommendation field from the change_request form

close_notes: string

Close notes field from the change_request form

u_monitoring_verification: boolean

Monitoring Verification field from the change_request form

u_monitoring_task: string (32 to 32 chars)

Monitoring Task field from the change_request form

u_security_verification: boolean

Security Verification field from the change_request form

u_security_task: string (32 to 32 chars)

Security Task field from the change_request form

u_backup_verification: boolean

Backup Verification field from the change_request form

u_backup_task: string (32 to 32 chars)

Backup Task field from the change_request form

u_directions: string

Directions field from the change_request form

u_testing_verification: boolean

Testing Verification field from the change_request form

u_testing_task: string (32 to 32 chars)

Testing Task field from the change_request form

approval: string

Approval field from the change_request form

category: string

Category field from the change_request form

sysparm_display_value

Pass 'true' to return the display value of the record, pass 'false' to get the sys_id of the record, or pass 'all' to get both for reference fields.

query string false
sysparm_exclude_reference_link

True to exclude Table API links for reference fields.

query string
sysparm_fields

A comma-separated list of fields to return in the response. Defaults to a list that will just get form fields

query string number,cmdb_ci,start_date,end_date,requested_by,type,risk,impact,short_description,description,priority,state,assignment_group,assigned_to,watch_list,u_planned_down_time,work_start,work_end,u_actual_down_time,u_completion_rating,comments,u_template,u_emergency_type_override,u_requested_date,u_testing,u_change_history,u_coordination,u_critical_services_affected,u_end_user_experience,u_campus_organizations,u_verification_plan,u_contingency_plan,u_service,u_service_manager,u_service_manager_approval,cab_required,cab_delegate,sys_created_on,sys_updated_on,requested_by_date,closed_at,sys_created_by,sys_updated_by,closed_by,u_approved,u_peer_reviewed_by,u_number_of_people,u_notify_network,u_notify_mybyu,u_notify_mybyu_date,u_notify_mybyu_task,u_notify_campus,u_notify_campus_date,u_notify_campus_task,u_notify_message_relay,u_notify_message_relay_date,u_notify_message_relay_task,u_notify_affected,u_notify_affected_date,u_notify_affected_task,u_notify_oit,u_notify_oit_date,u_notify_oit_task,u_notify_csr_list,u_notify_csr_date,u_notify_csr_task,u_notify_ycloud,u_notify_ycloud_date,u_notify_ycloud_task,u_osc_contacted,u_failure_start,u_failure_end,cab_date,cab_recommendation,close_code,close_notes,u_monitoring_verification,u_monitoring_task,u_security_verification,u_security_task,u_backup_verification,u_backup_task,u_directions,u_testing_verification,u_testing_task,approval,category
sysparm_view

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

query string
sysparm_input_display_value

True to set raw value of input fields.

query string false
sysparm_suppress_auto_sys_field

True to suppress auto generation of system fields.

query string false

application/json

200 OK

Success with response body.

result: object
{
"approval": "Not Yet Requested",
"assigned_to": "John Payne",
"assignment_group": "IS-Platform",
"cab_date": "",
"cab_delegate": "",
"cab_recommendation": "",
"cab_required": "false",
"category": "Other",
"close_notes": "",
"closed_at": "2014-05-28 16:04:31",
"closed_by": "John Payne",
"cmdb_ci": "",
"comments": "",
"description": "Semiannual Linux system updates. Schedule will follow the established pattern. Non-clustered systems will be patched on May 15 @ 12:01 am. Not included in this change are any ESX hosts, SAN patches, or Exadata patching. A more detailed description of the patch process, issues, and procedures being executed will be available at https://developer.byu.edu/wiki/pages/viewpage.action?pageId=48956666 in Mid-April.",
"end_date": "2014-05-18 03:00:00",
"impact": "3 - Low",
"number": "RFC0000002",
"priority": "Medium - B",
"requested_by": "John Payne",
"requested_by_date": "2014-02-06 15:06:06",
"risk": "Moderate",
"short_description": "Semiannual Linux system updates",
"start_date": "2014-05-12 09:00:00",
"state": "Finished",
"sys_created_by": "jjp",
"sys_created_on": "2014-02-06 14:51:52",
"sys_updated_by": "dlb44",
"sys_updated_on": "2015-07-16 17:11:56",
"type": "Request for Change",
"u_actual_down_time": "",
"u_approved": "2014-05-27 09:49:38",
"u_backup_task": "",
"u_backup_verification": "false",
"u_campus_organizations": "High",
"u_change_history": "Low",
"u_completion_rating": "4 - Poor",
"u_contingency_plan": "Patches can be backed out, as necessary. We will be patching all non-production systems before this change, and expect to find any issues in the course of those updates, rather than find them in the process of executing the production updates.",
"u_coordination": "Medium",
"u_critical_services_affected": "Medium",
"u_directions": "",
"u_emergency_type_override": "false",
"u_end_user_experience": "Low",
"u_failure_end": "",
"u_failure_start": "",
"u_monitoring_task": "",
"u_monitoring_verification": "false",
"u_notify_affected": "false",
"u_notify_affected_date": "",
"u_notify_affected_task": "",
"u_notify_campus": "true",
"u_notify_campus_date": "2014-05-13",
"u_notify_campus_task": "CTASK0000915",
"u_notify_csr_date": "2014-05-09",
"u_notify_csr_list": "true",
"u_notify_csr_task": "CTASK0000916",
"u_notify_message_relay": "false",
"u_notify_message_relay_date": "",
"u_notify_message_relay_task": "",
"u_notify_mybyu": "false",
"u_notify_mybyu_date": "",
"u_notify_mybyu_task": "",
"u_notify_network": "false",
"u_notify_oit": "false",
"u_notify_oit_date": "",
"u_notify_oit_task": "",
"u_notify_ycloud": "false",
"u_notify_ycloud_date": "",
"u_notify_ycloud_task": "",
"u_number_of_people": "",
"u_osc_contacted": "false",
"u_peer_reviewed_by": "",
"u_planned_down_time": "1 Hour",
"u_requested_date": "",
"u_security_task": "",
"u_security_verification": "false",
"u_service": "",
"u_service_manager": "John Payne",
"u_service_manager_approval": "Yes",
"u_template": "",
"u_testing": "Medium",
"u_testing_task": "",
"u_testing_verification": "false",
"u_verification_plan": "This change will be executed in conjunction with the NOC staff. We will look to the NOC staff to help us validate that services are up, alerts have cleared, and they do not have issues as we execute this change.",
"watch_list": "John Payne",
"work_end": "2014-05-28 16:04:31",
"work_start": "2014-05-12 10:15:00"
}
number: string

Number field from the change_request form

cmdb_ci: string (32 to 32 chars)

Affected CI field from the change_request form

start_date: string (date-time)

Planned Start Date field from the change_request form

end_date: string (date-time)

Planned End Date field from the change_request form

requested_by: string (32 to 32 chars)

Submitted by field from the change_request form

type: string

Type field from the change_request form

risk: integer (int32)

Risk field from the change_request form

impact: integer (int32)

Impact field from the change_request form

short_description: string

Short Description field from the change_request form

description: string

Description field from the change_request form

priority: integer (int32)

Priority field from the change_request form

state: integer (int32)

Status field from the change_request form

assignment_group: string (32 to 32 chars)

Assignment group field from the change_request form

assigned_to: string (32 to 32 chars)

Assigned To field from the change_request form

watch_list: string

Watch list field from the change_request form

u_planned_down_time: string (date-time)

Planned Down Time field from the change_request form

work_start: string (date-time)

Actual Start field from the change_request form

work_end: string (date-time)

Actual End field from the change_request form

u_actual_down_time: string (date-time)

Actual Down Time field from the change_request form

u_completion_rating: string

Completion Rating field from the change_request form

comments: string

Work Log field from the change_request form

u_template: string (32 to 32 chars)

Template field from the change_request form

u_emergency_type_override: boolean

Emergency Override field from the change_request form

u_requested_date: string (date)

Requested Date field from the change_request form

u_testing: string

Risk Based on Testing field from the change_request form

u_change_history: string

Risk Based on Change History field from the change_request form

u_coordination: string

Level of Coordinating Groups field from the change_request form

u_critical_services_affected: string

Potential Impact to Critical Services field from the change_request form

u_end_user_experience: string

Impact to End User Experience field from the change_request form

u_campus_organizations: string

Potential Reach of Change field from the change_request form

u_verification_plan: string

Verification Plan field from the change_request form

u_contingency_plan: string

Contingency Plan field from the change_request form

u_service: string (32 to 32 chars)

Primary Affected Service field from the change_request form

u_service_manager: string (32 to 32 chars)

Service/Product Manager field from the change_request form

u_service_manager_approval: string

Service/Product Manager Approval field from the change_request form

cab_required: boolean

CAB required field from the change_request form

cab_delegate: string (32 to 32 chars)

CAB delegate field from the change_request form

sys_created_on: string (date-time)

Created field from the change_request form

sys_updated_on: string (date-time)

Updated field from the change_request form

requested_by_date: string (date-time)

Submitted field from the change_request form

closed_at: string (date-time)

Closed field from the change_request form

sys_created_by: string

Created by field from the change_request form

sys_updated_by: string

Updated by field from the change_request form

closed_by: string (32 to 32 chars)

Closed by field from the change_request form

u_approved: string (date-time)

Approved field from the change_request form

u_peer_reviewed_by: string (32 to 32 chars)

Peer Reviewed by field from the change_request form

u_number_of_people: integer (int32)

Number of People field from the change_request form

u_notify_network: boolean

Notify Network field from the change_request form

u_notify_mybyu: boolean

Notify MyBYU field from the change_request form

u_notify_mybyu_date: string (date)

Date to Send field from the change_request form

u_notify_mybyu_task: string (32 to 32 chars)

Task field from the change_request form

u_notify_campus: boolean

Notify Campus field from the change_request form

u_notify_campus_date: string (date)

Date to Send field from the change_request form

u_notify_campus_task: string (32 to 32 chars)

Task field from the change_request form

u_notify_message_relay: boolean

Message Relay field from the change_request form

u_notify_message_relay_date: string (date)

Date to Send field from the change_request form

u_notify_message_relay_task: string (32 to 32 chars)

Task field from the change_request form

u_notify_affected: boolean

Notify Affected field from the change_request form

u_notify_affected_date: string (date)

Date to Send field from the change_request form

u_notify_affected_task: string (32 to 32 chars)

Task field from the change_request form

u_notify_oit: boolean

Notify OIT field from the change_request form

u_notify_oit_date: string (date)

Date to Send field from the change_request form

u_notify_oit_task: string (32 to 32 chars)

Task field from the change_request form

u_notify_csr_list: boolean

Notify CSR List field from the change_request form

u_notify_csr_date: string (date)

Date to Send field from the change_request form

u_notify_csr_task: string (32 to 32 chars)

Task field from the change_request form

u_notify_ycloud: boolean

Notify YCloud Admins field from the change_request form

u_notify_ycloud_date: string (date)

Date to Send field from the change_request form

u_notify_ycloud_task: string (32 to 32 chars)

Task field from the change_request form

u_osc_contacted: boolean

OSC Contacted field from the change_request form

u_failure_start: string (date-time)

Failure Start field from the change_request form

u_failure_end: string (date-time)

Failure End field from the change_request form

cab_date: string (date)

Cab date field from the change_request form

cab_recommendation: string

Cab recommendation field from the change_request form

close_notes: string

Close notes field from the change_request form

u_monitoring_verification: boolean

Monitoring Verification field from the change_request form

u_monitoring_task: string (32 to 32 chars)

Monitoring Task field from the change_request form

u_security_verification: boolean

Security Verification field from the change_request form

u_security_task: string (32 to 32 chars)

Security Task field from the change_request form

u_backup_verification: boolean

Backup Verification field from the change_request form

u_backup_task: string (32 to 32 chars)

Backup Task field from the change_request form

u_directions: string

Directions field from the change_request form

u_testing_verification: boolean

Testing Verification field from the change_request form

u_testing_task: string (32 to 32 chars)

Testing Task field from the change_request form

approval: string

Approval field from the change_request form

category: string

Category field from the change_request form

201 Created

Success with response body

result: object
{
"approval": "Not Yet Requested",
"assigned_to": "John Payne",
"assignment_group": "IS-Platform",
"cab_date": "",
"cab_delegate": "",
"cab_recommendation": "",
"cab_required": "false",
"category": "Other",
"close_notes": "",
"closed_at": "2014-05-28 16:04:31",
"closed_by": "John Payne",
"cmdb_ci": "",
"comments": "",
"description": "Semiannual Linux system updates. Schedule will follow the established pattern. Non-clustered systems will be patched on May 15 @ 12:01 am. Not included in this change are any ESX hosts, SAN patches, or Exadata patching. A more detailed description of the patch process, issues, and procedures being executed will be available at https://developer.byu.edu/wiki/pages/viewpage.action?pageId=48956666 in Mid-April.",
"end_date": "2014-05-18 03:00:00",
"impact": "3 - Low",
"number": "RFC0000002",
"priority": "Medium - B",
"requested_by": "John Payne",
"requested_by_date": "2014-02-06 15:06:06",
"risk": "Moderate",
"short_description": "Semiannual Linux system updates",
"start_date": "2014-05-12 09:00:00",
"state": "Finished",
"sys_created_by": "jjp",
"sys_created_on": "2014-02-06 14:51:52",
"sys_updated_by": "dlb44",
"sys_updated_on": "2015-07-16 17:11:56",
"type": "Request for Change",
"u_actual_down_time": "",
"u_approved": "2014-05-27 09:49:38",
"u_backup_task": "",
"u_backup_verification": "false",
"u_campus_organizations": "High",
"u_change_history": "Low",
"u_completion_rating": "4 - Poor",
"u_contingency_plan": "Patches can be backed out, as necessary. We will be patching all non-production systems before this change, and expect to find any issues in the course of those updates, rather than find them in the process of executing the production updates.",
"u_coordination": "Medium",
"u_critical_services_affected": "Medium",
"u_directions": "",
"u_emergency_type_override": "false",
"u_end_user_experience": "Low",
"u_failure_end": "",
"u_failure_start": "",
"u_monitoring_task": "",
"u_monitoring_verification": "false",
"u_notify_affected": "false",
"u_notify_affected_date": "",
"u_notify_affected_task": "",
"u_notify_campus": "true",
"u_notify_campus_date": "2014-05-13",
"u_notify_campus_task": "CTASK0000915",
"u_notify_csr_date": "2014-05-09",
"u_notify_csr_list": "true",
"u_notify_csr_task": "CTASK0000916",
"u_notify_message_relay": "false",
"u_notify_message_relay_date": "",
"u_notify_message_relay_task": "",
"u_notify_mybyu": "false",
"u_notify_mybyu_date": "",
"u_notify_mybyu_task": "",
"u_notify_network": "false",
"u_notify_oit": "false",
"u_notify_oit_date": "",
"u_notify_oit_task": "",
"u_notify_ycloud": "false",
"u_notify_ycloud_date": "",
"u_notify_ycloud_task": "",
"u_number_of_people": "",
"u_osc_contacted": "false",
"u_peer_reviewed_by": "",
"u_planned_down_time": "1 Hour",
"u_requested_date": "",
"u_security_task": "",
"u_security_verification": "false",
"u_service": "",
"u_service_manager": "John Payne",
"u_service_manager_approval": "Yes",
"u_template": "",
"u_testing": "Medium",
"u_testing_task": "",
"u_testing_verification": "false",
"u_verification_plan": "This change will be executed in conjunction with the NOC staff. We will look to the NOC staff to help us validate that services are up, alerts have cleared, and they do not have issues as we execute this change.",
"watch_list": "John Payne",
"work_end": "2014-05-28 16:04:31",
"work_start": "2014-05-12 10:15:00"
}
number: string

Number field from the change_request form

cmdb_ci: string (32 to 32 chars)

Affected CI field from the change_request form

start_date: string (date-time)

Planned Start Date field from the change_request form

end_date: string (date-time)

Planned End Date field from the change_request form

requested_by: string (32 to 32 chars)

Submitted by field from the change_request form

type: string

Type field from the change_request form

risk: integer (int32)

Risk field from the change_request form

impact: integer (int32)

Impact field from the change_request form

short_description: string

Short Description field from the change_request form

description: string

Description field from the change_request form

priority: integer (int32)

Priority field from the change_request form

state: integer (int32)

Status field from the change_request form

assignment_group: string (32 to 32 chars)

Assignment group field from the change_request form

assigned_to: string (32 to 32 chars)

Assigned To field from the change_request form

watch_list: string

Watch list field from the change_request form

u_planned_down_time: string (date-time)

Planned Down Time field from the change_request form

work_start: string (date-time)

Actual Start field from the change_request form

work_end: string (date-time)

Actual End field from the change_request form

u_actual_down_time: string (date-time)

Actual Down Time field from the change_request form

u_completion_rating: string

Completion Rating field from the change_request form

comments: string

Work Log field from the change_request form

u_template: string (32 to 32 chars)

Template field from the change_request form

u_emergency_type_override: boolean

Emergency Override field from the change_request form

u_requested_date: string (date)

Requested Date field from the change_request form

u_testing: string

Risk Based on Testing field from the change_request form

u_change_history: string

Risk Based on Change History field from the change_request form

u_coordination: string

Level of Coordinating Groups field from the change_request form

u_critical_services_affected: string

Potential Impact to Critical Services field from the change_request form

u_end_user_experience: string

Impact to End User Experience field from the change_request form

u_campus_organizations: string

Potential Reach of Change field from the change_request form

u_verification_plan: string

Verification Plan field from the change_request form

u_contingency_plan: string

Contingency Plan field from the change_request form

u_service: string (32 to 32 chars)

Primary Affected Service field from the change_request form

u_service_manager: string (32 to 32 chars)

Service/Product Manager field from the change_request form

u_service_manager_approval: string

Service/Product Manager Approval field from the change_request form

cab_required: boolean

CAB required field from the change_request form

cab_delegate: string (32 to 32 chars)

CAB delegate field from the change_request form

sys_created_on: string (date-time)

Created field from the change_request form

sys_updated_on: string (date-time)

Updated field from the change_request form

requested_by_date: string (date-time)

Submitted field from the change_request form

closed_at: string (date-time)

Closed field from the change_request form

sys_created_by: string

Created by field from the change_request form

sys_updated_by: string

Updated by field from the change_request form

closed_by: string (32 to 32 chars)

Closed by field from the change_request form

u_approved: string (date-time)

Approved field from the change_request form

u_peer_reviewed_by: string (32 to 32 chars)

Peer Reviewed by field from the change_request form

u_number_of_people: integer (int32)

Number of People field from the change_request form

u_notify_network: boolean

Notify Network field from the change_request form

u_notify_mybyu: boolean

Notify MyBYU field from the change_request form

u_notify_mybyu_date: string (date)

Date to Send field from the change_request form

u_notify_mybyu_task: string (32 to 32 chars)

Task field from the change_request form

u_notify_campus: boolean

Notify Campus field from the change_request form

u_notify_campus_date: string (date)

Date to Send field from the change_request form

u_notify_campus_task: string (32 to 32 chars)

Task field from the change_request form

u_notify_message_relay: boolean

Message Relay field from the change_request form

u_notify_message_relay_date: string (date)

Date to Send field from the change_request form

u_notify_message_relay_task: string (32 to 32 chars)

Task field from the change_request form

u_notify_affected: boolean

Notify Affected field from the change_request form

u_notify_affected_date: string (date)

Date to Send field from the change_request form

u_notify_affected_task: string (32 to 32 chars)

Task field from the change_request form

u_notify_oit: boolean

Notify OIT field from the change_request form

u_notify_oit_date: string (date)

Date to Send field from the change_request form

u_notify_oit_task: string (32 to 32 chars)

Task field from the change_request form

u_notify_csr_list: boolean

Notify CSR List field from the change_request form

u_notify_csr_date: string (date)

Date to Send field from the change_request form

u_notify_csr_task: string (32 to 32 chars)

Task field from the change_request form

u_notify_ycloud: boolean

Notify YCloud Admins field from the change_request form

u_notify_ycloud_date: string (date)

Date to Send field from the change_request form

u_notify_ycloud_task: string (32 to 32 chars)

Task field from the change_request form

u_osc_contacted: boolean

OSC Contacted field from the change_request form

u_failure_start: string (date-time)

Failure Start field from the change_request form

u_failure_end: string (date-time)

Failure End field from the change_request form

cab_date: string (date)

Cab date field from the change_request form

cab_recommendation: string

Cab recommendation field from the change_request form

close_notes: string

Close notes field from the change_request form

u_monitoring_verification: boolean

Monitoring Verification field from the change_request form

u_monitoring_task: string (32 to 32 chars)

Monitoring Task field from the change_request form

u_security_verification: boolean

Security Verification field from the change_request form

u_security_task: string (32 to 32 chars)

Security Task field from the change_request form

u_backup_verification: boolean

Backup Verification field from the change_request form

u_backup_task: string (32 to 32 chars)

Backup Task field from the change_request form

u_directions: string

Directions field from the change_request form

u_testing_verification: boolean

Testing Verification field from the change_request form

u_testing_task: string (32 to 32 chars)

Testing Task field from the change_request form

approval: string

Approval field from the change_request form

category: string

Category field from the change_request form

204 No Content

Success with no response body

400 Bad Request

The request URI does not match the APIs in the system, or the operation failed for unknown reasons. Invalid headers can also cause this error.

401 Unauthorized

The user is not authorized to use the API.

403 Forbidden

The requested operation is not permitted for the user. This error can also be caused by ACL failures, or business rule or data policy constraints.

404 Not Found

The requested resource was not found. This can be caused by an ACL constraint or if the resource does not exist.

405 Method Not Allowed

The HTTP action is not allowed for the requested REST API, or it is not supported by any API.

406 Not Acceptable

The endpoint does not support the response format specified in the request Accept header.

415 Unsupported Media Type

The endpoint does not support the format of the request body.

returns a single Change Request record

GET /change-request/{sys_id}*

sysparm_display_value

Pass 'true' to return the display value of the record, pass 'false' to get the sys_id of the record, or pass 'all' to get both for reference fields.

query string false
sysparm_exclude_reference_link

True to exclude Table API links for reference fields.

query string
sysparm_fields

A comma-separated list of fields to return in the response. Defaults to a list that will just get form fields

query string number,cmdb_ci,start_date,end_date,requested_by,type,risk,impact,short_description,description,priority,state,assignment_group,assigned_to,watch_list,u_planned_down_time,work_start,work_end,u_actual_down_time,u_completion_rating,comments,u_template,u_emergency_type_override,u_requested_date,u_testing,u_change_history,u_coordination,u_critical_services_affected,u_end_user_experience,u_campus_organizations,u_verification_plan,u_contingency_plan,u_service,u_service_manager,u_service_manager_approval,cab_required,cab_delegate,sys_created_on,sys_updated_on,requested_by_date,closed_at,sys_created_by,sys_updated_by,closed_by,u_approved,u_peer_reviewed_by,u_number_of_people,u_notify_network,u_notify_mybyu,u_notify_mybyu_date,u_notify_mybyu_task,u_notify_campus,u_notify_campus_date,u_notify_campus_task,u_notify_message_relay,u_notify_message_relay_date,u_notify_message_relay_task,u_notify_affected,u_notify_affected_date,u_notify_affected_task,u_notify_oit,u_notify_oit_date,u_notify_oit_task,u_notify_csr_list,u_notify_csr_date,u_notify_csr_task,u_notify_ycloud,u_notify_ycloud_date,u_notify_ycloud_task,u_osc_contacted,u_failure_start,u_failure_end,cab_date,cab_recommendation,close_code,close_notes,u_monitoring_verification,u_monitoring_task,u_security_verification,u_security_task,u_backup_verification,u_backup_task,u_directions,u_testing_verification,u_testing_task,approval,category
sysparm_view

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

query string
sysparm_input_display_value

True to set raw value of input fields.

query string false
sysparm_suppress_auto_sys_field

True to suppress auto generation of system fields.

query string false
sys_id

sys_id of the record you would like to delete from the table.

path string

application/json

200 OK

Success with response body.

result: object
{
"approval": "Not Yet Requested",
"assigned_to": "John Payne",
"assignment_group": "IS-Platform",
"cab_date": "",
"cab_delegate": "",
"cab_recommendation": "",
"cab_required": "false",
"category": "Other",
"close_notes": "",
"closed_at": "2014-05-28 16:04:31",
"closed_by": "John Payne",
"cmdb_ci": "",
"comments": "",
"description": "Semiannual Linux system updates. Schedule will follow the established pattern. Non-clustered systems will be patched on May 15 @ 12:01 am. Not included in this change are any ESX hosts, SAN patches, or Exadata patching. A more detailed description of the patch process, issues, and procedures being executed will be available at https://developer.byu.edu/wiki/pages/viewpage.action?pageId=48956666 in Mid-April.",
"end_date": "2014-05-18 03:00:00",
"impact": "3 - Low",
"number": "RFC0000002",
"priority": "Medium - B",
"requested_by": "John Payne",
"requested_by_date": "2014-02-06 15:06:06",
"risk": "Moderate",
"short_description": "Semiannual Linux system updates",
"start_date": "2014-05-12 09:00:00",
"state": "Finished",
"sys_created_by": "jjp",
"sys_created_on": "2014-02-06 14:51:52",
"sys_updated_by": "dlb44",
"sys_updated_on": "2015-07-16 17:11:56",
"type": "Request for Change",
"u_actual_down_time": "",
"u_approved": "2014-05-27 09:49:38",
"u_backup_task": "",
"u_backup_verification": "false",
"u_campus_organizations": "High",
"u_change_history": "Low",
"u_completion_rating": "4 - Poor",
"u_contingency_plan": "Patches can be backed out, as necessary. We will be patching all non-production systems before this change, and expect to find any issues in the course of those updates, rather than find them in the process of executing the production updates.",
"u_coordination": "Medium",
"u_critical_services_affected": "Medium",
"u_directions": "",
"u_emergency_type_override": "false",
"u_end_user_experience": "Low",
"u_failure_end": "",
"u_failure_start": "",
"u_monitoring_task": "",
"u_monitoring_verification": "false",
"u_notify_affected": "false",
"u_notify_affected_date": "",
"u_notify_affected_task": "",
"u_notify_campus": "true",
"u_notify_campus_date": "2014-05-13",
"u_notify_campus_task": "CTASK0000915",
"u_notify_csr_date": "2014-05-09",
"u_notify_csr_list": "true",
"u_notify_csr_task": "CTASK0000916",
"u_notify_message_relay": "false",
"u_notify_message_relay_date": "",
"u_notify_message_relay_task": "",
"u_notify_mybyu": "false",
"u_notify_mybyu_date": "",
"u_notify_mybyu_task": "",
"u_notify_network": "false",
"u_notify_oit": "false",
"u_notify_oit_date": "",
"u_notify_oit_task": "",
"u_notify_ycloud": "false",
"u_notify_ycloud_date": "",
"u_notify_ycloud_task": "",
"u_number_of_people": "",
"u_osc_contacted": "false",
"u_peer_reviewed_by": "",
"u_planned_down_time": "1 Hour",
"u_requested_date": "",
"u_security_task": "",
"u_security_verification": "false",
"u_service": "",
"u_service_manager": "John Payne",
"u_service_manager_approval": "Yes",
"u_template": "",
"u_testing": "Medium",
"u_testing_task": "",
"u_testing_verification": "false",
"u_verification_plan": "This change will be executed in conjunction with the NOC staff. We will look to the NOC staff to help us validate that services are up, alerts have cleared, and they do not have issues as we execute this change.",
"watch_list": "John Payne",
"work_end": "2014-05-28 16:04:31",
"work_start": "2014-05-12 10:15:00"
}
number: string

Number field from the change_request form

cmdb_ci: string (32 to 32 chars)

Affected CI field from the change_request form

start_date: string (date-time)

Planned Start Date field from the change_request form

end_date: string (date-time)

Planned End Date field from the change_request form

requested_by: string (32 to 32 chars)

Submitted by field from the change_request form

type: string

Type field from the change_request form

risk: integer (int32)

Risk field from the change_request form

impact: integer (int32)

Impact field from the change_request form

short_description: string

Short Description field from the change_request form

description: string

Description field from the change_request form

priority: integer (int32)

Priority field from the change_request form

state: integer (int32)

Status field from the change_request form

assignment_group: string (32 to 32 chars)

Assignment group field from the change_request form

assigned_to: string (32 to 32 chars)

Assigned To field from the change_request form

watch_list: string

Watch list field from the change_request form

u_planned_down_time: string (date-time)

Planned Down Time field from the change_request form

work_start: string (date-time)

Actual Start field from the change_request form

work_end: string (date-time)

Actual End field from the change_request form

u_actual_down_time: string (date-time)

Actual Down Time field from the change_request form

u_completion_rating: string

Completion Rating field from the change_request form

comments: string

Work Log field from the change_request form

u_template: string (32 to 32 chars)

Template field from the change_request form

u_emergency_type_override: boolean

Emergency Override field from the change_request form

u_requested_date: string (date)

Requested Date field from the change_request form

u_testing: string

Risk Based on Testing field from the change_request form

u_change_history: string

Risk Based on Change History field from the change_request form

u_coordination: string

Level of Coordinating Groups field from the change_request form

u_critical_services_affected: string

Potential Impact to Critical Services field from the change_request form

u_end_user_experience: string

Impact to End User Experience field from the change_request form