UNPKG

@itentialopensource/adapter-servicenow

Version:

This adapter integrates with system described as: servicenowMadrid.

1,325 lines 5.58 MB
{ "openapi": "3.1.0", "info": { "title": "", "version": "1.0.0" }, "paths": { "/now/table/{tableName}/{recordId}": { "get": { "tags": [ "Table" ], "operationId": "queryTableByNameAndId", "description": "The parameters and request body are for method: queryTableByNameAndId. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "object", "properties": { "sys_id": { "type": "string" }, "short_description": { "type": "string" }, "parent": { "type": "string" }, "made_sla": { "type": "string" }, "caused_by": { "type": "string" }, "watch_list": { "type": "string" }, "upon_reject": { "type": "string" }, "sys_updated_on": { "type": "string" }, "child_incidents": { "type": "string" }, "hold_reason": { "type": "string" }, "approval_history": { "type": "string" }, "number": { "type": "string" }, "resolved_by": { "type": "string" }, "sys_updated_by": { "type": "string" }, "opened_by": { "type": "object", "properties": { "link": { "type": "string" }, "value": { "type": "string" } } }, "user_input": { "type": "string" }, "sys_created_on": { "type": "string" }, "sys_domain": { "type": "object", "properties": { "link": { "type": "string" }, "value": { "type": "string" } } }, "state": { "type": "string" }, "sys_created_by": { "type": "string" }, "knowledge": { "type": "string" }, "order": { "type": "string" }, "calendar_stc": { "type": "string" }, "closed_at": { "type": "string" }, "cmdb_ci": { "type": "string" }, "delivery_plan": { "type": "string" }, "impact": { "type": "string" }, "active": { "type": "string" }, "work_notes_list": { "type": "string" }, "business_service": { "type": "string" }, "priority": { "type": "string" }, "sys_domain_path": { "type": "string" }, "rfc": { "type": "string" }, "time_worked": { "type": "string" }, "expected_start": { "type": "string" }, "opened_at": { "type": "string" }, "business_duration": { "type": "string" }, "group_list": { "type": "string" }, "work_end": { "type": "string" }, "caller_id": { "type": "string" }, "reopened_time": { "type": "string" }, "resolved_at": { "type": "string" }, "approval_set": { "type": "string" }, "subcategory": { "type": "string" }, "work_notes": { "type": "string" }, "close_code": { "type": "string" }, "correlation_display": { "type": "string" }, "delivery_task": { "type": "string" }, "work_start": { "type": "string" }, "assignment_group": { "type": "string" }, "additional_assignee_list": { "type": "string" }, "business_stc": { "type": "string" }, "description": { "type": "string" }, "calendar_duration": { "type": "string" }, "close_notes": { "type": "string" }, "notify": { "type": "string" }, "sys_class_name": { "type": "string" }, "closed_by": { "type": "string" }, "follow_up": { "type": "string" }, "parent_incident": { "type": "string" }, "contact_type": { "type": "string" }, "reopened_by": { "type": "string" }, "incident_state": { "type": "string" }, "urgency": { "type": "string" }, "problem_id": { "type": "string" }, "company": { "type": "string" }, "reassignment_count": { "type": "string" }, "activity_due": { "type": "string" }, "assigned_to": { "type": "string" }, "severity": { "type": "string" }, "comments": { "type": "string" }, "approval": { "type": "string" }, "sla_due": { "type": "string" }, "comments_and_work_notes": { "type": "string" }, "due_date": { "type": "string" }, "sys_mod_count": { "type": "string" }, "reopen_count": { "type": "string" }, "sys_tags": { "type": "string" }, "escalation": { "type": "string" }, "upon_approval": { "type": "string" }, "correlation_id": { "type": "string" }, "location": { "type": "string" }, "category": { "type": "string" } } } } }, "example": { "result": { "sys_id": "03dbb48fdb040010a704fe1b6896191b", "short_description": "Updated Table Record", "parent": "", "made_sla": "true", "caused_by": "", "watch_list": "", "upon_reject": "cancel", "sys_updated_on": "2019-09-26 23:01:47", "child_incidents": "0", "hold_reason": "", "approval_history": "", "number": "INC0010019", "resolved_by": "", "sys_updated_by": "admin", "opened_by": { "link": "https://dev58661.service-now.com/api/now/table/sys_user/6816f79cc0a8016401c5a33be04be441", "value": "6816f79cc0a8016401c5a33be04be441" }, "user_input": "", "sys_created_on": "2019-09-26 23:01:45", "sys_domain": { "link": "https://dev58661.service-now.com/api/now/table/sys_user_group/global", "value": "global" }, "state": "1", "sys_created_by": "admin", "knowledge": "false", "order": "", "calendar_stc": "", "closed_at": "", "cmdb_ci": "", "delivery_plan": "", "impact": "3", "active": "true", "work_notes_list": "", "business_service": "", "priority": "5", "sys_domain_path": "/", "rfc": "", "time_worked": "", "expected_start": "", "opened_at": "2019-09-26 23:01:45", "business_duration": "", "group_list": "", "work_end": "", "caller_id": "", "reopened_time": "", "resolved_at": "", "approval_set": "", "subcategory": "", "work_notes": "", "close_code": "", "correlation_display": "", "delivery_task": "", "work_start": "", "assignment_group": "", "additional_assignee_list": "", "business_stc": "", "description": "", "calendar_duration": "", "close_notes": "", "notify": "1", "sys_class_name": "incident", "closed_by": "", "follow_up": "", "parent_incident": "", "contact_type": "", "reopened_by": "", "incident_state": "1", "urgency": "3", "problem_id": "", "company": "", "reassignment_count": "0", "activity_due": "", "assigned_to": "", "severity": "3", "comments": "", "approval": "not requested", "sla_due": "", "comments_and_work_notes": "", "due_date": "", "sys_mod_count": "1", "reopen_count": "0", "sys_tags": "", "escalation": "0", "upon_approval": "proceed", "correlation_id": "", "location": "", "category": "inquiry" } } } } } }, "parameters": [ { "name": "tableName", "in": "path", "required": true, "schema": { "title": "tableName", "type": "string" } }, { "name": "recordId", "in": "path", "required": true, "schema": { "title": "recordId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "put": { "tags": [ "Table" ], "operationId": "updateTableRecord", "description": "The parameters and request body are for method: updateTableRecord. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "object", "properties": { "sys_id": { "type": "string" }, "short_description": { "type": "string" }, "parent": { "type": "string" }, "made_sla": { "type": "string" }, "caused_by": { "type": "string" }, "watch_list": { "type": "string" }, "upon_reject": { "type": "string" }, "sys_updated_on": { "type": "string" }, "child_incidents": { "type": "string" }, "hold_reason": { "type": "string" }, "approval_history": { "type": "string" }, "number": { "type": "string" }, "resolved_by": { "type": "string" }, "sys_updated_by": { "type": "string" }, "opened_by": { "type": "object", "properties": { "link": { "type": "string" }, "value": { "type": "string" } } }, "user_input": { "type": "string" }, "sys_created_on": { "type": "string" }, "sys_domain": { "type": "object", "properties": { "link": { "type": "string" }, "value": { "type": "string" } } }, "state": { "type": "string" }, "sys_created_by": { "type": "string" }, "knowledge": { "type": "string" }, "order": { "type": "string" }, "calendar_stc": { "type": "string" }, "closed_at": { "type": "string" }, "cmdb_ci": { "type": "string" }, "delivery_plan": { "type": "string" }, "impact": { "type": "string" }, "active": { "type": "string" }, "work_notes_list": { "type": "string" }, "business_service": { "type": "string" }, "priority": { "type": "string" }, "sys_domain_path": { "type": "string" }, "rfc": { "type": "string" }, "time_worked": { "type": "string" }, "expected_start": { "type": "string" }, "opened_at": { "type": "string" }, "business_duration": { "type": "string" }, "group_list": { "type": "string" }, "work_end": { "type": "string" }, "caller_id": { "type": "string" }, "reopened_time": { "type": "string" }, "resolved_at": { "type": "string" }, "approval_set": { "type": "string" }, "subcategory": { "type": "string" }, "work_notes": { "type": "string" }, "close_code": { "type": "string" }, "correlation_display": { "type": "string" }, "delivery_task": { "type": "string" }, "work_start": { "type": "string" }, "assignment_group": { "type": "string" }, "additional_assignee_list": { "type": "string" }, "business_stc": { "type": "string" }, "description": { "type": "string" }, "calendar_duration": { "type": "string" }, "close_notes": { "type": "string" }, "notify": { "type": "string" }, "sys_class_name": { "type": "string" }, "closed_by": { "type": "string" }, "follow_up": { "type": "string" }, "parent_incident": { "type": "string" }, "contact_type": { "type": "string" }, "reopened_by": { "type": "string" }, "incident_state": { "type": "string" }, "urgency": { "type": "string" }, "problem_id": { "type": "string" }, "company": { "type": "string" }, "reassignment_count": { "type": "string" }, "activity_due": { "type": "string" }, "assigned_to": { "type": "string" }, "severity": { "type": "string" }, "comments": { "type": "string" }, "approval": { "type": "string" }, "sla_due": { "type": "string" }, "comments_and_work_notes": { "type": "string" }, "due_date": { "type": "string" }, "sys_mod_count": { "type": "string" }, "reopen_count": { "type": "string" }, "sys_tags": { "type": "string" }, "escalation": { "type": "string" }, "upon_approval": { "type": "string" }, "correlation_id": { "type": "string" }, "location": { "type": "string" }, "category": { "type": "string" } } } } }, "example": { "result": { "sys_id": "03dbb48fdb040010a704fe1b6896191b", "short_description": "Updated Table Record", "parent": "", "made_sla": "true", "caused_by": "", "watch_list": "", "upon_reject": "cancel", "sys_updated_on": "2019-09-26 23:01:47", "child_incidents": "0", "hold_reason": "", "approval_history": "", "number": "INC0010019", "resolved_by": "", "sys_updated_by": "admin", "opened_by": { "link": "https://dev58661.service-now.com/api/now/table/sys_user/6816f79cc0a8016401c5a33be04be441", "value": "6816f79cc0a8016401c5a33be04be441" }, "user_input": "", "sys_created_on": "2019-09-26 23:01:45", "sys_domain": { "link": "https://dev58661.service-now.com/api/now/table/sys_user_group/global", "value": "global" }, "state": "1", "sys_created_by": "admin", "knowledge": "false", "order": "", "calendar_stc": "", "closed_at": "", "cmdb_ci": "", "delivery_plan": "", "impact": "3", "active": "true", "work_notes_list": "", "business_service": "", "priority": "5", "sys_domain_path": "/", "rfc": "", "time_worked": "", "expected_start": "", "opened_at": "2019-09-26 23:01:45", "business_duration": "", "group_list": "", "work_end": "", "caller_id": "", "reopened_time": "", "resolved_at": "", "approval_set": "", "subcategory": "", "work_notes": "", "close_code": "", "correlation_display": "", "delivery_task": "", "work_start": "", "assignment_group": "", "additional_assignee_list": "", "business_stc": "", "description": "", "calendar_duration": "", "close_notes": "", "notify": "1", "sys_class_name": "incident", "closed_by": "", "follow_up": "", "parent_incident": "", "contact_type": "", "reopened_by": "", "incident_state": "1", "urgency": "3", "problem_id": "", "company": "", "reassignment_count": "0", "activity_due": "", "assigned_to": "", "severity": "3", "comments": "", "approval": "not requested", "sla_due": "", "comments_and_work_notes": "", "due_date": "", "sys_mod_count": "1", "reopen_count": "0", "sys_tags": "", "escalation": "0", "upon_approval": "proceed", "correlation_id": "", "location": "", "category": "inquiry" } } } } } }, "parameters": [ { "name": "tableName", "in": "path", "required": true, "schema": { "title": "tableName", "type": "string" } }, { "name": "recordId", "in": "path", "required": true, "schema": { "title": "recordId", "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } }, "delete": { "tags": [ "Table" ], "operationId": "deleteTableRecord", "description": "The parameters and request body are for method: deleteTableRecord. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "parameters": [ { "name": "tableName", "in": "path", "required": true, "schema": { "title": "tableName", "type": "string" } }, { "name": "recordId", "in": "path", "required": true, "schema": { "title": "recordId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/now/table/{tableName}": { "get": { "tags": [ "Table" ], "operationId": "queryTableByName", "description": "The parameters and request body are for method: queryTableByName. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "properties": { "sys_id": { "type": "string" }, "short_description": { "type": "string" }, "parent": { "type": "string" }, "made_sla": { "type": "string" }, "caused_by": { "type": "string" }, "watch_list": { "type": "string" }, "upon_reject": { "type": "string" }, "sys_updated_on": { "type": "string" }, "child_incidents": { "type": "string" }, "hold_reason": { "type": "string" }, "approval_history": { "type": "string" }, "number": { "type": "string" }, "resolved_by": { "type": "object", "properties": { "link": { "type": "string" }, "value": { "type": "string" } } }, "sys_updated_by": { "type": "string" }, "opened_by": { "type": "object", "properties": { "link": { "type": "string" }, "value": { "type": "string" } } }, "user_input": { "type": "string" }, "sys_created_on": { "type": "string" }, "sys_domain": { "type": "object", "properties": { "link": { "type": "string" }, "value": { "type": "string" } } }, "state": { "type": "string" }, "sys_created_by": { "type": "string" }, "knowledge": { "type": "string" }, "order": { "type": "string" }, "calendar_stc": { "type": "string" }, "closed_at": { "type": "string" }, "cmdb_ci": { "type": "object", "properties": { "link": { "type": "string" }, "value": { "type": "string" } } }, "delivery_plan": { "type": "string" }, "impact": { "type": "string" }, "active": { "type": "string" }, "work_notes_list": { "type": "string" }, "business_service": { "type": "object", "properties": { "link": { "type": "string" }, "value": { "type": "string" } } }, "priority": { "type": "string" }, "sys_domain_path": { "type": "string" }, "rfc": { "type": "string" }, "time_worked": { "type": "string" }, "expected_start": { "type": "string" }, "opened_at": { "type": "string" }, "business_duration": { "type": "string" }, "group_list": { "type": "string" }, "work_end": { "type": "string" }, "caller_id": { "type": "object", "properties": { "link": { "type": "string" }, "value": { "type": "string" } } }, "reopened_time": { "type": "string" }, "resolved_at": { "type": "string" }, "approval_set": { "type": "string" }, "subcategory": { "type": "string" }, "work_notes": { "type": "string" }, "close_code": { "type": "string" }, "correlation_display": { "type": "string" }, "delivery_task": { "type": "string" }, "work_start": { "type": "string" }, "assignment_group": { "type": "object", "properties": { "link": { "type": "string" }, "value": { "type": "string" } } }, "additional_assignee_list": { "type": "string" }, "business_stc": { "type": "string" }, "description": { "type": "string" }, "calendar_duration": { "type": "string" }, "close_notes": { "type": "string" }, "notify": { "type": "string" }, "sys_class_name": { "type": "string" }, "closed_by": { "type": "object", "properties": { "link": { "type": "string" }, "value": { "type": "string" } } }, "follow_up": { "type": "string" }, "parent_incident": { "type": "string" }, "contact_type": { "type": "string" }, "reopened_by": { "type": "string" }, "incident_state": { "type": "string" }, "urgency": { "type": "string" }, "problem_id": { "type": "string" }, "company": { "type": "object", "properties": { "link": { "type": "string" }, "value": { "type": "string" } } }, "reassignment_count": { "type": "string" }, "activity_due": { "type": "string" }, "assigned_to": { "type": "object", "properties": { "link": { "type": "string" }, "value": { "type": "string" } } }, "severity": { "type": "string" }, "comments": { "type": "string" }, "approval": { "type": "string" }, "sla_due": { "type": "string" }, "comments_and_work_notes": { "type": "string" }, "due_date": { "type": "string" }, "sys_mod_count": { "type": "string" }, "reopen_count": { "type": "string" }, "sys_tags": { "type": "string" }, "escalation": { "type": "string" }, "upon_approval": { "type": "string" }, "correlation_id": { "type": "string" }, "location": { "type": "string" }, "category": { "type": "string" } } } } } }, "example": { "result": [ { "sys_id": "1c741bd70b2322007518478d83673af3", "short_description": "Unable to connect to email", "parent": "", "made_sla": "true", "caused_by": "", "watch_list": "", "upon_reject": "cancel", "sys_updated_on": "2016-12-14 02:46:44", "child_incidents": "0", "hold_reason": "", "approval_history": "", "number": "INC0000060", "resolved_by": { "link": "https://dev58661.service-now.com/api/now/table/sys_user/5137153cc611227c000bbd1bd8cd2007", "value": "5137153cc611227c000bbd1bd8cd2007" }, "sys_updated_by": "employee", "opened_by": { "link": "https://dev58661.service-now.com/api/now/table/sys_user/681ccaf9c0a8016400b98a06818d57c7", "value": "681ccaf9c0a8016400b98a06818d57c7" }, "user_input": "", "sys_created_on": "2016-12-12 15:19:57", "sys_domain": { "link": "https://dev58661.service-now.com/api/now/table/sys_user_group/global", "value": "global" }, "state": "7", "sys_created_by": "employee", "knowledge": "false", "order": "", "calendar_stc": "102197", "closed_at": "2016-12-14 02:46:44", "cmdb_ci": { "link": "https://dev58661.service-now.com/api/now/table/cmdb_ci/109562a3c611227500a7b7ff98cc0dc7", "value": "109562a3c611227500a7b7ff98cc0dc7" }, "delivery_plan": "", "impact": "2", "active": "false", "work_notes_list": "", "business_service": { "link": "https://dev58661.service-now.com/api/now/table/cmdb_ci_service/27d32778c0a8000b00db970eeaa60f16", "value": "27d32778c0a8000b00db970eeaa60f16" }, "priority": "3", "sys_domain_path": "/", "rfc": "", "time_worked": "", "expected_start": "", "opened_at": "2016-12-12 15:19:57", "business_duration": "1970-01-01 08:00:00", "group_list": "", "work_end": "", "caller_id": { "link": "https://dev58661.service-now.com/api/now/table/sys_user/681ccaf9c0a8016400b98a06818d57c7", "value": "681ccaf9c0a8016400b98a06818d57c7" }, "reopened_time": "", "resolved_at": "2016-12-13 21:43:14", "approval_set": "", "subcategory": "email", "work_notes": "", "close_code": "Solved (Permanently)", "correlation_display": "", "delivery_task": "", "work_start": "", "assignment_group": { "link": "https://dev58661.service-now.com/api/now/table/sys_user_group/287ebd7da9fe198100f92cc8d1d2154e", "value": "287ebd7da9fe198100f92cc8d1d2154e" }, "additional_assignee_list": "", "business_stc": "28800", "description": "I am unable to connect to the email server. It appears to be down.", "calendar_duration": "1970-01-02 04:23:17", "close_notes": "This incident is resolved.", "notify": "1", "sys_class_name": "incident", "closed_by": { "link": "https://dev58661.service-now.com/api/now/table/sys_user/681ccaf9c0a8016400b98a06818d57c7", "value": "681ccaf9c0a8016400b98a06818d