REST In IntegrationHub Flashcards

1
Q

What is IntegrationHub?

A

IntegrationHub is a framework used to interact with third-party platforms in ServiceNow. Developers can use IntegrationHub to build integration actions to execute commands against external platforms.

———————————————————————
📁 REST in IntegrationHub Developer Documentation

How well did you know this?
1
Not at all
2
3
4
5
Perfectly
2
Q

What are some examples of how to use IntegrationHub?

A
  • Post news to Slack, Teams, or other communication and social media platforms
  • Automate onboarding processes to update user information in a Human Resource system, create a user in Active Directory, and assign training to a new employee
  • Consume information from and interact with Internet of Things (IoT) devices

———————————————————————
📁 REST in IntegrationHub Developer Documentation

How well did you know this?
1
Not at all
2
3
4
5
Perfectly
3
Q

What are steps within the context of IntegrationHub?

A

Steps are individual actions or operations that are part of an integration flow.

———————————————————————
📁 REST in IntegrationHub Developer Documentation

How well did you know this?
1
Not at all
2
3
4
5
Perfectly
4
Q

What is an Integration Flow?

A

A sequence of steps that define the entire integration process. Each step represents a specific actions that should be performed during the integration.

———————————————————————
📁 REST in IntegrationHub Developer Documentation

How well did you know this?
1
Not at all
2
3
4
5
Perfectly
5
Q

IntegrationHub provides various pre-built step types that you can use in your integration flows.
Can you list off some of the common step types?

A
  • REST Steps
  • SOAP Steps
  • Script Steps
  • Subflow Steps
  • ServiceNow Table Steps
  • Utility Steps

———————————————————————
📁 REST in IntegrationHub Developer Documentation

How well did you know this?
1
Not at all
2
3
4
5
Perfectly
6
Q

IntegrationHub provides various pre-built step types that you can use in your integration flows.
Can you give a brief description of what a REST Step is?

A

REST Steps allow you to make HTTP requests to external RESTful APIs.

———————————————————————
📁 REST in IntegrationHub Developer Documentation

How well did you know this?
1
Not at all
2
3
4
5
Perfectly
7
Q

IntegrationHub provides various pre-built step types that you can use in your integration flows.
Can you give a brief description of what a SOAP Step is?

A

Used for interacting with SOAP-based web services

———————————————————————
📁 REST in IntegrationHub Developer Documentation

How well did you know this?
1
Not at all
2
3
4
5
Perfectly
8
Q

IntegrationHub provides various pre-built step types that you can use in your integration flows.
Can you give a brief description of what a Script Step is?

A

These steps enable you to write custom scripts (usually JavaScript) to perform specific actions or transformations.

———————————————————————
📁 REST in IntegrationHub Developer Documentation

How well did you know this?
1
Not at all
2
3
4
5
Perfectly
9
Q

IntegrationHub provides various pre-built step types that you can use in your integration flows.
Can you give a brief description of what a Subflow Step is?

A

You can include other integration flows as subflows within your main flow, allowing for modular and reusable integration designs.

———————————————————————
📁 REST in IntegrationHub Developer Documentation

How well did you know this?
1
Not at all
2
3
4
5
Perfectly
10
Q

IntegrationHub provides various pre-built step types that you can use in your integration flows.
Can you give a brief description of what ServiceNow Table Steps are?

A

These steps are used to interact with ServiceNow tables and records, enabling you to create, update, or retrieve data within your instance.

———————————————————————
📁 REST in IntegrationHub Developer Documentation

How well did you know this?
1
Not at all
2
3
4
5
Perfectly
11
Q

IntegrationHub provides various pre-built step types that you can use in your integration flows.
Can you give a brief description of what Utility Steps are?

A

Utility steps provide various utilities like branching, decision making, or setting variables within the flow.

———————————————————————
📁 REST in IntegrationHub Developer Documentation

How well did you know this?
1
Not at all
2
3
4
5
Perfectly
12
Q

What benefits does IntegrationHub provide for developers?

A
  • Automates application logic to interact with external platforms
  • Enables SMEs (Subject Matter Experts) to develop and share integration actions developers can leverage in custom applications
  • Provides natural-language descriptions of integration logic in an application to help non-technical users author flows and understand what flows do.

———————————————————————
📁 REST in IntegrationHub Developer Documentation

How well did you know this?
1
Not at all
2
3
4
5
Perfectly
13
Q

What is a spoke in the context of IntegrationHub?

A

A spoke is a logical grouping of related actions, subflows, and supporting application files.
A spoke is a scoped application that includes Flow Designer or IntegrationHub actions or subflows.
Process designers can reuse spoke logic in their own applications.
Their are default included spokes and customers spokes available to download or create.

———————————————————————
📁 REST in IntegrationHub Developer Documentation

How well did you know this?
1
Not at all
2
3
4
5
Perfectly
14
Q

How do you create a spoke?
What’s an important thing to remember when creating a spoke here?

A

You create a spoke in the same way that you would create a scoped application - using studio.

  • It’s convention to add the word Spoke to the application name to identify an application as a spoke.

———————————————————————
📁 REST in IntegrationHub Developer Documentation

How well did you know this?
1
Not at all
2
3
4
5
Perfectly
15
Q

What are the different parts of an endpoint URL?

A
  • Scheme / Protocol
  • Domain / Host
  • Port
  • Path
  • Query Parameters
  • Fragment Identifier
  • Authentication
  • HTTP Methods

———————————————————————
📁 REST in IntegrationHub Developer Documentation

How well did you know this?
1
Not at all
2
3
4
5
Perfectly
16
Q

What is an Endpoint URL?

A

A URL by which a REST API is accessed.

———————————————————————
📁 REST in IntegrationHub Developer Documentation

17
Q

What type of data makes up query parameters?

A

Name:Value Pairs

———————————————————————
📁 REST in IntegrationHub Developer Documentation

18
Q

What is an inline connection in IntegrationHub and when should it be used / not be used?

A

An inline connection is a type of connection configuration that allows you to define connection parameters directly within a flow or action, rather than creating a separate connection record in the Connection Registry.
Inline connections are not recommended for production use. Actions should be designed so the action itself does not need to be modified directly to use. Connection and Credentials aliases should be used to connect to REST APIs in production and to separate the configuration from the action definition.

———————————————————————
📁 REST in IntegrationHub Developer Documentation

19
Q

What is a resource path in the context of endpoint URLs?

A

A resource path is added to the Base URL to create the entirety of the endpoint URL.
An API will include a variety of different resource paths to return different information.

———————————————————————
📁 REST in IntegrationHub Developer Documentation

20
Q

REST API calls return data in the Response Body.
How is the response body data typically formatted?

A

It is usually structured in JSON or XML format.

———————————————————————
📁 REST in IntegrationHub Developer Documentation

21
Q

It is possible to parse a REST API call’s response body into variables that can be used elsewhere in an action or flow.
What is the general strategy to get extracted data from the response?

A
  • Review the response body to select the data to return
  • Create input and output variable in the Script step
  • — Create an input variable to pass in the Response Body from the REST step.
  • — Create output variables to return data from the response
  • Create a script to parse and map data
  • — Use the JSON.parse() method in a Script step to parse a JSON response body
  • — Map the parsed data to the output variables
  • Create action outputs for the output variables to make the data available to a flow.

NOTE: To parse XML there is a preincluded XML Parser step.

———————————————————————
📁 REST in IntegrationHub Developer Documentation

22
Q

What are Connection and Credential Aliases?

A

Pointers to a connection. A connection defines the URL or hostname to connect to a third-party platform.

———————————————————————
📁 REST in IntegrationHub Developer Documentation

23
Q

What is the difference between an inline connection and establishing a connection with Connection and Credential Aliases?

A

An inline connection creates a connection directly in a REST step, while Connection and Credential Aliases and Connections allows you to define a connection once, then use the connection in any custom action.

———————————————————————
📁 REST in IntegrationHub Developer Documentation

24
Q

What are some things the Connections and Credential Aliases and Connections Enables?

A
  • Connection details to be configured once for all actions that need to access that connection
  • Connection details can be updated without having to reconfigure every action
  • Multiple Connection hosts to be managed centrally

———————————————————————
📁 REST in IntegrationHub Developer Documentation

25
Q

After establishing a Connection, establishing Connection and Credential Aliases - what can be done to enable developers to only have to configure the base URL of the endpoint once?

A

Configure REST actions in a spoke to point to a Connection and Credentials Alias. Configure the Resource Path in the action’s REST step to point to the REST APIs resource.
Create actions for REST resources that point to the Connection & Credential Alias. Configure the Connection URL in a Connection record with the domain and the parts of the endpoint that are common for all resources.

———————————————————————
📁 REST in IntegrationHub Developer Documentation

26
Q

What feature of “Connection & Credential Alias”es enables a developer to switch between hosts easily?

A

A single Connection & Credential Alias can have multiple related Connection records.

———————————————————————
📁 REST in IntegrationHub Developer Documentation

27
Q

What roles are needed out of box to create and save Connection & Credential Aliases?

A

connection_admin or admin

———————————————————————
📁 REST in IntegrationHub Developer Documentation

28
Q

What are the steps to create a Connection & Credential Alias in Studio?

A
  • 1: Click the Create Application File link
  • 2: Select the Flow Designer category
  • 3: Select the Connection & Credential Aliases option
  • 4: Click the Create button
  • 5: Configure the Connection & Credential Alias properties

———————————————————————
📁 REST in IntegrationHub Developer Documentation

29
Q

How do you associate a Connection with a Connection & Credential Alias?

A

Use the Connections related list on a particular ‘Connection & Credential Alias’ record to create Connections associated with it.

———————————————————————
📁 REST in IntegrationHub Developer Documentation

30
Q

What roles are needed to create and save Connections?
(Connections here is used in the context of Connection & Credential Aliases)

A

connection_admin or admin

———————————————————————
📁 REST in IntegrationHub Developer Documentation

31
Q

What are Connection records considered in terms of “type”?

A

Connection records are considered data and not considered application files.

———————————————————————
📁 REST in IntegrationHub Developer Documentation

32
Q

In what fashion are Connections supposed to be added to an application, and what is the philosophy behind this?

A

Connections need to be manually added to an application to prevent developers from including connection details to internal computers or REST APIs.

———————————————————————
📁 REST in IntegrationHub Developer Documentation

33
Q

What is the only type of REST API that should be added to an application?

A

Connections should only be added to an application for public REST APIs.

———————————————————————
📁 REST in IntegrationHub Developer Documentation

34
Q

What are the steps to create a REST action that uses a Connection & Credential Alias?

A
  • Create an action
  • Add & Configure a REST step
  • Select Use Connection Alias as the Connection
  • Select Connection Alias
  • Configure the Request Details section with the Resource Path, HTTP Method, and Query Parameters

———————————————————————
📁 REST in IntegrationHub Developer Documentation

35
Q

What are credentials records?

A

Authentication data used to access the REST API.

———————————————————————
📁 REST in IntegrationHub Developer Documentation

36
Q

What is special about Credential Records in ServiceNow?

A

ServiceNow stores credential information in an encrypted field. Once a credential is entered, the credential cannot be viewed.

———————————————————————
📁 REST in IntegrationHub Developer Documentation

37
Q

What three credential types do REST APIs use and give a brief description.

A

API Key: A unique code provided by the REST API to identify the calling application or user
Basic Authentication: A user name and password combination to authenticate to the REST API
- OAuth 2.0: An authentication provider provides a secret and uses that information to grant access to a resource.

Always check docs and choose most secure method available for each API.

———————————————————————
📁 REST in IntegrationHub Developer Documentation

38
Q

What happens when a Basic Authentication credential is used?

A

ServiceNow generates an encoded string from the user name and password, which is passed to the Authorization header as a Basic encoded-string.

———————————————————————
📁 REST in IntegrationHub Developer Documentation

39
Q

What role is necessary to assign a Credential to a Connection?

A

connection_admin or admin

———————————————————————
📁 REST in IntegrationHub Developer Documentation