| <!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: AtlasGlossaryTerm</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: AtlasGlossaryTerm</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 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="syntax_json.html">JSON</a></li> |
| <li class="dropdown"><a href="json_AtlasGlossaryTerm.html">AtlasGlossaryTerm</a></li> |
| </ol> |
| |
| <h1 class="page-header">AtlasGlossaryTerm <small>Data Type</small></h1> |
| |
| <p></p> |
| |
| <dl class="dl-horizontal"> |
| </dl> |
| |
| <table class="table datatype-properties"> |
| <caption>Properties</caption> |
| <thead> |
| <tr> |
| <th>name</th> |
| <th>data type</th> |
| <th>description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td> <span id="prop-abbreviation" class="property-name">abbreviation</span> |
| </td> |
| <td> <span class="datatype-reference">string |
| </span> |
| </td> |
| <td> <span class="property-description"></span> |
| </td> |
| </tr> |
| <tr> |
| <td> <span id="prop-anchor" class="property-name">anchor</span> |
| </td> |
| <td> <span class="datatype-reference"><a href="json_AtlasGlossaryHeader.html">AtlasGlossaryHeader</a> |
| </span> |
| </td> |
| <td> <span class="property-description"></span> |
| </td> |
| </tr> |
| <tr> |
| <td> <span id="prop-antonyms" class="property-name">antonyms</span> |
| </td> |
| <td> <span class="datatype-reference">array of <a href="json_AtlasRelatedTermHeader.html">AtlasRelatedTermHeader</a> |
| </span> |
| </td> |
| <td> <span class="property-description"></span> |
| </td> |
| </tr> |
| <tr> |
| <td> <span id="prop-assignedEntities" class="property-name">assignedEntities</span> |
| </td> |
| <td> <span class="datatype-reference">array of <a href="json_AtlasRelatedObjectId.html">AtlasRelatedObjectId</a> |
| </span> |
| </td> |
| <td> <span class="property-description"></span> |
| </td> |
| </tr> |
| <tr> |
| <td> <span id="prop-categories" class="property-name">categories</span> |
| </td> |
| <td> <span class="datatype-reference">array of <a href="json_AtlasTermCategorizationHeader.html">AtlasTermCategorizationHeader</a> |
| </span> |
| </td> |
| <td> <span class="property-description"></span> |
| </td> |
| </tr> |
| <tr> |
| <td> <span id="prop-classifies" class="property-name">classifies</span> |
| </td> |
| <td> <span class="datatype-reference">array of <a href="json_AtlasRelatedTermHeader.html">AtlasRelatedTermHeader</a> |
| </span> |
| </td> |
| <td> <span class="property-description"></span> |
| </td> |
| </tr> |
| <tr> |
| <td> <span id="prop-examples" class="property-name">examples</span> |
| </td> |
| <td> <span class="datatype-reference">array of string |
| </span> |
| </td> |
| <td> <span class="property-description"></span> |
| </td> |
| </tr> |
| <tr> |
| <td> <span id="prop-glossaryTermHeader" class="property-name">glossaryTermHeader</span> |
| </td> |
| <td> <span class="datatype-reference"><a href="json_AtlasGlossaryTermHeader.html">AtlasGlossaryTermHeader</a> |
| </span> |
| </td> |
| <td> <span class="property-description"></span> |
| </td> |
| </tr> |
| <tr> |
| <td> <span id="prop-isA" class="property-name">isA</span> |
| </td> |
| <td> <span class="datatype-reference">array of <a href="json_AtlasRelatedTermHeader.html">AtlasRelatedTermHeader</a> |
| </span> |
| </td> |
| <td> <span class="property-description"></span> |
| </td> |
| </tr> |
| <tr> |
| <td> <span id="prop-preferredTerms" class="property-name">preferredTerms</span> |
| </td> |
| <td> <span class="datatype-reference">array of <a href="json_AtlasRelatedTermHeader.html">AtlasRelatedTermHeader</a> |
| </span> |
| </td> |
| <td> <span class="property-description"></span> |
| </td> |
| </tr> |
| <tr> |
| <td> <span id="prop-preferredToTerms" class="property-name">preferredToTerms</span> |
| </td> |
| <td> <span class="datatype-reference">array of <a href="json_AtlasRelatedTermHeader.html">AtlasRelatedTermHeader</a> |
| </span> |
| </td> |
| <td> <span class="property-description"></span> |
| </td> |
| </tr> |
| <tr> |
| <td> <span id="prop-replacedBy" class="property-name">replacedBy</span> |
| </td> |
| <td> <span class="datatype-reference">array of <a href="json_AtlasRelatedTermHeader.html">AtlasRelatedTermHeader</a> |
| </span> |
| </td> |
| <td> <span class="property-description"></span> |
| </td> |
| </tr> |
| <tr> |
| <td> <span id="prop-replacementTerms" class="property-name">replacementTerms</span> |
| </td> |
| <td> <span class="datatype-reference">array of <a href="json_AtlasRelatedTermHeader.html">AtlasRelatedTermHeader</a> |
| </span> |
| </td> |
| <td> <span class="property-description"></span> |
| </td> |
| </tr> |
| <tr> |
| <td> <span id="prop-seeAlso" class="property-name">seeAlso</span> |
| </td> |
| <td> <span class="datatype-reference">array of <a href="json_AtlasRelatedTermHeader.html">AtlasRelatedTermHeader</a> |
| </span> |
| </td> |
| <td> <span class="property-description"></span> |
| </td> |
| </tr> |
| <tr> |
| <td> <span id="prop-synonyms" class="property-name">synonyms</span> |
| </td> |
| <td> <span class="datatype-reference">array of <a href="json_AtlasRelatedTermHeader.html">AtlasRelatedTermHeader</a> |
| </span> |
| </td> |
| <td> <span class="property-description"></span> |
| </td> |
| </tr> |
| <tr> |
| <td> <span id="prop-translatedTerms" class="property-name">translatedTerms</span> |
| </td> |
| <td> <span class="datatype-reference">array of <a href="json_AtlasRelatedTermHeader.html">AtlasRelatedTermHeader</a> |
| </span> |
| </td> |
| <td> <span class="property-description"></span> |
| </td> |
| </tr> |
| <tr> |
| <td> <span id="prop-translationTerms" class="property-name">translationTerms</span> |
| </td> |
| <td> <span class="datatype-reference">array of <a href="json_AtlasRelatedTermHeader.html">AtlasRelatedTermHeader</a> |
| </span> |
| </td> |
| <td> <span class="property-description"></span> |
| </td> |
| </tr> |
| <tr> |
| <td> <span id="prop-usage" class="property-name">usage</span> |
| </td> |
| <td> <span class="datatype-reference">string |
| </span> |
| </td> |
| <td> <span class="property-description"></span> |
| </td> |
| </tr> |
| <tr> |
| <td> <span id="prop-validValues" class="property-name">validValues</span> |
| </td> |
| <td> <span class="datatype-reference">array of <a href="json_AtlasRelatedTermHeader.html">AtlasRelatedTermHeader</a> |
| </span> |
| </td> |
| <td> <span class="property-description"></span> |
| </td> |
| </tr> |
| <tr> |
| <td> <span id="prop-validValuesFor" class="property-name">validValuesFor</span> |
| </td> |
| <td> <span class="datatype-reference">array of <a href="json_AtlasRelatedTermHeader.html">AtlasRelatedTermHeader</a> |
| </span> |
| </td> |
| <td> <span class="property-description"></span> |
| </td> |
| </tr> |
| </tbody> |
| <tr> |
| <td colspan="3"><h5 class="text-muted">Properties inherited from <a href="json_AtlasGlossaryBaseObject.html">AtlasGlossaryBaseObject</a></h5></td> |
| </tr> |
| <tbody> |
| <tr> |
| <td><span class="property-name">additionalAttributes</span></td> |
| <td><span class="datatype-reference">map of object |
| </span></td> |
| <td><span class="property-description"></span></td> |
| </tr> |
| <tr> |
| <td><span class="property-name">classifications</span></td> |
| <td><span class="datatype-reference">array of <a href="json_AtlasClassification.html">AtlasClassification</a> |
| </span></td> |
| <td><span class="property-description"></span></td> |
| </tr> |
| <tr> |
| <td><span class="property-name">longDescription</span></td> |
| <td><span class="datatype-reference">string |
| </span></td> |
| <td><span class="property-description"></span></td> |
| </tr> |
| <tr> |
| <td><span class="property-name">name</span></td> |
| <td><span class="datatype-reference">string |
| </span></td> |
| <td><span class="property-description"></span></td> |
| </tr> |
| <tr> |
| <td><span class="property-name">qualifiedName</span></td> |
| <td><span class="datatype-reference">string |
| </span></td> |
| <td><span class="property-description"></span></td> |
| </tr> |
| <tr> |
| <td><span class="property-name">shortDescription</span></td> |
| <td><span class="datatype-reference">string |
| </span></td> |
| <td><span class="property-description"></span></td> |
| </tr> |
| </tbody> |
| <tr> |
| <td colspan="3"><h5 class="text-muted">Properties inherited from <a href="json_AtlasBaseModelObject.html">AtlasBaseModelObject</a></h5></td> |
| </tr> |
| <tbody> |
| <tr> |
| <td><span class="property-name">guid</span></td> |
| <td><span class="datatype-reference">string |
| </span></td> |
| <td><span class="property-description"></span></td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <p class="lead">Example</p> |
| |
| <pre class="prettyprint language-js example">{ |
| "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" : "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" : "DRAFT" |
| }, { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "relationGuid" : "...", |
| "status" : "DEPRECATED" |
| } ], |
| "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" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "preferredTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "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" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "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" : "ACTIVE", |
| "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" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "translatedTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "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" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "usage" : "...", |
| "validValues" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "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" : "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" : "..." |
| }</pre> |
| |
| <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> |
