You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@atlas.apache.org by ap...@apache.org on 2018/10/22 16:14:56 UTC
[14/27] atlas-website git commit: Updated REST docs for 1.x releases
(part 2)
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/d115dad8/1.1.0/api/v2/resource_GlossaryREST.html
----------------------------------------------------------------------
diff --git a/1.1.0/api/v2/resource_GlossaryREST.html b/1.1.0/api/v2/resource_GlossaryREST.html
index 3f0feef..4f6ec88 100644
--- a/1.1.0/api/v2/resource_GlossaryREST.html
+++ b/1.1.0/api/v2/resource_GlossaryREST.html
@@ -159,10 +159,15 @@
</thead>
<tbody>
<tr>
+ <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json</span></abbr></td>
+ <td><span class="datatype-reference">array of <a href="json_AtlasGlossary.html">AtlasGlossary</a>
+ (JSON)</span></td>
+ <td rowspan="2" class="multi-row-description"><span class="response-description">List of glossary entities fitting the above criteria</span></td>
+ </tr>
+ <tr>
<td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json;charset=UTF-8" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json;charset=UTF-8</span></abbr></td>
<td><span class="datatype-reference">(custom)
</span></td>
- <td><span class="response-description">List of glossary entities fitting the above criteria</span></td>
</tr>
</tbody>
</table>
@@ -174,8 +179,8 @@
<h5>Request</h5>
<pre>
GET /v2/glossary
-Content-Type: application/json;charset=UTF-8
-Accept: application/json;charset=UTF-8
+Content-Type: application/json
+Accept: application/json
<code class="prettyprint language-txt">
...
@@ -186,10 +191,89 @@ Accept: application/json;charset=UTF-8
<h5>Response</h5>
<pre>
HTTP/1.1 200 OK
-Content-Type: application/json;charset=UTF-8
-
- <code class="prettyprint language-txt">
-...
+Content-Type: application/json
+
+ <code class="prettyprint language-js">
+[ {
+ "categories" : [ {
+ "categoryGuid" : "...",
+ "description" : "...",
+ "displayText" : "...",
+ "parentCategoryGuid" : "...",
+ "relationGuid" : "..."
+ }, {
+ "categoryGuid" : "...",
+ "description" : "...",
+ "displayText" : "...",
+ "parentCategoryGuid" : "...",
+ "relationGuid" : "..."
+ } ],
+ "language" : "...",
+ "terms" : [ {
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "OTHER",
+ "steward" : "...",
+ "termGuid" : "..."
+ }, {
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "DRAFT",
+ "steward" : "...",
+ "termGuid" : "..."
+ } ],
+ "usage" : "...",
+ "classifications" : [ {
+ "entityGuid" : "...",
+ "entityStatus" : "DELETED",
+ "propagate" : true,
+ "removePropagationsOnEntityDelete" : true,
+ "validityPeriods" : [ {
+ "endTime" : "...",
+ "startTime" : "...",
+ "timeZone" : "..."
+ }, {
+ "endTime" : "...",
+ "startTime" : "...",
+ "timeZone" : "..."
+ } ],
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ }, {
+ "entityGuid" : "...",
+ "entityStatus" : "DELETED",
+ "propagate" : true,
+ "removePropagationsOnEntityDelete" : true,
+ "validityPeriods" : [ {
+ "endTime" : "...",
+ "startTime" : "...",
+ "timeZone" : "..."
+ }, {
+ "endTime" : "...",
+ "startTime" : "...",
+ "timeZone" : "..."
+ } ],
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ } ],
+ "longDescription" : "...",
+ "name" : "...",
+ "qualifiedName" : "...",
+ "shortDescription" : "...",
+ "guid" : "..."
+} ]
</code>
</pre>
</div>
@@ -213,11 +297,16 @@ Content-Type: application/json;charset=UTF-8
</thead>
<tbody>
<tr>
+ <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Content-Type: application/json" HTTP header to specify this media type to the server."><span class="request-type">application/json</span></abbr></td>
+ <td><span class="datatype-reference"><a href="json_AtlasGlossary.html">AtlasGlossary</a>
+ (JSON)</span></td>
+ <td rowspan="2" class="multi-row-description"><span class="request-description">Glossary definition, terms & categories can be anchored to a glossary
+using the anchor attribute when creating the Term/Category</span></td>
+ </tr>
+ <tr>
<td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Content-Type: application/json;charset=UTF-8" HTTP header to specify this media type to the server."><span class="request-type">application/json;charset=UTF-8</span></abbr></td>
<td><span class="datatype-reference">(custom)
</span></td>
- <td><span class="request-description">Glossary definition, terms & categories can be anchored to a glossary
-using the anchor attribute when creating the Term/Category</span></td>
</tr>
</tbody>
</table>
@@ -257,10 +346,15 @@ using the anchor attribute when creating the Term/Category</span></td>
</thead>
<tbody>
<tr>
+ <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json</span></abbr></td>
+ <td><span class="datatype-reference"><a href="json_AtlasGlossary.html">AtlasGlossary</a>
+ (JSON)</span></td>
+ <td rowspan="2" class="multi-row-description"><span class="response-description"></span></td>
+ </tr>
+ <tr>
<td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json;charset=UTF-8" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json;charset=UTF-8</span></abbr></td>
<td><span class="datatype-reference">(custom)
</span></td>
- <td><span class="response-description"></span></td>
</tr>
</tbody>
</table>
@@ -272,11 +366,90 @@ using the anchor attribute when creating the Term/Category</span></td>
<h5>Request</h5>
<pre>
POST /v2/glossary
-Content-Type: application/json;charset=UTF-8
-Accept: application/json;charset=UTF-8
-
- <code class="prettyprint language-txt">
-...
+Content-Type: application/json
+Accept: application/json
+
+ <code class="prettyprint language-js">
+{
+ "categories" : [ {
+ "categoryGuid" : "...",
+ "description" : "...",
+ "displayText" : "...",
+ "parentCategoryGuid" : "...",
+ "relationGuid" : "..."
+ }, {
+ "categoryGuid" : "...",
+ "description" : "...",
+ "displayText" : "...",
+ "parentCategoryGuid" : "...",
+ "relationGuid" : "..."
+ } ],
+ "language" : "...",
+ "terms" : [ {
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "ACTIVE",
+ "steward" : "...",
+ "termGuid" : "..."
+ }, {
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "DRAFT",
+ "steward" : "...",
+ "termGuid" : "..."
+ } ],
+ "usage" : "...",
+ "classifications" : [ {
+ "entityGuid" : "...",
+ "entityStatus" : "DELETED",
+ "propagate" : true,
+ "removePropagationsOnEntityDelete" : true,
+ "validityPeriods" : [ {
+ "endTime" : "...",
+ "startTime" : "...",
+ "timeZone" : "..."
+ }, {
+ "endTime" : "...",
+ "startTime" : "...",
+ "timeZone" : "..."
+ } ],
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ }, {
+ "entityGuid" : "...",
+ "entityStatus" : "ACTIVE",
+ "propagate" : true,
+ "removePropagationsOnEntityDelete" : true,
+ "validityPeriods" : [ {
+ "endTime" : "...",
+ "startTime" : "...",
+ "timeZone" : "..."
+ }, {
+ "endTime" : "...",
+ "startTime" : "...",
+ "timeZone" : "..."
+ } ],
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ } ],
+ "longDescription" : "...",
+ "name" : "...",
+ "qualifiedName" : "...",
+ "shortDescription" : "...",
+ "guid" : "..."
+}
</code>
</pre>
</div>
@@ -284,10 +457,89 @@ Accept: application/json;charset=UTF-8
<h5>Response</h5>
<pre>
HTTP/1.1 200 OK
-Content-Type: application/json;charset=UTF-8
-
- <code class="prettyprint language-txt">
-...
+Content-Type: application/json
+
+ <code class="prettyprint language-js">
+{
+ "categories" : [ {
+ "categoryGuid" : "...",
+ "description" : "...",
+ "displayText" : "...",
+ "parentCategoryGuid" : "...",
+ "relationGuid" : "..."
+ }, {
+ "categoryGuid" : "...",
+ "description" : "...",
+ "displayText" : "...",
+ "parentCategoryGuid" : "...",
+ "relationGuid" : "..."
+ } ],
+ "language" : "...",
+ "terms" : [ {
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "OBSOLETE",
+ "steward" : "...",
+ "termGuid" : "..."
+ }, {
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "DEPRECATED",
+ "steward" : "...",
+ "termGuid" : "..."
+ } ],
+ "usage" : "...",
+ "classifications" : [ {
+ "entityGuid" : "...",
+ "entityStatus" : "DELETED",
+ "propagate" : true,
+ "removePropagationsOnEntityDelete" : true,
+ "validityPeriods" : [ {
+ "endTime" : "...",
+ "startTime" : "...",
+ "timeZone" : "..."
+ }, {
+ "endTime" : "...",
+ "startTime" : "...",
+ "timeZone" : "..."
+ } ],
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ }, {
+ "entityGuid" : "...",
+ "entityStatus" : "ACTIVE",
+ "propagate" : true,
+ "removePropagationsOnEntityDelete" : true,
+ "validityPeriods" : [ {
+ "endTime" : "...",
+ "startTime" : "...",
+ "timeZone" : "..."
+ }, {
+ "endTime" : "...",
+ "startTime" : "...",
+ "timeZone" : "..."
+ } ],
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ } ],
+ "longDescription" : "...",
+ "name" : "...",
+ "qualifiedName" : "...",
+ "shortDescription" : "...",
+ "guid" : "..."
+}
</code>
</pre>
</div>
@@ -311,10 +563,15 @@ Content-Type: application/json;charset=UTF-8
</thead>
<tbody>
<tr>
+ <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Content-Type: application/json" HTTP header to specify this media type to the server."><span class="request-type">application/json</span></abbr></td>
+ <td><span class="datatype-reference">array of <a href="json_AtlasGlossaryCategory.html">AtlasGlossaryCategory</a>
+ (JSON)</span></td>
+ <td rowspan="2" class="multi-row-description"><span class="request-description">glossary category definitions</span></td>
+ </tr>
+ <tr>
<td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Content-Type: application/json;charset=UTF-8" HTTP header to specify this media type to the server."><span class="request-type">application/json;charset=UTF-8</span></abbr></td>
<td><span class="datatype-reference">(custom)
</span></td>
- <td><span class="request-description">glossary category definitions</span></td>
</tr>
</tbody>
</table>
@@ -350,10 +607,15 @@ Content-Type: application/json;charset=UTF-8
</thead>
<tbody>
<tr>
+ <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json</span></abbr></td>
+ <td><span class="datatype-reference">array of <a href="json_AtlasGlossaryCategory.html">AtlasGlossaryCategory</a>
+ (JSON)</span></td>
+ <td rowspan="2" class="multi-row-description"><span class="response-description"></span></td>
+ </tr>
+ <tr>
<td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json;charset=UTF-8" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json;charset=UTF-8</span></abbr></td>
<td><span class="datatype-reference">(custom)
</span></td>
- <td><span class="response-description"></span></td>
</tr>
</tbody>
</table>
@@ -365,11 +627,100 @@ Content-Type: application/json;charset=UTF-8
<h5>Request</h5>
<pre>
POST /v2/glossary/categories
-Content-Type: application/json;charset=UTF-8
-Accept: application/json;charset=UTF-8
-
- <code class="prettyprint language-txt">
-...
+Content-Type: application/json
+Accept: application/json
+
+ <code class="prettyprint language-js">
+[ {
+ "anchor" : {
+ "displayText" : "...",
+ "glossaryGuid" : "...",
+ "relationGuid" : "..."
+ },
+ "childrenCategories" : [ {
+ "categoryGuid" : "...",
+ "description" : "...",
+ "displayText" : "...",
+ "parentCategoryGuid" : "...",
+ "relationGuid" : "..."
+ }, {
+ "categoryGuid" : "...",
+ "description" : "...",
+ "displayText" : "...",
+ "parentCategoryGuid" : "...",
+ "relationGuid" : "..."
+ } ],
+ "parentCategory" : {
+ "categoryGuid" : "...",
+ "description" : "...",
+ "displayText" : "...",
+ "parentCategoryGuid" : "...",
+ "relationGuid" : "..."
+ },
+ "terms" : [ {
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "OTHER",
+ "steward" : "...",
+ "termGuid" : "..."
+ }, {
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "ACTIVE",
+ "steward" : "...",
+ "termGuid" : "..."
+ } ],
+ "classifications" : [ {
+ "entityGuid" : "...",
+ "entityStatus" : "ACTIVE",
+ "propagate" : true,
+ "removePropagationsOnEntityDelete" : true,
+ "validityPeriods" : [ {
+ "endTime" : "...",
+ "startTime" : "...",
+ "timeZone" : "..."
+ }, {
+ "endTime" : "...",
+ "startTime" : "...",
+ "timeZone" : "..."
+ } ],
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ }, {
+ "entityGuid" : "...",
+ "entityStatus" : "ACTIVE",
+ "propagate" : true,
+ "removePropagationsOnEntityDelete" : true,
+ "validityPeriods" : [ {
+ "endTime" : "...",
+ "startTime" : "...",
+ "timeZone" : "..."
+ }, {
+ "endTime" : "...",
+ "startTime" : "...",
+ "timeZone" : "..."
+ } ],
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ } ],
+ "longDescription" : "...",
+ "name" : "...",
+ "qualifiedName" : "...",
+ "shortDescription" : "...",
+ "guid" : "..."
+} ]
</code>
</pre>
</div>
@@ -377,10 +728,99 @@ Accept: application/json;charset=UTF-8
<h5>Response</h5>
<pre>
HTTP/1.1 200 OK
-Content-Type: application/json;charset=UTF-8
-
- <code class="prettyprint language-txt">
-...
+Content-Type: application/json
+
+ <code class="prettyprint language-js">
+[ {
+ "anchor" : {
+ "displayText" : "...",
+ "glossaryGuid" : "...",
+ "relationGuid" : "..."
+ },
+ "childrenCategories" : [ {
+ "categoryGuid" : "...",
+ "description" : "...",
+ "displayText" : "...",
+ "parentCategoryGuid" : "...",
+ "relationGuid" : "..."
+ }, {
+ "categoryGuid" : "...",
+ "description" : "...",
+ "displayText" : "...",
+ "parentCategoryGuid" : "...",
+ "relationGuid" : "..."
+ } ],
+ "parentCategory" : {
+ "categoryGuid" : "...",
+ "description" : "...",
+ "displayText" : "...",
+ "parentCategoryGuid" : "...",
+ "relationGuid" : "..."
+ },
+ "terms" : [ {
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "OTHER",
+ "steward" : "...",
+ "termGuid" : "..."
+ }, {
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "DEPRECATED",
+ "steward" : "...",
+ "termGuid" : "..."
+ } ],
+ "classifications" : [ {
+ "entityGuid" : "...",
+ "entityStatus" : "ACTIVE",
+ "propagate" : true,
+ "removePropagationsOnEntityDelete" : true,
+ "validityPeriods" : [ {
+ "endTime" : "...",
+ "startTime" : "...",
+ "timeZone" : "..."
+ }, {
+ "endTime" : "...",
+ "startTime" : "...",
+ "timeZone" : "..."
+ } ],
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ }, {
+ "entityGuid" : "...",
+ "entityStatus" : "ACTIVE",
+ "propagate" : true,
+ "removePropagationsOnEntityDelete" : true,
+ "validityPeriods" : [ {
+ "endTime" : "...",
+ "startTime" : "...",
+ "timeZone" : "..."
+ }, {
+ "endTime" : "...",
+ "startTime" : "...",
+ "timeZone" : "..."
+ } ],
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ } ],
+ "longDescription" : "...",
+ "name" : "...",
+ "qualifiedName" : "...",
+ "shortDescription" : "...",
+ "guid" : "..."
+} ]
</code>
</pre>
</div>
@@ -404,11 +844,16 @@ Content-Type: application/json;charset=UTF-8
</thead>
<tbody>
<tr>
+ <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Content-Type: application/json" HTTP header to specify this media type to the server."><span class="request-type">application/json</span></abbr></td>
+ <td><span class="datatype-reference"><a href="json_AtlasGlossaryCategory.html">AtlasGlossaryCategory</a>
+ (JSON)</span></td>
+ <td rowspan="2" class="multi-row-description"><span class="request-description">glossary category definition, a category must be anchored to a Glossary when creating
+Optionally, terms belonging to the category and the hierarchy can also be defined during creation</span></td>
+ </tr>
+ <tr>
<td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Content-Type: application/json;charset=UTF-8" HTTP header to specify this media type to the server."><span class="request-type">application/json;charset=UTF-8</span></abbr></td>
<td><span class="datatype-reference">(custom)
</span></td>
- <td><span class="request-description">glossary category definition, a category must be anchored to a Glossary when creating
-Optionally, terms belonging to the category and the hierarchy can also be defined during creation</span></td>
</tr>
</tbody>
</table>
@@ -448,10 +893,15 @@ Optionally, terms belonging to the category and the hierarchy can also be define
</thead>
<tbody>
<tr>
+ <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json</span></abbr></td>
+ <td><span class="datatype-reference"><a href="json_AtlasGlossaryCategory.html">AtlasGlossaryCategory</a>
+ (JSON)</span></td>
+ <td rowspan="2" class="multi-row-description"><span class="response-description"></span></td>
+ </tr>
+ <tr>
<td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json;charset=UTF-8" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json;charset=UTF-8</span></abbr></td>
<td><span class="datatype-reference">(custom)
</span></td>
- <td><span class="response-description"></span></td>
</tr>
</tbody>
</table>
@@ -463,11 +913,100 @@ Optionally, terms belonging to the category and the hierarchy can also be define
<h5>Request</h5>
<pre>
POST /v2/glossary/category
-Content-Type: application/json;charset=UTF-8
-Accept: application/json;charset=UTF-8
-
- <code class="prettyprint language-txt">
-...
+Content-Type: application/json
+Accept: application/json
+
+ <code class="prettyprint language-js">
+{
+ "anchor" : {
+ "displayText" : "...",
+ "glossaryGuid" : "...",
+ "relationGuid" : "..."
+ },
+ "childrenCategories" : [ {
+ "categoryGuid" : "...",
+ "description" : "...",
+ "displayText" : "...",
+ "parentCategoryGuid" : "...",
+ "relationGuid" : "..."
+ }, {
+ "categoryGuid" : "...",
+ "description" : "...",
+ "displayText" : "...",
+ "parentCategoryGuid" : "...",
+ "relationGuid" : "..."
+ } ],
+ "parentCategory" : {
+ "categoryGuid" : "...",
+ "description" : "...",
+ "displayText" : "...",
+ "parentCategoryGuid" : "...",
+ "relationGuid" : "..."
+ },
+ "terms" : [ {
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "DRAFT",
+ "steward" : "...",
+ "termGuid" : "..."
+ }, {
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "OBSOLETE",
+ "steward" : "...",
+ "termGuid" : "..."
+ } ],
+ "classifications" : [ {
+ "entityGuid" : "...",
+ "entityStatus" : "DELETED",
+ "propagate" : true,
+ "removePropagationsOnEntityDelete" : true,
+ "validityPeriods" : [ {
+ "endTime" : "...",
+ "startTime" : "...",
+ "timeZone" : "..."
+ }, {
+ "endTime" : "...",
+ "startTime" : "...",
+ "timeZone" : "..."
+ } ],
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ }, {
+ "entityGuid" : "...",
+ "entityStatus" : "ACTIVE",
+ "propagate" : true,
+ "removePropagationsOnEntityDelete" : true,
+ "validityPeriods" : [ {
+ "endTime" : "...",
+ "startTime" : "...",
+ "timeZone" : "..."
+ }, {
+ "endTime" : "...",
+ "startTime" : "...",
+ "timeZone" : "..."
+ } ],
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ } ],
+ "longDescription" : "...",
+ "name" : "...",
+ "qualifiedName" : "...",
+ "shortDescription" : "...",
+ "guid" : "..."
+}
</code>
</pre>
</div>
@@ -475,10 +1014,99 @@ Accept: application/json;charset=UTF-8
<h5>Response</h5>
<pre>
HTTP/1.1 200 OK
-Content-Type: application/json;charset=UTF-8
-
- <code class="prettyprint language-txt">
-...
+Content-Type: application/json
+
+ <code class="prettyprint language-js">
+{
+ "anchor" : {
+ "displayText" : "...",
+ "glossaryGuid" : "...",
+ "relationGuid" : "..."
+ },
+ "childrenCategories" : [ {
+ "categoryGuid" : "...",
+ "description" : "...",
+ "displayText" : "...",
+ "parentCategoryGuid" : "...",
+ "relationGuid" : "..."
+ }, {
+ "categoryGuid" : "...",
+ "description" : "...",
+ "displayText" : "...",
+ "parentCategoryGuid" : "...",
+ "relationGuid" : "..."
+ } ],
+ "parentCategory" : {
+ "categoryGuid" : "...",
+ "description" : "...",
+ "displayText" : "...",
+ "parentCategoryGuid" : "...",
+ "relationGuid" : "..."
+ },
+ "terms" : [ {
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "ACTIVE",
+ "steward" : "...",
+ "termGuid" : "..."
+ }, {
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "DEPRECATED",
+ "steward" : "...",
+ "termGuid" : "..."
+ } ],
+ "classifications" : [ {
+ "entityGuid" : "...",
+ "entityStatus" : "DELETED",
+ "propagate" : true,
+ "removePropagationsOnEntityDelete" : true,
+ "validityPeriods" : [ {
+ "endTime" : "...",
+ "startTime" : "...",
+ "timeZone" : "..."
+ }, {
+ "endTime" : "...",
+ "startTime" : "...",
+ "timeZone" : "..."
+ } ],
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ }, {
+ "entityGuid" : "...",
+ "entityStatus" : "DELETED",
+ "propagate" : true,
+ "removePropagationsOnEntityDelete" : true,
+ "validityPeriods" : [ {
+ "endTime" : "...",
+ "startTime" : "...",
+ "timeZone" : "..."
+ }, {
+ "endTime" : "...",
+ "startTime" : "...",
+ "timeZone" : "..."
+ } ],
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ } ],
+ "longDescription" : "...",
+ "name" : "...",
+ "qualifiedName" : "...",
+ "shortDescription" : "...",
+ "guid" : "..."
+}
</code>
</pre>
</div>
@@ -502,11 +1130,16 @@ Content-Type: application/json;charset=UTF-8
</thead>
<tbody>
<tr>
+ <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Content-Type: application/json" HTTP header to specify this media type to the server."><span class="request-type">application/json</span></abbr></td>
+ <td><span class="datatype-reference"><a href="json_AtlasGlossaryTerm.html">AtlasGlossaryTerm</a>
+ (JSON)</span></td>
+ <td rowspan="2" class="multi-row-description"><span class="request-description">Glossary term definition, a term must be anchored to a Glossary at the time of creation
+optionally it can be categorized as well</span></td>
+ </tr>
+ <tr>
<td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Content-Type: application/json;charset=UTF-8" HTTP header to specify this media type to the server."><span class="request-type">application/json;charset=UTF-8</span></abbr></td>
<td><span class="datatype-reference">(custom)
</span></td>
- <td><span class="request-description">Glossary term definition, a term must be anchored to a Glossary at the time of creation
-optionally it can be categorized as well</span></td>
</tr>
</tbody>
</table>
@@ -546,10 +1179,15 @@ optionally it can be categorized as well</span></td>
</thead>
<tbody>
<tr>
+ <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json</span></abbr></td>
+ <td><span class="datatype-reference"><a href="json_AtlasGlossaryTerm.html">AtlasGlossaryTerm</a>
+ (JSON)</span></td>
+ <td rowspan="2" class="multi-row-description"><span class="response-description"></span></td>
+ </tr>
+ <tr>
<td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json;charset=UTF-8" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json;charset=UTF-8</span></abbr></td>
<td><span class="datatype-reference">(custom)
</span></td>
- <td><span class="response-description"></span></td>
</tr>
</tbody>
</table>
@@ -561,11 +1199,361 @@ optionally it can be categorized as well</span></td>
<h5>Request</h5>
<pre>
POST /v2/glossary/term
-Content-Type: application/json;charset=UTF-8
-Accept: application/json;charset=UTF-8
-
- <code class="prettyprint language-txt">
-...
+Content-Type: application/json
+Accept: application/json
+
+ <code class="prettyprint language-js">
+{
+ "abbreviation" : "...",
+ "anchor" : {
+ "displayText" : "...",
+ "glossaryGuid" : "...",
+ "relationGuid" : "..."
+ },
+ "antonyms" : [ {
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "DRAFT",
+ "steward" : "...",
+ "termGuid" : "..."
+ }, {
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "OTHER",
+ "steward" : "...",
+ "termGuid" : "..."
+ } ],
+ "assignedEntities" : [ {
+ "displayText" : "...",
+ "entityStatus" : "DELETED",
+ "relationshipAttributes" : {
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ },
+ "relationshipGuid" : "...",
+ "relationshipStatus" : "DELETED",
+ "guid" : "...",
+ "typeName" : "...",
+ "uniqueAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ }, {
+ "displayText" : "...",
+ "entityStatus" : "DELETED",
+ "relationshipAttributes" : {
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ },
+ "relationshipGuid" : "...",
+ "relationshipStatus" : "DELETED",
+ "guid" : "...",
+ "typeName" : "...",
+ "uniqueAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ } ],
+ "categories" : [ {
+ "categoryGuid" : "...",
+ "description" : "...",
+ "displayText" : "...",
+ "relationGuid" : "...",
+ "status" : "OTHER"
+ }, {
+ "categoryGuid" : "...",
+ "description" : "...",
+ "displayText" : "...",
+ "relationGuid" : "...",
+ "status" : "DRAFT"
+ } ],
+ "classifies" : [ {
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "DRAFT",
+ "steward" : "...",
+ "termGuid" : "..."
+ }, {
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "DEPRECATED",
+ "steward" : "...",
+ "termGuid" : "..."
+ } ],
+ "examples" : [ "...", "..." ],
+ "isA" : [ {
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "DRAFT",
+ "steward" : "...",
+ "termGuid" : "..."
+ }, {
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "OTHER",
+ "steward" : "...",
+ "termGuid" : "..."
+ } ],
+ "preferredTerms" : [ {
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "ACTIVE",
+ "steward" : "...",
+ "termGuid" : "..."
+ }, {
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "DEPRECATED",
+ "steward" : "...",
+ "termGuid" : "..."
+ } ],
+ "preferredToTerms" : [ {
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "DRAFT",
+ "steward" : "...",
+ "termGuid" : "..."
+ }, {
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "DRAFT",
+ "steward" : "...",
+ "termGuid" : "..."
+ } ],
+ "replacedBy" : [ {
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "OBSOLETE",
+ "steward" : "...",
+ "termGuid" : "..."
+ }, {
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "OTHER",
+ "steward" : "...",
+ "termGuid" : "..."
+ } ],
+ "replacementTerms" : [ {
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "ACTIVE",
+ "steward" : "...",
+ "termGuid" : "..."
+ }, {
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "OTHER",
+ "steward" : "...",
+ "termGuid" : "..."
+ } ],
+ "seeAlso" : [ {
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "DEPRECATED",
+ "steward" : "...",
+ "termGuid" : "..."
+ }, {
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "OBSOLETE",
+ "steward" : "...",
+ "termGuid" : "..."
+ } ],
+ "synonyms" : [ {
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "OBSOLETE",
+ "steward" : "...",
+ "termGuid" : "..."
+ }, {
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "DRAFT",
+ "steward" : "...",
+ "termGuid" : "..."
+ } ],
+ "translatedTerms" : [ {
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "OTHER",
+ "steward" : "...",
+ "termGuid" : "..."
+ }, {
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "ACTIVE",
+ "steward" : "...",
+ "termGuid" : "..."
+ } ],
+ "translationTerms" : [ {
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "DRAFT",
+ "steward" : "...",
+ "termGuid" : "..."
+ }, {
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "DRAFT",
+ "steward" : "...",
+ "termGuid" : "..."
+ } ],
+ "usage" : "...",
+ "validValues" : [ {
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "ACTIVE",
+ "steward" : "...",
+ "termGuid" : "..."
+ }, {
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "ACTIVE",
+ "steward" : "...",
+ "termGuid" : "..."
+ } ],
+ "validValuesFor" : [ {
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "DEPRECATED",
+ "steward" : "...",
+ "termGuid" : "..."
+ }, {
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "ACTIVE",
+ "steward" : "...",
+ "termGuid" : "..."
+ } ],
+ "classifications" : [ {
+ "entityGuid" : "...",
+ "entityStatus" : "ACTIVE",
+ "propagate" : true,
+ "removePropagationsOnEntityDelete" : true,
+ "validityPeriods" : [ {
+ "endTime" : "...",
+ "startTime" : "...",
+ "timeZone" : "..."
+ }, {
+ "endTime" : "...",
+ "startTime" : "...",
+ "timeZone" : "..."
+ } ],
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ }, {
+ "entityGuid" : "...",
+ "entityStatus" : "DELETED",
+ "propagate" : true,
+ "removePropagationsOnEntityDelete" : true,
+ "validityPeriods" : [ {
+ "endTime" : "...",
+ "startTime" : "...",
+ "timeZone" : "..."
+ }, {
+ "endTime" : "...",
+ "startTime" : "...",
+ "timeZone" : "..."
+ } ],
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ } ],
+ "longDescription" : "...",
+ "name" : "...",
+ "qualifiedName" : "...",
+ "shortDescription" : "...",
+ "guid" : "..."
+}
</code>
</pre>
</div>
@@ -573,10 +1561,360 @@ Accept: application/json;charset=UTF-8
<h5>Response</h5>
<pre>
HTTP/1.1 200 OK
-Content-Type: application/json;charset=UTF-8
-
- <code class="prettyprint language-txt">
-...
+Content-Type: application/json
+
+ <code class="prettyprint language-js">
+{
+ "abbreviation" : "...",
+ "anchor" : {
+ "displayText" : "...",
+ "glossaryGuid" : "...",
+ "relationGuid" : "..."
+ },
+ "antonyms" : [ {
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "ACTIVE",
+ "steward" : "...",
+ "termGuid" : "..."
+ }, {
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "DRAFT",
+ "steward" : "...",
+ "termGuid" : "..."
+ } ],
+ "assignedEntities" : [ {
+ "displayText" : "...",
+ "entityStatus" : "DELETED",
+ "relationshipAttributes" : {
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ },
+ "relationshipGuid" : "...",
+ "relationshipStatus" : "ACTIVE",
+ "guid" : "...",
+ "typeName" : "...",
+ "uniqueAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ }, {
+ "displayText" : "...",
+ "entityStatus" : "DELETED",
+ "relationshipAttributes" : {
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ },
+ "relationshipGuid" : "...",
+ "relationshipStatus" : "ACTIVE",
+ "guid" : "...",
+ "typeName" : "...",
+ "uniqueAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ } ],
+ "categories" : [ {
+ "categoryGuid" : "...",
+ "description" : "...",
+ "displayText" : "...",
+ "relationGuid" : "...",
+ "status" : "ACTIVE"
+ }, {
+ "categoryGuid" : "...",
+ "description" : "...",
+ "displayText" : "...",
+ "relationGuid" : "...",
+ "status" : "DRAFT"
+ } ],
+ "classifies" : [ {
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "OTHER",
+ "steward" : "...",
+ "termGuid" : "..."
+ }, {
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "OBSOLETE",
+ "steward" : "...",
+ "termGuid" : "..."
+ } ],
+ "examples" : [ "...", "..." ],
+ "isA" : [ {
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "OTHER",
+ "steward" : "...",
+ "termGuid" : "..."
+ }, {
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "DRAFT",
+ "steward" : "...",
+ "termGuid" : "..."
+ } ],
+ "preferredTerms" : [ {
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "ACTIVE",
+ "steward" : "...",
+ "termGuid" : "..."
+ }, {
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "ACTIVE",
+ "steward" : "...",
+ "termGuid" : "..."
+ } ],
+ "preferredToTerms" : [ {
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "ACTIVE",
+ "steward" : "...",
+ "termGuid" : "..."
+ }, {
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "DEPRECATED",
+ "steward" : "...",
+ "termGuid" : "..."
+ } ],
+ "replacedBy" : [ {
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "DEPRECATED",
+ "steward" : "...",
+ "termGuid" : "..."
+ }, {
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "DRAFT",
+ "steward" : "...",
+ "termGuid" : "..."
+ } ],
+ "replacementTerms" : [ {
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "OBSOLETE",
+ "steward" : "...",
+ "termGuid" : "..."
+ }, {
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "DRAFT",
+ "steward" : "...",
+ "termGuid" : "..."
+ } ],
+ "seeAlso" : [ {
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "OTHER",
+ "steward" : "...",
+ "termGuid" : "..."
+ }, {
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "OBSOLETE",
+ "steward" : "...",
+ "termGuid" : "..."
+ } ],
+ "synonyms" : [ {
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "OTHER",
+ "steward" : "...",
+ "termGuid" : "..."
+ }, {
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "ACTIVE",
+ "steward" : "...",
+ "termGuid" : "..."
+ } ],
+ "translatedTerms" : [ {
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "OBSOLETE",
+ "steward" : "...",
+ "termGuid" : "..."
+ }, {
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "OTHER",
+ "steward" : "...",
+ "termGuid" : "..."
+ } ],
+ "translationTerms" : [ {
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "OTHER",
+ "steward" : "...",
+ "termGuid" : "..."
+ }, {
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "DEPRECATED",
+ "steward" : "...",
+ "termGuid" : "..."
+ } ],
+ "usage" : "...",
+ "validValues" : [ {
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "OTHER",
+ "steward" : "...",
+ "termGuid" : "..."
+ }, {
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "OTHER",
+ "steward" : "...",
+ "termGuid" : "..."
+ } ],
+ "validValuesFor" : [ {
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "OBSOLETE",
+ "steward" : "...",
+ "termGuid" : "..."
+ }, {
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "DRAFT",
+ "steward" : "...",
+ "termGuid" : "..."
+ } ],
+ "classifications" : [ {
+ "entityGuid" : "...",
+ "entityStatus" : "DELETED",
+ "propagate" : true,
+ "removePropagationsOnEntityDelete" : true,
+ "validityPeriods" : [ {
+ "endTime" : "...",
+ "startTime" : "...",
+ "timeZone" : "..."
+ }, {
+ "endTime" : "...",
+ "startTime" : "...",
+ "timeZone" : "..."
+ } ],
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ }, {
+ "entityGuid" : "...",
+ "entityStatus" : "ACTIVE",
+ "propagate" : true,
+ "removePropagationsOnEntityDelete" : true,
+ "validityPeriods" : [ {
+ "endTime" : "...",
+ "startTime" : "...",
+ "timeZone" : "..."
+ }, {
+ "endTime" : "...",
+ "startTime" : "...",
+ "timeZone" : "..."
+ } ],
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ } ],
+ "longDescription" : "...",
+ "name" : "...",
+ "qualifiedName" : "...",
+ "shortDescription" : "...",
+ "guid" : "..."
+}
</code>
</pre>
</div>
@@ -600,10 +1938,15 @@ Content-Type: application/json;charset=UTF-8
</thead>
<tbody>
<tr>
+ <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Content-Type: application/json" HTTP header to specify this media type to the server."><span class="request-type">application/json</span></abbr></td>
+ <td><span class="datatype-reference">array of <a href="json_AtlasGlossaryTerm.html">AtlasGlossaryTerm</a>
+ (JSON)</span></td>
+ <td rowspan="2" class="multi-row-description"><span class="request-description">glossary term definitions</span></td>
+ </tr>
+ <tr>
<td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Content-Type: application/json;charset=UTF-8" HTTP header to specify this media type to the server."><span class="request-type">application/json;charset=UTF-8</span></abbr></td>
<td><span class="datatype-reference">(custom)
</span></td>
- <td><span class="request-description">glossary term definitions</span></td>
</tr>
</tbody>
</table>
@@ -639,10 +1982,15 @@ Content-Type: application/json;charset=UTF-8
</thead>
<tbody>
<tr>
+ <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json</span></abbr></td>
+ <td><span class="datatype-reference">array of <a href="json_AtlasGlossaryTerm.html">AtlasGlossaryTerm</a>
+ (JSON)</span></td>
+ <td rowspan="2" class="multi-row-description"><span class="response-description"></span></td>
+ </tr>
+ <tr>
<td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json;charset=UTF-8" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json;charset=UTF-8</span></abbr></td>
<td><span class="datatype-reference">(custom)
</span></td>
- <td><span class="response-description"></span></td>
</tr>
</tbody>
</table>
@@ -654,11 +2002,361 @@ Content-Type: application/json;charset=UTF-8
<h5>Request</h5>
<pre>
POST /v2/glossary/terms
-Content-Type: application/json;charset=UTF-8
-Accept: application/json;charset=UTF-8
-
- <code class="prettyprint language-txt">
-...
+Content-Type: application/json
+Accept: application/json
+
+ <code class="prettyprint language-js">
+[ {
+ "abbreviation" : "...",
+ "anchor" : {
+ "displayText" : "...",
+ "glossaryGuid" : "...",
+ "relationGuid" : "..."
+ },
+ "antonyms" : [ {
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "DRAFT",
+ "steward" : "...",
+ "termGuid" : "..."
+ }, {
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "OBSOLETE",
+ "steward" : "...",
+ "termGuid" : "..."
+ } ],
+ "assignedEntities" : [ {
+ "displayText" : "...",
+ "entityStatus" : "DELETED",
+ "relationshipAttributes" : {
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ },
+ "relationshipGuid" : "...",
+ "relationshipStatus" : "DELETED",
+ "guid" : "...",
+ "typeName" : "...",
+ "uniqueAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ }, {
+ "displayText" : "...",
+ "entityStatus" : "DELETED",
+ "relationshipAttributes" : {
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ },
+ "relationshipGuid" : "...",
+ "relationshipStatus" : "ACTIVE",
+ "guid" : "...",
+ "typeName" : "...",
+ "uniqueAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ } ],
+ "categories" : [ {
+ "categoryGuid" : "...",
+ "description" : "...",
+ "displayText" : "...",
+ "relationGuid" : "...",
+ "status" : "ACTIVE"
+ }, {
+ "categoryGuid" : "...",
+ "description" : "...",
+ "displayText" : "...",
+ "relationGuid" : "...",
+ "status" : "DRAFT"
+ } ],
+ "classifies" : [ {
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "DEPRECATED",
+ "steward" : "...",
+ "termGuid" : "..."
+ }, {
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "ACTIVE",
+ "steward" : "...",
+ "termGuid" : "..."
+ } ],
+ "examples" : [ "...", "..." ],
+ "isA" : [ {
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "DRAFT",
+ "steward" : "...",
+ "termGuid" : "..."
+ }, {
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "ACTIVE",
+ "steward" : "...",
+ "termGuid" : "..."
+ } ],
+ "preferredTerms" : [ {
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "OTHER",
+ "steward" : "...",
+ "termGuid" : "..."
+ }, {
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "DEPRECATED",
+ "steward" : "...",
+ "termGuid" : "..."
+ } ],
+ "preferredToTerms" : [ {
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "DRAFT",
+ "steward" : "...",
+ "termGuid" : "..."
+ }, {
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "OBSOLETE",
+ "steward" : "...",
+ "termGuid" : "..."
+ } ],
+ "replacedBy" : [ {
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "OBSOLETE",
+ "steward" : "...",
+ "termGuid" : "..."
+ }, {
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "OBSOLETE",
+ "steward" : "...",
+ "termGuid" : "..."
+ } ],
+ "replacementTerms" : [ {
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "DEPRECATED",
+ "steward" : "...",
+ "termGuid" : "..."
+ }, {
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "OTHER",
+ "steward" : "...",
+ "termGuid" : "..."
+ } ],
+ "seeAlso" : [ {
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "ACTIVE",
+ "steward" : "...",
+ "termGuid" : "..."
+ }, {
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "ACTIVE",
+ "steward" : "...",
+ "termGuid" : "..."
+ } ],
+ "synonyms" : [ {
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "OBSOLETE",
+ "steward" : "...",
+ "termGuid" : "..."
+ }, {
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "OTHER",
+ "steward" : "...",
+ "termGuid" : "..."
+ } ],
+ "translatedTerms" : [ {
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "DEPRECATED",
+ "steward" : "...",
+ "termGuid" : "..."
+ }, {
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "ACTIVE",
+ "steward" : "...",
+ "termGuid" : "..."
+ } ],
+ "translationTerms" : [ {
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "DRAFT",
+ "steward" : "...",
+ "termGuid" : "..."
+ }, {
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "OBSOLETE",
+ "steward" : "...",
+ "termGuid" : "..."
+ } ],
+ "usage" : "...",
+ "validValues" : [ {
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "OTHER",
+ "steward" : "...",
+ "termGuid" : "..."
+ }, {
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "DEPRECATED",
+ "steward" : "...",
+ "termGuid" : "..."
+ } ],
+ "validValuesFor" : [ {
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "ACTIVE",
+ "steward" : "...",
+ "termGuid" : "..."
+ }, {
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "OBSOLETE",
+ "steward" : "...",
+ "termGuid" : "..."
+ } ],
+ "classifications" : [ {
+ "entityGuid" : "...",
+ "entityStatus" : "ACTIVE",
+ "propagate" : true,
+ "removePropagationsOnEntityDelete" : true,
+ "validityPeriods" : [ {
+ "endTime" : "...",
+ "startTime" : "...",
+ "timeZone" : "..."
+ }, {
+ "endTime" : "...",
+ "startTime" : "...",
+ "timeZone" : "..."
+ } ],
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ }, {
+ "entityGuid" : "...",
+ "entityStatus" : "ACTIVE",
+ "propagate" : true,
+ "removePropagationsOnEntityDelete" : true,
+ "validityPeriods" : [ {
+ "endTime" : "...",
+ "startTime" : "...",
+ "timeZone" : "..."
+ }, {
+ "endTime" : "...",
+ "startTime" : "...",
+ "timeZone" : "..."
+ } ],
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ } ],
+ "longDescription" : "...",
+ "name" : "...",
+ "qualifiedName" : "...",
+ "shortDescription" : "...",
+ "guid" : "..."
+} ]
</code>
</pre>
</div>
@@ -666,10 +2364,360 @@ Accept: application/json;charset=UTF-8
<h5>Response</h5>
<pre>
HTTP/1.1 200 OK
-Content-Type: application/json;charset=UTF-8
-
- <code class="prettyprint language-txt">
-...
+Content-Type: application/json
+
+ <code class="prettyprint language-js">
+[ {
+ "abbreviation" : "...",
+ "anchor" : {
+ "displayText" : "...",
+ "glossaryGuid" : "...",
+ "relationGuid" : "..."
+ },
+ "antonyms" : [ {
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "OBSOLETE",
+ "steward" : "...",
+ "termGuid" : "..."
+ }, {
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "OBSOLETE",
+ "steward" : "...",
+ "termGuid" : "..."
+ } ],
+ "assignedEntities" : [ {
+ "displayText" : "...",
+ "entityStatus" : "DELETED",
+ "relationshipAttributes" : {
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ },
+ "relationshipGuid" : "...",
+ "relationshipStatus" : "ACTIVE",
+ "guid" : "...",
+ "typeName" : "...",
+ "uniqueAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ }, {
+ "displayText" : "...",
+ "entityStatus" : "DELETED",
+ "relationshipAttributes" : {
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "typeName" : "..."
+ },
+ "relationshipGuid" : "...",
+ "relationshipStatus" : "DELETED",
+ "guid" : "...",
+ "typeName" : "...",
+ "uniqueAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ } ],
+ "categories" : [ {
+ "categoryGuid" : "...",
+ "description" : "...",
+ "displayText" : "...",
+ "relationGuid" : "...",
+ "status" : "DRAFT"
+ }, {
+ "categoryGuid" : "...",
+ "description" : "...",
+ "displayText" : "...",
+ "relationGuid" : "...",
+ "status" : "OBSOLETE"
+ } ],
+ "classifies" : [ {
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "ACTIVE",
+ "steward" : "...",
+ "termGuid" : "..."
+ }, {
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "DEPRECATED",
+ "steward" : "...",
+ "termGuid" : "..."
+ } ],
+ "examples" : [ "...", "..." ],
+ "isA" : [ {
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "DRAFT",
+ "steward" : "...",
+ "termGuid" : "..."
+ }, {
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "ACTIVE",
+ "steward" : "...",
+ "termGuid" : "..."
+ } ],
+ "preferredTerms" : [ {
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "DRAFT",
+ "steward" : "...",
+ "termGuid" : "..."
+ }, {
+ "description" : "...",
+ "displayText" : "...",
+ "expression" : "...",
+ "relationGuid" : "...",
+ "source" : "...",
+ "status" : "DRAFT",
+ "steward" : "...",
+ "termGuid" : "..."
+ } ],
+ "preferredToTerms" : [ {
+
<TRUNCATED>