Skip to content

Commit 36c2b17

Browse files
ShawnJacksonShawnJackson
authored
Merge pull request #201441 from BCS2022/tutorial-atlas-2-2-apis
edit pass: tutorial-atlas-2-2-apis
2 parents e63f3d3 + baa2606 commit 36c2b17

File tree

1 file changed

+38
-38
lines changed

1 file changed

+38
-38
lines changed

‎articles/purview/tutorial-atlas-2-2-apis.md

Lines changed: 38 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,41 @@
11
---
2-
title: "How to use new APIs available with Atlas 2.2"
3-
description: This tutorial describes the new APIs available with Atlas 2.2 upgrade.
2+
title: "Use new APIs available with Atlas 2.2."
3+
description: This tutorial describes the new APIs available with the Atlas 2.2 upgrade.
44
author: nayenama
55
ms.author: nayenama
66
ms.service: purview
77
ms.subservice: purview-data-catalog
88
ms.topic: tutorial
99
ms.date: 04/18/2022
1010

11-
# Customer intent: I can use the new APIs available with Atlas 2.2
11+
# Customer intent: As a developer, I want to use the new APIs available with Atlas 2.2 to interact programmatically with the data map in Microsoft Purview.
1212
---
1313

1414
# Tutorial: Atlas 2.2 new functionality
1515

16-
In this tutorial, you learn how to programmatically interact with new Atlas 2.2 APIs with Microsoft Purview's data map.
17-
18-
If you don't have an Azure subscription, [create a free account](https://azure.microsoft.com/free/?ref=microsoft.com&utm_source=microsoft.com&utm_medium=docs&utm_campaign=visualstudio) before you begin.
16+
In this tutorial, learn to programmatically interact with new Atlas 2.2 APIs with the data map in Microsoft Purview.
1917

2018
## Prerequisites
2119

22-
* To get started, you must have an existing Microsoft Purview account. If you don't have a catalog, see the [quickstart for creating a Microsoft Purview account](create-catalog-portal.md).
20+
* If you don't have an Azure subscription, [create a free account](https://azure.microsoft.com/free/?ref=microsoft.com&utm_source=microsoft.com&utm_medium=docs&utm_campaign=visualstudio) before you begin.
21+
22+
* You must have an existing Microsoft Purview account. If you don't have a catalog, see the [quickstart for creating a Microsoft Purview account](create-catalog-portal.md).
2323

24-
* To establish bearer token and to call any Data Plane APIs see [the documentation about how to call REST APIs for Purview Data planes](tutorial-using-rest-apis.md).
24+
* To establish a bearer token and to call any data plane APIs, see [the documentation about how to call REST APIs for Microsoft Purview data planes](tutorial-using-rest-apis.md).
2525

26-
## Business Metadata APIs
26+
## Business metadata APIs
2727

28-
Business Metadata is a template containing multiple custom attributes (key values) which can be created globally and then applied across multiple typedefs.
28+
Business metadata is a template that contains custom attributes (key values). You can create these attributes globally and then apply them across multiple typedefs.
2929

30-
### Create a Business metadata with attributes
30+
### Create business metadata with attributes
3131

32-
You can send POST request to the following endpoint
32+
You can send a `POST` request to the following endpoint:
3333

3434
```
3535
POST {{endpoint}}/api/atlas/v2/types/typedefs
3636
```
3737

38-
Sample JSON
38+
Sample JSON:
3939

4040
```json
4141
{
@@ -67,15 +67,15 @@ Sample JSON
6767
}
6868
```
6969

70-
### Add/Update an attribute to an existing business metadata
70+
### Add or update an attribute to existing business metadata
7171

72-
You can send PUT request to the following endpoint:
72+
You can send a `PUT` request to the following endpoint:
7373

7474
```
7575
PUT {{endpoint}}/api/atlas/v2/types/typedefs
7676
```
7777

78-
Sample JSON
78+
Sample JSON:
7979

8080
```json
8181
{
@@ -118,23 +118,23 @@ Sample JSON
118118
}
119119
```
120120

121-
### Get Business metadata definition
121+
### Get a business metadata definition
122122

123-
You can send GET request to the following endpoint
123+
You can send a `GET` request to the following endpoint:
124124

125125
```
126126
GET {endpoint}}/api/atlas/v2/types/typedef/name/{{Business Metadata Name}}
127127
```
128128

129-
### Set Business metadata attribute to an entity
129+
### Set a business metadata attribute to an entity
130130

131-
You can send POST request to the following endpoint
131+
You can send a `POST` request to the following endpoint:
132132

133133
```
134134
POST {{endpoint}}/api/atlas/v2/entity/guid/{{GUID}}/businessmetadata?isOverwrite=true
135135
```
136136

137-
Sample JSON
137+
Sample JSON:
138138

139139
```json
140140
{
@@ -145,15 +145,15 @@ Sample JSON
145145
}
146146
```
147147

148-
### Delete Business metadata attribute from an entity
148+
### Delete a business metadata attribute from an entity
149149

150-
You can send DELETE request to the following endpoint
150+
You can send a `DELETE` request to the following endpoint:
151151

152152
```
153-
DELETE {{endpoint}}/api/atlas/v2/entity/guid/{{GUID}}/businessmetadata?isOverwrite=true
153+
'DELETE' {{endpoint}}/api/atlas/v2/entity/guid/{{GUID}}/businessmetadata?isOverwrite=true
154154
```
155155

156-
Sample JSON
156+
Sample JSON:
157157

158158
```json
159159
{
@@ -163,27 +163,27 @@ Sample JSON
163163
}
164164
```
165165

166-
### Delete Business metadata type definition
166+
### Delete a business metadata type definition
167167

168-
You can send DELETE request to the following endpoint
168+
You can send a `DELETE` request to the following endpoint:
169169

170170
```
171171
DELETE {{endpoint}}/api/atlas/v2/types/typedef/name/{{Business Metadata Name}}
172172
```
173173

174-
## Custom Attribute APIs
174+
## Custom attribute APIs
175175

176-
Custom Attributes are key value pairs which can be directly added to an atlas entity.
176+
Custom attributes are key/value pairs that can be directly added to an Atlas entity.
177177

178-
### Set Custom Attribute to an entity
178+
### Set a custom attribute to an entity
179179

180-
You can send POST request to the following endpoint
180+
You can send a `POST` request to the following endpoint:
181181

182182
```
183183
POST {{endpoint}}/api/atlas/v2/entity
184184
```
185185

186-
Sample JSON
186+
Sample JSON:
187187

188188
```json
189189
{
@@ -204,17 +204,17 @@ Sample JSON
204204
```
205205
## Label APIs
206206

207-
Labels are free text tags which can be applied to any atlas entity.
207+
Labels are free text tags that can be applied to any Atlas entity.
208208

209209
### Set labels to an entity
210210

211-
You can send POST request to the following endpoint
211+
You can send a `POST` request to the following endpoint:
212212

213213
```
214214
POST {{endpoint}}/api/atlas/v2/entity/guid/{{GUID}}/labels
215215
```
216216

217-
Sample JSON
217+
Sample JSON:
218218

219219
```json
220220
[
@@ -225,13 +225,13 @@ Sample JSON
225225

226226
### Delete labels to an entity
227227

228-
You can send DELETE request to the following endpoint:
228+
You can send a `DELETE` request to the following endpoint:
229229

230230
```
231231
DELETE {{endpoint}}/api/atlas/v2/entity/guid/{{GUID}}/labels
232232
```
233233

234-
Sample JSON
234+
Sample JSON:
235235

236236
```json
237237
[
@@ -243,4 +243,4 @@ Sample JSON
243243

244244
> [!div class="nextstepaction"]
245245
> [Manage data sources](manage-data-sources.md)
246-
> [Purview Data Plane REST APIs](/rest/api/purview/)
246+
> [Microsoft Purview data plane REST APIs](/rest/api/purview/)

0 commit comments

Comments
 (0)