@itentialopensource/adapter-servicenow
Version:
This adapter integrates with system described as: servicenowMadrid.
1,202 lines (1,181 loc) • 233 kB
YAML
openapi: 3.0.0
info:
title: ServiceNow Madrid
description: Custom built swagger for ServiceNow Madrid. Built May 21, 2019
contact: {}
version: '1.0.0'
servers:
- url: https://{defaultHost}
variables:
defaultHost:
default: www.example.com
paths:
/now/table/{tableName}/{sys_id}:
get:
tags:
- Table
summary: queryTableByNameAndId
description: Retrieves the record identified by the specified sys_id from the specified table.
operationId: queryTableByNameAndId
parameters:
- name: tableName
in: path
description: Name of the table from which to retrieve the records.
required: true
style: simple
schema:
type: string
- name: sys_id
in: path
description: Unique identifier of the record to retrieve.
required: true
style: simple
schema:
type: string
responses:
'200':
description: Request completed successfully. If a valid query returned no results, the response body contains only an empty result array.
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/NowTableResponse'
- example:
result:
upon_approval: ''
location:
link: https://instance.service-now.com/api/now/table/cmn_location/105cf7f3c611227501e75e08b14a38ba
value: 105cf7f3c611227501e75e08b14a38ba
expected_start: ''
reopen_count: ''
close_notes: ''
additional_assignee_list: ''
impact: '1'
urgency: '3'
correlation_id: ''
sys_tags: ''
sys_domain:
link: https://instance.service-now.com/api/now/table/sys_user_group/global
value: global
description: ''
group_list: ''
priority: '3'
delivery_plan: ''
sys_mod_count: '4'
work_notes_list: ''
business_service: ''
follow_up: ''
closed_at: ''
sla_due: 2015-11-11 22:04:15
delivery_task: ''
sys_updated_on: 2015-11-01 22:37:27
parent: ''
work_end: ''
number: INC0000046
closed_by: ''
work_start: ''
calendar_stc: ''
category: software
business_duration: ''
incident_state: '1'
activity_due: ''
correlation_display: ''
company: ''
active: 'true'
due_date: ''
assignment_group:
link: https://instance.service-now.com/api/now/table/sys_user_group/8a4dde73c6112278017a6a4baf547aa7
value: 8a4dde73c6112278017a6a4baf547aa7
caller_id:
link: https://instance.service-now.com/api/now/table/sys_user/46c6f9efa9fe198101ddf5eed9adf6e7
value: 46c6f9efa9fe198101ddf5eed9adf6e7
knowledge: 'false'
made_sla: 'false'
comments_and_work_notes: ''
parent_incident: ''
state: '1'
user_input: ''
sys_created_on: 2015-11-01 22:05:30
approval_set: ''
reassignment_count: '1'
rfc: ''
child_incidents: ''
opened_at: 2015-11-02 22:04:15
short_description: Can't access SFA software
order: ''
sys_updated_by: glide.maint
resolved_by: ''
notify: '1'
upon_reject: ''
approval_history: ''
problem_id:
link: https://instance.service-now.com/api/now/table/problem/a9e4890bc6112276003d7a5a5c774a74
value: a9e4890bc6112276003d7a5a5c774a74
work_notes: ''
calendar_duration: ''
close_code: ''
sys_id: a9e30c7dc61122760116894de7bcc7bd
approval: not requested
caused_by: ''
severity: '3'
sys_created_by: admin
resolved_at: ''
assigned_to: ''
business_stc: ''
wf_activity: ''
sys_domain_path: /
cmdb_ci:
link: https://instance.service-now.com/api/now/table/cmdb_ci/a9c0c8d2c6112276018f7705562f9cb0
value: a9c0c8d2c6112276018f7705562f9cb0
opened_by:
link: https://instance.service-now.com/api/now/table/sys_user/46c6f9efa9fe198101ddf5eed9adf6e7
value: 46c6f9efa9fe198101ddf5eed9adf6e7
subcategory: ''
rejection_goto: ''
sys_class_name: incident
watch_list: ''
time_worked: ''
contact_type: phone
escalation: '0'
comments: ''
examples:
name-value-pairs:
value:
result:
upon_approval: ''
location:
link: https://instance.service-now.com/api/now/table/cmn_location/105cf7f3c611227501e75e08b14a38ba
value: 105cf7f3c611227501e75e08b14a38ba
expected_start: ''
reopen_count: ''
close_notes: ''
additional_assignee_list: ''
impact: '1'
urgency: '3'
correlation_id: ''
sys_tags: ''
sys_domain:
link: https://instance.service-now.com/api/now/table/sys_user_group/global
value: global
description: ''
group_list: ''
priority: '3'
delivery_plan: ''
sys_mod_count: '4'
work_notes_list: ''
business_service: ''
follow_up: ''
closed_at: ''
sla_due: 2015-11-11 22:04:15
delivery_task: ''
sys_updated_on: 2015-11-01 22:37:27
parent: ''
work_end: ''
number: INC0000046
closed_by: ''
work_start: ''
calendar_stc: ''
category: software
business_duration: ''
incident_state: '1'
activity_due: ''
correlation_display: ''
company: ''
active: 'true'
due_date: ''
assignment_group:
link: https://instance.service-now.com/api/now/table/sys_user_group/8a4dde73c6112278017a6a4baf547aa7
value: 8a4dde73c6112278017a6a4baf547aa7
caller_id:
link: https://instance.service-now.com/api/now/table/sys_user/46c6f9efa9fe198101ddf5eed9adf6e7
value: 46c6f9efa9fe198101ddf5eed9adf6e7
knowledge: 'false'
made_sla: 'false'
comments_and_work_notes: ''
parent_incident: ''
state: '1'
user_input: ''
sys_created_on: 2015-11-01 22:05:30
approval_set: ''
reassignment_count: '1'
rfc: ''
child_incidents: ''
opened_at: 2015-11-02 22:04:15
short_description: Can't access SFA software
order: ''
sys_updated_by: glide.maint
resolved_by: ''
notify: '1'
upon_reject: ''
approval_history: ''
problem_id:
link: https://instance.service-now.com/api/now/table/problem/a9e4890bc6112276003d7a5a5c774a74
value: a9e4890bc6112276003d7a5a5c774a74
work_notes: ''
calendar_duration: ''
close_code: ''
sys_id: a9e30c7dc61122760116894de7bcc7bd
approval: not requested
caused_by: ''
severity: '3'
sys_created_by: admin
resolved_at: ''
assigned_to: ''
business_stc: ''
wf_activity: ''
sys_domain_path: /
cmdb_ci:
link: https://instance.service-now.com/api/now/table/cmdb_ci/a9c0c8d2c6112276018f7705562f9cb0
value: a9c0c8d2c6112276018f7705562f9cb0
opened_by:
link: https://instance.service-now.com/api/now/table/sys_user/46c6f9efa9fe198101ddf5eed9adf6e7
value: 46c6f9efa9fe198101ddf5eed9adf6e7
subcategory: ''
rejection_goto: ''
sys_class_name: incident
watch_list: ''
time_worked: ''
contact_type: phone
escalation: '0'
comments: ''
'404':
description: Indicates the record is not found or the requesting user does not have access to the record.
headers: {}
content: {}
deprecated: false
put:
tags:
- Table
summary: updateTableRecord
description: >+
Updates the specified record with the request body.
operationId: updateTableRecord
parameters:
- name: tableName
in: path
description: Name of the table from which to retrieve the records.
required: true
style: simple
schema:
type: string
- name: sys_id
in: path
description: Unique identifier of the record to retrieve.
required: true
style: simple
schema:
type: string
requestBody:
description: 'name-value pairs for the field(s) to update in the associated table. For example, to update the short description file, enter a name-value pair similar to the following: --data "{\"short_description\": \"my short desc\" }" \.'
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/NowTableRequest'
- description: 'name-value pairs for the field(s) to update in the associated table. For example, to update the short description file, enter a name-value pair similar to the following: --data "{\"short_description\": \"my short desc\" }" \.'
example:
assigned_to: 681b365ec0a80164000fb0b05854a0cd
urgency: '1'
comments: Elevating urgency, this is a blocking issue
examples:
name-value pairs:
value:
assigned_to: 681b365ec0a80164000fb0b05854a0cd
urgency: '1'
comments: Elevating urgency, this is a blocking issue
required: true
responses:
'200':
description: Indicates the request completed successfully.
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/NowTableResponse'
- example:
result:
upon_approval: proceed
location:
link: https://instance.service-now.com/api/now/table/cmn_location/108752c8c611227501d4ab0e392ba97f
value: 108752c8c611227501d4ab0e392ba97f
expected_start: ''
reopen_count: ''
close_notes: ''
additional_assignee_list: ''
impact: '1'
urgency: '1'
correlation_id: ''
sys_tags: ''
sys_domain:
link: https://instance.service-now.com/api/now/table/sys_user_group/global
value: global
description: ''
group_list: ''
priority: '1'
delivery_plan: ''
sys_mod_count: '7'
work_notes_list: ''
business_service: ''
follow_up: ''
closed_at: ''
sla_due: 2017-07-05 05:58:24
delivery_task: ''
sys_updated_on: 2016-01-22 14:12:37
parent: ''
work_end: ''
number: INC0000050
closed_by: ''
work_start: ''
calendar_stc: ''
category: hardware
business_duration: ''
incident_state: '2'
activity_due: 2016-01-22 16:12:37
correlation_display: ''
company:
link: https://instance.service-now.com/api/now/table/core_company/31bea3d53790200044e0bfc8bcbe5dec
value: 31bea3d53790200044e0bfc8bcbe5dec
active: 'true'
due_date: ''
assignment_group:
link: https://instance.service-now.com/api/now/table/sys_user_group/8a5055c9c61122780043563ef53438e3
value: 8a5055c9c61122780043563ef53438e3
caller_id:
link: https://instance.service-now.com/api/now/table/sys_user/5b7c200d0a640069006b3845b5d0fa7c
value: 5b7c200d0a640069006b3845b5d0fa7c
knowledge: 'false'
made_sla: 'true'
comments_and_work_notes: ''
parent_incident: ''
state: '2'
user_input: ''
sys_created_on: 2015-11-02 18:05:40
approval_set: ''
reassignment_count: '0'
rfc: ''
child_incidents: ''
opened_at: 2015-11-02 21:58:24
short_description: Can't access Exchange server - is it down?
order: ''
sys_updated_by: admin
resolved_by: ''
notify: '1'
upon_reject: cancel
approval_history: ''
problem_id: ''
work_notes: ''
calendar_duration: ''
close_code: ''
sys_id: ef43c6d40a0a0b5700c77f9bf387afe3
approval: not requested
caused_by: ''
severity: '3'
sys_created_by: glide.maint
resolved_at: ''
assigned_to:
link: https://instance.service-now.com/api/now/table/sys_user/681b365ec0a80164000fb0b05854a0cd
value: 681b365ec0a80164000fb0b05854a0cd
business_stc: ''
wf_activity: ''
sys_domain_path: /
cmdb_ci:
link: https://instance.service-now.com/api/now/table/cmdb_ci/281190e3c0a8000b003f593aa3f20ca6
value: 281190e3c0a8000b003f593aa3f20ca6
opened_by:
link: https://instance.service-now.com/api/now/table/sys_user/glide.maint
value: glide.maint
subcategory: ''
rejection_goto: ''
sys_class_name: incident
watch_list: ''
time_worked: ''
contact_type: phone
escalation: '3'
comments: ''
examples:
name-value pairs:
value:
result:
upon_approval: proceed
location:
link: https://instance.service-now.com/api/now/table/cmn_location/108752c8c611227501d4ab0e392ba97f
value: 108752c8c611227501d4ab0e392ba97f
expected_start: ''
reopen_count: ''
close_notes: ''
additional_assignee_list: ''
impact: '1'
urgency: '1'
correlation_id: ''
sys_tags: ''
sys_domain:
link: https://instance.service-now.com/api/now/table/sys_user_group/global
value: global
description: ''
group_list: ''
priority: '1'
delivery_plan: ''
sys_mod_count: '7'
work_notes_list: ''
business_service: ''
follow_up: ''
closed_at: ''
sla_due: 2017-07-05 05:58:24
delivery_task: ''
sys_updated_on: 2016-01-22 14:12:37
parent: ''
work_end: ''
number: INC0000050
closed_by: ''
work_start: ''
calendar_stc: ''
category: hardware
business_duration: ''
incident_state: '2'
activity_due: 2016-01-22 16:12:37
correlation_display: ''
company:
link: https://instance.service-now.com/api/now/table/core_company/31bea3d53790200044e0bfc8bcbe5dec
value: 31bea3d53790200044e0bfc8bcbe5dec
active: 'true'
due_date: ''
assignment_group:
link: https://instance.service-now.com/api/now/table/sys_user_group/8a5055c9c61122780043563ef53438e3
value: 8a5055c9c61122780043563ef53438e3
caller_id:
link: https://instance.service-now.com/api/now/table/sys_user/5b7c200d0a640069006b3845b5d0fa7c
value: 5b7c200d0a640069006b3845b5d0fa7c
knowledge: 'false'
made_sla: 'true'
comments_and_work_notes: ''
parent_incident: ''
state: '2'
user_input: ''
sys_created_on: 2015-11-02 18:05:40
approval_set: ''
reassignment_count: '0'
rfc: ''
child_incidents: ''
opened_at: 2015-11-02 21:58:24
short_description: Can't access Exchange server - is it down?
order: ''
sys_updated_by: admin
resolved_by: ''
notify: '1'
upon_reject: cancel
approval_history: ''
problem_id: ''
work_notes: ''
calendar_duration: ''
close_code: ''
sys_id: ef43c6d40a0a0b5700c77f9bf387afe3
approval: not requested
caused_by: ''
severity: '3'
sys_created_by: glide.maint
resolved_at: ''
assigned_to:
link: https://instance.service-now.com/api/now/table/sys_user/681b365ec0a80164000fb0b05854a0cd
value: 681b365ec0a80164000fb0b05854a0cd
business_stc: ''
wf_activity: ''
sys_domain_path: /
cmdb_ci:
link: https://instance.service-now.com/api/now/table/cmdb_ci/281190e3c0a8000b003f593aa3f20ca6
value: 281190e3c0a8000b003f593aa3f20ca6
opened_by:
link: https://instance.service-now.com/api/now/table/sys_user/glide.maint
value: glide.maint
subcategory: ''
rejection_goto: ''
sys_class_name: incident
watch_list: ''
time_worked: ''
contact_type: phone
escalation: '3'
comments: ''
deprecated: false
delete:
tags:
- Table
summary: deleteTableRecord
description: >+
Deletes the specified record from the specified table.
operationId: deleteTableRecord
parameters:
- name: tableName
in: path
description: Name of the table from which to retrieve the records.
required: true
style: simple
schema:
type: string
- name: sys_id
in: path
description: Unique identifier of the record to retrieve.
required: true
style: simple
schema:
type: string
responses:
'204':
description: Indicates the request completed successfully.
headers: {}
content: {}
deprecated: false
/now/table/{tableName}:
get:
tags:
- Table
summary: queryTableByName
description: Retrieves all the records from the specified table.
operationId: queryTableByName
parameters:
- name: tableName
in: path
description: Name of the table from which to retrieve the records.
required: true
style: simple
schema:
type: string
- name: sysparm_query
in: query
description: e.g. number=CHG12345
style: form
explode: true
schema:
type: object
responses:
'200':
description: Request completed successfully. If a valid query returned no results, the response body contains only an empty result array.
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/NowTableResponse'
- example:
result:
upon_approval: ''
location:
link: https://instance.service-now.com/api/now/table/cmn_location/105cf7f3c611227501e75e08b14a38ba
value: 105cf7f3c611227501e75e08b14a38ba
expected_start: ''
reopen_count: ''
close_notes: ''
additional_assignee_list: ''
impact: '1'
urgency: '3'
correlation_id: ''
sys_tags: ''
sys_domain:
link: https://instance.service-now.com/api/now/table/sys_user_group/global
value: global
description: ''
group_list: ''
priority: '3'
delivery_plan: ''
sys_mod_count: '4'
work_notes_list: ''
business_service: ''
follow_up: ''
closed_at: ''
sla_due: 2015-11-11 22:04:15
delivery_task: ''
sys_updated_on: 2015-11-01 22:37:27
parent: ''
work_end: ''
number: INC0000046
closed_by: ''
work_start: ''
calendar_stc: ''
category: software
business_duration: ''
incident_state: '1'
activity_due: ''
correlation_display: ''
company: ''
active: 'true'
due_date: ''
assignment_group:
link: https://instance.service-now.com/api/now/table/sys_user_group/8a4dde73c6112278017a6a4baf547aa7
value: 8a4dde73c6112278017a6a4baf547aa7
caller_id:
link: https://instance.service-now.com/api/now/table/sys_user/46c6f9efa9fe198101ddf5eed9adf6e7
value: 46c6f9efa9fe198101ddf5eed9adf6e7
knowledge: 'false'
made_sla: 'false'
comments_and_work_notes: ''
parent_incident: ''
state: '1'
user_input: ''
sys_created_on: 2015-11-01 22:05:30
approval_set: ''
reassignment_count: '1'
rfc: ''
child_incidents: ''
opened_at: 2015-11-02 22:04:15
short_description: Can't access SFA software
order: ''
sys_updated_by: glide.maint
resolved_by: ''
notify: '1'
upon_reject: ''
approval_history: ''
problem_id:
link: https://instance.service-now.com/api/now/table/problem/a9e4890bc6112276003d7a5a5c774a74
value: a9e4890bc6112276003d7a5a5c774a74
work_notes: ''
calendar_duration: ''
close_code: ''
sys_id: a9e30c7dc61122760116894de7bcc7bd
approval: not requested
caused_by: ''
severity: '3'
sys_created_by: admin
resolved_at: ''
assigned_to: ''
business_stc: ''
wf_activity: ''
sys_domain_path: /
cmdb_ci:
link: https://instance.service-now.com/api/now/table/cmdb_ci/a9c0c8d2c6112276018f7705562f9cb0
value: a9c0c8d2c6112276018f7705562f9cb0
opened_by:
link: https://instance.service-now.com/api/now/table/sys_user/46c6f9efa9fe198101ddf5eed9adf6e7
value: 46c6f9efa9fe198101ddf5eed9adf6e7
subcategory: ''
rejection_goto: ''
sys_class_name: incident
watch_list: ''
time_worked: ''
contact_type: phone
escalation: '0'
comments: ''
examples:
name-value-pairs:
value:
result:
upon_approval: ''
location:
link: https://instance.service-now.com/api/now/table/cmn_location/105cf7f3c611227501e75e08b14a38ba
value: 105cf7f3c611227501e75e08b14a38ba
expected_start: ''
reopen_count: ''
close_notes: ''
additional_assignee_list: ''
impact: '1'
urgency: '3'
correlation_id: ''
sys_tags: ''
sys_domain:
link: https://instance.service-now.com/api/now/table/sys_user_group/global
value: global
description: ''
group_list: ''
priority: '3'
delivery_plan: ''
sys_mod_count: '4'
work_notes_list: ''
business_service: ''
follow_up: ''
closed_at: ''
sla_due: 2015-11-11 22:04:15
delivery_task: ''
sys_updated_on: 2015-11-01 22:37:27
parent: ''
work_end: ''
number: INC0000046
closed_by: ''
work_start: ''
calendar_stc: ''
category: software
business_duration: ''
incident_state: '1'
activity_due: ''
correlation_display: ''
company: ''
active: 'true'
due_date: ''
assignment_group:
link: https://instance.service-now.com/api/now/table/sys_user_group/8a4dde73c6112278017a6a4baf547aa7
value: 8a4dde73c6112278017a6a4baf547aa7
caller_id:
link: https://instance.service-now.com/api/now/table/sys_user/46c6f9efa9fe198101ddf5eed9adf6e7
value: 46c6f9efa9fe198101ddf5eed9adf6e7
knowledge: 'false'
made_sla: 'false'
comments_and_work_notes: ''
parent_incident: ''
state: '1'
user_input: ''
sys_created_on: 2015-11-01 22:05:30
approval_set: ''
reassignment_count: '1'
rfc: ''
child_incidents: ''
opened_at: 2015-11-02 22:04:15
short_description: Can't access SFA software
order: ''
sys_updated_by: glide.maint
resolved_by: ''
notify: '1'
upon_reject: ''
approval_history: ''
problem_id:
link: https://instance.service-now.com/api/now/table/problem/a9e4890bc6112276003d7a5a5c774a74
value: a9e4890bc6112276003d7a5a5c774a74
work_notes: ''
calendar_duration: ''
close_code: ''
sys_id: a9e30c7dc61122760116894de7bcc7bd
approval: not requested
caused_by: ''
severity: '3'
sys_created_by: admin
resolved_at: ''
assigned_to: ''
business_stc: ''
wf_activity: ''
sys_domain_path: /
cmdb_ci:
link: https://instance.service-now.com/api/now/table/cmdb_ci/a9c0c8d2c6112276018f7705562f9cb0
value: a9c0c8d2c6112276018f7705562f9cb0
opened_by:
link: https://instance.service-now.com/api/now/table/sys_user/46c6f9efa9fe198101ddf5eed9adf6e7
value: 46c6f9efa9fe198101ddf5eed9adf6e7
subcategory: ''
rejection_goto: ''
sys_class_name: incident
watch_list: ''
time_worked: ''
contact_type: phone
escalation: '0'
comments: ''
'404':
description: Indicates the record is not found or the requesting user does not have access to the record.
headers: {}
content: {}
deprecated: false
post:
tags:
- Table
summary: createRecordInTable
description: Inserts one record in the specified table. Multiple record insertion is not supported by this method.
operationId: createRecordInTable
parameters:
- name: tableName
in: path
description: Name of the table from which to retrieve the records.
required: true
style: simple
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/NowTableRequest1'
- example:
short_description: Unable to connect to office wifi
assignment_group: 287ebd7da9fe198100f92cc8d1d2154e
urgency: '2'
impact: '2'
examples:
name-value pairs:
value:
short_description: Unable to connect to office wifi
assignment_group: 287ebd7da9fe198100f92cc8d1d2154e
urgency: '2'
impact: '2'
required: true
responses:
'201':
description: Indicates the request completed successfully.
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/NowTableResponse'
- example:
result:
upon_approval: proceed
location: ''
expected_start: ''
reopen_count: '0'
close_notes: ''
additional_assignee_list: ''
impact: '2'
urgency: '2'
correlation_id: ''
sys_tags: ''
sys_domain:
link: https://instance.service-now.com/api/now/table/sys_user_group/global
value: global
description: ''
group_list: ''
priority: '3'
delivery_plan: ''
sys_mod_count: '0'
work_notes_list: ''
business_service: ''
follow_up: ''
closed_at: ''
sla_due: ''
delivery_task: ''
sys_updated_on: 2016-01-22 14:28:24
parent: ''
work_end: ''
number: INC0010002
closed_by: ''
work_start: ''
calendar_stc: ''
category: inquiry
business_duration: ''
incident_state: '1'
activity_due: ''
correlation_display: ''
company: ''
active: 'true'
due_date: ''
assignment_group:
link: https://instance.service-now.com/api/now/table/sys_user_group/287ebd7da9fe198100f92cc8d1d2154e
value: 287ebd7da9fe198100f92cc8d1d2154e
caller_id: ''
knowledge: 'false'
made_sla: 'true'
comments_and_work_notes: ''
parent_incident: ''
state: '1'
user_input: ''
sys_created_on: 2016-01-22 14:28:24
approval_set: ''
reassignment_count: '0'
rfc: ''
child_incidents: '0'
opened_at: 2016-01-22 14:28:24
short_description: Unable to connect to office wifi
order: ''
sys_updated_by: admin
resolved_by: ''
notify: '1'
upon_reject: cancel
approval_history: ''
problem_id: ''
work_notes: ''
calendar_duration: ''
close_code: ''
sys_id: c537bae64f411200adf9f8e18110c76e
approval: not requested
caused_by: ''
severity: '3'
sys_created_by: admin
resolved_at: ''
assigned_to: ''
business_stc: ''
wf_activity: ''
sys_domain_path: /
cmdb_ci: ''
opened_by:
link: https://instance.service-now.com/api/now/table/sys_user/6816f79cc0a8016401c5a33be04be441
value: 6816f79cc0a8016401c5a33be04be441
subcategory: ''
rejection_goto: ''
sys_class_name: incident
watch_list: ''
time_worked: ''
contact_type: phone
escalation: '0'
comments: ''
examples:
name-value pairs:
value:
result:
upon_approval: proceed
location: ''
expected_start: ''
reopen_count: '0'
close_notes: ''
additional_assignee_list: ''
impact: '2'
urgency: '2'
correlation_id: ''
sys_tags: ''
sys_domain:
link: https://instance.service-now.com/api/now/table/sys_user_group/global
value: global
description: ''
group_list: ''
priority: '3'
delivery_plan: ''
sys_mod_count: '0'
work_notes_list: ''
business_service: ''
follow_up: ''
closed_at: ''
sla_due: ''
delivery_task: ''
sys_updated_on: 2016-01-22 14:28:24
parent: ''
work_end: ''
number: INC0010002
closed_by: ''
work_start: ''
calendar_stc: ''
category: inquiry
business_duration: ''
incident_state: '1'
activity_due: ''
correlation_display: ''
company: ''
active: 'true'
due_date: ''
assignment_group:
link: https://instance.service-now.com/api/now/table/sys_user_group/287ebd7da9fe198100f92cc8d1d2154e
value: 287ebd7da9fe198100f92cc8d1d2154e
caller_id: ''
knowledge: 'false'
made_sla: 'true'
comments_and_work_notes: ''
parent_incident: ''
state: '1'
user_input: ''
sys_created_on: 2016-01-22 14:28:24
approval_set: ''
reassignment_count: '0'
rfc: ''
child_incidents: '0'
opened_at: 2016-01-22 14:28:24
short_description: Unable to connect to office wifi
order: ''
sys_updated_by: admin
resolved_by: ''
notify: '1'
upon_reject: cancel
approval_history: ''
problem_id: ''
work_notes: ''
calendar_duration: ''
close_code: ''
sys_id: c537bae64f411200adf9f8e18110c76e
approval: not requested
caused_by: ''
severity: '3'
sys_created_by: admin
resolved_at: ''
assigned_to: ''
business_stc: ''
wf_activity: ''
sys_domain_path: /
cmdb_ci: ''
opened_by:
link: https://instance.service-now.com/api/now/table/sys_user/6816f79cc0a8016401c5a33be04be441
value: 6816f79cc0a8016401c5a33be04be441
subcategory: ''
rejection_goto: ''
sys_class_name: incident
watch_list: ''
time_worked: ''
contact_type: phone
escalation: '0'
comments: ''
deprecated: false
/now/awa/agents/{sys_id}:
put:
tags:
- Agent Presence
summary: setAgentPresence
description: >+
Sets the state of a provided agent’s presence and sets the agent’s channel availability for that state (if provided).
operationId: setAgentPresence
parameters:
- name: sys_id
in: path
description: The sys_id of the user listed in sys_user table.
required: true
style: simple
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
type: string
required: true
responses:
'200':
description: Request completed successfully.
headers: {}
content: {}
'400':
description: Bad Request. A bad request type or malformed request was detected.
headers: {}
content: {}
'404':
description: Not Found. The specified record could not be found.
headers: {}
content: {}
deprecated: false
/now/stats/{tableName}:
get:
tags:
- Aggregate
summary: getAggregate
description: >+
This method retrieves records for the specified table and performs aggregate functions on the returned values.
operationId: getAggregate
parameters:
- name: sysparm_query
in: query
description: An encoded query.
required: true
style: form
explode: true
schema:
type: object
- name: tableName
in: path
description: tableName
required: true
style: simple
schema:
type: string
responses:
'200':
description: Indicates that the request completed successfully.
headers: {}
content: {}
deprecated: false
/now/cmdb/app_service/{sys_id}/getContent:
get:
tags:
- Application Service
summary: getApplicationById
description: >+
Retrieve a list of CIs in an application service and the relationships between them. Only retrieves content for services that were manually created.
operationId: getApplicationById
parameters:
- name: sys_id
in: path
description: sysId
required: true
style: simple
schema:
type: string
responses:
'200':
description: Indicates the query ran successfully.
headers: {}
content: {}
'404':
description: Indicates the specified resource was not available. As import set tables are deleted frequently based on a schedule, GET requests may return 404 NotFound responses if the transformation result no longer exists.
headers: {}
content: {}
deprecated: false
/now/cmdb/app_service/create:
post:
tags:
- Application Service
summary: createApplication
description: >+
Create an application service or update an existing application service.
operationId: createApplication
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
type: object
examples:
data:
value: >-
{
\"name\": \"myTestAppService\",
\"comments\": \"Passing data to the Comments field\",
\"service_relations\": [
{ \"parent\": \"\",
\"child\": \"3a70f789c0a8ce010091b0ea635b982a\"
},{ \"parent\": \"3a70f789c0a8ce010091b0ea635b982a\",
\"child\": \"b4fd7c8437201000deeabfc8bcbe5dc1\"
},{ \"parent\": \"b4fd7c8437201000deeabfc8bcbe5dc1\",
\"child\": \"53fdbc8437201000deeabfc8bcbe5d10\"
}
]
}
required: true
responses:
'201':
description: Indicates the import completed successfully.
headers: {}
content: {}
deprecated: false
/now/attachment/{sys_id}:
get:
tags:
- Attachment
summary: getAttachmentMetadataById
description: >+
This method gets the metadata for the attachment file with a specific sys_id value.
operationId: getAttachmentMetadataById
parameters:
- name: sys_id
in: path
description: The sys_id of the attachment record you want to get metadata for.
required: true
style: simple
schema:
type: string
responses:
'200':
description: Indicates the query ran successfully.
headers: {}
content: {}
deprecated: false
delete:
tags:
- Attachment
summary: deleteAttachmentById
description: >+
This method deletes the attachment with a specific sys_id value.
operationId: deleteAttachmentById
parameters:
- name: sys_id
in: path
description: The sys_id of the attachment record you want to get metadata for.
required: true
style: simple
schema:
type: string
responses:
'204':
description: Indicates the request ran successfully.
headers: {}
content: {}
deprecated: false
/now/attachment/{sys_id}/file:
get:
tags:
- Attachment
summary: getAttachmentBinaryById
description: >+
This method gets the binary file attachment with a specific sys_id value.
operationId: getAttachmentBinaryById
parameters:
- name: sys_id
in: path
description: The sys_id of the attachment record you want to get metadata for.
required: true
style: simple
schema:
type: string
responses:
'200':
description: Indicates the query ran successfully.
headers