Skip to content

Service Now Service Now: Interactions

Summary

This module contains actions related to ServiceNow Interactions.

Minimum Plugin Version: 6.0.0

Actions

service_now.interactions.

get_by_number

Get an interaction by its number.

Minimum Plugin Version: 6.0.0

Input
Output

A single Interaction Dictionary.

Interaction Numbers

ServiceNow interaction numbers are not unique by default, but for simplicity this action assumes they are.

If you do have shared interaction numbers, you can use the search action to get multiples.

Example
1
2
3
4
5
- service_now.interactions.get_by_number:
    number: TEST-INTERACTION
  load:
    access_details: service_now_api_info
  save: test_interaction

service_now.interactions.

get_by_number_interactive

Interactively search for an interaction using the number field.

Minimum Plugin Version: 6.0.0

Input
Output

An Interaction Dictionary.

Example
1
2
3
4
- service_now.interactions.get_by_number_interactive:
  load:
    access_details: service_now_api_info
  save: interaction

service_now.interactions.

input_table

Display a list of interactions in a table, & allow the task operator to make a selection.

The table will have the following columns:

  • Number
  • Short Description
  • State
  • Assigned To
  • Active

Minimum Plugin Version: 6.0.0

Input

  • text: The title of the table

  • interaction_list: A list of Interaction Dictionaries to display in the table

  • minimum: The minimum number of acceptable selections

  • maximum: The maximum number of acceptable selections

Output

A list of Interaction Dictionaries.

Tip
  • If neither a minimum or maximum is provided, the task operator will be able to submit 0 selections.
  • If minimum or maximum are provided, the operation will repeat until the task operator makes a valid number of selections.
Example
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
- service_now.interactions.search:
  load:
    access_details: service_now_api_info
  save: interactions

- service_now.interactions.input_table:
    text: Please Select 1 Interaction
    minimum: 1
    maximum: 1
  load:
    interaction_list: interactions
  save: interaction

service_now.interactions.

output_table

Display a list of interactions in a table.

The table will have the following columns:

  • Number
  • Short Description
  • State
  • Assigned To
  • Active

Minimum Plugin Version: 6.0.0

Input
Output

Nothing is outputted by this action.

Example
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
- service_now.users.search:
    user_name: john.smith
  load:
    access_details: service_now_api_info
  save: users

- ppa_tools.lists.get_first_item:
  load:
    items: users
  save: user

- service_now.interactions.search:
  load:
    assigned_to: user.sys_id
    access_details: service_now_api_info
  save: user_interactions

- service_now.interactions.output_table:
    text: Interactions for {{ user.user_name }}
  load:
    interaction_list: user_interactions

service_now.interactions.

Search for interactions. Supports multiple search fields and values.

Advanced search techniques & filters are not supported yet.

Each supplied field & value will be converted to field=value in the search query.

Minimum Plugin Version: 6.0.0

Input
Output

A list of Interaction Dictionaries.

Example

Searching for all active interactions. 

1
2
3
4
5
- service_now.interactions.search:
    active: true
  load:
    access_details: service_now_api_info
  save: active_interactions