Cyware Orchestrate

Checkout Item Order Request 

This action checkouts an item order request based on the specified parameters.

Close Incident 

This action closes an incident.

Create Change Request 

This action creates a change request in ServiceNow ITSM.

Create Incident 

This action creates a new incident in the incident table.

Create Item Order Request 

This action creates a catalog item order request based on the specified parameters.

Create New Record in a Table 

This action creates a record in the table in ServiceNow ITSM.

Create Request Item 

This action adds a request item in ServiceNow ITSM.

Delete Record from Table 

This action deletes a record from a table.

Download Attachment 

This action gets the file attachment with a specific sys_id value. Note: It will show both the content and file path where the file is stored.

Generic Action 

This is a generic action to perform any additional use case that you want on ServiceNow ITSM.

Get Attachment Metadata 

The action gets the metadata for multiple attachments using the system ID.

Get Change Request Record 

This action retrieves the details of the change request records.

Get Details of a Record 

This action gets more details about a record from the table.

Get Incident Details by Incident Number 

This action gets the incident details by the incident number.

Get Requested Item Record (RITM) 

This action retrieves details of a requested item record.

Get Stats Of A Table 

This action gets the statistics of a table.

Get User Roles 

This action gets a list of user roles.

Get Users 

This action gets user details based on the specified table.

List Catalog Items 

This action retrieves a list of catalog items based on the specified parameters.

Perform Analytics on Fields 

This action performs analytics on the specified fields (experimental).

Resolve Incident Records 

This action resolves incident records.

Search Records From Table 

This action performs a search for the records from the table.

Update Incident 

This action updates an incident.

Update Request Item Record (RITM) 

This action updates the requested item record.

Update Table Record 

This action updates a record of a table.

Upload File 

This action uploads a multipart file attachment.

Username 

Enter the username to connect to ServiceNow ITSM.

Text

Required

Password 

Enter the password for the provided ServiceNow ITSM account.

Password

Required

Base URL 

Enter the base URL to access ServiceNow ITSM.

Example:

https://instancename.service-now.com/api

Text

Required

Client ID 

Enter the client ID.

Text

Optional

Client Secret 

Enter the client secret to authorize communication with the application.

Password

Optional

Time-Based One-Time-Password Secret 

Enter the secret password generated for MFA using the one time password.

Password

Optional

Proxy Type 

Enter the proxy type.

Text

Optional

Proxy URL 

Enter the proxy URL.

Text

Optional

Proxy Username 

Enter the proxy username.

Text

Optional

Proxy Password 

Enter the proxy password.

Password

Optional

Verify 

Verify the SSL/TLS certificate while authenticating with the server. It's recommended to enable this option. By default, the verification is not enabled.

Boolean

Optional

Default:

false

Timeout 

Enter the timeout for the actions in seconds.

Integer

Optional

Allowed values:

15-120

Default:

15

System ID 

Enter the system ID of the attachment.

Example:

1f27d9a5db131010a3c28a18489619b6

Text

Required

You can retrieve this ID using the action Create Item Order Request. 

result.cart_id

String

Unique identifier for the shopping cart. Example: "0d8c7a32c3211200d68d3b0ac3d3aeba"

result.subtotal_price

String

Subtotal price of the items in the cart. Example: "$3,350.00"

result.subtotal_recurring_frequency

String

Recurring frequency of the subtotal. Example: ""

result.subtotal_recurring_price

String

Recurring price of the subtotal. Example: "$300.00"

result.total_title

String

Title for the total section. Example: "Total"

result.monthly.subtotal_price

String

Subtotal price for the monthly items. Example: "$50.00"

result.monthly.subtotal_recurring_frequency

String

Recurring frequency for the monthly items. Example: "Monthly"

result.monthly.subtotal_recurring_price

String

Recurring price for the monthly items. Example: "$0.00"

result.monthly.total_title

String

Title for the monthly total section. Example: "Total"

result.monthly.items[].catalog_item_id

String

Unique identifier for the catalog item. Example: "90af095bcd38798071a208d710d1b64f"

result.monthly.items[].variables

Object

Variables associated with the catalog item. Example: {}

result.monthly.items[].quantity

String

Quantity of the item. Example: "1"

result.monthly.items[].localized_price

String

Localized price of the item. Example: "$50.00"

result.monthly.items[].price

String

Price of the item. Example: "$50.00"

result.monthly.items[].recurring_frequency

String

Recurring frequency of the item. Example: "Monthly"

result.monthly.items[].localized_recurring_price

String

Localized recurring price of the item. Example: "$0.00"

result.monthly.items[].recurring_price

String

Recurring price of the item. Example: "$0.00"

result.monthly.items[].item_name

String

Name of the item. Example: "Belkin iPad Mini Case"

result.monthly.items[].cart_item_id

String

Unique identifier for the cart item. Example: "cb6e485fc3211200d68d3b0ac3d3ae35"

result.monthly.items[].delivery_time

String

Delivery time for the item. Example: "2 Days"

result.monthly.show_subtotal_price

String

Flag to show or hide the subtotal price. Example: "true"

result.monthly.subtotal_title

String

Title for the monthly subtotal section. Example: "Subtotal"

result.none.subtotal_price

String

Subtotal price for items with no recurring frequency. Example: "-"

result.none.subtotal_recurring_frequency

String

Recurring frequency for items with no recurring frequency. Example: ""

result.none.subtotal_recurring_price

String

Recurring price for items with no recurring frequency. Example: "$0.00"

result.none.total_title

String

Title for the total section. Example: "Total"

result.none.items[].catalog_item_id

String

Unique identifier for the catalog item. Example: "186d917a6fab7980575967ddbb3ee4f2"

result.none.items[].variables

Object

Variables associated with the catalog item. Example: {"Preferred Email address": "abel.tuter@example.com"}

result.none.items[].quantity

String

Quantity of the item. Example: "1"

result.none.items[].localized_price

String

Localized price of the item. Example: "$0.00"

result.none.items[].price

String

Price of the item. Example: "$0.00"

result.none.items[].recurring_frequency

String

Recurring frequency of the item. Example: ""

result.none.items[].localized_recurring_price

String

Localized recurring price of the item. Example: "$0.00"

result.none.items[].recurring_price

String

Recurring price of the item. Example: "$0.00"

result.none.items[].item_name

String

Name of the item. Example: "New Email Account"

result.none.items[].cart_item_id

String

Unique identifier for the cart item. Example: "17c5241fc3211200d68d3b0ac3d3ae7f"

result.none.items[].delivery_time

String

Delivery time for the item. Example: "global.Workflow"

result.none.show_subtotal_price

String

Flag to show or hide the subtotal price. Example: "false"

result.none.subtotal_title

String

Title for the subtotal section. Example: "Subtotal"

result.yearly.subtotal_price

String

Subtotal price for the yearly items. Example: "$3,300.00"

result.yearly.subtotal_recurring_frequency

String

Recurring frequency for the yearly items. Example: "Annually"

result.yearly.subtotal_recurring_price

String

Recurring price for the yearly items. Example: "$300.00"

result.yearly.total_title

String

Title for the yearly total section. Example: "Total"

result.yearly.items[].catalog_item_id

String

Unique identifier for the catalog item. Example: "04b7e94b4f7b4200086eeed18110c7fd"

result.yearly.items[].variables

Object

Variables associated with the catalog item. Example: {"Adobe Photoshop": "", "Adobe Acrobat": "true", "Optional Software": "", "Additional software requirements": "MS Office 2007"}

result.yearly.items[].quantity

String

Quantity of the item. Example: "3"

result.yearly.items[].localized_price

String

Localized price of the item. Example: "$1,100.00"

result.yearly.items[].price

String

Price of the item. Example: "$1,100.00"

result.yearly.items[].recurring_frequency

String

Recurring frequency of the item. Example: "Annually"

result.yearly.items[].localized_recurring_price

String

Localized recurring price of the item. Example: "$100.00"

result.yearly.items[].recurring_price

String

Recurring price of the item. Example: "$100.00"

result.yearly.items[].item_name

String

Name of the item. Example: "Standard Laptop"

result.yearly.items[].cart_item_id

String

Unique identifier for the cart item. Example: "9fc5241fc3211200d68d3b0ac3d3ae7e"

result.yearly.items[].delivery_time

String

Delivery time for the item. Example: "5 Days"

result.yearly.show_subtotal_price

String

Flag to show or hide the subtotal price. Example: "true"

result.yearly.subtotal_title

String

Title for the yearly subtotal section. Example: "Subtotal"

result.show_subtotal_price

String

Flag to show or hide the overall subtotal price. Example: "true"

result.subtotal_title

String

Title for the overall subtotal section. Example: "Subtotal"

System ID 

Enter the system ID of the incident to close.

Example:

0a9cdf93dbd31010a3c28a1848961994

Text

Required

You can retrieve this ID using the action Create Incident.

Work notes 

Enter the work notes for closing the incident.

Example:

Resolved

Text

Required

{app_instance} 

JSON Object

This parameter indicates the ID of the app instance configured in Orchestrate from which the response is retrieved.

app_instance.result.upon_approval

String

Action to take upon approval. Example: "proceed"

app_instance.result.location

Object

Location details with link and value. Example: {"link": "https://instance.servicenow.com/api/now/table/cmn_location/108752c8c611227501d4ab0e392ba97f", "value": "108752c8c611227501d4ab0e392ba97f"}

app_instance.result.expected_start

String

Expected start time. Example: ""

app_instance.result.reopen_count

String

The number of times the incident was reopened. Example: ""

app_instance.result.close_notes

String

Notes added upon closing the incident. Example: ""

app_instance.result.additional_assignee_list

String

List of additional assignees. Example: ""

app_instance.result.impact

String

Impact level of the incident. Example: "1"

app_instance.result.urgency

String

Urgency level of the incident. Example: "1"

app_instance.result.correlation_id

String

Correlation ID for the incident. Example: ""

app_instance.result.sys_tags

String

System tags associated with the incident. Example: ""

app_instance.result.sys_domain

Object

Domain details with link and value. Example: {"link": "https://instance.servicenow.com/api/now/table/sys_user_group/global", "value": "global"}

app_instance.result.description

String

Detailed description of the incident. Example: ""

app_instance.result.group_list

String

List of groups involved. Example: ""

app_instance.result.priority

String

Priority level of the incident. Example: "1"

app_instance.result.delivery_plan

String

Delivery plan details. Example: ""

app_instance.result.sys_mod_count

String

Modification count of the incident. Example: "7"

app_instance.result.work_notes_list

String

List of work notes. Example: ""

app_instance.result.business_service

String

Business service associated with the incident. Example: ""

app_instance.result.follow_up

String

Follow-up details. Example: ""

app_instance.result.closed_at

String

Timestamp when the incident was closed. Example: ""

app_instance.result.sla_due

String

SLA due date and time. Example: "2017-07-05 05:58:24"

app_instance.result.delivery_task

String

Delivery task details. Example: ""

app_instance.result.sys_updated_on

String

Last update timestamp. Example: "2016-01-22 14:12:37"

app_instance.result.parent

String

Parent incident details. Example: ""

app_instance.result.work_end

String

Work end timestamp. Example: ""

app_instance.result.number

String

Incident number. Example: "INC0000050"

app_instance.result.closed_by

String

User who closed the incident. Example: ""

app_instance.result.work_start

String

Work start timestamp. Example: ""

app_instance.result.calendar_stc

String

Calendar duration in seconds. Example: ""

app_instance.result.category

String

Incident category. Example: "hardware"

app_instance.result.business_duration

String

Business duration of the incident. Example: ""

app_instance.result.incident_state

String

Current state of the incident. Example: "2"

app_instance.result.activity_due

String

Activity due timestamp. Example: "2016-01-22 16:12:37"

app_instance.result.correlation_display

String

Correlation display value. Example: ""

app_instance.result.company

Object

Company details with link and value. Example: {"link": "https://instance.servicenow.com/api/now/table/core_company/31bea3d53790200044e0bfc8bcbe5dec", "value": "31bea3d53790200044e0bfc8bcbe5dec"}

app_instance.result.active

String

Indicates if the incident is active. Example: "true"

app_instance.result.due_date

String

Due date of the incident. Example: ""

app_instance.result.assignment_group

Object

Assignment group details with link and value. Example: {"link": "https://instance.servicenow.com/api/now/table/sys_user_group/8a5055c9c61122780043563ef53438e3", "value": "8a5055c9c61122780043563ef53438e3"}

app_instance.result.caller_id

Object

Caller ID details with link and value. Example: {"link": "https://instance.servicenow.com/api/now/table/sys_user/5b7c200d0a640069006b3845b5d0fa7c", "value": "5b7c200d0a640069006b3845b5d0fa7c"}

app_instance.result.knowledge

String

Indicates if knowledge is required. Example: "false"

app_instance.result.made_sla

String

Indicates if the SLA was met. Example: "true"

app_instance.result.comments_and_work_notes

String

Comments and work notes. Example: ""

app_instance.result.parent_incident

String

Parent incident details. Example: ""

app_instance.result.state

String

State of the incident. Example: "2"

app_instance.result.user_input

String

User input details. Example: ""

app_instance.result.sys_created_on

String

Creation timestamp. Example: "2015-11-02 18:05:40"

app_instance.result.approval_set

String

Approval set details. Example: ""

app_instance.result.reassignment_count

String

Number of times reassigned. Example: "0"

app_instance.result.rfc

String

RFC details. Example: ""

app_instance.result.child_incidents

String

Details of child incidents. Example: ""

app_instance.result.opened_at

String

Opened timestamp. Example: "2015-11-02 21:58:24"

app_instance.result.short_description

String

Short description of the incident. Example: "Can't access Exchange server - is it down?"

app_instance.result.order

String

Order details. Example: ""

app_instance.result.sys_updated_by

String

User who last updated the incident. Example: "admin"

app_instance.result.resolved_by

String

User who resolved the incident. Example: ""

app_instance.result.notify

String

Notification preference. Example: "1"

app_instance.result.upon_reject

String

Action to take upon rejection. Example: "cancel"

app_instance.result.approval_history

String

Approval history details. Example: ""

app_instance.result.problem_id

String

Problem ID details. Example: ""

app_instance.result.work_notes

String

Work notes details. Example: ""

app_instance.result.calendar_duration

String

Calendar duration details. Example: ""

app_instance.result.close_code

String

Close code details. Example: ""

app_instance.result.sys_id

String

System ID of the incident. Example: "ef43c6d40a0a0b5700c77f9bf387afe3"

app_instance.result.approval

String

Approval status. Example: "not requested"

app_instance.result.caused_by

String

Details of the cause. Example: ""

app_instance.result.severity

String

Severity level of the incident. Example: "3"

app_instance.result.sys_created_by

String

User who created the incident. Example: "glide.maint"

app_instance.result.resolved_at

String

Resolution timestamp. Example: ""

app_instance.result.assigned_to

Object

Assigned to user details with link and value. Example: {"link": "https://instance.servicenow.com/api/now/table/sys_user/681b365ec0a80164000fb0b05854a0cd", "value": "681b365ec0a80164000fb0b05854a0cd"}

app_instance.result.business_stc

String

Business duration in seconds. Example: ""

app_instance.result.wf_activity

String

Workflow activity details. Example: ""

app_instance.result.sys_domain_path

String

System domain path. Example: "/"

app_instance.result.cmdb_ci

Object

Configuration item details with link and value. Example: {"link": "https://instance.servicenow.com/api/now/table/cmdb_ci/281190e3c0a8000b003f593aa3f20ca6", "value": "281190e3c0a8000b003f593aa3f20ca6"}

app_instance.result.opened_by

Object

Opened by user details with link and value. Example: {"link": "https://instance.servicenow.com/api/now/table/sys_user/glide.maint", "value": "glide.maint"}

app_instance.result.subcategory

String

Subcategory of the incident. Example: ""

app_instance.result.rejection_goto

String

Rejection go-to details. Example: ""

app_instance.result.sys_class_name

String

Class name of the incident. Example: "incident"

app_instance.result.watch_list

String

Watch list details. Example: ""

app_instance.result.time_worked

String

Time worked on the incident. Example: ""

app_instance.result.contact_type

String

Type of contact. Example: "phone"

app_instance.result.escalation

String

Escalation level of the incident. Example: "3"

app_instance.result.comments

String

Comments added to the incident. Example: ""

Request type 

Enter the request type.

Example:

normal

Text

Required

Allowed values:

Category of change request 

Enter the category of the change request.

Example:

normal

Text

Required

Allowed values:

System ID of configuration item 

Enter the system ID of the configuration item.

Text

Required

Impact of the request 

Provide the impact of the change request.

Example:

2

Text

Required

Accepted values:

Short description 

Provide a short description or summary of the change request.

Example:

Sample Description for Reference

Text

Optional

Description 

Provide the details for the change request.

Text

Optional

System ID of group 

Enter the system ID of the group to assign the request.

Text

Optional

Start date 

Provide a start date as input.

The date should be in the format:

2015-10-20 23:59:59

Text

Optional

End date 

Provide an end date. 

The date should be in the format:

2015-10-20 23:59:59

Text

Optional

Work note 

Provide a work note.

Text

Optional

Query params 

Enter additional parameters in the form of key-value pairs.

Example:

{"quantity": 10}

Key Value

Optional

(app_instance}

Object

This parameter indicates the ID of the app instance configured in Orchestrate from which the response is retrieved.

app_instance.result.sys_id

String

System ID of the record. Example: "b0dbda5347c12200e0ef563dbb9a718f"

app_instance.result.state

Object

State details with value and display value. Example: {"value": "-5", "display_value": "New"}

app_instance.result.type

Object

Type details with value and display value. Example: {"value": "normal", "display_value": "Normal"}

app_instance.result.short_description

Object

Short description details with value and display value. Example: {"value": "Remove server", "display_value": "Remove server"}

app_instance.result.__meta

Object

Meta-information object. Example: {"ignoredFields": ["no_such_field"]}

Short Description 

Provide a short description of the incident.

Example:

Sample description for reference

Text

Required

Urgency 

Enter the urgency of the incident. Possible values are 1, 2 or 3.

Example:

3

Text

Required

Allowed values:

Impact 

Enter the impact of the incident. Possible values are 1, 2, or 3.

Example:

3

Text

Required

Allowed values:

Caller ID 

Enter the caller ID associated with the incident.

Example:

user

Text

Optional

Additional Data 

Enter additional data to be added while creating the incident in ServiceNow ITSM.

Key Value

Optional

app_instance.result.upon_approval

String

Action to be taken upon approval. Example: "proceed"

app_instance.result.location

String

Location information. Example: ""

app_instance.result.expected_start

String

Expected start time. Example: ""

app_instance.result.reopen_count

String

Number of times the incident was reopened. Example: "0"

app_instance.result.close_notes

String

Notes added upon closing the incident. Example: ""

app_instance.result.additional_assignee_list

String

List of additional assignees. Example: ""

app_instance.result.impact

String

Impact level. Example: "2"

app_instance.result.urgency

String

Urgency level. Example: "2"

app_instance.result.correlation_id

String

Correlation ID. Example: ""

app_instance.result.sys_tags

String

System tags. Example: ""

app_instance.result.sys_domain.link

String

URL to the system domain resource. Example: "https://instance.servicenow.com/api/now/table/sys_user_group/global"

app_instance.result.sys_domain.value

String

Value of the system domain. Example: "global"

app_instance.result.description

String

Description of the incident. Example: ""

app_instance.result.group_list

String

List of groups. Example: ""

app_instance.result.priority

String

Priority level. Example: "3"

app_instance.result.delivery_plan

String

Delivery plan. Example: ""

app_instance.result.sys_mod_count

String

System modification count. Example: "0"

app_instance.result.work_notes_list

String

List of work notes. Example: ""

app_instance.result.business_service

String

Business service associated with the incident. Example: ""

app_instance.result.follow_up

String

Follow-up information. Example: ""

app_instance.result.closed_at

String

Timestamp when the incident was closed. Example: ""

app_instance.result.sla_due

String

SLA due date. Example: ""

app_instance.result.delivery_task

String

Delivery task. Example: ""

app_instance.result.sys_updated_on

String

Timestamp when the incident was last updated. Example: "2016-01-22 14:28:24"

app_instance.result.parent

String

Parent incident ID. Example: ""

app_instance.result.work_end

String

Work end time. Example: ""

app_instance.result.number

String

Incident number. Example: "INC0010002"

app_instance.result.closed_by

String

User who closed the incident. Example: ""

app_instance.result.work_start

String

Work start time. Example: ""

app_instance.result.calendar_stc

String

Calendar static time. Example: ""

app_instance.result.category

String

Incident category. Example: "inquiry"

app_instance.result.business_duration

String

Business duration. Example: ""

app_instance.result.incident_state

String

State of the incident. Example: "1"

app_instance.result.activity_due

String

Activity due date. Example: ""

app_instance.result.correlation_display

String

Correlation display. Example: ""

app_instance.result.company

String

Company associated with the incident. Example: ""

app_instance.result.active

String

Indicates if the incident is active. Example: "true"

app_instance.result.due_date

String

Due date of the incident. Example: ""

app_instance.result.assignment_group.link

String

URL to the assignment group resource. Example: "https://instance.servicenow.com/api/now/table/sys_user_group/287ebd7da9fe198100f92cc8d1d2154e"

app_instance.result.assignment_group.value

String

Value of the assignment group. Example: "287ebd7da9fe198100f92cc8d1d2154e"

app_instance.result.caller_id

String

Caller ID. Example: ""

app_instance.result.knowledge

String

Indicates if the incident is a knowledge article. Example: "false"

app_instance.result.made_sla

String

Indicates if the SLA was met. Example: "true"

app_instance.result.comments_and_work_notes

String

Comments and work notes associated with the incident. Example: ""

app_instance.result.parent_incident

String

Parent incident ID. Example: ""

app_instance.result.state

String

State of the incident. Example: "1"

app_instance.result.user_input

String

User input related to the incident. Example: ""

app_instance.result.sys_created_on

String

Timestamp when the incident was created. Example: "2016-01-22 14:28:24"

app_instance.result.approval_set

String

Approval set information. Example: ""

app_instance.result.reassignment_count

String

Number of times the incident was reassigned. Example: "0"

app_instance.result.rfc

String

RFC (Request for Change) ID. Example: ""

app_instance.result.child_incidents

String

Number of child incidents. Example: "0"

app_instance.result.opened_at

String

Timestamp when the incident was opened. Example: "2016-01-22 14:28:24"

app_instance.result.short_description

String

Short description of the incident. Example: "Unable to connect to office wifi"

app_instance.result.order

String

Order information. Example: ""

app_instance.result.sys_updated_by

String

User who last updated the incident. Example: "admin"

app_instance.result.resolved_by

String

User who resolved the incident. Example: ""

app_instance.result.notify

String

Notification type. Example: "1"

app_instance.result.upon_reject

String

Action to be taken upon rejection. Example: "cancel"

app_instance.result.approval_history

String

Approval history. Example: ""

app_instance.result.problem_id

String

Problem ID associated with the incident. Example: ""

app_instance.result.work_notes

String

Work notes associated with the incident. Example: ""

app_instance.result.calendar_duration

String

Calendar duration. Example: ""

app_instance.result.close_code

String

Close code. Example: ""

app_instance.result.sys_id

String

System ID of the incident. Example: "c537bae64f411200adf9f8e18110c76e"

app_instance.result.approval

String

Approval status. Example: "not requested"

app_instance.result.caused_by

String

Cause of the incident. Example: ""

app_instance.result.severity

String

Severity level. Example: "3"

app_instance.result.sys_created_by

String

User who created the incident. Example: "admin"

app_instance.result.resolved_at

String

Timestamp when the incident was resolved. Example: ""

app_instance.result.assigned_to

String

User assigned to the incident. Example: ""

app_instance.result.business_stc

String

Business static time. Example: ""

app_instance.result.wf_activity

String

Workflow activity. Example: ""

app_instance.result.sys_domain_path

String

Path of the system domain. Example: "/"

app_instance.result.cmdb_ci

String

Configuration item. Example: ""

app_instance.result.opened_by.link

String

URL to the user who opened the incident. Example: "https://instance.servicenow.com/api/now/table/sys_user/6816f79cc0a8016401c5a33be04be441"

app_instance.result.opened_by.value

String

Value of the user who opened the incident. Example: "6816f79cc0a8016401c5a33be04be441"

app_instance.result.subcategory

String

Subcategory of the incident. Example: ""

app_instance.result.rejection_goto

String

Rejection goto information. Example: ""

app_instance.result.sys_class_name

String

Class name of the incident. Example: "incident"

app_instance.result.watch_list

String

List of watchers. Example: ""

app_instance.result.time_worked

String

Time worked on the incident. Example: ""

app_instance.result.contact_type

String

Type of contact. Example: "phone"

app_instance.result.escalation

String

Escalation level. Example: "0"

app_instance.result.comments

String

Comments on the incident. Example: ""

System ID

Enter the system ID of the attachment.

Example:

1f27d9a5db131010a3c28a18489619b6

Text

Required

Quantity

Enter the quantity of the item. This cannot be a negative number.

Text

Required

Extra params

Enter additional parameters as key-value pairs.

Key Value

Optional

{app_instance}

Object

This parameter indicates the ID of the app instance configured in Orchestrate from which the response is retrieved.

app_instance.result.sys_id

String

System ID of the record. Example: "cf56a3fcdb3a2300e890f71fbf9619ac"

app_instance.result.number

String

Request number. Example: "REQ0010012"

app_instance.result.request_number

String

Request number. Example: "REQ0010012"

app_instance.result.request_id

String

Request ID. Example: "cf56a3fcdb3a2300e890f71fbf9619ac"

app_instance.result.table

String

Name of the table. Example: "sc_request"

Table name 

Specify the table name.

Example:

u_co_test

Text

Required

Post params 

Enter parameters to be filled while creating the record in the form of key-value pairs.

Key Value

Required

upon_approval

String

Action to be taken upon approval. Example: "proceed"

location

String

Location information.

expected_start

String

Expected start time. 

reopen_count

String

Number of times the incident was reopened. Example: "0"

close_notes

String

Notes added upon closing the incident. 

additional_assignee_list

String

List of additional assignees. 

impact

String

Impact level. Example: "2"

urgency

String

Urgency level. Example: "2"

correlation_id

String

Correlation ID. 

sys_tags

String

System tags.

sys_domain.link

String

URL to the system domain resource. Example: "https://instance.servicenow.com/api/now/table/sys_user_group/global"

sys_domain.value

String

Value of the system domain. Example: "global"

description

String

Description of the incident. 

group_list

String

List of groups. 

priority

String

Priority level. Example: "3"

delivery_plan

String

Delivery plan. 

sys_mod_count

String

System modification count. Example: "0"

work_notes_list

String

List of work notes.

business_service

String

Business service associated with the incident.

follow_up

String

Follow-up information. 

closed_at

String

Timestamp when the incident was closed. 

sla_due

String

SLA due date. 

delivery_task

String

Delivery task. 

sys_updated_on

String

Timestamp when the incident was last updated. Example: "2016-01-22 14:28:24"

parent

String

Parent incident ID.

work_end

String

Work end time.

number

String

Incident number. Example: "INC0010002"

closed_by

String

User who closed the incident. 

work_start

String

Work start time. 

calendar_stc

String

Calendar static time.

category

String

Incident category. Example: "inquiry"

business_duration

String

Business duration. 

incident_state

String

State of the incident. Example: "1"

activity_due

String

Activity due date.

correlation_display

String

Correlation display.

company

String

Company associated with the incident.

active

String

Indicates if the incident is active. Example: "true"

due_date

String

Due date of the incident. Example: ""

assignment_group.link

String

URL to the assignment group resource. Example: "https://instance.servicenow.com/api/now/table/sys_user_group/287ebd7da9fe198100f92cc8d1d2154e"

assignment_group.value

String

Value of the assignment group. Example: "287ebd7da9fe198100f92cc8d1d2154e"

caller_id

String

Caller ID. 

knowledge

String

Indicates if the incident is a knowledge article. Example: "false"

made_sla

String

Indicates if the SLA was met. Example: "true"

comments_and_work_notes

String

Comments and work notes associated with the incident. Example: ""

parent_incident

String

Parent incident ID. 

state

String

State of the incident. Example: "1"

user_input

String

User input related to the incident.

sys_created_on

String

Timestamp when the incident was created. Example: "2016-01-22 14:28:24"

approval_set

String

Approval set information.

reassignment_count

String

Number of times the incident was reassigned. Example: "0"

rfc

String

RFC (Request for Change) ID.

child_incidents

String

Number of child incidents. Example: "0"

opened_at

String

Timestamp when the incident was opened. Example: "2016-01-22 14:28:24"

short_description

String

Short description of the incident. Example: "Unable to connect to office wifi"

order

String

Order information. 

sys_updated_by

String

User who last updated the incident. Example: "admin"

resolved_by

String

User who resolved the incident.

notify

String

Notification type. Example: "1"

upon_reject

String

Action to be taken upon rejection. Example: "cancel"

approval_history

String

Approval history. 

problem_id

String

Problem ID associated with the incident.

work_notes

String

Work notes associated with the incident.

calendar_duration

String

Calendar duration. 

close_code

String

Close code. 

sys_id

String

System ID of the incident. Example: "c537bae64f411200adf9f8e18110c76e"

approval

String

Approval status. Example: "not requested"

caused_by

String

Cause of the incident. 

severity

String

Severity level. Example: "3"

sys_created_by

String

User who created the incident. Example: "admin"

resolved_at

String

Timestamp when the incident was resolved.

assigned_to

String

User assigned to the incident. 

business_stc

String

Business static time. 

wf_activity

String

Workflow activity.

sys_domain_path

String

Path of the system domain. Example: "/"

cmdb_ci

String

Configuration item.

opened_by.link

String

URL to the user who opened the incident. Example: "https://instance.servicenow.com/api/now/table/sys_user/6816f79cc0a8016401c5a33be04be441"

opened_by.value

String

Value of the user who opened the incident. Example: "6816f79cc0a8016401c5a33be04be441"

subcategory

String

Subcategory of the incident. 

rejection_goto

String

Rejection goto information. 

sys_class_name

String

Class name of the incident. Example: "incident"

watch_list

String

List of watchers.

time_worked

String

Time worked on the incident.

contact_type

String

Type of contact. Example: "phone"

escalation

String

Escalation level. Example: "0"

comments

String

Comments on the incident.

Table name 

Enter the table name. 

Example: 

incident

Text

Required

Request item information 

Enter information to add to the request item in the form of key-value pairs. 

Example:

{"quantity": 10}

Key Value

Optional

{app_instance}

Object

This parameter indicates the ID of the app instance configured in Orchestrate from which the response is retrieved.

app_instance.result.upon_approval

String

Action to take upon approval. Example: "proceed"

app_instance.result.location

Object

Location details with link and value. Example: {"link": "https://instance.servicenow.com/api/now/table/cmn_location/108752c8c611227501d4ab0e392ba97f", "value": "108752c8c611227501d4ab0e392ba97f"}

app_instance.result.expected_start

String

Expected start time. 

app_instance.result.reopen_count

String

Reopen count. 

app_instance.result.close_notes

String

Notes on closure.

app_instance.result.additional_assignee_list

String

Additional assignee list. 

app_instance.result.impact

String

Impact level. Example: "1"

app_instance.result.urgency

String

Urgency level. Example: "1"

app_instance.result.correlation_id

String

Correlation ID. 

app_instance.result.sys_tags

String

System tags.

app_instance.result.sys_domain

Object

System domain details with link and value. Example: {"link": "https://instance.servicenow.com/api/now/table/sys_user_group/global", "value": "global"}

app_instance.result.description

String

Description of the incident. 

app_instance.result.group_list

String

List of groups.

app_instance.result.priority

String

Priority level. Example: "1"

app_instance.result.delivery_plan

String

Delivery plan. 

app_instance.result.sys_mod_count

String

System modification count. Example: "7"

app_instance.result.work_notes_list

String

List of work notes. 

app_instance.result.business_service

String

Business service.

app_instance.result.follow_up

String

Follow-up information. 

app_instance.result.closed_at

String

Closure timestamp.

app_instance.result.sla_due

String

SLA due date. Example: "2017-07-05 05:58:24"

app_instance.result.delivery_task

String

Delivery task. 

app_instance.result.sys_updated_on

String

Timestamp of last update. Example: "2016-01-22 14:12:37"

app_instance.result.parent

String

Parent incident.

app_instance.result.work_end

String

Work end time. 

app_instance.result.number

String

Incident number. Example: "INC0000050"

app_instance.result.closed_by

String

User who closed the incident.

app_instance.result.work_start

String

Work start time. 

app_instance.result.calendar_stc

String

Calendar short time code. 

app_instance.result.category

String

Category of the incident. Example: "hardware"

app_instance.result.business_duration

String

Business duration. 

app_instance.result.incident_state

String

State of the incident. Example: "2"

app_instance.result.activity_due

String

Activity due date. Example: "2016-01-22 16:12:37"

app_instance.result.correlation_display

String

Correlation display. 

app_instance.result.company

Object

Company details with link and value. Example: {"link": "https://instance.servicenow.com/api/now/table/core_company/31bea3d53790200044e0bfc8bcbe5dec", "value": "31bea3d53790200044e0bfc8bcbe5dec"}

app_instance.result.active

String

Active status. Example: "true"

app_instance.result.due_date

String

Due date. 

app_instance.result.assignment_group

Object

Assignment group details with link and value. Example: {"link": "https://instance.servicenow.com/api/now/table/sys_user_group/8a5055c9c61122780043563ef53438e3", "value": "8a5055c9c61122780043563ef53438e3"}

app_instance.result.caller_id

Object

Caller ID details with link and value. Example: {"link": "https://instance.servicenow.com/api/now/table/sys_user/5b7c200d0a640069006b3845b5d0fa7c", "value": "5b7c200d0a640069006b3845b5d0fa7c"}

app_instance.result.knowledge

String

Knowledge article. Example: "false"

app_instance.result.made_sla

String

SLA met status. Example: "true"

app_instance.result.comments_and_work_notes

String

Comments and work notes. 

app_instance.result.parent_incident

String

Parent incident.

app_instance.result.state

String

State of the incident. Example: "2"

app_instance.result.user_input

String

User input. 

app_instance.result.sys_created_on

String

Timestamp of creation. Example: "2015-11-02 18:05:40"

app_instance.result.approval_set

String

Approval set. 

app_instance.result.reassignment_count

String

Reassignment count. Example: "0"

app_instance.result.rfc

String

RFC number. 

app_instance.result.child_incidents

String

Child incidents.

app_instance.result.opened_at

String

Timestamp when the incident was opened. Example: "2015-11-02 21:58:24"

app_instance.result.short_description

String

Short description of the incident. Example: "Can't access Exchange server - is it down?"

app_instance.result.order

String

Order number.

app_instance.result.sys_updated_by

String

User who last updated the incident. Example: "admin"

app_instance.result.resolved_by

String

User who resolved the incident. Example: "admin"

app_instance.result.notify

String

Notification preference. Example: "1"

app_instance.result.upon_reject

String

Action to take upon rejection. Example: "cancel"

app_instance.result.approval_history

String

Approval history.

app_instance.result.problem_id

String

Problem ID.

app_instance.result.work_notes

String

Work notes.

app_instance.result.calendar_duration

String

Calendar duration.

app_instance.result.close_code

String

Close code.

app_instance.result.sys_id

String

System ID. Example: "ef43c6d40a0a0b5700c77f9bf387afe3"

app_instance.result.approval

String

Approval status. Example: "not requested"

app_instance.result.caused_by

String

Causing factor.

app_instance.result.severity

String

Severity level. Example: "3"

app_instance.result.sys_created_by

String

User who created the incident. Example: "glide.maint"

app_instance.result.resolved_at

String

Timestamp when the incident was resolved. Example: "2015-11-09 22:59:24"

app_instance.result.assigned_to

Object

Assigned user details with link and value. Example: {"link": "https://instance.servicenow.com/api/now/table/sys_user/681b365ec0a80164000fb0b05854a0cd", "value": "681b365ec0a80164000fb0b05854a0cd"}

app_instance.result.business_stc

String

Business short time code.

app_instance.result.wf_activity

String

Workflow activity.

app_instance.result.sys_domain_path

String

System domain path. Example: "/"

app_instance.result.cmdb_ci

Object

CMDB CI details with link and value. Example: {"link": "https://instance.servicenow.com/api/now/table/cmdb_ci/281190e3c0a8000b003f593aa3f20ca6", "value": "281190e3c0a8000b003f593aa3f20ca6"}

app_instance.result.opened_by

Object

Opened by user details with link and value. Example: {"link": "https://instance.servicenow.com/api/now/table/sys_user/glide.maint", "value": "glide.maint"}

app_instance.result.subcategory

String

Subcategory of the incident. Example: ""

app_instance.result.rejection_goto

String

Rejection redirection.

app_instance.result.sys_class_name

String

Class name of the incident. Example: "incident"

app_instance.result.watch_list

String

Watch list.

app_instance.result.time_worked

String

Time worked.

app_instance.result.contact_type

String

Type of contact. Example: "phone"

app_instance.result.escalation

String

Escalation level. Example: "3"

app_instance.result.comments

String

Comments.

Table name

Enter the table name from which the record must be deleted.

Example:

u_co_test

Text

Required

System ID

Enter the system ID of the record in the table that must be deleted.

Example:

0a9cdf93dbd31010a3c28a1848961994

Text

Required

app_instance.parent

String

Parent record ID.

app_instance.made_sla

String

Indicates if the SLA was met. Example: "true"

app_instance.watch_list

String

List of watchers.

app_instance.upon_reject

String

Action to be taken upon rejection. Example: "cancel"

app_instance.sys_updated_on

String

Timestamp when the record was last updated. Example: "2016-01-19 04:52:04"

app_instance.approval_history

String

Approval history.

app_instance.number

String

Record number. Example: "PRB0000050"

app_instance.sys_updated_by

String

User who last updated the record. Example: "glide.maint"

app_instance.opened_by.link

String

URL to the user who opened the record. Example: "https://instance.servicenow.com/api/now/table/sys_user/glide.maint"

app_instance.opened_by.value

String

Value of the user who opened the record. Example: "glide.maint"

app_instance.user_input

String

User input related to the record.

app_instance.sys_created_on

String

Timestamp when the record was created. Example: "2016-01-19 04:51:19"

app_instance.sys_domain.link

String

URL to the system domain resource. Example: "https://instance.servicenow.com/api/now/table/sys_user_group/global"

app_instance.sys_domain.value

String

Value of the system domain. Example: "global"

app_instance.state

String

State of the record. Example: "4"

app_instance.sys_created_by

String

User who created the record. Example: "glide.maint"

app_instance.knowledge

String

Indicates if the record is a knowledge article. Example: "false"

app_instance.order

String

Order information.

app_instance.closed_at

String

Timestamp when the record was closed. Example: "2016-01-19 04:52:04"

app_instance.cmdb_ci.link

String

URL to the configuration item resource. Example: "https://instance.servicenow.com/api/now/table/cmdb_ci/55b35562c0a8010e01cff22378e0aea9"

app_instance.cmdb_ci.value

String

Value of the configuration item. Example: "55b35562c0a8010e01cff22378e0aea9"

app_instance.delivery_plan

String

Delivery plan.

app_instance.impact

String

Impact level. Example: "3"

app_instance.active

String

Indicates if the record is active. Example: "false"

app_instance.work_notes_list

String

List of work notes.

app_instance.business_service

String

Business service associated with the record.

app_instance.priority

String

Priority level. Example: "4"

app_instance.sys_domain_path

String

Path of the system domain. Example: "/"

app_instance.time_worked

String

Time worked on the record.

app_instance.expected_start

String

Expected start time.

app_instance.rejection_goto

String

Rejection goto information.

app_instance.opened_at

String

Timestamp when the record was opened. Example: "2016-01-19 04:49:47"

app_instance.business_duration

String

Business duration. Example: "1970-01-01 00:00:00"

app_instance.group_list

String

List of groups.

app_instance.work_end

String

Work end time.

app_instance.approval_set

String

Approval set information.

app_instance.wf_activity

String

Workflow activity.

app_instance.work_notes

String

Work notes associated with the record.

app_instance.short_description

String

Short description of the record. Example: "Switch occasionally drops connections"

app_instance.correlation_display

String

Correlation display.

app_instance.delivery_task

String

Delivery task.

app_instance.work_start

String

Work start time.

app_instance.assignment_group

String

Assignment group.

app_instance.additional_assignee_list

String

List of additional assignees.

app_instance.description

String

Description of the record. Example: "Switch occasionally drops connections"

app_instance.calendar_duration

String

Calendar duration. Example: "1970-01-01 00:02:17"

app_instance.close_notes

String

Close notes. Example: "updated firmware"

app_instance.sys_class_name

String

Class name of the record. Example: "problem"

app_instance.closed_by

String

User who closed the record.

app_instance.follow_up

String

Follow-up information.

app_instance.sys_id

String

System ID of the record. Example: "04ce72c9c0a8016600b5b7f75ac67b5b"

app_instance.contact_type

String

Type of contact. Example: "phone"

app_instance.urgency

String

Urgency level. Example: "3"

app_instance.company

String

Company associated with the record.

app_instance.reassignment_count

String

Number of times the record was reassigned.

app_instance.activity_due

String

Activity due date.

app_instance.assigned_to

String

User assigned to the record.

app_instance.comments

String

Comments on the record.

app_instance.approval

String

Approval status. Example: "not requested"

app_instance.sla_due

String

SLA due date.

app_instance.comments_and_work_notes

String

Comments and work notes.

app_instance.due_date

String

Due date.

app_instance.sys_mod_count

String

Modification count. Example: "1"

app_instance.sys_tags

String

System tags.

app_instance.escalation

String

Escalation level. Example: "0"

app_instance.upon_approval

String

Action to be taken upon approval. Example: "proceed"

app_instance.correlation_id

String

Correlation ID.

app_instance.location

String

Location information.

System ID 

Enter the system ID of the attachment.

Example:

1f27d9a5db131010a3c28a18489619b6

Text

Required

File name 

Enter the file name from which you want to download the file. 

Text

Optional

Default: 

{sys_id}_attachment

Binary file attachment

Unknown

Binary response not shown.

Method 

Enter the HTTP method to be used.

Text

Required

Allowed values:

Endpoint 

Enter the endpoint.

Example:

cyl/cyware/incident

Text

Required

Query parameters 

Enter the query parameters for the API request as key-value pairs.

Key Value

Optional

Payload 

Enter the body of the API request as key-value pairs.

Key Value

Optional

Table system ID 

Enter the system ID of the record on the specified table to which you want to attach the file.

Example: 

a83820b58f723300e7e16c7827bdeed2

Text

Optional

Extra parameters 

Enter the query parameters for the API request as key-value pairs.

Key Value

Optional

{app_instance}

Object

This parameter indicates the ID of the app instance configured in Orchestrate from which the response is retrieved.

app_instance.table_sys_id

String

System ID of the table. Example: "5054b6f8c0a800060056addcf551ecf8"

app_instance.size_bytes

String

Size in bytes. Example: "462"

app_instance.download_link

String

Download link. Example: "https://instance.service-now.com/api/now/attachment/615ea769c0a80166001cf5f2367302f5/file"

app_instance.sys_updated_on

String

Timestamp when the record was last updated. Example: "2009-05-21 04:12:21"

app_instance.sys_id

String

System ID of the record. Example: "615ea769c0a80166001cf5f2367302f5"

app_instance.sys_created_on

String

Timestamp when the record was created. Example: "2009-05-21 04:12:21"

app_instance.file_name

String

File name. Example: "blocks.swf"

app_instance.sys_created_by

String

User who created the record. Example: "glide.maint"

app_instance.compressed

String

Indicates if the file is compressed. Example: "true"

app_instance.sys_updated_by

String

User who last updated the record. Example: "glide.maint"

app_instance.table_name

String

Table name. Example: "content_block_programmatic"

app_instance.sys_mod_count

String

Modification count. Example: "0"

app_instance.content_type

String

Content type. Example: "application/x-shockwave-flash"

app_instance.size_compressed

String

Size when compressed. Example: "485"

Request type 

Enter the request type of a record.

Example:

normal

Text

Required

Allowed values:

Change request system ID 

Enter the system ID of the change request.

Example:

0a9cdf93dbd31010a3c28a1848961994

Text

Required

app_instance.action_status

Number

Current action status of the associated change request. Possible values: 1 (Blocked internally), 2 (Blocked by customer), 3 (Blocked internally and by customer), 4 (Needs attention)

app_instance.active

Boolean

Flag indicating whether the change request is active. Possible values: true (Active), false (Not active). Default: true

app_instance.activity_due

String

Date and time for which the associated case is expected to be completed.

app_instance.additional_assignee_list

Array

List of sys_ids of additional persons assigned to work on the change request.

app_instance.approval

String

Type of approval process required. Default: not requested

app_instance.approval_history

String

Most recent approval history journal entry.

app_instance.approval_set

String

Date and time that the associated action was approved.

app_instance.assigned_to

String

Sys_id of the user assigned to the change request.

app_instance.assignment_group

String

Sys_id of the group assigned to the change request.

app_instance.backout_plan

String

Description of the plan to execute if the change must be reversed.

app_instance.business_duration

String

Length in scheduled work hours, work days, and work weeks that it took to complete the change.

app_instance.business_service

String

Sys_id of the business service associated with the change request. Located in the Service [cmdb_ci_service] table.

app_instance.cab_date

String

Date on which the Change Advisory Board (CAB) meets.

app_instance.cab_delegate

String

Sys_id of the user that can substitute for the CAB manager during a CAB meeting. Located in the User [sys_user] table

app_instance.cab_recommendation

String

Description of the CAB recommendations for the change request. Maximum length: 4,000

app_instance.cab_required

Boolean

Flag indicating whether the CAB is required. Possible values: true (Required), false (Not required). Default: false

app_instance.calendar_duration

String

Not currently used by Change Management.

app_instance.category

String

Category of the change, for example hardware, network, or software. Default: Other

app_instance.change_plan

String

Activities and roles for managing and controlling the change request.

app_instance.chg_model

String

Sys_id of the change model that the associated change request was based on. Located in the Change Model [chg_model] table.

app_instance.close_code

String

Code assigned to the change request when it was closed. For example, Successful, Successful with issues, and Unsuccessful.

app_instance.close_notes

String

Notes that the person entered when closing the change request.

app_instance.closed_at

String

Date and time that the associated change request was closed.

app_instance.closed_by

String

Sys_id of the person that closed the change request. Located in the User [sys_user] table.

app_instance.cmdb_ci

String

Sys_id of the configuration item associated with the change request. Located in the Configuration Item [cmdb_ci] table.

app_instance.comments

Array

List of customer-facing work notes entered in the associated change request.

app_instance.comments_and_work_notes

Array

List of both internal and customer-facing work notes entered for the associated change request. Maximum length: 4,000

app_instance.company

String

Sys_id of the company associated with the change request. Located in the Company [core_company] table.

app_instance.conflict_last_run

String

Date and time that the conflict detection script was last run on the change request.

app_instance.conflict_status

String

Current conflict status as detected by the conflict detection script, such as Conflict and Not Run. Maximum length: 40. Default: Not Run

app_instance.contact_type

String

Method in which the change request was initially requested. Possible values: chat, email, phone, social, web

app_instance.contract

String

Sys_id of the contract associated with the change request. Located in the Contract [ast_contract] table.

app_instance.correlation_display

String

User-friendly name for the correlation_id. Maximum length: 100

app_instance.correlation_id

String

Globally unique ID (GUID) of a matching change request record in a third-party system. Maximum length: 100

app_instance.delivery_plan

String

No longer in use. Sys_id of the delivery plan associated with the change request. Located in the Execution Plan [sc_cat_item_delivery_plan] table.

app_instance.delivery_task

String

No longer in use. Sys_id of the delivery task associated with the change request. Located in the Execution Plan Task [sc_cat_item_delivery_task] table.

app_instance.description

String

Detailed description of the change request. Maximum length: 4,000

app_instance.due_date

String

Task due date. Not used by change request process.

app_instance.due_date

String

Task due date. Not used by change request process.

app_instance.end_date

String

Date and time when the change request is to be completed.

app_instance.escalation

Number (Integer)

Current escalation level. Possible values: 0 (Normal), 1 (Moderate), 2 (High), 3 (Overdue). Default: 0

app_instance.expected_start

String

Date and time when the task is to start. Not used by the change request process.

app_instance.follow_up

String

Date and time when a user followed-up with the person requesting the change request.

app_instance.group_list

Array

List of sys_ids and names of the groups associated with the change request. Maximum length: 4,000

app_instance.impact

Number (Integer)

Impact the change request will have on the customer. Possible values: 1 (High), 2 (Medium), 3 (Low). Default: 3

app_instance.implementation_plan

String

Sequential steps to execute to implement this change. Maximum length: 4,000

app_instance.justification

String

Benefits of implementing this change and the impact if this change is not implemented. Maximum length: 4,000

app_instance.knowledge

Boolean

Flag indicating whether there are any knowledge base (KB) articles associated with the change request. Possible values: true (Associated KB articles), false (No associated KB articles)

app_instance.location

String

Sys_id and name of the location of the equipment referenced in the change request. Located in the Location [cmn_location] table.

app_instance.made_sla

Boolean

No longer used. Flag indicating whether the change request was implemented in alignment with the associated service level agreement.

app_instance.needs_attention

Boolean

Flag indicating whether the change request needs attention. Possible values: true (Needs attention), false (Does not need attention). Default: false

app_instance.number

String

Change number assigned to the change request by the system, such as CHG0040007.

app_instance.on_hold

Boolean

Flag indicating whether the change request is currently on hold. Possible values: true (On hold), false (Not on hold). Default: false

app_instance.on_hold_reason

String

If the on_hold parameter is "true", description of the reason why the change request is being held up. Maximum length: 4,000

app_instance.on_hold_task

String

If the on_hold parameter is "true", list of the sys_ids of the tasks that must be completed before the hold is released. Maximum length: 4,000

app_instance.opened_at

String

Date and time that the change release was created.

app_instance.opened_by

String

Sys_id and name of the user that created the change release. Located in the User [sys_user] table.

app_instance.order

Number (Integer)

Not used by Change Management. Optional numeric field by which to order records, such as when retrieving them from a database.

app_instance.outside_maintenance_schedule

Boolean

Flag indicating whether maintenance by an outside company has been scheduled for the change request. Possible values: true (Outside maintenance scheduled), false (No outside maintenance scheduled). Default: false

app_instance.parent

String

Sys_id and name of the parent task to this change request, if any. Located in the Task [task] table.

app_instance.phase

String

Current phase of the change request. Possible values: accept, build, plan, requested.

app_instance.phase_state

String

Change_phase records that should be created for a change. Possible values: complete, on hold, open, rejected, requested, work in progress.

app_instance.priority

Number (Integer)

Priority of the change request. Possible values: 1 (Critical), 2 (High), 3 (Moderate), 4 (Low). Default: 4

app_instance.production_system

Boolean

Flag indicating whether the change request is for a ServiceNow instance that is in a production environment. Possible values: true (Production environment), false (Non-production environment).

app_instance.reason

String

Description of why the change request was initiated.

app_instance.reassignment_count

Number (Integer)

Number of times that the change request has been reassigned to a new owner. Default: 0

app_instance.rejection_goto

String

Sys_id of the task to perform if the change request is rejected. Located in the Task [table].

app_instance.requested_by

String

Sys_id of the user that requested the change. Located in the User [sys_user] table.

app_instance.requested_by_date

String

Date and time when the change is requested to be implemented by.

app_instance.result

Array

List containing one or more change request record objects. Each object describes a change request. Each element in the change request object corresponds to a field in its associated record in the Change Request [change_request] table. All elements contain value and display_value name-value pairs. Date fields also contain display_value_internal name-value pairs.

app_instance.review_comments

String

Comments entered when the change request was reviewed. Maximum length: 4,000

app_instance.review_date

String

Date that the change request was reviewed.

app_instance.review_status

String

Current status of the requested change request review.

app_instance.risk_impact_analysis

String

Description of the risk and analysis of implementing the change request. Maximum length: 4,000

app_instance.route_reason

Number (Integer)

Not currently used by Change Management. Reason that the change request was transferred. Possible values: 1 (Transfer with Resolution), 9 (Transfer without Resolutions)

app_instance.scope

Number (Integer)

Size of the change request. Possible values: 1 (Massive), 2 (Large), 3 (Medium), 4 (Small), 5 (Tiny). Default: 3

app_instance.service_offering

String

Sys_id of the service offering associated with the change request. Located in the Offering [service_offering] table.

app_instance.short_description

String

Description of the change request. Maximum length: 40

app_instance.skills

Array

List of the sys_ids of all of the skills required to implement the change request. Located in the Skill [cmn_skill] table.

app_instance.sla_due

String

No longer in use. Date and time that the change request must be completed based on the associated service level agreement.

app_instance.sn_esign_document

String

Sys_id of any E-signed document attached to the change request. Located in the Attachment [sys_attachment] table.

app_instance.sn_esign_esignature_configuration

String

Sys_id of the E-signed signature template used for the associated document. Located in the E-signature Template [sn_esign_configuration] table.

app_instance.start_date

String

Date and time that the change request is planned to start implementation.

app_instance.state

Number (Integer)

Current state of the change request. Possible values are defined in the change model.

app_instance.std_change_producer_version

String

Sys_id of the record producer and change proposal associated with the change request. Located in the Standard Change Template Version [std_change_producer_version] table.

app_instance.sys_class_name

String

Name of the table in which the change request is located.

app_instance.sys_created_by

String

Name of the user that initially created the change request. Maximum length: 40

app_instance.sys_created_on

String

Date and time that the associated change request record was originally created.

app_instance.sys_domain

String

If using domains in the instance, the name of the domain to which the change module record is associated.

app_instance.sys_domain_path

String

If using domains in the instance, the domain path in which the associated change module record resides.

app_instance.sys_id

String

Unique identifier of the associated change request record.

app_instance.sys_mod_count

Number (Integer)

Number of updates to the case since it was initially created.

app_instance.sys_updated_by

String

Person that last updated the case. Maximum length: 40

app_instance.sys_updated_on

String

Date and time when the case was last updated.

app_instance.task_effective_number

String

Universal request number. Maximum length: 40

app_instance.task_for

String

Not used by Change Management. Sys_id of the user that the task was created for. Located in the User [sys_user] table.

app_instance.test_plan

String

Description of the associated test plan for the change. Maximum length: 4,000

app_instance.time_worked

String

Total amount of time worked on the change request.

app_instance.type

String

Change request type. Possible values: emergency, normal, standard. Maximum length: 40

app_instance.unauthorized

Boolean

Flag indicating whether the change request is unauthorized. Possible values: true (Unauthorized), false (Authorized)

app_instance.universal_request

String

Sys_id of the Parent Universal request to which this change request is a part of. Located in the Task [task] table.

app_instance.upon_approval

String

Action to take if the change request is approved. Possible values: do_nothing, proceed. Maximum length: 40

app_instance.upon_reject

String

Action to take if the change request is rejected. Possible values: cancel, goto. Maximum length: 40

app_instance.urgency

Number (Integer)

Urgency of the change request. Possible values: 1 (High), 2 (Medium), 3 (Low). Default: 3

app_instance.user_input

String

Additional user input. Maximum length: 4,000

app_instance.variables

String

Name-value pairs of variables associated with the change request. Maximum length: 40

app_instance.watch_list

Array

List of sys_ids of the users who receive notifications about this change request when additional comments are added or if the state of a change request is changed to Resolved or Closed. Located in the User [sys_user] table.

app_instance.wf_activity

String

Sys_id of the workflow activity record associated with the change request. Located in the Workflow Activity [wf_activity] table.

app_instance.work_end

String

Date and time work ended on the change request.

app_instance.work_notes

String

Information about how to resolve the change request, or steps taken to resolve it. Maximum length: 4,000

Table name

Enter the table name.

Example:

u_co_test

Text

Required

System ID

Enter the system ID of the record that needs to be fetched.

Example:

0a9cdf93dbd31010a3c28a1848961994

Text

Required

Query params

Enter query parameters as key-value pairs to filter the results.

Key Value

Optional

Allowed keys:

upon_approval

String

Action to be taken upon approval. Example: "proceed"

location

String

Location information. Example: ""

expected_start

String

Expected start time. Example: ""

reopen_count

String

Number of times the incident was reopened. Example: "0"

close_notes

String

Notes added upon closing the incident. Example: ""

additional_assignee_list

String

List of additional assignees. Example: ""

impact

String

Impact level. Example: "2"

urgency

String

Urgency level. Example: "2"

correlation_id

String

Correlation ID. Example: ""

sys_tags

String

System tags. Example: ""

sys_domain.link

String

URL to the system domain resource. Example: "https://instance.servicenow.com/api/now/table/sys_user_group/global"

sys_domain.value

String

Value of the system domain. Example: "global"

description

String

Description of the incident. Example: ""

group_list

String

List of groups. Example: ""

priority

String

Priority level. Example: "3"

delivery_plan

String

Delivery plan. Example: ""

sys_mod_count

String

System modification count. Example: "0"

work_notes_list

String

List of work notes. Example: ""

business_service

String

Business service associated with the incident. Example: ""

follow_up

String

Follow-up information. Example: ""

closed_at

String

Timestamp when the incident was closed. Example: ""

sla_due

String

SLA due date. Example: ""

delivery_task

String

Delivery task. Example: ""

sys_updated_on

String

Timestamp when the incident was last updated. Example: "2016-01-22 14:28:24"

parent

String

Parent incident ID. Example: ""

work_end

String

Work end time. Example: ""

number

String

Incident number. Example: "INC0010002"

closed_by

String

User who closed the incident. Example: ""

work_start

String

Work start time. Example: ""

calendar_stc

String

Calendar static time. Example: ""

category

String

Incident category. Example: "inquiry"

business_duration

String

Business duration. Example: ""

incident_state

String

State of the incident. Example: "1"

activity_due

String

Activity due date. Example: ""

correlation_display

String

Correlation display. Example: ""

company

String

Company associated with the incident. Example: ""

active

String

Indicates if the incident is active. Example: "true"

due_date

String

Due date of the incident. Example: ""

assignment_group.link

String

URL to the assignment group resource. Example: "https://instance.servicenow.com/api/now/table/sys_user_group/287ebd7da9fe198100f92cc8d1d2154e"

assignment_group.value

String

Value of the assignment group. Example: "287ebd7da9fe198100f92cc8d1d2154e"

caller_id

String

Caller ID. Example: ""

knowledge

String

Indicates if the incident is a knowledge article. Example: "false"

made_sla

String

Indicates if the SLA was met. Example: "true"

comments_and_work_notes

String

Comments and work notes associated with the incident. Example: ""

parent_incident

String

Parent incident ID. Example: ""

state

String

State of the incident. Example: "1"

user_input

String

User input related to the incident. Example: ""

sys_created_on

String

Timestamp when the incident was created. Example: "2016-01-22 14:28:24"

approval_set

String

Approval set information. Example: ""

reassignment_count

String

Number of times the incident was reassigned. Example: "0"

rfc

String

RFC (Request for Change) ID. Example: ""

child_incidents

String

Number of child incidents. Example: "0"

opened_at

String

Timestamp when the incident was opened. Example: "2016-01-22 14:28:24"

short_description

String

Short description of the incident. Example: "Unable to connect to office wifi"

order

String

Order information. Example: ""

sys_updated_by

String

User who last updated the incident. Example: "admin"

resolved_by

String

User who resolved the incident. Example: ""

notify

String

Notification type. Example: "1"

upon_reject

String

Action to be taken upon rejection. Example: "cancel"

approval_history

String

Approval history. Example: ""

problem_id

String

Problem ID associated with the incident. Example: ""

work_notes

String

Work notes associated with the incident. Example: ""

calendar_duration

String

Calendar duration. Example: ""

close_code

String

Close code. Example: ""

sys_id

String

System ID of the incident. Example: "c537bae64f411200adf9f8e18110c76e"

approval

String

Approval status. Example: "not requested"

caused_by

String

Cause of the incident. Example: ""

severity

String

Severity level. Example: "3"

sys_created_by

String

User who created the incident. Example: "admin"

resolved_at

String

Timestamp when the incident was resolved. Example: ""

assigned_to

String

User assigned to the incident. Example: ""

business_stc

String

Business static time. Example: ""

wf_activity

String

Workflow activity. Example: ""

sys_domain_path

String

Path of the system domain. Example: "/"

cmdb_ci

String

Configuration item. Example: ""

opened_by.link

String

URL to the user who opened the incident. Example: "https://instance.servicenow.com/api/now/table/sys_user/6816f79cc0a8016401c5a33be04be441"

opened_by.value

String

Value of the user who opened the incident. Example: "6816f79cc0a8016401c5a33be04be441"

subcategory

String

Subcategory of the incident. Example: ""

rejection_goto

String

Rejection goto information. Example: ""

sys_class_name

String

Class name of the incident. Example: "incident"

watch_list

String

List of watchers. Example: ""

time_worked

String

Time worked on the incident. Example: ""

contact_type

String

Type of contact. Example: "phone"

escalation

String

Escalation level. Example: "0"

comments

String

Comments on the incident. Example: ""

Incident number 

Enter the incident number to get details.

Example:

inc04521

Text

Required

{app_instance}

Object

This parameter indicates the ID of the app instance configured in Orchestrate from which the response is retrieved.

app_instance.upon_approval

String

Action to take upon approval. Example: "Escalate".

app_instance.location

Object

Location information with link and value.

app_instance.expected_start

String

Expected start time. Example: "2024-06-17 10:00:00".

app_instance.reopen_count

String

Number of times the incident was reopened. Example: "2".

app_instance.close_notes

String

Notes added upon closing the incident. Example: "Issue resolved".

app_instance.additional_assignee_list

String

List of additional assignees. Example: "user1, user2".

app_instance.impact

String

Impact level of the incident. Example: "1" (High).

app_instance.urgency

String

Urgency level of the incident. Example: "3" (Low).

app_instance.correlation_id

String

Correlation ID for related incidents. Example: "CORR12345".

app_instance.sys_tags

String

System tags for the incident. Example: "tag1, tag2".

app_instance.sys_domain

Object

Domain information with link and value.

app_instance.description

String

Detailed description of the incident. Example: "User cannot access software".

app_instance.group_list

String

List of groups associated with the incident. Example: "group1, group2".

app_instance.priority

String

Priority level of the incident. Example: "3" (Low).

app_instance.delivery_plan

String

Delivery plan for the incident. Example: "Plan A".

app_instance.sys_mod_count

String

Number of times the record was modified. Example: "4".

app_instance.work_notes_list

String

List of work notes for the incident. Example: "Note 1, Note 2".

app_instance.business_service

String

Business service affected by the incident. Example: "Email Service".

app_instance.follow_up

String

Follow-up actions required. Example: "Check after 24 hours".

app_instance.closed_at

String

Timestamp when the incident was closed. Example: "2024-06-18 15:30:00".

app_instance.sla_due

String

SLA due date. Example: "2015-11-11 22:04:15".

app_instance.delivery_task

String

Delivery task associated with the incident. Example: "Task 123".

app_instance.sys_updated_on

String

Timestamp when the incident was last updated. Example: "2015-11-01 22:37:27".

app_instance.parent

String

Parent incident ID. Example: "INC0000045".

app_instance.work_end

String

Timestamp when the work ended. Example: "2024-06-17 17:00:00".

app_instance.number

String

Unique number of the incident. Example: "INC0000046".

app_instance.closed_by

String

User who closed the incident. Example: "admin".

app_instance.work_start

String

Timestamp when the work started. Example: "2024-06-17 09:00:00".

app_instance.calendar_stc

String

Calendar time spent on the incident. Example: "3 hours".

app_instance.category

String

Category of the incident. Example: "software".

app_instance.business_duration

String

Business duration of the incident. Example: "2 days".

app_instance.incident_state

String

State of the incident. Example: "1" (Open).

app_instance.activity_due

String

Due date for the next activity. Example: "2024-06-18 12:00:00".

app_instance.correlation_display

String

Display value for the correlation ID. Example: "CORR12345".

app_instance.company

String

Company associated with the incident. Example: "ABC Corp".

app_instance.active

String

Active status of the incident. Example: "true".

app_instance

String

Due date of the incident. Example: "2024-06-18 17:00:00".

app_instance.assignment_group

Object

Assignment group information with link and value.

app_instance.caller_id

Object

Caller ID information with link and value.

app_instance.knowledge

String

Knowledge article status. Example: "false".

app_instance.made_sla

String

SLA met status. Example: "false".

app_instance.comments_and_work_notes

String

Comments and work notes associated with the incident. Example: "Initial analysis done".

app_instance.parent_incident

String

Parent incident ID. Example: "INC0000045".

app_instance.state

String

State of the incident. Example: "1" (Open).

app_instance.user_input

String

User input associated with the incident. Example: "User input details".

app_instance.sys_created_on

String

Timestamp when the incident was created. Example: "2015-11-01 22:05:30".

app_instance.approval_set

String

Approval set for the incident. Example: "Approval set details".

app_instance.reassignment_count

String

Number of times the incident was reassigned. Example: "1".

app_instance.rfc

String

RFC associated with the incident. Example: "RFC12345".

app_instance.child_incidents

String

Child incidents associated with this incident. Example: "INC0000047, INC0000048".

app_instance.opened_at

String

Timestamp when the incident was opened. Example: "2015-11-02 22:04:15".

app_instance.short_description

String

Short description of the incident. Example: "Can't access SFA software".

app_instance.order

String

Order associated with the incident. Example: "Order123".

app_instance.sys_updated_by

String

User who last updated the incident. Example: "glide.maint".

app_instance.resolved_by

String

User who resolved the incident. Example: "resolver1".

app_instance.notify

String

Notification status of the incident. Example: "1".

app_instance.upon_reject

String

Action to take upon rejection. Example: "Reassign".

app_instance.approval_history

String

History of approvals for the incident. Example: "Approval history details".

app_instance.problem_id

Object

Problem ID information with link and value.

app_instance.work_notes

String

Work notes associated with the incident. Example: "Work note details".

app_instance.calendar_duration

String

Calendar duration of the incident. Example: "2 hours".

app_instance.close_code

String

Code indicating the reason for closing the incident. Example: "Resolved".

app_instance.sys_id

String

System ID of the incident. Example: "a9e30c7dc61122760116894de7bcc7bd".

app_instance.approval

String

Approval status of the incident. Example: "not requested".

app_instance.caused_by

String

Cause of the incident. Example: "Network issue".

app_instance.severity

String

Severity level of the incident. Example: "3" (Low).

app_instance.sys_created_by

String

User who created the incident. Example: "admin".

app_instance.resolved_at

String

Timestamp when the incident was resolved. Example: "2024-06-18 10:30:00".

app_instance.assigned_to

String

User assigned to the incident. Example: "assignee1".

app_instance.business_stc

String

Business stc details. Example: "Business STC info".

app_instance.wf_activity

String

Workflow activity details. Example: "Workflow activity info".

app_instance.sys_domain_path

String

System domain path. Example: "/".

app_instance.cmdb_ci

Object

Configuration item information with link and value.

app_instance.opened_by

Object

User who opened the incident with link and value.

app_instance.subcategory

String

Subcategory of the incident. Example: "Software issue".

app_instance.rejection_goto

String

Action to take if rejected. Example: "Escalate".

app_instance.sys_class_name

String

Class name of the incident. Example: "incident".

app_instance.watch_list

String

List of users watching the incident. Example: "user1, user2".

app_instance.time_worked

String

Total time worked on the incident. Example: "2 hours".

app_instance.contact_type

String

Type of contact for the incident. Example: "phone".

app_instance.escalation

String

Escalation status of the incident. Example: "0" (Not escalated).

app_instance.comments

String

Comments associated with the incident. Example: "Additional comments".

Table name 

Enter the table name to get the requested item record.

Example:

incident

Text

Required

System ID of record 

Enter the system ID of the record to get details.

Example:

a83820b58f723300e7e16c7827bdeed2

Text

Required

Filters 

Specify the filters using key-value pairs to refine the data.

Example:

{'sysparm_display_value':'all'}

Key Value

Optional

Allowed keys:

{app_instance}

Object

This parameter indicates the ID of the app instance configured in Orchestrate from which the response is retrieved.

app_instance.upon_approval

String

Action to take upon approval. Example: "Escalate".

app_instance.location

Object

Location information with link and value.

app_instance.expected_start

String

Expected start time. Example: "2024-06-17 10:00:00".

app_instance.reopen_count

String

Number of times the incident was reopened. Example: "2".

app_instance.close_notes

String

Notes added upon closing the incident. Example: "Issue resolved".

app_instance.additional_assignee_list

String

List of additional assignees. Example: "user1, user2".

app_instance.impact

String

Impact level of the incident. Example: "1" (High).

app_instance.urgency

String

Urgency level of the incident. Example: "3" (Low).

app_instance.correlation_id

String

Correlation ID for related incidents. Example: "CORR12345".

app_instance.sys_tags

String

System tags for the incident. Example: "tag1, tag2".

app_instance.sys_domain

Object

Domain information with link and value.

app_instance.description

String

Detailed description of the incident. Example: "User cannot access software".

app_instance.group_list

String

List of groups associated with the incident. Example: "group1, group2".

app_instance.priority

String

Priority level of the incident. Example: "3" (Low).

app_instance.delivery_plan

String

Delivery plan for the incident. Example: "Plan A".

app_instance.sys_mod_count

String

Number of times the record was modified. Example: "4".

app_instance.work_notes_list

String

List of work notes for the incident. Example: "Note 1, Note 2".

app_instance.business_service

String

Business service affected by the incident. Example: "Email Service".

app_instance.follow_up

String

Follow-up actions required. Example: "Check after 24 hours".

app_instance.closed_at

String

Timestamp when the incident was closed. Example: "2024-06-18 15:30:00".

app_instance.sla_due

String

SLA due date. Example: "2015-11-11 22:04:15".

app_instance.delivery_task

String

Delivery task associated with the incident. Example: "Task 123".

app_instance.sys_updated_on

String

Timestamp when the incident was last updated. Example: "2015-11-01 22:37:27".

app_instance.parent

String

Parent incident ID. Example: "INC0000045".

app_instance.work_end

String

Timestamp when the work ended. Example: "2024-06-17 17:00:00".

app_instance.number

String

Unique number of the incident. Example: "INC0000046".

app_instance.closed_by

String

User who closed the incident. Example: "admin".

app_instance.work_start

String

Timestamp when the work started. Example: "2024-06-17 09:00:00".

app_instance.calendar_stc

String

Calendar time spent on the incident. Example: "3 hours".

app_instance.category

String

Category of the incident. Example: "software".

app_instance.business_duration

String

Business duration of the incident. Example: "2 days".

app_instance.incident_state

String

State of the incident. Example: "1" (Open).

app_instance.activity_due

String

Due date for the next activity. Example: "2024-06-18 12:00:00".

app_instance.correlation_display

String

Display value for the correlation ID. Example: "CORR12345".

app_instance.company

String

Company associated with the incident. Example: "ABC Corp".

app_instance.active

String

Active status of the incident. Example: "true".

app_instance.due_date

String

Due date of the incident. Example: "2024-06-18 17:00:00".

app_instance.assignment_group

Object

Assignment group information with link and value.

app_instance.caller_id

Object

Caller ID information with link and value.

app_instance.knowledge

String

Knowledge article status. Example: "false".

app_instance.made_sla

String

SLA met status. Example: "false".

app_instance.comments_and_work_notes

String

Comments and work notes associated with the incident. Example: "Initial analysis done".

app_instance.parent_incident

String

Parent incident ID. Example: "INC0000045".

app_instance.state

String

State of the incident. Example: "1" (Open).

app_instance.user_input

String

User input associated with the incident. Example: "User input details".

app_instance.sys_created_on

String

Timestamp when the incident was created. Example: "2015-11-01 22:05:30".

app_instance.approval_set

String

Approval set for the incident. Example: "Approval set details".

app_instance.reassignment_count

String

Number of times the incident was reassigned. Example: "1".

app_instance.rfc

String

RFC associated with the incident. Example: "RFC12345".

app_instance.child_incidents

String

Child incidents associated with this incident. Example: "INC0000047, INC0000048".

app_instance.opened_at

String

Timestamp when the incident was opened. Example: "2015-11-02 22:04:15".

app_instance.short_description

String

Short description of the incident. Example: "Can't access SFA software".

app_instance.order

String

Order associated with the incident. Example: "Order123".

app_instance.sys_updated_by

String

User who last updated the incident. Example: "glide.maint".

app_instance.resolved_by

String

User who resolved the incident. Example: "resolver1".

app_instance.notify

String

Notification status of the incident. Example: "1".

app_instance.upon_reject

String

Action to take upon rejection. Example: "Reassign".

app_instance.approval_history

String

History of approvals for the incident. Example: "Approval history details".

app_instance.problem_id

Object

Problem ID information with link and value. Example: "https://instance.servicenow.com/api/now/table/problem/a9e4890bc6112276003d7a5a5c774a74"

app_instance.work_notes

String

Work notes associated with the incident. Example: "Work note details".

app_instance.calendar_duration

String

Calendar duration of the incident. Example: "2 hours".

app_instance.close_code

String

Code indicating the reason for closing the incident. Example: "Resolved".

app_instance.sys_id

String

System ID of the incident. Example: "a9e30c7dc61122760116894de7bcc7bd".

app_instance.approval

String

Approval status of the incident. Example: "not requested".

app_instance.caused_by

String

Cause of the incident. Example: "Network issue".

app_instance.severity

String

Severity level of the incident. Example: "3" (Low).

app_instance.sys_created_by

String

User who created the incident. Example: "admin".

app_instance.resolved_at

String

Timestamp when the incident was resolved. Example: "2024-06-18 10:30:00".

app_instance.assigned_to

String

User assigned to the incident. Example: "assignee1".

app_instance.business_stc

String

Business stc details. Example: "Business STC info".

app_instance.wf_activity

String

Workflow activity details. Example: "Workflow activity info".

app_instance.sys_domain_path

String

System domain path. Example: "/".

app_instance.cmdb_ci

Object

Configuration item information with link and value. Example:"https://instance.servicenow.com/api/now/table/cmdb_ci/a9c0c8d2c6112276018f7705562f9cb0"

app_instance.opened_by

Object

User who opened the incident with link and value. Example: "https://instance.servicenow.com/api/now/table/sys_user/46c6f9efa9fe198101ddf5eed9adf6e7"

app_instance.subcategory

String

Subcategory of the incident. Example: "Software issue".

app_instance.rejection_goto

String

Action to take if rejected. Example: "Escalate".

app_instance.sys_class_name

String

Class name of the incident. Example: "incident".

app_instance.watch_list

String

List of users watching the incident. Example: "user1, user2".

app_instance.time_worked

String

Total time worked on the incident. Example: "2 hours".

app_instance.contact_type

String

Type of contact for the incident. Example: "phone".

app_instance.escalation

String

Escalation status of the incident. Example: "0" (Not escalated).

app_instance.comments

String

Comments associated with the incident. Example: "Additional comments".

Table name 

Enter the table name to get the statistics.

Example:

incident

Text

Required

Query params 

Enter the query parameters as key-value pairs. 

Key Value

Optional

Allowed keys:

Default: 

{sysparm_avg_fields: reassignment_count, business_stc data}

{app_instance}

Object

This parameter indicates the ID of the app instance configured in Orchestrate from which the response is retrieved.

app_instance.result

Array of Objects

Stats for the specified table.

app_instance.result.stats.avg.business_stc

String

Average business service time in seconds. Example: "804162.7143".

app_instance.result.stats.avg.reassignment_count

String

Average reassignment count. Example: "1.0000".

app_instance.result.groupby_fields.value

String

Assignment group value.

app_instance.result.groupby_fields.field

String

Field name for the assignment group. Example: "assignment_group".

User system ID 

Enter the system ID of the user for which the role information needs to be fetched.

Example:

005d500b536073005e0addeeff7b12f4

Text

Required

{app_instance}

Object

This parameter indicates the ID of the app instance configured in Orchestrate from which the response is retrieved.

app_instance.result.user_name

String

Username. Example: "abel.tuter"

app_instance.result.from_group

Array of Strings

List of groups from which the user belongs. Example: ["[Azure Operators]/sn_azure.operator", "[Azure Operators]/sn_azure.operator/sn_azure.user"]

app_instance.result.from_role

Array of Strings

List of roles assigned to the user. Example: ["/snc_internal", "/cloud_user", "/cloud_user/pa_viewer", "/cloud_user/sn_azure.user", "/cloud_user/aws_user"]

Table name 

Enter the table name.

Example:

incident

Text

Required

Maximum number of users 

Enter the maximum number of users to be returned.

Example:

10

Integer