Skip to content

Commit f57b841

Browse files
authored
Merge pull request #238279 from whhender/patch-102
Adding Parse JSON
2 parents 51d183c + 5272eea commit f57b841

File tree

4 files changed

+35
-13
lines changed

4 files changed

+35
-13
lines changed

articles/purview/how-to-use-workflow-http-connector.md

Lines changed: 33 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,48 +1,70 @@
11
---
2-
title: Workflow HTTP connector
3-
description: This article describes how to use HTTP connector in Purview workflows
2+
title: Use external APIs in Workflows
3+
description: Work with external APIs using HTTP connector and Parse JSON in Microsoft Purview workflows.
44
author: nayenama
55
ms.author: nayenama
66
ms.service: purview
77
ms.subservice: purview-workflows
88
ms.topic: how-to
9-
ms.date: 09/30/2022
9+
ms.date: 05/16/2023
1010
ms.custom: template-how-to
1111
---
1212

13-
# Workflows HTTP connector
13+
# Use external APIs in Workflows
1414

1515
[!INCLUDE [feature-in-preview](includes/feature-in-preview.md)]
1616

17-
You can use [workflows](concept-workflow.md) to automate some business processes through Microsoft Purview. HTTP connector allows Purview workflows to integrate with external applications. HTTP connectors use Representational State Transfer (REST) architecture, which allows Microsoft Purview workflows to interact directly with third party applications by using web requests.
17+
You can use [workflows](concept-workflow.md) to automate some business processes through Microsoft Purview, and the [HTTP connector](#http-connector) and [parse JSON action](#parse-json-action) allow you to integrate your workflows with external applications.
18+
19+
## HTTP connector
20+
21+
HTTP connectors use Representational State Transfer (REST) architecture, which allows Microsoft Purview workflows to interact directly with third party applications by using web requests.
1822

1923
HTTP connector is available in all workflow templates.
2024

2125
>[!NOTE]
2226
> To create or edit a workflow, you need the [workflow admin role](catalog-permissions.md) in Microsoft Purview. You can also contact the workflow admin in your collection, or reach out to your collection administrator, for permissions.
2327
24-
1. To add a HTTP connector, click on the **+** icon in the template where you want to add and select HTTP connector.
28+
1. To add an HTTP connector, click on the **+** icon in the template where you want to add and select HTTP connector.
2529

2630
:::image type="content" source="./media/how-to-use-workflow-http-connector/add-http-connector.png" alt-text="Screenshot of how to add HTTP connector.":::
2731

28-
1. Once you select HTTP connector, you will see the following parameters:
32+
1. Once you select HTTP connector, you see the following parameters:
2933
1. Host - Request URL you want to call when this connector is executed.
30-
1. Method - Select one of the following methods. GET, PUT, PATCH, POST and DELETE. These correspond to create, read, update and delete operations.
34+
1. Method - Select one of the following methods. GET, PUT, PATCH, POST and DELETE. These methods correspond to create, read, update and delete operations.
3135
1. Path - Optionally you can enter request URL Path. You can use dynamic content for this parameter.
3236
1. Headers - Optionally, you can enter HTTP headers. HTTP headers let the client and the server pass additional information with an HTTP request or response
3337
1. Queries - Optionally, you can pass queries.
3438
1. Body - Optionally, you can pass HTTP body while invoking the URL
35-
1. Authentication - HTTP connector is integrated with Purview credentials. Depending on the URL you may invoke the endpoint with None (no authentication) or you can use credentials to create a basic authentication. To learn more about credentials see the [Microsoft Purview credentials article](manage-credentials.md).
39+
1. Authentication - HTTP connector is integrated with Purview credentials. Depending on the URL, you may invoke the endpoint with None (no authentication) or you can use credentials to create a basic authentication. To learn more about credentials see the [Microsoft Purview credentials article](manage-credentials.md).
3640

3741
:::image type="content" source="./media/how-to-use-workflow-http-connector/add-http-properties.png" alt-text="Screenshot of how to add HTTP connector properties.":::
3842

3943
1. By default, secure settings are turned on for HTTP connectors. To turn OFF secure inputs and outputs select the ellipsis icon (**...**) to go to settings.
4044

4145
:::image type="content" source="./media/how-to-use-workflow-http-connector/add-http-settings.png" alt-text="Screenshot of how to add HTTP connector settings.":::
4246

43-
1. You will be now presented with the settings for HTTP connector and you can turn secure inputs and outputs OFF.
47+
1. You are now presented with the settings for HTTP connector and you can turn secure inputs and outputs OFF.
48+
49+
:::image type="content" source="./media/how-to-use-workflow-http-connector/add-http-secure.png" alt-text="Screenshot of how to add HTTP connector secure input and outputs.":::
50+
51+
## Parse JSON action
52+
53+
The parse JSON action in workflows allows you to take an incoming JSON from HTTP (or any other action/connector), and parse the JSON to extract values for use in your workflow.
54+
55+
The parse JSON action is available in all workflows.
56+
57+
:::image type="content" source="./media/how-to-use-workflow-http-connector/parse-json-action.png" alt-text="Screenshot of the workflows parse JSON action, showing its parameters filled out with sample data.":::
58+
59+
The parse JSON action has two parameters:
60+
61+
- Content - a variable that should contain the JSON you want to parse.
62+
- Schema - the schema of the incoming JSON, which allows the workflow to parse the incoming information. You can supply your own, or use the **Generate from sample** button. If you generate from a sample, you'll enter a sample JSON payload and a schema will be automatically generated for you.
63+
64+
Actions and connectors in the workflow after the parse JSON action will be able to use the values extracted from the JSON by selecting **Add dynamic content** for any parameters.
65+
66+
:::image type="content" source="./media/how-to-use-workflow-http-connector/add-dynamic-content.png" alt-text="Screenshot of another connector with values from the Parse JSON action added.":::
4467

45-
:::image type="content" source="./media/how-to-use-workflow-http-connector/add-http-secure.png" alt-text="Screenshot of how to add HTTP connector secure input and outputs.":::
4668

4769
## Next steps
4870

26.7 KB
Loading
18.2 KB
Loading

articles/purview/toc.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -323,11 +323,11 @@ items:
323323
href: how-to-workflow-manage-requests-approvals.md
324324
- name: Manage workflow runs
325325
href: how-to-workflow-manage-runs.md
326-
- name: Workflow connectors
326+
- name: Workflow connectors and actions
327327
href: how-to-use-workflow-connectors.md
328328
- name: Workflow dynamic content
329329
href: how-to-use-workflow-dynamic-content.md
330-
- name: Workflow HTTP connector
330+
- name: Workflows and external APIs
331331
href: how-to-use-workflow-http-connector.md
332332
- name: Data sharing
333333
items:

0 commit comments

Comments
 (0)