| <!DOCTYPE html> |
| <html lang="en"> |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge"> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <!-- The above 3 meta tags *must* come first in the head; any other head content must come *after* these tags --> |
| |
| <title>Atlas REST API: GlossaryREST</title> |
| |
| <!-- Mobile viewport optimized: j.mp/bplateviewport --> |
| <meta name="viewport" content="width=device-width, initial-scale=1.0"> |
| |
| <!-- Bootstrap core CSS --> |
| <link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/3.4.1/css/bootstrap.min.css"> |
| |
| <!--custom css for these pages--> |
| <link rel="stylesheet" href="css/enunciate.css"> |
| |
| <!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries --> |
| <!--[if lt IE 9]> |
| <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script> |
| <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script> |
| <![endif]--> |
| </head> |
| |
| <body data-spy="scroll" data-target="#apinav"> |
| |
| <nav class="navbar navbar-inverse navbar-fixed-top"> |
| <div class="container-fluid"> |
| <div class="navbar-header"> |
| <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar"> |
| <span class="sr-only">Toggle navigation</span> |
| <span class="icon-bar"></span> |
| <span class="icon-bar"></span> |
| <span class="icon-bar"></span> |
| </button> |
| <a class="navbar-brand" href="index.html">Atlas REST API: GlossaryREST</a> |
| </div> |
| <div id="navbar" class="navbar-collapse collapse"> |
| <ul class="nav navbar-nav navbar-right"> |
| <li><a href="resources.html">Resources</a></li> |
| <li><a href="data.html">Data Types</a></li> |
| </ul> |
| </div> |
| </div> |
| </nav> |
| |
| <div class="container-fluid"> |
| <div class="row"> |
| <div class="col-sm-3 col-md-2 sidebar" id="apinav"> |
| <ul class="nav nav-sidebar"> |
| <li><a href="#resource_GlossaryREST_getGlossaries_GET"><abbr title="GET /v2/glossary" class="side-abbr"><span class="sideoverflow">GET /v2/glossary</span></abbr></a></li> |
| <li><a href="#resource_GlossaryREST_createGlossary_POST"><abbr title="POST /v2/glossary" class="side-abbr"><span class="sideoverflow">POST /v2/glossary</span></abbr></a></li> |
| <li><a href="#resource_GlossaryREST_createGlossaryCategories_POST"><abbr title="POST /v2/glossary/categories" class="side-abbr"><span class="sideoverflow">POST /v2/glossary/categories</span></abbr></a></li> |
| <li><a href="#resource_GlossaryREST_createGlossaryCategory_POST"><abbr title="POST /v2/glossary/category" class="side-abbr"><span class="sideoverflow">POST /v2/glossary/category</span></abbr></a></li> |
| <li><a href="#resource_GlossaryREST_importGlossaryData_POST"><abbr title="POST /v2/glossary/import" class="side-abbr"><span class="sideoverflow">POST /v2/glossary/import</span></abbr></a></li> |
| <li><a href="#resource_GlossaryREST_createGlossaryTerm_POST"><abbr title="POST /v2/glossary/term" class="side-abbr"><span class="sideoverflow">POST /v2/glossary/term</span></abbr></a></li> |
| <li><a href="#resource_GlossaryREST_createGlossaryTerms_POST"><abbr title="POST /v2/glossary/terms" class="side-abbr"><span class="sideoverflow">POST /v2/glossary/terms</span></abbr></a></li> |
| <li><a href="#resource_GlossaryREST_deleteGlossary_DELETE"><abbr title="DELETE /v2/glossary/{glossaryGuid}" class="side-abbr"><span class="sideoverflow">DELETE /v2/glossary/{glossaryGuid}</span></abbr></a></li> |
| <li><a href="#resource_GlossaryREST_getGlossary_GET"><abbr title="GET /v2/glossary/{glossaryGuid}" class="side-abbr"><span class="sideoverflow">GET /v2/glossary/{glossaryGuid}</span></abbr></a></li> |
| <li><a href="#resource_GlossaryREST_updateGlossary_PUT"><abbr title="PUT /v2/glossary/{glossaryGuid}" class="side-abbr"><span class="sideoverflow">PUT /v2/glossary/{glossaryGuid}</span></abbr></a></li> |
| <li><a href="#resource_GlossaryREST_deleteGlossaryCategory_DELETE"><abbr title="DELETE /v2/glossary/category/{categoryGuid}" class="side-abbr"><span class="sideoverflow">DELETE /v2/glossary/category/{categoryGuid}</span></abbr></a></li> |
| <li><a href="#resource_GlossaryREST_getGlossaryCategory_GET"><abbr title="GET /v2/glossary/category/{categoryGuid}" class="side-abbr"><span class="sideoverflow">GET /v2/glossary/category/{categoryGuid}</span></abbr></a></li> |
| <li><a href="#resource_GlossaryREST_updateGlossaryCategory_PUT"><abbr title="PUT /v2/glossary/category/{categoryGuid}" class="side-abbr"><span class="sideoverflow">PUT /v2/glossary/category/{categoryGuid}</span></abbr></a></li> |
| <li><a href="#resource_GlossaryREST_produceTemplate_GET"><abbr title="GET /v2/glossary/import/template" class="side-abbr"><span class="sideoverflow">GET /v2/glossary/import/template</span></abbr></a></li> |
| <li><a href="#resource_GlossaryREST_deleteGlossaryTerm_DELETE"><abbr title="DELETE /v2/glossary/term/{termGuid}" class="side-abbr"><span class="sideoverflow">DELETE /v2/glossary/term/{termGuid}</span></abbr></a></li> |
| <li><a href="#resource_GlossaryREST_getGlossaryTerm_GET"><abbr title="GET /v2/glossary/term/{termGuid}" class="side-abbr"><span class="sideoverflow">GET /v2/glossary/term/{termGuid}</span></abbr></a></li> |
| <li><a href="#resource_GlossaryREST_updateGlossaryTerm_PUT"><abbr title="PUT /v2/glossary/term/{termGuid}" class="side-abbr"><span class="sideoverflow">PUT /v2/glossary/term/{termGuid}</span></abbr></a></li> |
| <li><a href="#resource_GlossaryREST_getGlossaryCategories_GET"><abbr title="GET /v2/glossary/{glossaryGuid}/categories" class="side-abbr"><span class="sideoverflow">GET /v2/glossary/{glossaryGuid}/categories</span></abbr></a></li> |
| <li><a href="#resource_GlossaryREST_getDetailedGlossary_GET"><abbr title="GET /v2/glossary/{glossaryGuid}/detailed" class="side-abbr"><span class="sideoverflow">GET /v2/glossary/{glossaryGuid}/detailed</span></abbr></a></li> |
| <li><a href="#resource_GlossaryREST_partialUpdateGlossary_PUT"><abbr title="PUT /v2/glossary/{glossaryGuid}/partial" class="side-abbr"><span class="sideoverflow">PUT /v2/glossary/{glossaryGuid}/partial</span></abbr></a></li> |
| <li><a href="#resource_GlossaryREST_getGlossaryTerms_GET"><abbr title="GET /v2/glossary/{glossaryGuid}/terms" class="side-abbr"><span class="sideoverflow">GET /v2/glossary/{glossaryGuid}/terms</span></abbr></a></li> |
| <li><a href="#resource_GlossaryREST_partialUpdateGlossaryCategory_PUT"><abbr title="PUT /v2/glossary/category/{categoryGuid}/partial" class="side-abbr"><span class="sideoverflow">PUT /v2/glossary/category/{categoryGuid}/partial</span></abbr></a></li> |
| <li><a href="#resource_GlossaryREST_getRelatedCategories_GET"><abbr title="GET /v2/glossary/category/{categoryGuid}/related" class="side-abbr"><span class="sideoverflow">GET /v2/glossary/category/{categoryGuid}/related</span></abbr></a></li> |
| <li><a href="#resource_GlossaryREST_getCategoryTerms_GET"><abbr title="GET /v2/glossary/category/{categoryGuid}/terms" class="side-abbr"><span class="sideoverflow">GET /v2/glossary/category/{categoryGuid}/terms</span></abbr></a></li> |
| <li><a href="#resource_GlossaryREST_partialUpdateGlossaryTerm_PUT"><abbr title="PUT /v2/glossary/term/{termGuid}/partial" class="side-abbr"><span class="sideoverflow">PUT /v2/glossary/term/{termGuid}/partial</span></abbr></a></li> |
| <li><a href="#resource_GlossaryREST_removeTermAssignmentFromEntities_DELETE"><abbr title="DELETE /v2/glossary/terms/{termGuid}/assignedEntities" class="side-abbr"><span class="sideoverflow">DELETE /v2/glossary/terms/{termGuid}/assignedEntities</span></abbr></a></li> |
| <li><a href="#resource_GlossaryREST_getEntitiesAssignedWithTerm_GET"><abbr title="GET /v2/glossary/terms/{termGuid}/assignedEntities" class="side-abbr"><span class="sideoverflow">GET /v2/glossary/terms/{termGuid}/assignedEntities</span></abbr></a></li> |
| <li><a href="#resource_GlossaryREST_assignTermToEntities_POST"><abbr title="POST /v2/glossary/terms/{termGuid}/assignedEntities" class="side-abbr"><span class="sideoverflow">POST /v2/glossary/terms/{termGuid}/assignedEntities</span></abbr></a></li> |
| <li><a href="#resource_GlossaryREST_disassociateTermAssignmentFromEntities_PUT"><abbr title="PUT /v2/glossary/terms/{termGuid}/assignedEntities" class="side-abbr"><span class="sideoverflow">PUT /v2/glossary/terms/{termGuid}/assignedEntities</span></abbr></a></li> |
| <li><a href="#resource_GlossaryREST_getRelatedTerms_GET"><abbr title="GET /v2/glossary/terms/{termGuid}/related" class="side-abbr"><span class="sideoverflow">GET /v2/glossary/terms/{termGuid}/related</span></abbr></a></li> |
| <li><a href="#resource_GlossaryREST_getGlossaryCategoriesHeaders_GET"><abbr title="GET /v2/glossary/{glossaryGuid}/categories/headers" class="side-abbr"><span class="sideoverflow">GET /v2/glossary/{glossaryGuid}/categories/headers</span></abbr></a></li> |
| <li><a href="#resource_GlossaryREST_getGlossaryTermHeaders_GET"><abbr title="GET /v2/glossary/{glossaryGuid}/terms/headers" class="side-abbr"><span class="sideoverflow">GET /v2/glossary/{glossaryGuid}/terms/headers</span></abbr></a></li> |
| <li class="divider"></li> |
| <li class="text-right"><a href="#top"><small>Back to Top</small></a></li> |
| </ul> |
| </div> |
| |
| <div class="col-sm-9 col-sm-offset-3 col-md-10 col-md-offset-2 main"> |
| <ol class="breadcrumb" id="top"> |
| <li class="active dropdown"><a href="index.html">Home</a></li> |
| <li class="active dropdown"><a href="resources.html">Resources</a></li> |
| <li class="dropdown"><a href="resource_GlossaryREST.html">GlossaryREST</a></li> |
| </ol> |
| |
| <h1 class="page-header">GlossaryREST <small>Resource</small></h1> |
| |
| <p></p> |
| |
| <div id="resource_GlossaryREST_getGlossaries_GET"> |
| <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/v2/glossary <a href="../v2/glossary" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> |
| |
| <p>Retrieve all glossaries registered with Atlas</p> |
| |
| <table class="table resource-parameters"> |
| <caption>Request Parameters</caption> |
| <thead> |
| <tr> |
| <th>name</th> |
| <th>type</th> |
| <th>description</th> |
| <th>default</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="parameter-name">limit</span></td> |
| <td>query</td> |
| <td><span class="parameter-description">page size - by default there is no paging</span></td> |
| <td><span class="parameter-default-value">-1</span></td> |
| </tr> |
| <tr> |
| <td><span class="parameter-name">offset</span></td> |
| <td>query</td> |
| <td><span class="parameter-description">offset for pagination purpose</span></td> |
| <td><span class="parameter-default-value">0</span></td> |
| </tr> |
| <tr> |
| <td><span class="parameter-name">sort</span></td> |
| <td>query</td> |
| <td><span class="parameter-description">Sort order, ASC (default) or DESC</span></td> |
| <td><span class="parameter-default-value">ASC</span></td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table resource-response-codes"> |
| <caption>Response Codes</caption> |
| <thead> |
| <tr> |
| <th>code</th> |
| <th>condition</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="label label-success response-code">200</span></td> |
| <td><span class="response-condition">List of existing glossaries fitting the search criteria or empty list if nothing matches</span></td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table resource-response-body"> |
| <caption>Response Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| <th>description</th> |
| </tr> |
| </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" 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> |
| </tr> |
| </tbody> |
| </table> |
| <h4>Example</h4> |
| |
| <div class="container-fluid example panel"> |
| <div class="row panel-body"> |
| <div class="col-md-6"> |
| <h5>Request</h5> |
| <pre> |
| GET /v2/glossary |
| Content-Type: application/json |
| Accept: application/json |
| |
| <code class="prettyprint language-txt"> |
| ... |
| </code> |
| </pre> |
| </div> |
| <div class="col-md-6"> |
| <h5>Response</h5> |
| <pre> |
| HTTP/1.1 200 OK |
| 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" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "usage" : "...", |
| "additionalAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "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> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_GlossaryREST_createGlossary_POST"> |
| <h3><span class="label label-default resource-method">POST</span> <span class="resource-path">/v2/glossary <a href="../v2/glossary" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> |
| |
| <p>Create a glossary</p> |
| |
| <table class="table resource-request-body"> |
| <caption>Request Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| <th>description</th> |
| </tr> |
| </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" 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> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table resource-response-codes"> |
| <caption>Response Codes</caption> |
| <thead> |
| <tr> |
| <th>code</th> |
| <th>condition</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="label label-success response-code">200</span></td> |
| <td><span class="response-condition">If glossary creation was successful</span></td> |
| </tr> |
| <tr> |
| <td><span class="label label-warning response-code">400</span></td> |
| <td><span class="response-condition">If Glossary definition has invalid or missing information</span></td> |
| </tr> |
| <tr> |
| <td><span class="label label-warning response-code">409</span></td> |
| <td><span class="response-condition">If Glossary definition already exists (duplicate qualifiedName)</span></td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table resource-response-body"> |
| <caption>Response Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| <th>description</th> |
| </tr> |
| </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" 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> |
| </tr> |
| </tbody> |
| </table> |
| <h4>Example</h4> |
| |
| <div class="container-fluid example panel"> |
| <div class="row panel-body"> |
| <div class="col-md-6"> |
| <h5>Request</h5> |
| <pre> |
| POST /v2/glossary |
| 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" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "usage" : "...", |
| "additionalAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "longDescription" : "...", |
| "name" : "...", |
| "qualifiedName" : "...", |
| "shortDescription" : "...", |
| "guid" : "..." |
| } |
| </code> |
| </pre> |
| </div> |
| <div class="col-md-6"> |
| <h5>Response</h5> |
| <pre> |
| HTTP/1.1 200 OK |
| 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" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "usage" : "...", |
| "additionalAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "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> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_GlossaryREST_createGlossaryCategories_POST"> |
| <h3><span class="label label-default resource-method">POST</span> <span class="resource-path">/v2/glossary/categories <a href="../v2/glossary/categories" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> |
| |
| <p>Create glossary category in bulk</p> |
| |
| <table class="table resource-request-body"> |
| <caption>Request Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| <th>description</th> |
| </tr> |
| </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" 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> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table resource-response-codes"> |
| <caption>Response Codes</caption> |
| <thead> |
| <tr> |
| <th>code</th> |
| <th>condition</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="label label-success response-code">200</span></td> |
| <td><span class="response-condition">If BULK glossary category creation was successful</span></td> |
| </tr> |
| <tr> |
| <td><span class="label label-warning response-code">400</span></td> |
| <td><span class="response-condition">If ANY Glossary category definition has invalid or missing information</span></td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table resource-response-body"> |
| <caption>Response Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| <th>description</th> |
| </tr> |
| </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" 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> |
| </tr> |
| </tbody> |
| </table> |
| <h4>Example</h4> |
| |
| <div class="container-fluid example panel"> |
| <div class="row panel-body"> |
| <div class="col-md-6"> |
| <h5>Request</h5> |
| <pre> |
| POST /v2/glossary/categories |
| 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" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "additionalAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "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> |
| <div class="col-md-6"> |
| <h5>Response</h5> |
| <pre> |
| HTTP/1.1 200 OK |
| 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" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "additionalAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "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> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_GlossaryREST_createGlossaryCategory_POST"> |
| <h3><span class="label label-default resource-method">POST</span> <span class="resource-path">/v2/glossary/category <a href="../v2/glossary/category" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> |
| |
| <p>Create glossary category</p> |
| |
| <table class="table resource-request-body"> |
| <caption>Request Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| <th>description</th> |
| </tr> |
| </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" 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> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table resource-response-codes"> |
| <caption>Response Codes</caption> |
| <thead> |
| <tr> |
| <th>code</th> |
| <th>condition</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="label label-success response-code">200</span></td> |
| <td><span class="response-condition">If glossary category creation was successful</span></td> |
| </tr> |
| <tr> |
| <td><span class="label label-warning response-code">400</span></td> |
| <td><span class="response-condition">If Glossary category definition has invalid or missing information</span></td> |
| </tr> |
| <tr> |
| <td><span class="label label-warning response-code">409</span></td> |
| <td><span class="response-condition">If Glossary category already exists (duplicate qualifiedName)</span></td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table resource-response-body"> |
| <caption>Response Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| <th>description</th> |
| </tr> |
| </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" 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> |
| </tr> |
| </tbody> |
| </table> |
| <h4>Example</h4> |
| |
| <div class="container-fluid example panel"> |
| <div class="row panel-body"> |
| <div class="col-md-6"> |
| <h5>Request</h5> |
| <pre> |
| POST /v2/glossary/category |
| 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" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "additionalAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "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> |
| <div class="col-md-6"> |
| <h5>Response</h5> |
| <pre> |
| HTTP/1.1 200 OK |
| 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" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "additionalAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "longDescription" : "...", |
| "name" : "...", |
| "qualifiedName" : "...", |
| "shortDescription" : "...", |
| "guid" : "..." |
| } |
| </code> |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_GlossaryREST_importGlossaryData_POST"> |
| <h3><span class="label label-default resource-method">POST</span> <span class="resource-path">/v2/glossary/import <a href="../v2/glossary/import" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> |
| |
| <p>Upload glossary file for creating AtlasGlossaryTerms in bulk</p> |
| |
| <table class="table resource-parameters"> |
| <caption>Request Parameters</caption> |
| <thead> |
| <tr> |
| <th>name</th> |
| <th>type</th> |
| <th>description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="parameter-name">fileDetail</span></td> |
| <td>formdata</td> |
| <td><span class="parameter-description">FormDataContentDisposition metadata of file</span></td> |
| </tr> |
| <tr> |
| <td><span class="parameter-name">inputStream</span></td> |
| <td>formdata</td> |
| <td><span class="parameter-description">InputStream of file</span></td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table resource-request-body"> |
| <caption>Request Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Content-Type: multipart/form-data" HTTP header to specify this media type to the server."><span class="request-type">multipart/form-data</span></abbr></td> |
| <td><span class="datatype-reference">(custom) |
| </span></td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table resource-response-codes"> |
| <caption>Response Codes</caption> |
| <thead> |
| <tr> |
| <th>code</th> |
| <th>condition</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="label label-success response-code">200</span></td> |
| <td><span class="response-condition">If glossary term creation was successful</span></td> |
| </tr> |
| <tr> |
| <td><span class="label label-warning response-code">400</span></td> |
| <td><span class="response-condition">If Glossary term definition has invalid or missing information</span></td> |
| </tr> |
| <tr> |
| <td><span class="label label-warning response-code">409</span></td> |
| <td><span class="response-condition">If Glossary term already exists (duplicate qualifiedName)</span></td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table resource-response-body"> |
| <caption>Response Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| <th>description</th> |
| </tr> |
| </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_BulkImportResponse.html">BulkImportResponse</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" 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_BulkImportResponse.html">BulkImportResponse</a> |
| (JSON)</span></td> |
| </tr> |
| </tbody> |
| </table> |
| <h4>Example</h4> |
| |
| <div class="container-fluid example panel"> |
| <div class="row panel-body"> |
| <div class="col-md-6"> |
| <h5>Request</h5> |
| <pre> |
| POST /v2/glossary/import |
| Content-Type: multipart/form-data |
| Accept: application/json |
| |
| <code class="prettyprint language-txt"> |
| ... |
| </code> |
| </pre> |
| </div> |
| <div class="col-md-6"> |
| <h5>Response</h5> |
| <pre> |
| HTTP/1.1 200 OK |
| Content-Type: application/json |
| |
| <code class="prettyprint language-js"> |
| { |
| "failedImportInfoList" : [ { |
| "childObjectName" : "...", |
| "importStatus" : "SUCCESS", |
| "parentObjectName" : "...", |
| "remarks" : "..." |
| }, { |
| "childObjectName" : "...", |
| "importStatus" : "SUCCESS", |
| "parentObjectName" : "...", |
| "remarks" : "..." |
| } ], |
| "successImportInfoList" : [ { |
| "childObjectName" : "...", |
| "importStatus" : "FAILED", |
| "parentObjectName" : "...", |
| "remarks" : "..." |
| }, { |
| "childObjectName" : "...", |
| "importStatus" : "FAILED", |
| "parentObjectName" : "...", |
| "remarks" : "..." |
| } ] |
| } |
| </code> |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_GlossaryREST_createGlossaryTerm_POST"> |
| <h3><span class="label label-default resource-method">POST</span> <span class="resource-path">/v2/glossary/term <a href="../v2/glossary/term" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> |
| |
| <p>Create a glossary term</p> |
| |
| <table class="table resource-request-body"> |
| <caption>Request Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| <th>description</th> |
| </tr> |
| </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" 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> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table resource-response-codes"> |
| <caption>Response Codes</caption> |
| <thead> |
| <tr> |
| <th>code</th> |
| <th>condition</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="label label-success response-code">200</span></td> |
| <td><span class="response-condition">If glossary term creation was successful</span></td> |
| </tr> |
| <tr> |
| <td><span class="label label-warning response-code">400</span></td> |
| <td><span class="response-condition">If Glossary term definition has invalid or missing information</span></td> |
| </tr> |
| <tr> |
| <td><span class="label label-warning response-code">409</span></td> |
| <td><span class="response-condition">If Glossary term already exists (duplicate qualifiedName)</span></td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table resource-response-body"> |
| <caption>Response Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| <th>description</th> |
| </tr> |
| </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" 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> |
| </tr> |
| </tbody> |
| </table> |
| <h4>Example</h4> |
| |
| <div class="container-fluid example panel"> |
| <div class="row panel-body"> |
| <div class="col-md-6"> |
| <h5>Request</h5> |
| <pre> |
| POST /v2/glossary/term |
| Content-Type: application/json |
| Accept: application/json |
| |
| <code class="prettyprint language-js"> |
| { |
| "abbreviation" : "...", |
| "anchor" : { |
| "displayText" : "...", |
| "glossaryGuid" : "...", |
| "relationGuid" : "..." |
| }, |
| "antonyms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "assignedEntities" : [ { |
| "displayText" : "...", |
| "entityStatus" : "DELETED", |
| "qualifiedName" : "...", |
| "relationshipAttributes" : { |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "relationshipGuid" : "...", |
| "relationshipStatus" : "DELETED", |
| "relationshipType" : "...", |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, { |
| "displayText" : "...", |
| "entityStatus" : "ACTIVE", |
| "qualifiedName" : "...", |
| "relationshipAttributes" : { |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "relationshipGuid" : "...", |
| "relationshipStatus" : "ACTIVE", |
| "relationshipType" : "...", |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| } ], |
| "categories" : [ { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "relationGuid" : "...", |
| "status" : "OBSOLETE" |
| }, { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "relationGuid" : "...", |
| "status" : "DRAFT" |
| } ], |
| "classifies" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "examples" : [ "...", "..." ], |
| "glossaryTermHeader" : { |
| "qualifiedName" : "...", |
| "termGuid" : "..." |
| }, |
| "isA" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "preferredTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "preferredToTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "replacedBy" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "replacementTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "seeAlso" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "synonyms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "translatedTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "translationTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "usage" : "...", |
| "validValues" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "validValuesFor" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "additionalAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "longDescription" : "...", |
| "name" : "...", |
| "qualifiedName" : "...", |
| "shortDescription" : "...", |
| "guid" : "..." |
| } |
| </code> |
| </pre> |
| </div> |
| <div class="col-md-6"> |
| <h5>Response</h5> |
| <pre> |
| HTTP/1.1 200 OK |
| Content-Type: application/json |
| |
| <code class="prettyprint language-js"> |
| { |
| "abbreviation" : "...", |
| "anchor" : { |
| "displayText" : "...", |
| "glossaryGuid" : "...", |
| "relationGuid" : "..." |
| }, |
| "antonyms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "assignedEntities" : [ { |
| "displayText" : "...", |
| "entityStatus" : "PURGED", |
| "qualifiedName" : "...", |
| "relationshipAttributes" : { |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "relationshipGuid" : "...", |
| "relationshipStatus" : "DELETED", |
| "relationshipType" : "...", |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, { |
| "displayText" : "...", |
| "entityStatus" : "DELETED", |
| "qualifiedName" : "...", |
| "relationshipAttributes" : { |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "relationshipGuid" : "...", |
| "relationshipStatus" : "ACTIVE", |
| "relationshipType" : "...", |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| } ], |
| "categories" : [ { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "relationGuid" : "...", |
| "status" : "ACTIVE" |
| }, { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "relationGuid" : "...", |
| "status" : "DRAFT" |
| } ], |
| "classifies" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "examples" : [ "...", "..." ], |
| "glossaryTermHeader" : { |
| "qualifiedName" : "...", |
| "termGuid" : "..." |
| }, |
| "isA" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "preferredTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "preferredToTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "replacedBy" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "replacementTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "seeAlso" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "synonyms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "translatedTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "translationTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "usage" : "...", |
| "validValues" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "validValuesFor" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "additionalAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "longDescription" : "...", |
| "name" : "...", |
| "qualifiedName" : "...", |
| "shortDescription" : "...", |
| "guid" : "..." |
| } |
| </code> |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_GlossaryREST_createGlossaryTerms_POST"> |
| <h3><span class="label label-default resource-method">POST</span> <span class="resource-path">/v2/glossary/terms <a href="../v2/glossary/terms" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> |
| |
| <p>Create glossary terms in bulk</p> |
| |
| <table class="table resource-request-body"> |
| <caption>Request Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| <th>description</th> |
| </tr> |
| </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" 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> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table resource-response-codes"> |
| <caption>Response Codes</caption> |
| <thead> |
| <tr> |
| <th>code</th> |
| <th>condition</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="label label-success response-code">200</span></td> |
| <td><span class="response-condition">If Bulk glossary terms creation was successful</span></td> |
| </tr> |
| <tr> |
| <td><span class="label label-warning response-code">400</span></td> |
| <td><span class="response-condition">If any glossary term definition has invalid or missing information</span></td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table resource-response-body"> |
| <caption>Response Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| <th>description</th> |
| </tr> |
| </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" 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> |
| </tr> |
| </tbody> |
| </table> |
| <h4>Example</h4> |
| |
| <div class="container-fluid example panel"> |
| <div class="row panel-body"> |
| <div class="col-md-6"> |
| <h5>Request</h5> |
| <pre> |
| POST /v2/glossary/terms |
| Content-Type: application/json |
| Accept: application/json |
| |
| <code class="prettyprint language-js"> |
| [ { |
| "abbreviation" : "...", |
| "anchor" : { |
| "displayText" : "...", |
| "glossaryGuid" : "...", |
| "relationGuid" : "..." |
| }, |
| "antonyms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "assignedEntities" : [ { |
| "displayText" : "...", |
| "entityStatus" : "DELETED", |
| "qualifiedName" : "...", |
| "relationshipAttributes" : { |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "relationshipGuid" : "...", |
| "relationshipStatus" : "ACTIVE", |
| "relationshipType" : "...", |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, { |
| "displayText" : "...", |
| "entityStatus" : "DELETED", |
| "qualifiedName" : "...", |
| "relationshipAttributes" : { |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "relationshipGuid" : "...", |
| "relationshipStatus" : "DELETED", |
| "relationshipType" : "...", |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| } ], |
| "categories" : [ { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "relationGuid" : "...", |
| "status" : "OTHER" |
| }, { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "relationGuid" : "...", |
| "status" : "DRAFT" |
| } ], |
| "classifies" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "examples" : [ "...", "..." ], |
| "glossaryTermHeader" : { |
| "qualifiedName" : "...", |
| "termGuid" : "..." |
| }, |
| "isA" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "preferredTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "preferredToTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "replacedBy" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "replacementTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "seeAlso" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "synonyms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "translatedTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "translationTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "usage" : "...", |
| "validValues" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "validValuesFor" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "additionalAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "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> |
| <div class="col-md-6"> |
| <h5>Response</h5> |
| <pre> |
| HTTP/1.1 200 OK |
| Content-Type: application/json |
| |
| <code class="prettyprint language-js"> |
| [ { |
| "abbreviation" : "...", |
| "anchor" : { |
| "displayText" : "...", |
| "glossaryGuid" : "...", |
| "relationGuid" : "..." |
| }, |
| "antonyms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "assignedEntities" : [ { |
| "displayText" : "...", |
| "entityStatus" : "PURGED", |
| "qualifiedName" : "...", |
| "relationshipAttributes" : { |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "relationshipGuid" : "...", |
| "relationshipStatus" : "DELETED", |
| "relationshipType" : "...", |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, { |
| "displayText" : "...", |
| "entityStatus" : "DELETED", |
| "qualifiedName" : "...", |
| "relationshipAttributes" : { |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "relationshipGuid" : "...", |
| "relationshipStatus" : "ACTIVE", |
| "relationshipType" : "...", |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| } ], |
| "categories" : [ { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "relationGuid" : "...", |
| "status" : "ACTIVE" |
| }, { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "relationGuid" : "...", |
| "status" : "DRAFT" |
| } ], |
| "classifies" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "examples" : [ "...", "..." ], |
| "glossaryTermHeader" : { |
| "qualifiedName" : "...", |
| "termGuid" : "..." |
| }, |
| "isA" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "preferredTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "preferredToTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "replacedBy" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "replacementTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "seeAlso" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "synonyms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "translatedTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "translationTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "usage" : "...", |
| "validValues" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "validValuesFor" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "additionalAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "longDescription" : "...", |
| "name" : "...", |
| "qualifiedName" : "...", |
| "shortDescription" : "...", |
| "guid" : "..." |
| } ] |
| </code> |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_GlossaryREST_deleteGlossary_DELETE"> |
| <h3><span class="label label-default resource-method">DELETE</span> <span class="resource-path">/v2/glossary/{glossaryGuid} <a href="../v2/glossary/{glossaryGuid}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> |
| |
| <p>Delete a glossary</p> |
| |
| <table class="table resource-parameters"> |
| <caption>Request Parameters</caption> |
| <thead> |
| <tr> |
| <th>name</th> |
| <th>type</th> |
| <th>description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="parameter-name">glossaryGuid</span></td> |
| <td>path</td> |
| <td><span class="parameter-description">unique identifier for glossary</span></td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table resource-response-codes"> |
| <caption>Response Codes</caption> |
| <thead> |
| <tr> |
| <th>code</th> |
| <th>condition</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="label label-success response-code">204</span></td> |
| <td><span class="response-condition">If glossary delete was successful</span></td> |
| </tr> |
| <tr> |
| <td><span class="label label-warning response-code">404</span></td> |
| <td><span class="response-condition">If glossary guid in invalid</span></td> |
| </tr> |
| </tbody> |
| </table> |
| <h4>Example</h4> |
| |
| <div class="container-fluid example panel"> |
| <div class="row panel-body"> |
| <div class="col-md-6"> |
| <h5>Request</h5> |
| <pre> |
| DELETE /v2/glossary/{glossaryGuid} |
| Content-Type: application/json |
| |
| <code class="prettyprint language-txt"> |
| ... |
| </code> |
| </pre> |
| </div> |
| <div class="col-md-6"> |
| <h5>Response</h5> |
| <pre> |
| HTTP/1.1 204 No Content |
| |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_GlossaryREST_getGlossary_GET"> |
| <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/v2/glossary/{glossaryGuid} <a href="../v2/glossary/{glossaryGuid}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> |
| |
| <p>Get a specific Glossary</p> |
| |
| <table class="table resource-parameters"> |
| <caption>Request Parameters</caption> |
| <thead> |
| <tr> |
| <th>name</th> |
| <th>type</th> |
| <th>description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="parameter-name">glossaryGuid</span></td> |
| <td>path</td> |
| <td><span class="parameter-description">unique glossary identifier</span></td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table resource-response-codes"> |
| <caption>Response Codes</caption> |
| <thead> |
| <tr> |
| <th>code</th> |
| <th>condition</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="label label-success response-code">200</span></td> |
| <td><span class="response-condition">If glossary with given guid exists</span></td> |
| </tr> |
| <tr> |
| <td><span class="label label-warning response-code">404</span></td> |
| <td><span class="response-condition">If glossary GUID is invalid</span></td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table resource-response-body"> |
| <caption>Response Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| <th>description</th> |
| </tr> |
| </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">Glossary</span></td> |
| </tr> |
| <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> |
| </tr> |
| </tbody> |
| </table> |
| <h4>Example</h4> |
| |
| <div class="container-fluid example panel"> |
| <div class="row panel-body"> |
| <div class="col-md-6"> |
| <h5>Request</h5> |
| <pre> |
| GET /v2/glossary/{glossaryGuid} |
| Content-Type: application/json |
| Accept: application/json |
| |
| <code class="prettyprint language-txt"> |
| ... |
| </code> |
| </pre> |
| </div> |
| <div class="col-md-6"> |
| <h5>Response</h5> |
| <pre> |
| HTTP/1.1 200 OK |
| 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" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "usage" : "...", |
| "additionalAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "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> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_GlossaryREST_updateGlossary_PUT"> |
| <h3><span class="label label-default resource-method">PUT</span> <span class="resource-path">/v2/glossary/{glossaryGuid} <a href="../v2/glossary/{glossaryGuid}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> |
| |
| <p>Update the given glossary</p> |
| |
| <table class="table resource-parameters"> |
| <caption>Request Parameters</caption> |
| <thead> |
| <tr> |
| <th>name</th> |
| <th>type</th> |
| <th>description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="parameter-name">glossaryGuid</span></td> |
| <td>path</td> |
| <td><span class="parameter-description">unique identifier for glossary</span></td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table resource-request-body"> |
| <caption>Request Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| <th>description</th> |
| </tr> |
| </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">Updated glossary definition</span></td> |
| </tr> |
| <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> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table resource-response-codes"> |
| <caption>Response Codes</caption> |
| <thead> |
| <tr> |
| <th>code</th> |
| <th>condition</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="label label-success response-code">200</span></td> |
| <td><span class="response-condition">If glossary update was successful</span></td> |
| </tr> |
| <tr> |
| <td><span class="label label-warning response-code">404</span></td> |
| <td><span class="response-condition">If glossary guid in invalid</span></td> |
| </tr> |
| <tr> |
| <td><span class="label label-warning response-code">400</span></td> |
| <td><span class="response-condition">If Glossary definition has invalid or missing information</span></td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table resource-response-body"> |
| <caption>Response Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| <th>description</th> |
| </tr> |
| </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">Glossary</span></td> |
| </tr> |
| <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> |
| </tr> |
| </tbody> |
| </table> |
| <h4>Example</h4> |
| |
| <div class="container-fluid example panel"> |
| <div class="row panel-body"> |
| <div class="col-md-6"> |
| <h5>Request</h5> |
| <pre> |
| PUT /v2/glossary/{glossaryGuid} |
| 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" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "usage" : "...", |
| "additionalAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "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> |
| <div class="col-md-6"> |
| <h5>Response</h5> |
| <pre> |
| HTTP/1.1 200 OK |
| 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" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "usage" : "...", |
| "additionalAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "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> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_GlossaryREST_deleteGlossaryCategory_DELETE"> |
| <h3><span class="label label-default resource-method">DELETE</span> <span class="resource-path">/v2/glossary/category/{categoryGuid} <a href="../v2/glossary/category/{categoryGuid}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> |
| |
| <p>Delete a glossary category</p> |
| |
| <table class="table resource-parameters"> |
| <caption>Request Parameters</caption> |
| <thead> |
| <tr> |
| <th>name</th> |
| <th>type</th> |
| <th>description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="parameter-name">categoryGuid</span></td> |
| <td>path</td> |
| <td><span class="parameter-description">unique identifier for glossary category</span></td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table resource-response-codes"> |
| <caption>Response Codes</caption> |
| <thead> |
| <tr> |
| <th>code</th> |
| <th>condition</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="label label-success response-code">204</span></td> |
| <td><span class="response-condition">If glossary category delete was successful</span></td> |
| </tr> |
| <tr> |
| <td><span class="label label-warning response-code">404</span></td> |
| <td><span class="response-condition">If glossary category guid in invalid</span></td> |
| </tr> |
| </tbody> |
| </table> |
| <h4>Example</h4> |
| |
| <div class="container-fluid example panel"> |
| <div class="row panel-body"> |
| <div class="col-md-6"> |
| <h5>Request</h5> |
| <pre> |
| DELETE /v2/glossary/category/{categoryGuid} |
| Content-Type: application/json |
| |
| <code class="prettyprint language-txt"> |
| ... |
| </code> |
| </pre> |
| </div> |
| <div class="col-md-6"> |
| <h5>Response</h5> |
| <pre> |
| HTTP/1.1 204 No Content |
| |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_GlossaryREST_getGlossaryCategory_GET"> |
| <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/v2/glossary/category/{categoryGuid} <a href="../v2/glossary/category/{categoryGuid}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> |
| |
| <p>Get specific glossary category</p> |
| |
| <table class="table resource-parameters"> |
| <caption>Request Parameters</caption> |
| <thead> |
| <tr> |
| <th>name</th> |
| <th>type</th> |
| <th>description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="parameter-name">categoryGuid</span></td> |
| <td>path</td> |
| <td><span class="parameter-description">unique identifier for glossary category</span></td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table resource-response-codes"> |
| <caption>Response Codes</caption> |
| <thead> |
| <tr> |
| <th>code</th> |
| <th>condition</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="label label-success response-code">200</span></td> |
| <td><span class="response-condition">If glossary category exists for given GUID</span></td> |
| </tr> |
| <tr> |
| <td><span class="label label-warning response-code">404</span></td> |
| <td><span class="response-condition">If glossary category GUID is invalid</span></td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table resource-response-body"> |
| <caption>Response Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| <th>description</th> |
| </tr> |
| </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">Glossary category</span></td> |
| </tr> |
| <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> |
| </tr> |
| </tbody> |
| </table> |
| <h4>Example</h4> |
| |
| <div class="container-fluid example panel"> |
| <div class="row panel-body"> |
| <div class="col-md-6"> |
| <h5>Request</h5> |
| <pre> |
| GET /v2/glossary/category/{categoryGuid} |
| Content-Type: application/json |
| Accept: application/json |
| |
| <code class="prettyprint language-txt"> |
| ... |
| </code> |
| </pre> |
| </div> |
| <div class="col-md-6"> |
| <h5>Response</h5> |
| <pre> |
| HTTP/1.1 200 OK |
| 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" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "additionalAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "longDescription" : "...", |
| "name" : "...", |
| "qualifiedName" : "...", |
| "shortDescription" : "...", |
| "guid" : "..." |
| } |
| </code> |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_GlossaryREST_updateGlossaryCategory_PUT"> |
| <h3><span class="label label-default resource-method">PUT</span> <span class="resource-path">/v2/glossary/category/{categoryGuid} <a href="../v2/glossary/category/{categoryGuid}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> |
| |
| <p>Update the given glossary category</p> |
| |
| <table class="table resource-parameters"> |
| <caption>Request Parameters</caption> |
| <thead> |
| <tr> |
| <th>name</th> |
| <th>type</th> |
| <th>description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="parameter-name">categoryGuid</span></td> |
| <td>path</td> |
| <td><span class="parameter-description">unique identifier for glossary category</span></td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table resource-request-body"> |
| <caption>Request Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| <th>description</th> |
| </tr> |
| </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">updated glossary category</span></td> |
| </tr> |
| <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> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table resource-response-codes"> |
| <caption>Response Codes</caption> |
| <thead> |
| <tr> |
| <th>code</th> |
| <th>condition</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="label label-success response-code">200</span></td> |
| <td><span class="response-condition">If glossary category partial update was successful</span></td> |
| </tr> |
| <tr> |
| <td><span class="label label-warning response-code">404</span></td> |
| <td><span class="response-condition">If glossary category guid in invalid</span></td> |
| </tr> |
| <tr> |
| <td><span class="label label-warning response-code">400</span></td> |
| <td><span class="response-condition">If Glossary category definition has invalid or missing information</span></td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table resource-response-body"> |
| <caption>Response Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| <th>description</th> |
| </tr> |
| </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">glossary category</span></td> |
| </tr> |
| <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> |
| </tr> |
| </tbody> |
| </table> |
| <h4>Example</h4> |
| |
| <div class="container-fluid example panel"> |
| <div class="row panel-body"> |
| <div class="col-md-6"> |
| <h5>Request</h5> |
| <pre> |
| PUT /v2/glossary/category/{categoryGuid} |
| 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" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "additionalAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "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> |
| <div class="col-md-6"> |
| <h5>Response</h5> |
| <pre> |
| HTTP/1.1 200 OK |
| 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" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "additionalAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "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> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_GlossaryREST_produceTemplate_GET"> |
| <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/v2/glossary/import/template <a href="../v2/glossary/import/template" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> |
| |
| <p>Get sample template for uploading/creating bulk AtlasGlossaryTerm</p> |
| |
| <table class="table resource-response-codes"> |
| <caption>Response Codes</caption> |
| <thead> |
| <tr> |
| <th>code</th> |
| <th>condition</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="label label-warning response-code">400</span></td> |
| <td><span class="response-condition">If the provided fileType is not supported</span></td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table resource-response-body"> |
| <caption>Response Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| <th>description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/octet-stream" HTTP header to request that this media type be provided by the server."><span class="response-type">application/octet-stream</span></abbr></td> |
| <td><span class="datatype-reference">object |
| </span></td> |
| <td><span class="response-description">Template File</span></td> |
| </tr> |
| </tbody> |
| </table> |
| <h4>Example</h4> |
| |
| <div class="container-fluid example panel"> |
| <div class="row panel-body"> |
| <div class="col-md-6"> |
| <h5>Request</h5> |
| <pre> |
| GET /v2/glossary/import/template |
| Content-Type: application/json |
| Accept: application/octet-stream |
| |
| <code class="prettyprint language-txt"> |
| ... |
| </code> |
| </pre> |
| </div> |
| <div class="col-md-6"> |
| <h5>Response</h5> |
| <pre> |
| HTTP/1.1 200 OK |
| Content-Type: application/octet-stream |
| |
| <code class="prettyprint language-txt"> |
| ... |
| </code> |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_GlossaryREST_deleteGlossaryTerm_DELETE"> |
| <h3><span class="label label-default resource-method">DELETE</span> <span class="resource-path">/v2/glossary/term/{termGuid} <a href="../v2/glossary/term/{termGuid}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> |
| |
| <p>Delete a glossary term</p> |
| |
| <table class="table resource-parameters"> |
| <caption>Request Parameters</caption> |
| <thead> |
| <tr> |
| <th>name</th> |
| <th>type</th> |
| <th>description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="parameter-name">termGuid</span></td> |
| <td>path</td> |
| <td><span class="parameter-description">unique identifier for glossary term</span></td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table resource-response-codes"> |
| <caption>Response Codes</caption> |
| <thead> |
| <tr> |
| <th>code</th> |
| <th>condition</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="label label-success response-code">204</span></td> |
| <td><span class="response-condition">If glossary term delete was successful</span></td> |
| </tr> |
| <tr> |
| <td><span class="label label-warning response-code">404</span></td> |
| <td><span class="response-condition">If glossary term guid in invalid</span></td> |
| </tr> |
| </tbody> |
| </table> |
| <h4>Example</h4> |
| |
| <div class="container-fluid example panel"> |
| <div class="row panel-body"> |
| <div class="col-md-6"> |
| <h5>Request</h5> |
| <pre> |
| DELETE /v2/glossary/term/{termGuid} |
| Content-Type: application/json |
| |
| <code class="prettyprint language-txt"> |
| ... |
| </code> |
| </pre> |
| </div> |
| <div class="col-md-6"> |
| <h5>Response</h5> |
| <pre> |
| HTTP/1.1 204 No Content |
| |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_GlossaryREST_getGlossaryTerm_GET"> |
| <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/v2/glossary/term/{termGuid} <a href="../v2/glossary/term/{termGuid}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> |
| |
| <p>Get specific glossary term</p> |
| |
| <table class="table resource-parameters"> |
| <caption>Request Parameters</caption> |
| <thead> |
| <tr> |
| <th>name</th> |
| <th>type</th> |
| <th>description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="parameter-name">termGuid</span></td> |
| <td>path</td> |
| <td><span class="parameter-description">unique identifier for glossary term</span></td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table resource-response-codes"> |
| <caption>Response Codes</caption> |
| <thead> |
| <tr> |
| <th>code</th> |
| <th>condition</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="label label-success response-code">200</span></td> |
| <td><span class="response-condition">If glossary term exists for given GUID</span></td> |
| </tr> |
| <tr> |
| <td><span class="label label-warning response-code">404</span></td> |
| <td><span class="response-condition">If glossary term GUID is invalid</span></td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table resource-response-body"> |
| <caption>Response Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| <th>description</th> |
| </tr> |
| </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">Glossary term</span></td> |
| </tr> |
| <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> |
| </tr> |
| </tbody> |
| </table> |
| <h4>Example</h4> |
| |
| <div class="container-fluid example panel"> |
| <div class="row panel-body"> |
| <div class="col-md-6"> |
| <h5>Request</h5> |
| <pre> |
| GET /v2/glossary/term/{termGuid} |
| Content-Type: application/json |
| Accept: application/json |
| |
| <code class="prettyprint language-txt"> |
| ... |
| </code> |
| </pre> |
| </div> |
| <div class="col-md-6"> |
| <h5>Response</h5> |
| <pre> |
| HTTP/1.1 200 OK |
| Content-Type: application/json |
| |
| <code class="prettyprint language-js"> |
| { |
| "abbreviation" : "...", |
| "anchor" : { |
| "displayText" : "...", |
| "glossaryGuid" : "...", |
| "relationGuid" : "..." |
| }, |
| "antonyms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "assignedEntities" : [ { |
| "displayText" : "...", |
| "entityStatus" : "PURGED", |
| "qualifiedName" : "...", |
| "relationshipAttributes" : { |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "relationshipGuid" : "...", |
| "relationshipStatus" : "DELETED", |
| "relationshipType" : "...", |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, { |
| "displayText" : "...", |
| "entityStatus" : "PURGED", |
| "qualifiedName" : "...", |
| "relationshipAttributes" : { |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "relationshipGuid" : "...", |
| "relationshipStatus" : "ACTIVE", |
| "relationshipType" : "...", |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| } ], |
| "categories" : [ { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "relationGuid" : "...", |
| "status" : "OBSOLETE" |
| }, { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "relationGuid" : "...", |
| "status" : "ACTIVE" |
| } ], |
| "classifies" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "examples" : [ "...", "..." ], |
| "glossaryTermHeader" : { |
| "qualifiedName" : "...", |
| "termGuid" : "..." |
| }, |
| "isA" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "preferredTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "preferredToTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "replacedBy" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "replacementTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "seeAlso" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "synonyms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "translatedTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "translationTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "usage" : "...", |
| "validValues" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "validValuesFor" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "additionalAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "longDescription" : "...", |
| "name" : "...", |
| "qualifiedName" : "...", |
| "shortDescription" : "...", |
| "guid" : "..." |
| } |
| </code> |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_GlossaryREST_updateGlossaryTerm_PUT"> |
| <h3><span class="label label-default resource-method">PUT</span> <span class="resource-path">/v2/glossary/term/{termGuid} <a href="../v2/glossary/term/{termGuid}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> |
| |
| <p>Update the given glossary term</p> |
| |
| <table class="table resource-parameters"> |
| <caption>Request Parameters</caption> |
| <thead> |
| <tr> |
| <th>name</th> |
| <th>type</th> |
| <th>description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="parameter-name">termGuid</span></td> |
| <td>path</td> |
| <td><span class="parameter-description">unique identifier for glossary term</span></td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table resource-request-body"> |
| <caption>Request Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| <th>description</th> |
| </tr> |
| </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">updated glossary term</span></td> |
| </tr> |
| <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> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table resource-response-codes"> |
| <caption>Response Codes</caption> |
| <thead> |
| <tr> |
| <th>code</th> |
| <th>condition</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="label label-success response-code">200</span></td> |
| <td><span class="response-condition">If glossary term update was successful</span></td> |
| </tr> |
| <tr> |
| <td><span class="label label-warning response-code">404</span></td> |
| <td><span class="response-condition">If glossary term guid in invalid</span></td> |
| </tr> |
| <tr> |
| <td><span class="label label-warning response-code">400</span></td> |
| <td><span class="response-condition">If Glossary temr definition has invalid or missing information</span></td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table resource-response-body"> |
| <caption>Response Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| <th>description</th> |
| </tr> |
| </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">Updated glossary term</span></td> |
| </tr> |
| <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> |
| </tr> |
| </tbody> |
| </table> |
| <h4>Example</h4> |
| |
| <div class="container-fluid example panel"> |
| <div class="row panel-body"> |
| <div class="col-md-6"> |
| <h5>Request</h5> |
| <pre> |
| PUT /v2/glossary/term/{termGuid} |
| Content-Type: application/json |
| Accept: application/json |
| |
| <code class="prettyprint language-js"> |
| { |
| "abbreviation" : "...", |
| "anchor" : { |
| "displayText" : "...", |
| "glossaryGuid" : "...", |
| "relationGuid" : "..." |
| }, |
| "antonyms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "assignedEntities" : [ { |
| "displayText" : "...", |
| "entityStatus" : "ACTIVE", |
| "qualifiedName" : "...", |
| "relationshipAttributes" : { |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "relationshipGuid" : "...", |
| "relationshipStatus" : "DELETED", |
| "relationshipType" : "...", |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, { |
| "displayText" : "...", |
| "entityStatus" : "PURGED", |
| "qualifiedName" : "...", |
| "relationshipAttributes" : { |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "relationshipGuid" : "...", |
| "relationshipStatus" : "ACTIVE", |
| "relationshipType" : "...", |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| } ], |
| "categories" : [ { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "relationGuid" : "...", |
| "status" : "DEPRECATED" |
| }, { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "relationGuid" : "...", |
| "status" : "ACTIVE" |
| } ], |
| "classifies" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "examples" : [ "...", "..." ], |
| "glossaryTermHeader" : { |
| "qualifiedName" : "...", |
| "termGuid" : "..." |
| }, |
| "isA" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "preferredTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "preferredToTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "replacedBy" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "replacementTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "seeAlso" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "synonyms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "translatedTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "translationTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "usage" : "...", |
| "validValues" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "validValuesFor" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "additionalAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "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> |
| <div class="col-md-6"> |
| <h5>Response</h5> |
| <pre> |
| HTTP/1.1 200 OK |
| Content-Type: application/json |
| |
| <code class="prettyprint language-js"> |
| { |
| "abbreviation" : "...", |
| "anchor" : { |
| "displayText" : "...", |
| "glossaryGuid" : "...", |
| "relationGuid" : "..." |
| }, |
| "antonyms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "assignedEntities" : [ { |
| "displayText" : "...", |
| "entityStatus" : "ACTIVE", |
| "qualifiedName" : "...", |
| "relationshipAttributes" : { |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "relationshipGuid" : "...", |
| "relationshipStatus" : "ACTIVE", |
| "relationshipType" : "...", |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, { |
| "displayText" : "...", |
| "entityStatus" : "DELETED", |
| "qualifiedName" : "...", |
| "relationshipAttributes" : { |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "relationshipGuid" : "...", |
| "relationshipStatus" : "DELETED", |
| "relationshipType" : "...", |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| } ], |
| "categories" : [ { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "relationGuid" : "...", |
| "status" : "ACTIVE" |
| }, { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "relationGuid" : "...", |
| "status" : "DRAFT" |
| } ], |
| "classifies" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "examples" : [ "...", "..." ], |
| "glossaryTermHeader" : { |
| "qualifiedName" : "...", |
| "termGuid" : "..." |
| }, |
| "isA" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "preferredTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "preferredToTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "replacedBy" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "replacementTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "seeAlso" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "synonyms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "translatedTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "translationTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "usage" : "...", |
| "validValues" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "validValuesFor" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "additionalAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "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> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_GlossaryREST_getGlossaryCategories_GET"> |
| <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/v2/glossary/{glossaryGuid}/categories <a href="../v2/glossary/{glossaryGuid}/categories" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> |
| |
| <p>Get the categories belonging to a specific glossary</p> |
| |
| <table class="table resource-parameters"> |
| <caption>Request Parameters</caption> |
| <thead> |
| <tr> |
| <th>name</th> |
| <th>type</th> |
| <th>description</th> |
| <th>default</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="parameter-name">glossaryGuid</span></td> |
| <td>path</td> |
| <td><span class="parameter-description">unique identifier for glossary term</span></td> |
| <td><span class="parameter-default-value"> </span></td> |
| </tr> |
| <tr> |
| <td><span class="parameter-name">limit</span></td> |
| <td>query</td> |
| <td><span class="parameter-description">page size - by default there is no paging</span></td> |
| <td><span class="parameter-default-value">-1</span></td> |
| </tr> |
| <tr> |
| <td><span class="parameter-name">offset</span></td> |
| <td>query</td> |
| <td><span class="parameter-description">offset for pagination purpose</span></td> |
| <td><span class="parameter-default-value">0</span></td> |
| </tr> |
| <tr> |
| <td><span class="parameter-name">sort</span></td> |
| <td>query</td> |
| <td><span class="parameter-description">ASC (default) or DESC</span></td> |
| <td><span class="parameter-default-value">ASC</span></td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table resource-response-codes"> |
| <caption>Response Codes</caption> |
| <thead> |
| <tr> |
| <th>code</th> |
| <th>condition</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="label label-success response-code">200</span></td> |
| <td><span class="response-condition">List of glossary categories for the given glossary or an empty list</span></td> |
| </tr> |
| <tr> |
| <td><span class="label label-warning response-code">404</span></td> |
| <td><span class="response-condition">If glossary guid in invalid</span></td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table resource-response-body"> |
| <caption>Response Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| <th>description</th> |
| </tr> |
| </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">List of associated categories</span></td> |
| </tr> |
| <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> |
| </tr> |
| </tbody> |
| </table> |
| <h4>Example</h4> |
| |
| <div class="container-fluid example panel"> |
| <div class="row panel-body"> |
| <div class="col-md-6"> |
| <h5>Request</h5> |
| <pre> |
| GET /v2/glossary/{glossaryGuid}/categories |
| Content-Type: application/json |
| Accept: application/json |
| |
| <code class="prettyprint language-txt"> |
| ... |
| </code> |
| </pre> |
| </div> |
| <div class="col-md-6"> |
| <h5>Response</h5> |
| <pre> |
| HTTP/1.1 200 OK |
| 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" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "additionalAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "longDescription" : "...", |
| "name" : "...", |
| "qualifiedName" : "...", |
| "shortDescription" : "...", |
| "guid" : "..." |
| } ] |
| </code> |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_GlossaryREST_getDetailedGlossary_GET"> |
| <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/v2/glossary/{glossaryGuid}/detailed <a href="../v2/glossary/{glossaryGuid}/detailed" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> |
| |
| <p>Get a specific Glossary</p> |
| |
| <table class="table resource-parameters"> |
| <caption>Request Parameters</caption> |
| <thead> |
| <tr> |
| <th>name</th> |
| <th>type</th> |
| <th>description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="parameter-name">glossaryGuid</span></td> |
| <td>path</td> |
| <td><span class="parameter-description">unique glossary identifier</span></td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table resource-response-codes"> |
| <caption>Response Codes</caption> |
| <thead> |
| <tr> |
| <th>code</th> |
| <th>condition</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="label label-success response-code">200</span></td> |
| <td><span class="response-condition">If glossary exists for given GUID</span></td> |
| </tr> |
| <tr> |
| <td><span class="label label-warning response-code">404</span></td> |
| <td><span class="response-condition">If glossary GUID is invalid</span></td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table resource-response-body"> |
| <caption>Response Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| <th>description</th> |
| </tr> |
| </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_AtlasGlossaryExtInfo.html">AtlasGlossaryExtInfo</a> |
| (JSON)</span></td> |
| <td rowspan="2" class="multi-row-description"><span class="response-description">Glossary</span></td> |
| </tr> |
| <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_AtlasGlossaryExtInfo.html">AtlasGlossaryExtInfo</a> |
| (JSON)</span></td> |
| </tr> |
| </tbody> |
| </table> |
| <h4>Example</h4> |
| |
| <div class="container-fluid example panel"> |
| <div class="row panel-body"> |
| <div class="col-md-6"> |
| <h5>Request</h5> |
| <pre> |
| GET /v2/glossary/{glossaryGuid}/detailed |
| Content-Type: application/json |
| Accept: application/json |
| |
| <code class="prettyprint language-txt"> |
| ... |
| </code> |
| </pre> |
| </div> |
| <div class="col-md-6"> |
| <h5>Response</h5> |
| <pre> |
| HTTP/1.1 200 OK |
| Content-Type: application/json |
| |
| <code class="prettyprint language-js"> |
| { |
| "categoryInfo" : { |
| "property1" : { |
| "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" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "additionalAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "longDescription" : "...", |
| "name" : "...", |
| "qualifiedName" : "...", |
| "shortDescription" : "...", |
| "guid" : "..." |
| }, |
| "property2" : { |
| "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" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "additionalAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "longDescription" : "...", |
| "name" : "...", |
| "qualifiedName" : "...", |
| "shortDescription" : "...", |
| "guid" : "..." |
| } |
| }, |
| "termInfo" : { |
| "property1" : { |
| "abbreviation" : "...", |
| "anchor" : { |
| "displayText" : "...", |
| "glossaryGuid" : "...", |
| "relationGuid" : "..." |
| }, |
| "antonyms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "assignedEntities" : [ { |
| "displayText" : "...", |
| "entityStatus" : "PURGED", |
| "qualifiedName" : "...", |
| "relationshipAttributes" : { }, |
| "relationshipGuid" : "...", |
| "relationshipStatus" : "DELETED", |
| "relationshipType" : "...", |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, { |
| "displayText" : "...", |
| "entityStatus" : "ACTIVE", |
| "qualifiedName" : "...", |
| "relationshipAttributes" : { }, |
| "relationshipGuid" : "...", |
| "relationshipStatus" : "ACTIVE", |
| "relationshipType" : "...", |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| } ], |
| "categories" : [ { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "relationGuid" : "...", |
| "status" : "DRAFT" |
| }, { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "relationGuid" : "...", |
| "status" : "DEPRECATED" |
| } ], |
| "classifies" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "examples" : [ "...", "..." ], |
| "glossaryTermHeader" : { |
| "qualifiedName" : "...", |
| "termGuid" : "..." |
| }, |
| "isA" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "preferredTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "preferredToTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "replacedBy" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "replacementTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "seeAlso" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "synonyms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "translatedTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "translationTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "usage" : "...", |
| "validValues" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "validValuesFor" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "additionalAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "longDescription" : "...", |
| "name" : "...", |
| "qualifiedName" : "...", |
| "shortDescription" : "...", |
| "guid" : "..." |
| }, |
| "property2" : { |
| "abbreviation" : "...", |
| "anchor" : { |
| "displayText" : "...", |
| "glossaryGuid" : "...", |
| "relationGuid" : "..." |
| }, |
| "antonyms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "assignedEntities" : [ { |
| "displayText" : "...", |
| "entityStatus" : "ACTIVE", |
| "qualifiedName" : "...", |
| "relationshipAttributes" : { }, |
| "relationshipGuid" : "...", |
| "relationshipStatus" : "ACTIVE", |
| "relationshipType" : "...", |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, { |
| "displayText" : "...", |
| "entityStatus" : "ACTIVE", |
| "qualifiedName" : "...", |
| "relationshipAttributes" : { }, |
| "relationshipGuid" : "...", |
| "relationshipStatus" : "ACTIVE", |
| "relationshipType" : "...", |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| } ], |
| "categories" : [ { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "relationGuid" : "...", |
| "status" : "OBSOLETE" |
| }, { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "relationGuid" : "...", |
| "status" : "DRAFT" |
| } ], |
| "classifies" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "examples" : [ "...", "..." ], |
| "glossaryTermHeader" : { |
| "qualifiedName" : "...", |
| "termGuid" : "..." |
| }, |
| "isA" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "preferredTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "preferredToTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "replacedBy" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "replacementTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "seeAlso" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "synonyms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "translatedTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "translationTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "usage" : "...", |
| "validValues" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "validValuesFor" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "additionalAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "longDescription" : "...", |
| "name" : "...", |
| "qualifiedName" : "...", |
| "shortDescription" : "...", |
| "guid" : "..." |
| } |
| }, |
| "categories" : [ { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "parentCategoryGuid" : "...", |
| "relationGuid" : "..." |
| }, { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "parentCategoryGuid" : "...", |
| "relationGuid" : "..." |
| } ], |
| "language" : "...", |
| "terms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "usage" : "...", |
| "additionalAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "longDescription" : "...", |
| "name" : "...", |
| "qualifiedName" : "...", |
| "shortDescription" : "...", |
| "guid" : "..." |
| } |
| </code> |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_GlossaryREST_partialUpdateGlossary_PUT"> |
| <h3><span class="label label-default resource-method">PUT</span> <span class="resource-path">/v2/glossary/{glossaryGuid}/partial <a href="../v2/glossary/{glossaryGuid}/partial" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> |
| |
| <p>Partially update the glossary</p> |
| |
| <table class="table resource-parameters"> |
| <caption>Request Parameters</caption> |
| <thead> |
| <tr> |
| <th>name</th> |
| <th>type</th> |
| <th>description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="parameter-name">glossaryGuid</span></td> |
| <td>path</td> |
| <td><span class="parameter-description">unique identifier for glossary term</span></td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table resource-request-body"> |
| <caption>Request Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| <th>description</th> |
| </tr> |
| </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">map of string |
| (JSON)</span></td> |
| <td rowspan="2" class="multi-row-description"><span class="request-description">Map containing keys as attribute names and values as corresponding attribute values</span></td> |
| </tr> |
| <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">map of string |
| (JSON)</span></td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table resource-response-codes"> |
| <caption>Response Codes</caption> |
| <thead> |
| <tr> |
| <th>code</th> |
| <th>condition</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="label label-success response-code">200</span></td> |
| <td><span class="response-condition">If glossary partial update was successful</span></td> |
| </tr> |
| <tr> |
| <td><span class="label label-warning response-code">404</span></td> |
| <td><span class="response-condition">If glossary guid in invalid</span></td> |
| </tr> |
| <tr> |
| <td><span class="label label-warning response-code">400</span></td> |
| <td><span class="response-condition">If partial update parameters are invalid</span></td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table resource-response-body"> |
| <caption>Response Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| <th>description</th> |
| </tr> |
| </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">Updated glossary</span></td> |
| </tr> |
| <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> |
| </tr> |
| </tbody> |
| </table> |
| <h4>Example</h4> |
| |
| <div class="container-fluid example panel"> |
| <div class="row panel-body"> |
| <div class="col-md-6"> |
| <h5>Request</h5> |
| <pre> |
| PUT /v2/glossary/{glossaryGuid}/partial |
| Content-Type: application/json |
| Accept: application/json |
| |
| <code class="prettyprint language-txt"> |
| ... |
| </code> |
| </pre> |
| </div> |
| <div class="col-md-6"> |
| <h5>Response</h5> |
| <pre> |
| HTTP/1.1 200 OK |
| 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" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "usage" : "...", |
| "additionalAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "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> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_GlossaryREST_getGlossaryTerms_GET"> |
| <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/v2/glossary/{glossaryGuid}/terms <a href="../v2/glossary/{glossaryGuid}/terms" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> |
| |
| <p>Get terms belonging to a specific glossary</p> |
| |
| <table class="table resource-parameters"> |
| <caption>Request Parameters</caption> |
| <thead> |
| <tr> |
| <th>name</th> |
| <th>type</th> |
| <th>description</th> |
| <th>default</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="parameter-name">glossaryGuid</span></td> |
| <td>path</td> |
| <td><span class="parameter-description">unique identifier for glossary</span></td> |
| <td><span class="parameter-default-value"> </span></td> |
| </tr> |
| <tr> |
| <td><span class="parameter-name">limit</span></td> |
| <td>query</td> |
| <td><span class="parameter-description">page size - by default there is no paging</span></td> |
| <td><span class="parameter-default-value">-1</span></td> |
| </tr> |
| <tr> |
| <td><span class="parameter-name">offset</span></td> |
| <td>query</td> |
| <td><span class="parameter-description">starting offset for loading terms</span></td> |
| <td><span class="parameter-default-value">0</span></td> |
| </tr> |
| <tr> |
| <td><span class="parameter-name">sort</span></td> |
| <td>query</td> |
| <td><span class="parameter-description">ASC(default) or DESC</span></td> |
| <td><span class="parameter-default-value">ASC</span></td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table resource-response-codes"> |
| <caption>Response Codes</caption> |
| <thead> |
| <tr> |
| <th>code</th> |
| <th>condition</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="label label-success response-code">200</span></td> |
| <td><span class="response-condition">List of glossary terms for the given glossary or an empty list</span></td> |
| </tr> |
| <tr> |
| <td><span class="label label-warning response-code">404</span></td> |
| <td><span class="response-condition">If glossary guid in invalid</span></td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table resource-response-body"> |
| <caption>Response Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| <th>description</th> |
| </tr> |
| </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">List of terms associated with the glossary</span></td> |
| </tr> |
| <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> |
| </tr> |
| </tbody> |
| </table> |
| <h4>Example</h4> |
| |
| <div class="container-fluid example panel"> |
| <div class="row panel-body"> |
| <div class="col-md-6"> |
| <h5>Request</h5> |
| <pre> |
| GET /v2/glossary/{glossaryGuid}/terms |
| Content-Type: application/json |
| Accept: application/json |
| |
| <code class="prettyprint language-txt"> |
| ... |
| </code> |
| </pre> |
| </div> |
| <div class="col-md-6"> |
| <h5>Response</h5> |
| <pre> |
| HTTP/1.1 200 OK |
| Content-Type: application/json |
| |
| <code class="prettyprint language-js"> |
| [ { |
| "abbreviation" : "...", |
| "anchor" : { |
| "displayText" : "...", |
| "glossaryGuid" : "...", |
| "relationGuid" : "..." |
| }, |
| "antonyms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "assignedEntities" : [ { |
| "displayText" : "...", |
| "entityStatus" : "ACTIVE", |
| "qualifiedName" : "...", |
| "relationshipAttributes" : { |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "relationshipGuid" : "...", |
| "relationshipStatus" : "ACTIVE", |
| "relationshipType" : "...", |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, { |
| "displayText" : "...", |
| "entityStatus" : "DELETED", |
| "qualifiedName" : "...", |
| "relationshipAttributes" : { |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "relationshipGuid" : "...", |
| "relationshipStatus" : "ACTIVE", |
| "relationshipType" : "...", |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| } ], |
| "categories" : [ { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "relationGuid" : "...", |
| "status" : "DEPRECATED" |
| }, { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "relationGuid" : "...", |
| "status" : "ACTIVE" |
| } ], |
| "classifies" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "examples" : [ "...", "..." ], |
| "glossaryTermHeader" : { |
| "qualifiedName" : "...", |
| "termGuid" : "..." |
| }, |
| "isA" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "preferredTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "preferredToTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "replacedBy" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "replacementTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "seeAlso" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "synonyms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "translatedTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "translationTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "usage" : "...", |
| "validValues" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "validValuesFor" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "additionalAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "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> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_GlossaryREST_partialUpdateGlossaryCategory_PUT"> |
| <h3><span class="label label-default resource-method">PUT</span> <span class="resource-path">/v2/glossary/category/{categoryGuid}/partial <a href="../v2/glossary/category/{categoryGuid}/partial" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> |
| |
| <p>Partially update the glossary category</p> |
| |
| <table class="table resource-parameters"> |
| <caption>Request Parameters</caption> |
| <thead> |
| <tr> |
| <th>name</th> |
| <th>type</th> |
| <th>description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="parameter-name">categoryGuid</span></td> |
| <td>path</td> |
| <td><span class="parameter-description">unique identifier for glossary term</span></td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table resource-request-body"> |
| <caption>Request Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| <th>description</th> |
| </tr> |
| </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">map of string |
| (JSON)</span></td> |
| <td rowspan="2" class="multi-row-description"><span class="request-description">Map containing keys as attribute names and values as corresponding attribute values</span></td> |
| </tr> |
| <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">map of string |
| (JSON)</span></td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table resource-response-codes"> |
| <caption>Response Codes</caption> |
| <thead> |
| <tr> |
| <th>code</th> |
| <th>condition</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="label label-success response-code">200</span></td> |
| <td><span class="response-condition">If glossary category partial update was successful</span></td> |
| </tr> |
| <tr> |
| <td><span class="label label-warning response-code">404</span></td> |
| <td><span class="response-condition">If glossary category guid in invalid</span></td> |
| </tr> |
| <tr> |
| <td><span class="label label-warning response-code">400</span></td> |
| <td><span class="response-condition">If category attributes are invalid</span></td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table resource-response-body"> |
| <caption>Response Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| <th>description</th> |
| </tr> |
| </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">Updated glossary category</span></td> |
| </tr> |
| <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> |
| </tr> |
| </tbody> |
| </table> |
| <h4>Example</h4> |
| |
| <div class="container-fluid example panel"> |
| <div class="row panel-body"> |
| <div class="col-md-6"> |
| <h5>Request</h5> |
| <pre> |
| PUT /v2/glossary/category/{categoryGuid}/partial |
| Content-Type: application/json |
| Accept: application/json |
| |
| <code class="prettyprint language-txt"> |
| ... |
| </code> |
| </pre> |
| </div> |
| <div class="col-md-6"> |
| <h5>Response</h5> |
| <pre> |
| HTTP/1.1 200 OK |
| 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" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "additionalAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "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> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_GlossaryREST_getRelatedCategories_GET"> |
| <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/v2/glossary/category/{categoryGuid}/related <a href="../v2/glossary/category/{categoryGuid}/related" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> |
| |
| <p>Get all related categories (parent and children)</p> |
| |
| <table class="table resource-parameters"> |
| <caption>Request Parameters</caption> |
| <thead> |
| <tr> |
| <th>name</th> |
| <th>type</th> |
| <th>description</th> |
| <th>default</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="parameter-name">categoryGuid</span></td> |
| <td>path</td> |
| <td><span class="parameter-description">unique identifier for glossary category</span></td> |
| <td><span class="parameter-default-value"> </span></td> |
| </tr> |
| <tr> |
| <td><span class="parameter-name">limit</span></td> |
| <td>query</td> |
| <td><span class="parameter-description">page size - by default there is no paging</span></td> |
| <td><span class="parameter-default-value">-1</span></td> |
| </tr> |
| <tr> |
| <td><span class="parameter-name">offset</span></td> |
| <td>query</td> |
| <td><span class="parameter-description">offset for pagination purpose</span></td> |
| <td><span class="parameter-default-value">0</span></td> |
| </tr> |
| <tr> |
| <td><span class="parameter-name">sort</span></td> |
| <td>query</td> |
| <td><span class="parameter-description">ASC (default) or DESC</span></td> |
| <td><span class="parameter-default-value">ASC</span></td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table resource-response-body"> |
| <caption>Response Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| <th>description</th> |
| </tr> |
| </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">map of array of <a href="json_AtlasRelatedCategoryHeader.html">AtlasRelatedCategoryHeader</a> |
| (JSON)</span></td> |
| <td rowspan="2" class="multi-row-description"><span class="response-description">List of related categories</span></td> |
| </tr> |
| <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">map of array of <a href="json_AtlasRelatedCategoryHeader.html">AtlasRelatedCategoryHeader</a> |
| (JSON)</span></td> |
| </tr> |
| </tbody> |
| </table> |
| <h4>Example</h4> |
| |
| <div class="container-fluid example panel"> |
| <div class="row panel-body"> |
| <div class="col-md-6"> |
| <h5>Request</h5> |
| <pre> |
| GET /v2/glossary/category/{categoryGuid}/related |
| Content-Type: application/json |
| Accept: application/json |
| |
| <code class="prettyprint language-txt"> |
| ... |
| </code> |
| </pre> |
| </div> |
| <div class="col-md-6"> |
| <h5>Response</h5> |
| <pre> |
| HTTP/1.1 200 OK |
| Content-Type: application/json |
| |
| <code class="prettyprint language-js"> |
| [ { |
| "..." : { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "parentCategoryGuid" : "...", |
| "relationGuid" : "..." |
| } |
| } ] |
| </code> |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_GlossaryREST_getCategoryTerms_GET"> |
| <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/v2/glossary/category/{categoryGuid}/terms <a href="../v2/glossary/category/{categoryGuid}/terms" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> |
| |
| <p>Get all terms associated with the specific category</p> |
| |
| <table class="table resource-parameters"> |
| <caption>Request Parameters</caption> |
| <thead> |
| <tr> |
| <th>name</th> |
| <th>type</th> |
| <th>description</th> |
| <th>default</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="parameter-name">categoryGuid</span></td> |
| <td>path</td> |
| <td><span class="parameter-description">unique identifier for glossary category</span></td> |
| <td><span class="parameter-default-value"> </span></td> |
| </tr> |
| <tr> |
| <td><span class="parameter-name">limit</span></td> |
| <td>query</td> |
| <td><span class="parameter-description">page size - by default there is no paging</span></td> |
| <td><span class="parameter-default-value">-1</span></td> |
| </tr> |
| <tr> |
| <td><span class="parameter-name">offset</span></td> |
| <td>query</td> |
| <td><span class="parameter-description">offset for pagination purpose</span></td> |
| <td><span class="parameter-default-value">0</span></td> |
| </tr> |
| <tr> |
| <td><span class="parameter-name">sort</span></td> |
| <td>query</td> |
| <td><span class="parameter-description">ASC (default) or DESC</span></td> |
| <td><span class="parameter-default-value">ASC</span></td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table resource-response-codes"> |
| <caption>Response Codes</caption> |
| <thead> |
| <tr> |
| <th>code</th> |
| <th>condition</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="label label-success response-code">200</span></td> |
| <td><span class="response-condition">List of terms for the given category or an empty list</span></td> |
| </tr> |
| <tr> |
| <td><span class="label label-warning response-code">404</span></td> |
| <td><span class="response-condition">If glossary category guid in invalid</span></td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table resource-response-body"> |
| <caption>Response Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| <th>description</th> |
| </tr> |
| </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_AtlasRelatedTermHeader.html">AtlasRelatedTermHeader</a> |
| (JSON)</span></td> |
| <td rowspan="2" class="multi-row-description"><span class="response-description">List of associated terms</span></td> |
| </tr> |
| <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_AtlasRelatedTermHeader.html">AtlasRelatedTermHeader</a> |
| (JSON)</span></td> |
| </tr> |
| </tbody> |
| </table> |
| <h4>Example</h4> |
| |
| <div class="container-fluid example panel"> |
| <div class="row panel-body"> |
| <div class="col-md-6"> |
| <h5>Request</h5> |
| <pre> |
| GET /v2/glossary/category/{categoryGuid}/terms |
| Content-Type: application/json |
| Accept: application/json |
| |
| <code class="prettyprint language-txt"> |
| ... |
| </code> |
| </pre> |
| </div> |
| <div class="col-md-6"> |
| <h5>Response</h5> |
| <pre> |
| HTTP/1.1 200 OK |
| Content-Type: application/json |
| |
| <code class="prettyprint language-js"> |
| [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ] |
| </code> |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_GlossaryREST_partialUpdateGlossaryTerm_PUT"> |
| <h3><span class="label label-default resource-method">PUT</span> <span class="resource-path">/v2/glossary/term/{termGuid}/partial <a href="../v2/glossary/term/{termGuid}/partial" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> |
| |
| <p>Partially update the glossary term</p> |
| |
| <table class="table resource-parameters"> |
| <caption>Request Parameters</caption> |
| <thead> |
| <tr> |
| <th>name</th> |
| <th>type</th> |
| <th>description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="parameter-name">termGuid</span></td> |
| <td>path</td> |
| <td><span class="parameter-description">unique identifier for glossary term</span></td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table resource-request-body"> |
| <caption>Request Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| <th>description</th> |
| </tr> |
| </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">map of string |
| (JSON)</span></td> |
| <td rowspan="2" class="multi-row-description"><span class="request-description">Map containing keys as attribute names and values as corresponding attribute values</span></td> |
| </tr> |
| <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">map of string |
| (JSON)</span></td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table resource-response-codes"> |
| <caption>Response Codes</caption> |
| <thead> |
| <tr> |
| <th>code</th> |
| <th>condition</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="label label-success response-code">200</span></td> |
| <td><span class="response-condition">If glossary partial update was successful</span></td> |
| </tr> |
| <tr> |
| <td><span class="label label-warning response-code">404</span></td> |
| <td><span class="response-condition">If glossary term guid in invalid</span></td> |
| </tr> |
| <tr> |
| <td><span class="label label-warning response-code">400</span></td> |
| <td><span class="response-condition">If partial attributes are invalid</span></td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table resource-response-body"> |
| <caption>Response Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| <th>description</th> |
| </tr> |
| </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">Updated glossary term</span></td> |
| </tr> |
| <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> |
| </tr> |
| </tbody> |
| </table> |
| <h4>Example</h4> |
| |
| <div class="container-fluid example panel"> |
| <div class="row panel-body"> |
| <div class="col-md-6"> |
| <h5>Request</h5> |
| <pre> |
| PUT /v2/glossary/term/{termGuid}/partial |
| Content-Type: application/json |
| Accept: application/json |
| |
| <code class="prettyprint language-txt"> |
| ... |
| </code> |
| </pre> |
| </div> |
| <div class="col-md-6"> |
| <h5>Response</h5> |
| <pre> |
| HTTP/1.1 200 OK |
| Content-Type: application/json |
| |
| <code class="prettyprint language-js"> |
| { |
| "abbreviation" : "...", |
| "anchor" : { |
| "displayText" : "...", |
| "glossaryGuid" : "...", |
| "relationGuid" : "..." |
| }, |
| "antonyms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "assignedEntities" : [ { |
| "displayText" : "...", |
| "entityStatus" : "PURGED", |
| "qualifiedName" : "...", |
| "relationshipAttributes" : { |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "relationshipGuid" : "...", |
| "relationshipStatus" : "ACTIVE", |
| "relationshipType" : "...", |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, { |
| "displayText" : "...", |
| "entityStatus" : "PURGED", |
| "qualifiedName" : "...", |
| "relationshipAttributes" : { |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "relationshipGuid" : "...", |
| "relationshipStatus" : "ACTIVE", |
| "relationshipType" : "...", |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| } ], |
| "categories" : [ { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "relationGuid" : "...", |
| "status" : "OBSOLETE" |
| }, { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "relationGuid" : "...", |
| "status" : "ACTIVE" |
| } ], |
| "classifies" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "examples" : [ "...", "..." ], |
| "glossaryTermHeader" : { |
| "qualifiedName" : "...", |
| "termGuid" : "..." |
| }, |
| "isA" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "preferredTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "preferredToTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "replacedBy" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "replacementTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "seeAlso" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "synonyms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "translatedTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "translationTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "usage" : "...", |
| "validValues" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "validValuesFor" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "additionalAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "longDescription" : "...", |
| "name" : "...", |
| "qualifiedName" : "...", |
| "shortDescription" : "...", |
| "guid" : "..." |
| } |
| </code> |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_GlossaryREST_removeTermAssignmentFromEntities_DELETE"> |
| <h3><span class="label label-default resource-method">DELETE</span> <span class="resource-path">/v2/glossary/terms/{termGuid}/assignedEntities <a href="../v2/glossary/terms/{termGuid}/assignedEntities" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> |
| |
| <p>Remove the term assignment for the given list of entity headers</p> |
| |
| <table class="table resource-parameters"> |
| <caption>Request Parameters</caption> |
| <thead> |
| <tr> |
| <th>name</th> |
| <th>type</th> |
| <th>description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="parameter-name">termGuid</span></td> |
| <td>path</td> |
| <td><span class="parameter-description">Glossary term GUID</span></td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table resource-request-body"> |
| <caption>Request Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| <th>description</th> |
| </tr> |
| </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_AtlasRelatedObjectId.html">AtlasRelatedObjectId</a> |
| (JSON)</span></td> |
| <td rowspan="2" class="multi-row-description"><span class="request-description">List of related entity IDs from which the term has to be dissociated</span></td> |
| </tr> |
| <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_AtlasRelatedObjectId.html">AtlasRelatedObjectId</a> |
| (JSON)</span></td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table resource-response-codes"> |
| <caption>Response Codes</caption> |
| <thead> |
| <tr> |
| <th>code</th> |
| <th>condition</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="label label-success response-code">204</span></td> |
| <td><span class="response-condition">If glossary term dissociation was successful</span></td> |
| </tr> |
| <tr> |
| <td><span class="label label-warning response-code">400</span></td> |
| <td><span class="response-condition">If ANY of the entity header is invalid</span></td> |
| </tr> |
| <tr> |
| <td><span class="label label-warning response-code">404</span></td> |
| <td><span class="response-condition">If glossary term guid in invalid</span></td> |
| </tr> |
| </tbody> |
| </table> |
| <h4>Example</h4> |
| |
| <div class="container-fluid example panel"> |
| <div class="row panel-body"> |
| <div class="col-md-6"> |
| <h5>Request</h5> |
| <pre> |
| DELETE /v2/glossary/terms/{termGuid}/assignedEntities |
| Content-Type: application/json |
| |
| <code class="prettyprint language-js"> |
| [ { |
| "displayText" : "...", |
| "entityStatus" : "ACTIVE", |
| "qualifiedName" : "...", |
| "relationshipAttributes" : { |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "relationshipGuid" : "...", |
| "relationshipStatus" : "DELETED", |
| "relationshipType" : "...", |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| } ] |
| </code> |
| </pre> |
| </div> |
| <div class="col-md-6"> |
| <h5>Response</h5> |
| <pre> |
| HTTP/1.1 204 No Content |
| |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_GlossaryREST_getEntitiesAssignedWithTerm_GET"> |
| <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/v2/glossary/terms/{termGuid}/assignedEntities <a href="../v2/glossary/terms/{termGuid}/assignedEntities" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> |
| |
| <p>Get all entity headers assigned with the specified term</p> |
| |
| <table class="table resource-parameters"> |
| <caption>Request Parameters</caption> |
| <thead> |
| <tr> |
| <th>name</th> |
| <th>type</th> |
| <th>description</th> |
| <th>default</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="parameter-name">termGuid</span></td> |
| <td>path</td> |
| <td><span class="parameter-description">GUID of the term</span></td> |
| <td><span class="parameter-default-value"> </span></td> |
| </tr> |
| <tr> |
| <td><span class="parameter-name">limit</span></td> |
| <td>query</td> |
| <td><span class="parameter-description">page size - by default there is no paging</span></td> |
| <td><span class="parameter-default-value">-1</span></td> |
| </tr> |
| <tr> |
| <td><span class="parameter-name">offset</span></td> |
| <td>query</td> |
| <td><span class="parameter-description">offset for pagination purpose</span></td> |
| <td><span class="parameter-default-value">0</span></td> |
| </tr> |
| <tr> |
| <td><span class="parameter-name">sort</span></td> |
| <td>query</td> |
| <td><span class="parameter-description">ASC (default) or DESC</span></td> |
| <td><span class="parameter-default-value">ASC</span></td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table resource-response-codes"> |
| <caption>Response Codes</caption> |
| <thead> |
| <tr> |
| <th>code</th> |
| <th>condition</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="label label-success response-code">200</span></td> |
| <td><span class="response-condition">List of entity headers (if any) for the given glossary or an empty list</span></td> |
| </tr> |
| <tr> |
| <td><span class="label label-warning response-code">404</span></td> |
| <td><span class="response-condition">If glossary term guid in invalid</span></td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table resource-response-body"> |
| <caption>Response Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| <th>description</th> |
| </tr> |
| </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_AtlasRelatedObjectId.html">AtlasRelatedObjectId</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" 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_AtlasRelatedObjectId.html">AtlasRelatedObjectId</a> |
| (JSON)</span></td> |
| </tr> |
| </tbody> |
| </table> |
| <h4>Example</h4> |
| |
| <div class="container-fluid example panel"> |
| <div class="row panel-body"> |
| <div class="col-md-6"> |
| <h5>Request</h5> |
| <pre> |
| GET /v2/glossary/terms/{termGuid}/assignedEntities |
| Content-Type: application/json |
| Accept: application/json |
| |
| <code class="prettyprint language-txt"> |
| ... |
| </code> |
| </pre> |
| </div> |
| <div class="col-md-6"> |
| <h5>Response</h5> |
| <pre> |
| HTTP/1.1 200 OK |
| Content-Type: application/json |
| |
| <code class="prettyprint language-js"> |
| [ { |
| "displayText" : "...", |
| "entityStatus" : "ACTIVE", |
| "qualifiedName" : "...", |
| "relationshipAttributes" : { |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "relationshipGuid" : "...", |
| "relationshipStatus" : "ACTIVE", |
| "relationshipType" : "...", |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| } ] |
| </code> |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_GlossaryREST_assignTermToEntities_POST"> |
| <h3><span class="label label-default resource-method">POST</span> <span class="resource-path">/v2/glossary/terms/{termGuid}/assignedEntities <a href="../v2/glossary/terms/{termGuid}/assignedEntities" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> |
| |
| <p>Assign the given term to the provided list of entity headers</p> |
| |
| <table class="table resource-parameters"> |
| <caption>Request Parameters</caption> |
| <thead> |
| <tr> |
| <th>name</th> |
| <th>type</th> |
| <th>description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="parameter-name">termGuid</span></td> |
| <td>path</td> |
| <td><span class="parameter-description">Glossary term GUID</span></td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table resource-request-body"> |
| <caption>Request Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| <th>description</th> |
| </tr> |
| </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_AtlasRelatedObjectId.html">AtlasRelatedObjectId</a> |
| (JSON)</span></td> |
| <td rowspan="2" class="multi-row-description"><span class="request-description">Related Entity IDs to which the term has to be associated</span></td> |
| </tr> |
| <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_AtlasRelatedObjectId.html">AtlasRelatedObjectId</a> |
| (JSON)</span></td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table resource-response-codes"> |
| <caption>Response Codes</caption> |
| <thead> |
| <tr> |
| <th>code</th> |
| <th>condition</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="label label-success response-code">204</span></td> |
| <td><span class="response-condition">If the term assignment was successful</span></td> |
| </tr> |
| <tr> |
| <td><span class="label label-warning response-code">400</span></td> |
| <td><span class="response-condition">If ANY of the entity header is invalid</span></td> |
| </tr> |
| <tr> |
| <td><span class="label label-warning response-code">404</span></td> |
| <td><span class="response-condition">If glossary guid in invalid</span></td> |
| </tr> |
| </tbody> |
| </table> |
| <h4>Example</h4> |
| |
| <div class="container-fluid example panel"> |
| <div class="row panel-body"> |
| <div class="col-md-6"> |
| <h5>Request</h5> |
| <pre> |
| POST /v2/glossary/terms/{termGuid}/assignedEntities |
| Content-Type: application/json |
| |
| <code class="prettyprint language-js"> |
| [ { |
| "displayText" : "...", |
| "entityStatus" : "ACTIVE", |
| "qualifiedName" : "...", |
| "relationshipAttributes" : { |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "relationshipGuid" : "...", |
| "relationshipStatus" : "DELETED", |
| "relationshipType" : "...", |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| } ] |
| </code> |
| </pre> |
| </div> |
| <div class="col-md-6"> |
| <h5>Response</h5> |
| <pre> |
| HTTP/1.1 204 No Content |
| |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_GlossaryREST_disassociateTermAssignmentFromEntities_PUT"> |
| <h3><span class="label label-default resource-method">PUT</span> <span class="resource-path">/v2/glossary/terms/{termGuid}/assignedEntities <a href="../v2/glossary/terms/{termGuid}/assignedEntities" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> |
| |
| <p>Remove the term assignment for the given list of entity headers</p> |
| |
| <table class="table resource-parameters"> |
| <caption>Request Parameters</caption> |
| <thead> |
| <tr> |
| <th>name</th> |
| <th>type</th> |
| <th>description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="parameter-name">termGuid</span></td> |
| <td>path</td> |
| <td><span class="parameter-description">Glossary term GUID</span></td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table resource-request-body"> |
| <caption>Request Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| <th>description</th> |
| </tr> |
| </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_AtlasRelatedObjectId.html">AtlasRelatedObjectId</a> |
| (JSON)</span></td> |
| <td rowspan="2" class="multi-row-description"><span class="request-description">List of related entity IDs from which the term has to be dissociated</span></td> |
| </tr> |
| <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_AtlasRelatedObjectId.html">AtlasRelatedObjectId</a> |
| (JSON)</span></td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table resource-response-codes"> |
| <caption>Response Codes</caption> |
| <thead> |
| <tr> |
| <th>code</th> |
| <th>condition</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="label label-success response-code">204</span></td> |
| <td><span class="response-condition">If glossary term dissociation was successful</span></td> |
| </tr> |
| <tr> |
| <td><span class="label label-warning response-code">400</span></td> |
| <td><span class="response-condition">If ANY of the entity header is invalid</span></td> |
| </tr> |
| <tr> |
| <td><span class="label label-warning response-code">404</span></td> |
| <td><span class="response-condition">If glossary term guid in invalid</span></td> |
| </tr> |
| </tbody> |
| </table> |
| <h4>Example</h4> |
| |
| <div class="container-fluid example panel"> |
| <div class="row panel-body"> |
| <div class="col-md-6"> |
| <h5>Request</h5> |
| <pre> |
| PUT /v2/glossary/terms/{termGuid}/assignedEntities |
| Content-Type: application/json |
| |
| <code class="prettyprint language-js"> |
| [ { |
| "displayText" : "...", |
| "entityStatus" : "ACTIVE", |
| "qualifiedName" : "...", |
| "relationshipAttributes" : { |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "relationshipGuid" : "...", |
| "relationshipStatus" : "DELETED", |
| "relationshipType" : "...", |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| } ] |
| </code> |
| </pre> |
| </div> |
| <div class="col-md-6"> |
| <h5>Response</h5> |
| <pre> |
| HTTP/1.1 204 No Content |
| |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_GlossaryREST_getRelatedTerms_GET"> |
| <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/v2/glossary/terms/{termGuid}/related <a href="../v2/glossary/terms/{termGuid}/related" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> |
| |
| <p>Get all related terms for a specific term</p> |
| |
| <table class="table resource-parameters"> |
| <caption>Request Parameters</caption> |
| <thead> |
| <tr> |
| <th>name</th> |
| <th>type</th> |
| <th>description</th> |
| <th>default</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="parameter-name">termGuid</span></td> |
| <td>path</td> |
| <td><span class="parameter-description">unique identifier for glossary term</span></td> |
| <td><span class="parameter-default-value"> </span></td> |
| </tr> |
| <tr> |
| <td><span class="parameter-name">limit</span></td> |
| <td>query</td> |
| <td><span class="parameter-description">page size - by default there is no paging</span></td> |
| <td><span class="parameter-default-value">-1</span></td> |
| </tr> |
| <tr> |
| <td><span class="parameter-name">offset</span></td> |
| <td>query</td> |
| <td><span class="parameter-description">offset for pagination purpose</span></td> |
| <td><span class="parameter-default-value">0</span></td> |
| </tr> |
| <tr> |
| <td><span class="parameter-name">sort</span></td> |
| <td>query</td> |
| <td><span class="parameter-description">ASC (default) or DESC</span></td> |
| <td><span class="parameter-default-value">ASC</span></td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table resource-response-codes"> |
| <caption>Response Codes</caption> |
| <thead> |
| <tr> |
| <th>code</th> |
| <th>condition</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="label label-success response-code">200</span></td> |
| <td><span class="response-condition">List of related glossary terms for the given glossary or an empty list</span></td> |
| </tr> |
| <tr> |
| <td><span class="label label-warning response-code">404</span></td> |
| <td><span class="response-condition">If glossary term guid in invalid</span></td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table resource-response-body"> |
| <caption>Response Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| <th>description</th> |
| </tr> |
| </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">map of array of <a href="json_AtlasRelatedTermHeader.html">AtlasRelatedTermHeader</a> |
| (JSON)</span></td> |
| <td rowspan="2" class="multi-row-description"><span class="response-description">List of all related terms</span></td> |
| </tr> |
| <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">map of array of <a href="json_AtlasRelatedTermHeader.html">AtlasRelatedTermHeader</a> |
| (JSON)</span></td> |
| </tr> |
| </tbody> |
| </table> |
| <h4>Example</h4> |
| |
| <div class="container-fluid example panel"> |
| <div class="row panel-body"> |
| <div class="col-md-6"> |
| <h5>Request</h5> |
| <pre> |
| GET /v2/glossary/terms/{termGuid}/related |
| Content-Type: application/json |
| Accept: application/json |
| |
| <code class="prettyprint language-txt"> |
| ... |
| </code> |
| </pre> |
| </div> |
| <div class="col-md-6"> |
| <h5>Response</h5> |
| <pre> |
| HTTP/1.1 200 OK |
| Content-Type: application/json |
| |
| <code class="prettyprint language-js"> |
| [ { |
| "..." : { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } |
| } ] |
| </code> |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_GlossaryREST_getGlossaryCategoriesHeaders_GET"> |
| <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/v2/glossary/{glossaryGuid}/categories/headers <a href="../v2/glossary/{glossaryGuid}/categories/headers" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> |
| |
| <p>Get the categories belonging to a specific glossary</p> |
| |
| <table class="table resource-parameters"> |
| <caption>Request Parameters</caption> |
| <thead> |
| <tr> |
| <th>name</th> |
| <th>type</th> |
| <th>description</th> |
| <th>default</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="parameter-name">glossaryGuid</span></td> |
| <td>path</td> |
| <td><span class="parameter-description">unique identifier for glossary term</span></td> |
| <td><span class="parameter-default-value"> </span></td> |
| </tr> |
| <tr> |
| <td><span class="parameter-name">limit</span></td> |
| <td>query</td> |
| <td><span class="parameter-description">page size - by default there is no paging</span></td> |
| <td><span class="parameter-default-value">-1</span></td> |
| </tr> |
| <tr> |
| <td><span class="parameter-name">offset</span></td> |
| <td>query</td> |
| <td><span class="parameter-description">offset for pagination purpose</span></td> |
| <td><span class="parameter-default-value">0</span></td> |
| </tr> |
| <tr> |
| <td><span class="parameter-name">sort</span></td> |
| <td>query</td> |
| <td><span class="parameter-description">ASC (default) or DESC</span></td> |
| <td><span class="parameter-default-value">ASC</span></td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table resource-response-codes"> |
| <caption>Response Codes</caption> |
| <thead> |
| <tr> |
| <th>code</th> |
| <th>condition</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="label label-success response-code">200</span></td> |
| <td><span class="response-condition">List of glossary categories for the given glossary or an empty list</span></td> |
| </tr> |
| <tr> |
| <td><span class="label label-warning response-code">404</span></td> |
| <td><span class="response-condition">If glossary guid in invalid</span></td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table resource-response-body"> |
| <caption>Response Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| <th>description</th> |
| </tr> |
| </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_AtlasRelatedCategoryHeader.html">AtlasRelatedCategoryHeader</a> |
| (JSON)</span></td> |
| <td rowspan="2" class="multi-row-description"><span class="response-description">List of associated categories</span></td> |
| </tr> |
| <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_AtlasRelatedCategoryHeader.html">AtlasRelatedCategoryHeader</a> |
| (JSON)</span></td> |
| </tr> |
| </tbody> |
| </table> |
| <h4>Example</h4> |
| |
| <div class="container-fluid example panel"> |
| <div class="row panel-body"> |
| <div class="col-md-6"> |
| <h5>Request</h5> |
| <pre> |
| GET /v2/glossary/{glossaryGuid}/categories/headers |
| Content-Type: application/json |
| Accept: application/json |
| |
| <code class="prettyprint language-txt"> |
| ... |
| </code> |
| </pre> |
| </div> |
| <div class="col-md-6"> |
| <h5>Response</h5> |
| <pre> |
| HTTP/1.1 200 OK |
| Content-Type: application/json |
| |
| <code class="prettyprint language-js"> |
| [ { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "parentCategoryGuid" : "...", |
| "relationGuid" : "..." |
| } ] |
| </code> |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_GlossaryREST_getGlossaryTermHeaders_GET"> |
| <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/v2/glossary/{glossaryGuid}/terms/headers <a href="../v2/glossary/{glossaryGuid}/terms/headers" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> |
| |
| <p>Get term headers belonging to a specific glossary</p> |
| |
| <table class="table resource-parameters"> |
| <caption>Request Parameters</caption> |
| <thead> |
| <tr> |
| <th>name</th> |
| <th>type</th> |
| <th>description</th> |
| <th>default</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="parameter-name">glossaryGuid</span></td> |
| <td>path</td> |
| <td><span class="parameter-description">unique identifier for glossary</span></td> |
| <td><span class="parameter-default-value"> </span></td> |
| </tr> |
| <tr> |
| <td><span class="parameter-name">limit</span></td> |
| <td>query</td> |
| <td><span class="parameter-description">page size - by default there is no paging</span></td> |
| <td><span class="parameter-default-value">-1</span></td> |
| </tr> |
| <tr> |
| <td><span class="parameter-name">offset</span></td> |
| <td>query</td> |
| <td><span class="parameter-description">starting offset for loading terms</span></td> |
| <td><span class="parameter-default-value">0</span></td> |
| </tr> |
| <tr> |
| <td><span class="parameter-name">sort</span></td> |
| <td>query</td> |
| <td><span class="parameter-description">ASC(default) or DESC</span></td> |
| <td><span class="parameter-default-value">ASC</span></td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table resource-response-codes"> |
| <caption>Response Codes</caption> |
| <thead> |
| <tr> |
| <th>code</th> |
| <th>condition</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="label label-success response-code">200</span></td> |
| <td><span class="response-condition">List of glossary terms for the given glossary or an empty list</span></td> |
| </tr> |
| <tr> |
| <td><span class="label label-warning response-code">404</span></td> |
| <td><span class="response-condition">If glossary guid in invalid</span></td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table resource-response-body"> |
| <caption>Response Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| <th>description</th> |
| </tr> |
| </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_AtlasRelatedTermHeader.html">AtlasRelatedTermHeader</a> |
| (JSON)</span></td> |
| <td rowspan="2" class="multi-row-description"><span class="response-description">List of terms associated with the glossary</span></td> |
| </tr> |
| <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_AtlasRelatedTermHeader.html">AtlasRelatedTermHeader</a> |
| (JSON)</span></td> |
| </tr> |
| </tbody> |
| </table> |
| <h4>Example</h4> |
| |
| <div class="container-fluid example panel"> |
| <div class="row panel-body"> |
| <div class="col-md-6"> |
| <h5>Request</h5> |
| <pre> |
| GET /v2/glossary/{glossaryGuid}/terms/headers |
| Content-Type: application/json |
| Accept: application/json |
| |
| <code class="prettyprint language-txt"> |
| ... |
| </code> |
| </pre> |
| </div> |
| <div class="col-md-6"> |
| <h5>Response</h5> |
| <pre> |
| HTTP/1.1 200 OK |
| Content-Type: application/json |
| |
| <code class="prettyprint language-js"> |
| [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ] |
| </code> |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <footer class="footer"> |
| <div class="container"> |
| <p class="text-muted">Generated by <a href="http://enunciate.webcohesion.com">Enunciate</a>.</p> |
| </div> |
| </footer> |
| |
| </div> |
| </div> |
| </div> |
| |
| |
| <!-- JavaScript placed at the end of the document so the pages load faster. --> |
| <script src="https://code.jquery.com/jquery-1.12.2.min.js"></script> |
| |
| <!-- Bootstrap core JavaScript |
| ================================================== --> |
| <script src="https://stackpath.bootstrapcdn.com/bootstrap/3.4.1/js/bootstrap.min.js"></script> |
| |
| <!-- prettify code blocks. see http://code.google.com/p/google-code-prettify/ --> |
| <script src="https://cdn.jsdelivr.net/gh/google/code-prettify@master/loader/run_prettify.js" type="text/javascript"></script> |
| <script> |
| $(function() { |
| $(".clickable-row").click(function() { |
| window.document.location = $(this).data("href"); |
| }); |
| |
| $('[data-toggle="tooltip"]').tooltip() |
| }); |
| </script> |
| |
| </body> |
| </html> |
