http://git-wip-us.apache.org/repos/asf/atlas-website/blob/3fad5df3/1.1.0/api/v2/json_AtlasEntityDef.html ---------------------------------------------------------------------- diff --git a/1.1.0/api/v2/json_AtlasEntityDef.html b/1.1.0/api/v2/json_AtlasEntityDef.html index 98ddd09..59ba2eb 100644 --- a/1.1.0/api/v2/json_AtlasEntityDef.html +++ b/1.1.0/api/v2/json_AtlasEntityDef.html @@ -15,7 +15,7 @@ <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/css/bootstrap.min.css"> <!--custom css for these pages--> - <link rel="stylesheet" href="css/style.css"> + <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]> @@ -79,7 +79,16 @@ </thead> <tbody> <tr> - <td> <span class="property-name">superTypes</span> + <td> <span id="prop-subTypes" class="property-name">subTypes</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-superTypes" class="property-name">superTypes</span> </td> <td> <span class="datatype-reference">array of string </span> @@ -110,8 +119,8 @@ <td><span class="property-description"></span></td> </tr> <tr> - <td><span class="property-name">guid</span></td> - <td><span class="datatype-reference">string + <td><span class="property-name">createTime</span></td> + <td><span class="datatype-reference">number </span></td> <td><span class="property-description"></span></td> </tr> @@ -122,50 +131,56 @@ <td><span class="property-description"></span></td> </tr> <tr> - <td><span class="property-name">updatedBy</span></td> + <td><span class="property-name">dateFormatter</span></td> + <td><span class="datatype-reference"><a href="json_DateFormat.html">DateFormat</a> +</span></td> + <td><span class="property-description"></span></td> + </tr> + <tr> + <td><span class="property-name">description</span></td> <td><span class="datatype-reference">string </span></td> <td><span class="property-description"></span></td> </tr> <tr> - <td><span class="property-name">createTime</span></td> - <td><span class="datatype-reference">number + <td><span class="property-name">guid</span></td> + <td><span class="datatype-reference">string </span></td> <td><span class="property-description"></span></td> </tr> <tr> - <td><span class="property-name">updateTime</span></td> - <td><span class="datatype-reference">number + <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">version</span></td> - <td><span class="datatype-reference">number + <td><span class="property-name">options</span></td> + <td><span class="datatype-reference">map of string </span></td> <td><span class="property-description"></span></td> </tr> <tr> - <td><span class="property-name">name</span></td> + <td><span class="property-name">typeVersion</span></td> <td><span class="datatype-reference">string </span></td> <td><span class="property-description"></span></td> </tr> <tr> - <td><span class="property-name">description</span></td> - <td><span class="datatype-reference">string + <td><span class="property-name">updateTime</span></td> + <td><span class="datatype-reference">number </span></td> <td><span class="property-description"></span></td> </tr> <tr> - <td><span class="property-name">typeVersion</span></td> + <td><span class="property-name">updatedBy</span></td> <td><span class="datatype-reference">string </span></td> <td><span class="property-description"></span></td> </tr> <tr> - <td><span class="property-name">options</span></td> - <td><span class="datatype-reference">map of string + <td><span class="property-name">version</span></td> + <td><span class="datatype-reference">number </span></td> <td><span class="property-description"></span></td> </tr> @@ -175,68 +190,114 @@ <p class="lead">Example</p> <pre class="prettyprint language-js example">{ + "subTypes" : [ "...", "..." ], "superTypes" : [ "...", "..." ], "attributeDefs" : [ { - "name" : "...", - "typeName" : "...", - "isOptional" : true, "cardinality" : "SET", - "valuesMinCount" : 12345, - "valuesMaxCount" : 12345, - "isUnique" : true, - "isIndexable" : true, - "defaultValue" : "...", "constraints" : [ { - "type" : "...", "params" : { "property1" : { }, "property2" : { } - } + }, + "type" : "..." }, { - "type" : "...", "params" : { "property1" : { }, "property2" : { } - } - } ] - }, { + }, + "type" : "..." + } ], + "defaultValue" : "...", + "description" : "...", + "includeInNotification" : true, + "isIndexable" : true, + "isOptional" : true, + "isUnique" : true, "name" : "...", + "options" : { + "property1" : "...", + "property2" : "..." + }, "typeName" : "...", - "isOptional" : true, - "cardinality" : "SET", - "valuesMinCount" : 12345, "valuesMaxCount" : 12345, - "isUnique" : true, - "isIndexable" : true, - "defaultValue" : "...", + "valuesMinCount" : 12345 + }, { + "cardinality" : "SINGLE", "constraints" : [ { - "type" : "...", "params" : { "property1" : { }, "property2" : { } - } + }, + "type" : "..." }, { - "type" : "...", "params" : { "property1" : { }, "property2" : { } - } - } ] + }, + "type" : "..." + } ], + "defaultValue" : "...", + "description" : "...", + "includeInNotification" : true, + "isIndexable" : true, + "isOptional" : true, + "isUnique" : true, + "name" : "...", + "options" : { + "property1" : "...", + "property2" : "..." + }, + "typeName" : "...", + "valuesMaxCount" : 12345, + "valuesMinCount" : 12345 } ], - "category" : "ARRAY", - "guid" : "...", - "createdBy" : "...", - "updatedBy" : "...", + "category" : "RELATIONSHIP", "createTime" : 12345, - "updateTime" : 12345, - "version" : 12345, - "name" : "...", + "createdBy" : "...", + "dateFormatter" : { + "availableLocales" : [ "...", "..." ], + "calendar" : 12345, + "dateInstance" : { }, + "dateTimeInstance" : { }, + "instance" : { }, + "lenient" : true, + "numberFormat" : { + "availableLocales" : [ "...", "..." ], + "currency" : "...", + "currencyInstance" : { }, + "groupingUsed" : true, + "instance" : { }, + "integerInstance" : { }, + "maximumFractionDigits" : 12345, + "maximumIntegerDigits" : 12345, + "minimumFractionDigits" : 12345, + "minimumIntegerDigits" : 12345, + "numberInstance" : { }, + "parseIntegerOnly" : true, + "percentInstance" : { }, + "roundingMode" : "HALF_DOWN" + }, + "timeInstance" : { }, + "timeZone" : { + "DSTSavings" : 12345, + "ID" : "...", + "availableIDs" : [ "...", "..." ], + "default" : { }, + "displayName" : "...", + "rawOffset" : 12345 + } + }, "description" : "...", - "typeVersion" : "...", + "guid" : "...", + "name" : "...", "options" : { "property1" : "...", "property2" : "..." - } + }, + "typeVersion" : "...", + "updateTime" : 12345, + "updatedBy" : "...", + "version" : 12345 }</pre> <footer class="footer">
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/3fad5df3/1.1.0/api/v2/json_AtlasEntityExtInfo.html ---------------------------------------------------------------------- diff --git a/1.1.0/api/v2/json_AtlasEntityExtInfo.html b/1.1.0/api/v2/json_AtlasEntityExtInfo.html index 218f53a..24735f7 100644 --- a/1.1.0/api/v2/json_AtlasEntityExtInfo.html +++ b/1.1.0/api/v2/json_AtlasEntityExtInfo.html @@ -15,7 +15,7 @@ <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/css/bootstrap.min.css"> <!--custom css for these pages--> - <link rel="stylesheet" href="css/style.css"> + <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]> @@ -81,7 +81,7 @@ </thead> <tbody> <tr> - <td> <span class="property-name">referredEntities</span> + <td> <span id="prop-referredEntities" class="property-name">referredEntities</span> </td> <td> <span class="datatype-reference">map of <a href="json_AtlasEntity.html">AtlasEntity</a> </span> @@ -97,66 +97,136 @@ <pre class="prettyprint language-js example">{ "referredEntities" : { "property1" : { - "guid" : "...", - "status" : "ACTIVE", - "createdBy" : "...", - "updatedBy" : "...", - "createTime" : 12345, - "updateTime" : 12345, - "version" : 12345, - "relationshipAttributes" : { - "property1" : { }, - "property2" : { } - }, "classifications" : [ { - "typeName" : "...", + "entityGuid" : "...", + "entityStatus" : "DELETED", + "propagate" : true, + "removePropagationsOnEntityDelete" : true, + "validityPeriods" : [ { }, { } ], "attributes" : { "property1" : { }, "property2" : { } - } + }, + "typeName" : "..." }, { - "typeName" : "...", + "entityGuid" : "...", + "entityStatus" : "DELETED", + "propagate" : true, + "removePropagationsOnEntityDelete" : true, + "validityPeriods" : [ { }, { } ], "attributes" : { "property1" : { }, "property2" : { } - } + }, + "typeName" : "..." } ], - "typeName" : "...", - "attributes" : { + "createTime" : 12345, + "createdBy" : "...", + "guid" : "...", + "homeId" : "...", + "meanings" : [ { + "confidence" : 12345, + "createdBy" : "...", + "description" : "...", + "displayText" : "...", + "expression" : "...", + "relationGuid" : "...", + "source" : "...", + "status" : "IMPORTED", + "steward" : "...", + "termGuid" : "..." + }, { + "confidence" : 12345, + "createdBy" : "...", + "description" : "...", + "displayText" : "...", + "expression" : "...", + "relationGuid" : "...", + "source" : "...", + "status" : "OBSOLETE", + "steward" : "...", + "termGuid" : "..." + } ], + "proxy" : true, + "relationshipAttributes" : { "property1" : { }, "property2" : { } - } - }, - "property2" : { - "guid" : "...", + }, "status" : "ACTIVE", - "createdBy" : "...", - "updatedBy" : "...", - "createTime" : 12345, "updateTime" : 12345, + "updatedBy" : "...", "version" : 12345, - "relationshipAttributes" : { + "attributes" : { "property1" : { }, "property2" : { } }, + "typeName" : "..." + }, + "property2" : { "classifications" : [ { - "typeName" : "...", + "entityGuid" : "...", + "entityStatus" : "DELETED", + "propagate" : true, + "removePropagationsOnEntityDelete" : true, + "validityPeriods" : [ { }, { } ], "attributes" : { "property1" : { }, "property2" : { } - } + }, + "typeName" : "..." }, { - "typeName" : "...", + "entityGuid" : "...", + "entityStatus" : "ACTIVE", + "propagate" : true, + "removePropagationsOnEntityDelete" : true, + "validityPeriods" : [ { }, { } ], "attributes" : { "property1" : { }, "property2" : { } - } + }, + "typeName" : "..." + } ], + "createTime" : 12345, + "createdBy" : "...", + "guid" : "...", + "homeId" : "...", + "meanings" : [ { + "confidence" : 12345, + "createdBy" : "...", + "description" : "...", + "displayText" : "...", + "expression" : "...", + "relationGuid" : "...", + "source" : "...", + "status" : "VALIDATED", + "steward" : "...", + "termGuid" : "..." + }, { + "confidence" : 12345, + "createdBy" : "...", + "description" : "...", + "displayText" : "...", + "expression" : "...", + "relationGuid" : "...", + "source" : "...", + "status" : "DISCOVERED", + "steward" : "...", + "termGuid" : "..." } ], - "typeName" : "...", + "proxy" : true, + "relationshipAttributes" : { + "property1" : { }, + "property2" : { } + }, + "status" : "ACTIVE", + "updateTime" : 12345, + "updatedBy" : "...", + "version" : 12345, "attributes" : { "property1" : { }, "property2" : { } - } + }, + "typeName" : "..." } } }</pre> http://git-wip-us.apache.org/repos/asf/atlas-website/blob/3fad5df3/1.1.0/api/v2/json_AtlasEntityHeader.html ---------------------------------------------------------------------- diff --git a/1.1.0/api/v2/json_AtlasEntityHeader.html b/1.1.0/api/v2/json_AtlasEntityHeader.html index b255a32..992b29c 100644 --- a/1.1.0/api/v2/json_AtlasEntityHeader.html +++ b/1.1.0/api/v2/json_AtlasEntityHeader.html @@ -15,7 +15,7 @@ <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/css/bootstrap.min.css"> <!--custom css for these pages--> - <link rel="stylesheet" href="css/style.css"> + <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]> @@ -79,25 +79,25 @@ </thead> <tbody> <tr> - <td> <span class="property-name">guid</span> + <td> <span id="prop-classificationNames" class="property-name">classificationNames</span> </td> - <td> <span class="datatype-reference">string + <td> <span class="datatype-reference">array of string </span> </td> <td> <span class="property-description"></span> </td> </tr> <tr> - <td> <span class="property-name">status</span> + <td> <span id="prop-classifications" class="property-name">classifications</span> </td> - <td> <span class="datatype-reference"><a href="json_Status.html">Status</a> + <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">displayText</span> + <td> <span id="prop-displayText" class="property-name">displayText</span> </td> <td> <span class="datatype-reference">string </span> @@ -106,7 +106,16 @@ </td> </tr> <tr> - <td> <span class="property-name">classificationNames</span> + <td> <span id="prop-guid" class="property-name">guid</span> +</td> + <td> <span class="datatype-reference">string +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span id="prop-meaningNames" class="property-name">meaningNames</span> </td> <td> <span class="datatype-reference">array of string </span> @@ -114,20 +123,38 @@ <td> <span class="property-description"></span> </td> </tr> + <tr> + <td> <span id="prop-meanings" class="property-name">meanings</span> +</td> + <td> <span class="datatype-reference">array of <a href="json_AtlasTermAssignmentHeader.html">AtlasTermAssignmentHeader</a> +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span id="prop-status" class="property-name">status</span> +</td> + <td> <span class="datatype-reference"><a href="json_Status.html">Status</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_AtlasStruct.html">AtlasStruct</a></h5></td> </tr> <tbody> <tr> - <td><span class="property-name">typeName</span></td> - <td><span class="datatype-reference">string + <td><span class="property-name">attributes</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">attributes</span></td> - <td><span class="datatype-reference">map of object + <td><span class="property-name">typeName</span></td> + <td><span class="datatype-reference">string </span></td> <td><span class="property-description"></span></td> </tr> @@ -137,15 +164,78 @@ <p class="lead">Example</p> <pre class="prettyprint language-js example">{ + "classificationNames" : [ "...", "..." ], + "classifications" : [ { + "entityGuid" : "...", + "entityStatus" : "ACTIVE", + "propagate" : true, + "removePropagationsOnEntityDelete" : true, + "validityPeriods" : [ { + "endTime" : "...", + "startTime" : "...", + "timeZone" : "..." + }, { + "endTime" : "...", + "startTime" : "...", + "timeZone" : "..." + } ], + "attributes" : { + "property1" : { }, + "property2" : { } + }, + "typeName" : "..." + }, { + "entityGuid" : "...", + "entityStatus" : "ACTIVE", + "propagate" : true, + "removePropagationsOnEntityDelete" : true, + "validityPeriods" : [ { + "endTime" : "...", + "startTime" : "...", + "timeZone" : "..." + }, { + "endTime" : "...", + "startTime" : "...", + "timeZone" : "..." + } ], + "attributes" : { + "property1" : { }, + "property2" : { } + }, + "typeName" : "..." + } ], + "displayText" : "...", "guid" : "...", + "meaningNames" : [ "...", "..." ], + "meanings" : [ { + "confidence" : 12345, + "createdBy" : "...", + "description" : "...", + "displayText" : "...", + "expression" : "...", + "relationGuid" : "...", + "source" : "...", + "status" : "VALIDATED", + "steward" : "...", + "termGuid" : "..." + }, { + "confidence" : 12345, + "createdBy" : "...", + "description" : "...", + "displayText" : "...", + "expression" : "...", + "relationGuid" : "...", + "source" : "...", + "status" : "OBSOLETE", + "steward" : "...", + "termGuid" : "..." + } ], "status" : "DELETED", - "displayText" : "...", - "classificationNames" : [ "...", "..." ], - "typeName" : "...", "attributes" : { "property1" : { }, "property2" : { } - } + }, + "typeName" : "..." }</pre> <footer class="footer"> http://git-wip-us.apache.org/repos/asf/atlas-website/blob/3fad5df3/1.1.0/api/v2/json_AtlasEntityWithExtInfo.html ---------------------------------------------------------------------- diff --git a/1.1.0/api/v2/json_AtlasEntityWithExtInfo.html b/1.1.0/api/v2/json_AtlasEntityWithExtInfo.html index 688b940..e048cee 100644 --- a/1.1.0/api/v2/json_AtlasEntityWithExtInfo.html +++ b/1.1.0/api/v2/json_AtlasEntityWithExtInfo.html @@ -15,7 +15,7 @@ <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/css/bootstrap.min.css"> <!--custom css for these pages--> - <link rel="stylesheet" href="css/style.css"> + <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]> @@ -79,7 +79,7 @@ </thead> <tbody> <tr> - <td> <span class="property-name">entity</span> + <td> <span id="prop-entity" class="property-name">entity</span> </td> <td> <span class="datatype-reference"><a href="json_AtlasEntity.html">AtlasEntity</a> </span> @@ -105,98 +105,203 @@ <pre class="prettyprint language-js example">{ "entity" : { - "guid" : "...", - "status" : "DELETED", - "createdBy" : "...", - "updatedBy" : "...", - "createTime" : 12345, - "updateTime" : 12345, - "version" : 12345, - "relationshipAttributes" : { - "property1" : { }, - "property2" : { } - }, "classifications" : [ { - "typeName" : "...", + "entityGuid" : "...", + "entityStatus" : "DELETED", + "propagate" : true, + "removePropagationsOnEntityDelete" : true, + "validityPeriods" : [ { }, { } ], "attributes" : { "property1" : { }, "property2" : { } - } + }, + "typeName" : "..." }, { - "typeName" : "...", + "entityGuid" : "...", + "entityStatus" : "ACTIVE", + "propagate" : true, + "removePropagationsOnEntityDelete" : true, + "validityPeriods" : [ { }, { } ], "attributes" : { "property1" : { }, "property2" : { } - } + }, + "typeName" : "..." + } ], + "createTime" : 12345, + "createdBy" : "...", + "guid" : "...", + "homeId" : "...", + "meanings" : [ { + "confidence" : 12345, + "createdBy" : "...", + "description" : "...", + "displayText" : "...", + "expression" : "...", + "relationGuid" : "...", + "source" : "...", + "status" : "OTHER", + "steward" : "...", + "termGuid" : "..." + }, { + "confidence" : 12345, + "createdBy" : "...", + "description" : "...", + "displayText" : "...", + "expression" : "...", + "relationGuid" : "...", + "source" : "...", + "status" : "PROPOSED", + "steward" : "...", + "termGuid" : "..." } ], - "typeName" : "...", + "proxy" : true, + "relationshipAttributes" : { + "property1" : { }, + "property2" : { } + }, + "status" : "ACTIVE", + "updateTime" : 12345, + "updatedBy" : "...", + "version" : 12345, "attributes" : { "property1" : { }, "property2" : { } - } + }, + "typeName" : "..." }, "referredEntities" : { "property1" : { - "guid" : "...", - "status" : "ACTIVE", - "createdBy" : "...", - "updatedBy" : "...", - "createTime" : 12345, - "updateTime" : 12345, - "version" : 12345, - "relationshipAttributes" : { - "property1" : { }, - "property2" : { } - }, "classifications" : [ { - "typeName" : "...", + "entityGuid" : "...", + "entityStatus" : "ACTIVE", + "propagate" : true, + "removePropagationsOnEntityDelete" : true, + "validityPeriods" : [ { }, { } ], "attributes" : { "property1" : { }, "property2" : { } - } + }, + "typeName" : "..." }, { - "typeName" : "...", + "entityGuid" : "...", + "entityStatus" : "ACTIVE", + "propagate" : true, + "removePropagationsOnEntityDelete" : true, + "validityPeriods" : [ { }, { } ], "attributes" : { "property1" : { }, "property2" : { } - } + }, + "typeName" : "..." } ], - "typeName" : "...", - "attributes" : { + "createTime" : 12345, + "createdBy" : "...", + "guid" : "...", + "homeId" : "...", + "meanings" : [ { + "confidence" : 12345, + "createdBy" : "...", + "description" : "...", + "displayText" : "...", + "expression" : "...", + "relationGuid" : "...", + "source" : "...", + "status" : "DISCOVERED", + "steward" : "...", + "termGuid" : "..." + }, { + "confidence" : 12345, + "createdBy" : "...", + "description" : "...", + "displayText" : "...", + "expression" : "...", + "relationGuid" : "...", + "source" : "...", + "status" : "IMPORTED", + "steward" : "...", + "termGuid" : "..." + } ], + "proxy" : true, + "relationshipAttributes" : { "property1" : { }, "property2" : { } - } - }, - "property2" : { - "guid" : "...", + }, "status" : "ACTIVE", - "createdBy" : "...", - "updatedBy" : "...", - "createTime" : 12345, "updateTime" : 12345, + "updatedBy" : "...", "version" : 12345, - "relationshipAttributes" : { + "attributes" : { "property1" : { }, "property2" : { } }, + "typeName" : "..." + }, + "property2" : { "classifications" : [ { - "typeName" : "...", + "entityGuid" : "...", + "entityStatus" : "DELETED", + "propagate" : true, + "removePropagationsOnEntityDelete" : true, + "validityPeriods" : [ { }, { } ], "attributes" : { "property1" : { }, "property2" : { } - } + }, + "typeName" : "..." }, { - "typeName" : "...", + "entityGuid" : "...", + "entityStatus" : "DELETED", + "propagate" : true, + "removePropagationsOnEntityDelete" : true, + "validityPeriods" : [ { }, { } ], "attributes" : { "property1" : { }, "property2" : { } - } + }, + "typeName" : "..." + } ], + "createTime" : 12345, + "createdBy" : "...", + "guid" : "...", + "homeId" : "...", + "meanings" : [ { + "confidence" : 12345, + "createdBy" : "...", + "description" : "...", + "displayText" : "...", + "expression" : "...", + "relationGuid" : "...", + "source" : "...", + "status" : "OTHER", + "steward" : "...", + "termGuid" : "..." + }, { + "confidence" : 12345, + "createdBy" : "...", + "description" : "...", + "displayText" : "...", + "expression" : "...", + "relationGuid" : "...", + "source" : "...", + "status" : "OTHER", + "steward" : "...", + "termGuid" : "..." } ], - "typeName" : "...", + "proxy" : true, + "relationshipAttributes" : { + "property1" : { }, + "property2" : { } + }, + "status" : "ACTIVE", + "updateTime" : 12345, + "updatedBy" : "...", + "version" : 12345, "attributes" : { "property1" : { }, "property2" : { } - } + }, + "typeName" : "..." } } }</pre> http://git-wip-us.apache.org/repos/asf/atlas-website/blob/3fad5df3/1.1.0/api/v2/json_AtlasEnumDef.html ---------------------------------------------------------------------- diff --git a/1.1.0/api/v2/json_AtlasEnumDef.html b/1.1.0/api/v2/json_AtlasEnumDef.html index af3de9f..3b3d883 100644 --- a/1.1.0/api/v2/json_AtlasEnumDef.html +++ b/1.1.0/api/v2/json_AtlasEnumDef.html @@ -15,7 +15,7 @@ <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/css/bootstrap.min.css"> <!--custom css for these pages--> - <link rel="stylesheet" href="css/style.css"> + <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]> @@ -79,18 +79,18 @@ </thead> <tbody> <tr> - <td> <span class="property-name">elementDefs</span> + <td> <span id="prop-defaultValue" class="property-name">defaultValue</span> </td> - <td> <span class="datatype-reference">array of <a href="json_AtlasEnumElementDef.html">AtlasEnumElementDef</a> + <td> <span class="datatype-reference">string </span> </td> <td> <span class="property-description"></span> </td> </tr> <tr> - <td> <span class="property-name">defaultValue</span> + <td> <span id="prop-elementDefs" class="property-name">elementDefs</span> </td> - <td> <span class="datatype-reference">string + <td> <span class="datatype-reference">array of <a href="json_AtlasEnumElementDef.html">AtlasEnumElementDef</a> </span> </td> <td> <span class="property-description"></span> @@ -108,8 +108,8 @@ <td><span class="property-description"></span></td> </tr> <tr> - <td><span class="property-name">guid</span></td> - <td><span class="datatype-reference">string + <td><span class="property-name">createTime</span></td> + <td><span class="datatype-reference">number </span></td> <td><span class="property-description"></span></td> </tr> @@ -120,50 +120,56 @@ <td><span class="property-description"></span></td> </tr> <tr> - <td><span class="property-name">updatedBy</span></td> + <td><span class="property-name">dateFormatter</span></td> + <td><span class="datatype-reference"><a href="json_DateFormat.html">DateFormat</a> +</span></td> + <td><span class="property-description"></span></td> + </tr> + <tr> + <td><span class="property-name">description</span></td> <td><span class="datatype-reference">string </span></td> <td><span class="property-description"></span></td> </tr> <tr> - <td><span class="property-name">createTime</span></td> - <td><span class="datatype-reference">number + <td><span class="property-name">guid</span></td> + <td><span class="datatype-reference">string </span></td> <td><span class="property-description"></span></td> </tr> <tr> - <td><span class="property-name">updateTime</span></td> - <td><span class="datatype-reference">number + <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">version</span></td> - <td><span class="datatype-reference">number + <td><span class="property-name">options</span></td> + <td><span class="datatype-reference">map of string </span></td> <td><span class="property-description"></span></td> </tr> <tr> - <td><span class="property-name">name</span></td> + <td><span class="property-name">typeVersion</span></td> <td><span class="datatype-reference">string </span></td> <td><span class="property-description"></span></td> </tr> <tr> - <td><span class="property-name">description</span></td> - <td><span class="datatype-reference">string + <td><span class="property-name">updateTime</span></td> + <td><span class="datatype-reference">number </span></td> <td><span class="property-description"></span></td> </tr> <tr> - <td><span class="property-name">typeVersion</span></td> + <td><span class="property-name">updatedBy</span></td> <td><span class="datatype-reference">string </span></td> <td><span class="property-description"></span></td> </tr> <tr> - <td><span class="property-name">options</span></td> - <td><span class="datatype-reference">map of string + <td><span class="property-name">version</span></td> + <td><span class="datatype-reference">number </span></td> <td><span class="property-description"></span></td> </tr> @@ -173,30 +179,63 @@ <p class="lead">Example</p> <pre class="prettyprint language-js example">{ + "defaultValue" : "...", "elementDefs" : [ { - "value" : "...", "description" : "...", - "ordinal" : 12345 + "ordinal" : 12345, + "value" : "..." }, { - "value" : "...", "description" : "...", - "ordinal" : 12345 + "ordinal" : 12345, + "value" : "..." } ], - "defaultValue" : "...", - "category" : "ARRAY", - "guid" : "...", - "createdBy" : "...", - "updatedBy" : "...", + "category" : "ENUM", "createTime" : 12345, - "updateTime" : 12345, - "version" : 12345, - "name" : "...", + "createdBy" : "...", + "dateFormatter" : { + "availableLocales" : [ "...", "..." ], + "calendar" : 12345, + "dateInstance" : { }, + "dateTimeInstance" : { }, + "instance" : { }, + "lenient" : true, + "numberFormat" : { + "availableLocales" : [ "...", "..." ], + "currency" : "...", + "currencyInstance" : { }, + "groupingUsed" : true, + "instance" : { }, + "integerInstance" : { }, + "maximumFractionDigits" : 12345, + "maximumIntegerDigits" : 12345, + "minimumFractionDigits" : 12345, + "minimumIntegerDigits" : 12345, + "numberInstance" : { }, + "parseIntegerOnly" : true, + "percentInstance" : { }, + "roundingMode" : "UNNECESSARY" + }, + "timeInstance" : { }, + "timeZone" : { + "DSTSavings" : 12345, + "ID" : "...", + "availableIDs" : [ "...", "..." ], + "default" : { }, + "displayName" : "...", + "rawOffset" : 12345 + } + }, "description" : "...", - "typeVersion" : "...", + "guid" : "...", + "name" : "...", "options" : { "property1" : "...", "property2" : "..." - } + }, + "typeVersion" : "...", + "updateTime" : 12345, + "updatedBy" : "...", + "version" : 12345 }</pre> <footer class="footer"> http://git-wip-us.apache.org/repos/asf/atlas-website/blob/3fad5df3/1.1.0/api/v2/json_AtlasEnumElementDef.html ---------------------------------------------------------------------- diff --git a/1.1.0/api/v2/json_AtlasEnumElementDef.html b/1.1.0/api/v2/json_AtlasEnumElementDef.html index 768d224..d7b3405 100644 --- a/1.1.0/api/v2/json_AtlasEnumElementDef.html +++ b/1.1.0/api/v2/json_AtlasEnumElementDef.html @@ -15,7 +15,7 @@ <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/css/bootstrap.min.css"> <!--custom css for these pages--> - <link rel="stylesheet" href="css/style.css"> + <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]> @@ -79,7 +79,7 @@ </thead> <tbody> <tr> - <td> <span class="property-name">value</span> + <td> <span id="prop-description" class="property-name">description</span> </td> <td> <span class="datatype-reference">string </span> @@ -88,18 +88,18 @@ </td> </tr> <tr> - <td> <span class="property-name">description</span> + <td> <span id="prop-ordinal" class="property-name">ordinal</span> </td> - <td> <span class="datatype-reference">string + <td> <span class="datatype-reference">number </span> </td> <td> <span class="property-description"></span> </td> </tr> <tr> - <td> <span class="property-name">ordinal</span> + <td> <span id="prop-value" class="property-name">value</span> </td> - <td> <span class="datatype-reference">number + <td> <span class="datatype-reference">string </span> </td> <td> <span class="property-description"></span> @@ -111,9 +111,9 @@ <p class="lead">Example</p> <pre class="prettyprint language-js example">{ - "value" : "...", "description" : "...", - "ordinal" : 12345 + "ordinal" : 12345, + "value" : "..." }</pre> <footer class="footer"> http://git-wip-us.apache.org/repos/asf/atlas-website/blob/3fad5df3/1.1.0/api/v2/json_AtlasFullTextResult.html ---------------------------------------------------------------------- diff --git a/1.1.0/api/v2/json_AtlasFullTextResult.html b/1.1.0/api/v2/json_AtlasFullTextResult.html index e8f99f4..30c96f5 100644 --- a/1.1.0/api/v2/json_AtlasFullTextResult.html +++ b/1.1.0/api/v2/json_AtlasFullTextResult.html @@ -15,7 +15,7 @@ <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/css/bootstrap.min.css"> <!--custom css for these pages--> - <link rel="stylesheet" href="css/style.css"> + <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]> @@ -79,7 +79,7 @@ </thead> <tbody> <tr> - <td> <span class="property-name">entity</span> + <td> <span id="prop-entity" class="property-name">entity</span> </td> <td> <span class="datatype-reference"><a href="json_AtlasEntityHeader.html">AtlasEntityHeader</a> </span> @@ -88,7 +88,7 @@ </td> </tr> <tr> - <td> <span class="property-name">score</span> + <td> <span id="prop-score" class="property-name">score</span> </td> <td> <span class="datatype-reference">number </span> @@ -103,15 +103,62 @@ <pre class="prettyprint language-js example">{ "entity" : { - "guid" : "...", - "status" : "ACTIVE", - "displayText" : "...", "classificationNames" : [ "...", "..." ], - "typeName" : "...", + "classifications" : [ { + "entityGuid" : "...", + "entityStatus" : "DELETED", + "propagate" : true, + "removePropagationsOnEntityDelete" : true, + "validityPeriods" : [ { }, { } ], + "attributes" : { + "property1" : { }, + "property2" : { } + }, + "typeName" : "..." + }, { + "entityGuid" : "...", + "entityStatus" : "DELETED", + "propagate" : true, + "removePropagationsOnEntityDelete" : true, + "validityPeriods" : [ { }, { } ], + "attributes" : { + "property1" : { }, + "property2" : { } + }, + "typeName" : "..." + } ], + "displayText" : "...", + "guid" : "...", + "meaningNames" : [ "...", "..." ], + "meanings" : [ { + "confidence" : 12345, + "createdBy" : "...", + "description" : "...", + "displayText" : "...", + "expression" : "...", + "relationGuid" : "...", + "source" : "...", + "status" : "VALIDATED", + "steward" : "...", + "termGuid" : "..." + }, { + "confidence" : 12345, + "createdBy" : "...", + "description" : "...", + "displayText" : "...", + "expression" : "...", + "relationGuid" : "...", + "source" : "...", + "status" : "DEPRECATED", + "steward" : "...", + "termGuid" : "..." + } ], + "status" : "DELETED", "attributes" : { "property1" : { }, "property2" : { } - } + }, + "typeName" : "..." }, "score" : 12345.0 }</pre> http://git-wip-us.apache.org/repos/asf/atlas-website/blob/3fad5df3/1.1.0/api/v2/json_AtlasGlossary.html ---------------------------------------------------------------------- diff --git a/1.1.0/api/v2/json_AtlasGlossary.html b/1.1.0/api/v2/json_AtlasGlossary.html new file mode 100644 index 0000000..f14cdc8 --- /dev/null +++ b/1.1.0/api/v2/json_AtlasGlossary.html @@ -0,0 +1,282 @@ +<!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: AtlasGlossary</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://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/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: AtlasGlossary</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_AtlasGlossary.html">AtlasGlossary</a></li> + </ol> + + <h1 class="page-header">AtlasGlossary <small>Data Type</small></h1> + + <p></p> + + <dl class="dl-horizontal"> + <dt>Subtypes</dt> + <dd><a href="json_AtlasGlossaryExtInfo.html">AtlasGlossaryExtInfo</a></dd> + </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-categories" class="property-name">categories</span> +</td> + <td> <span class="datatype-reference">array of <a href="json_AtlasRelatedCategoryHeader.html">AtlasRelatedCategoryHeader</a> +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span id="prop-language" class="property-name">language</span> +</td> + <td> <span class="datatype-reference">string +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span id="prop-terms" class="property-name">terms</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> + </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">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">{ + "categories" : [ { + "categoryGuid" : "...", + "description" : "...", + "displayText" : "...", + "parentCategoryGuid" : "...", + "relationGuid" : "..." + }, { + "categoryGuid" : "...", + "description" : "...", + "displayText" : "...", + "parentCategoryGuid" : "...", + "relationGuid" : "..." + } ], + "language" : "...", + "terms" : [ { + "description" : "...", + "displayText" : "...", + "expression" : "...", + "relationGuid" : "...", + "source" : "...", + "status" : "OTHER", + "steward" : "...", + "termGuid" : "..." + }, { + "description" : "...", + "displayText" : "...", + "expression" : "...", + "relationGuid" : "...", + "source" : "...", + "status" : "DRAFT", + "steward" : "...", + "termGuid" : "..." + } ], + "usage" : "...", + "classifications" : [ { + "entityGuid" : "...", + "entityStatus" : "DELETED", + "propagate" : true, + "removePropagationsOnEntityDelete" : true, + "validityPeriods" : [ { + "endTime" : "...", + "startTime" : "...", + "timeZone" : "..." + }, { + "endTime" : "...", + "startTime" : "...", + "timeZone" : "..." + } ], + "attributes" : { + "property1" : { }, + "property2" : { } + }, + "typeName" : "..." + }, { + "entityGuid" : "...", + "entityStatus" : "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://cdnjs.cloudflare.com/ajax/libs/jquery/1.11.2/jquery.min.js"></script> + + <!-- Bootstrap core JavaScript + ================================================== --> + <script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/js/bootstrap.min.js"></script> + + <!-- prettify code blocks. see http://code.google.com/p/google-code-prettify/ --> + <script src="https://cdn.rawgit.com/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> http://git-wip-us.apache.org/repos/asf/atlas-website/blob/3fad5df3/1.1.0/api/v2/json_AtlasGlossaryBaseObject.html ---------------------------------------------------------------------- diff --git a/1.1.0/api/v2/json_AtlasGlossaryBaseObject.html b/1.1.0/api/v2/json_AtlasGlossaryBaseObject.html new file mode 100644 index 0000000..b433eff --- /dev/null +++ b/1.1.0/api/v2/json_AtlasGlossaryBaseObject.html @@ -0,0 +1,226 @@ +<!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: AtlasGlossaryBaseObject</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://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/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: AtlasGlossaryBaseObject</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_AtlasGlossaryBaseObject.html">AtlasGlossaryBaseObject</a></li> + </ol> + + <h1 class="page-header">AtlasGlossaryBaseObject <small>Data Type</small></h1> + + <p></p> + + <dl class="dl-horizontal"> + <dt>Abstract Type</dt> + <dd></dd> + <dt>Subtypes</dt> + <dd><a href="json_AtlasGlossary.html">AtlasGlossary</a>, <a href="json_AtlasGlossaryCategory.html">AtlasGlossaryCategory</a>, <a href="json_AtlasGlossaryExtInfo.html">AtlasGlossaryExtInfo</a>, <a href="json_AtlasGlossaryTerm.html">AtlasGlossaryTerm</a></dd> + </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-classifications" 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 id="prop-longDescription" 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 id="prop-name" 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 id="prop-qualifiedName" 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 id="prop-shortDescription" 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> + + <div class="alert alert-warning">This data type is abstract. The example below may be incomplete. More accurate examples can be found in subtypes pages.</div> + + <pre class="prettyprint language-js example">{ + "classifications" : [ { + "entityGuid" : "...", + "entityStatus" : "ACTIVE", + "propagate" : true, + "removePropagationsOnEntityDelete" : true, + "validityPeriods" : [ { + "endTime" : "...", + "startTime" : "...", + "timeZone" : "..." + }, { + "endTime" : "...", + "startTime" : "...", + "timeZone" : "..." + } ], + "attributes" : { + "property1" : { }, + "property2" : { } + }, + "typeName" : "..." + }, { + "entityGuid" : "...", + "entityStatus" : "ACTIVE", + "propagate" : true, + "removePropagationsOnEntityDelete" : true, + "validityPeriods" : [ { + "endTime" : "...", + "startTime" : "...", + "timeZone" : "..." + }, { + "endTime" : "...", + "startTime" : "...", + "timeZone" : "..." + } ], + "attributes" : { + "property1" : { }, + "property2" : { } + }, + "typeName" : "..." + } ], + "longDescription" : "...", + "name" : "...", + "qualifiedName" : "...", + "shortDescription" : "...", + "guid" : "..." +}</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://cdnjs.cloudflare.com/ajax/libs/jquery/1.11.2/jquery.min.js"></script> + + <!-- Bootstrap core JavaScript + ================================================== --> + <script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/js/bootstrap.min.js"></script> + + <!-- prettify code blocks. see http://code.google.com/p/google-code-prettify/ --> + <script src="https://cdn.rawgit.com/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> http://git-wip-us.apache.org/repos/asf/atlas-website/blob/3fad5df3/1.1.0/api/v2/json_AtlasGlossaryCategory.html ---------------------------------------------------------------------- diff --git a/1.1.0/api/v2/json_AtlasGlossaryCategory.html b/1.1.0/api/v2/json_AtlasGlossaryCategory.html new file mode 100644 index 0000000..49a1eab --- /dev/null +++ b/1.1.0/api/v2/json_AtlasGlossaryCategory.html @@ -0,0 +1,290 @@ +<!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: AtlasGlossaryCategory</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://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/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: AtlasGlossaryCategory</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_AtlasGlossaryCategory.html">AtlasGlossaryCategory</a></li> + </ol> + + <h1 class="page-header">AtlasGlossaryCategory <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-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-childrenCategories" class="property-name">childrenCategories</span> +</td> + <td> <span class="datatype-reference">array of <a href="json_AtlasRelatedCategoryHeader.html">AtlasRelatedCategoryHeader</a> +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span id="prop-parentCategory" class="property-name">parentCategory</span> +</td> + <td> <span class="datatype-reference"><a href="json_AtlasRelatedCategoryHeader.html">AtlasRelatedCategoryHeader</a> +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span id="prop-terms" class="property-name">terms</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">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">{ + "anchor" : { + "displayText" : "...", + "glossaryGuid" : "...", + "relationGuid" : "..." + }, + "childrenCategories" : [ { + "categoryGuid" : "...", + "description" : "...", + "displayText" : "...", + "parentCategoryGuid" : "...", + "relationGuid" : "..." + }, { + "categoryGuid" : "...", + "description" : "...", + "displayText" : "...", + "parentCategoryGuid" : "...", + "relationGuid" : "..." + } ], + "parentCategory" : { + "categoryGuid" : "...", + "description" : "...", + "displayText" : "...", + "parentCategoryGuid" : "...", + "relationGuid" : "..." + }, + "terms" : [ { + "description" : "...", + "displayText" : "...", + "expression" : "...", + "relationGuid" : "...", + "source" : "...", + "status" : "OBSOLETE", + "steward" : "...", + "termGuid" : "..." + }, { + "description" : "...", + "displayText" : "...", + "expression" : "...", + "relationGuid" : "...", + "source" : "...", + "status" : "OTHER", + "steward" : "...", + "termGuid" : "..." + } ], + "classifications" : [ { + "entityGuid" : "...", + "entityStatus" : "ACTIVE", + "propagate" : true, + "removePropagationsOnEntityDelete" : true, + "validityPeriods" : [ { + "endTime" : "...", + "startTime" : "...", + "timeZone" : "..." + }, { + "endTime" : "...", + "startTime" : "...", + "timeZone" : "..." + } ], + "attributes" : { + "property1" : { }, + "property2" : { } + }, + "typeName" : "..." + }, { + "entityGuid" : "...", + "entityStatus" : "ACTIVE", + "propagate" : true, + "removePropagationsOnEntityDelete" : true, + "validityPeriods" : [ { + "endTime" : "...", + "startTime" : "...", + "timeZone" : "..." + }, { + "endTime" : "...", + "startTime" : "...", + "timeZone" : "..." + } ], + "attributes" : { + "property1" : { }, + "property2" : { } + }, + "typeName" : "..." + } ], + "longDescription" : "...", + "name" : "...", + "qualifiedName" : "...", + "shortDescription" : "...", + "guid" : "..." +}</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://cdnjs.cloudflare.com/ajax/libs/jquery/1.11.2/jquery.min.js"></script> + + <!-- Bootstrap core JavaScript + ================================================== --> + <script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/js/bootstrap.min.js"></script> + + <!-- prettify code blocks. see http://code.google.com/p/google-code-prettify/ --> + <script src="https://cdn.rawgit.com/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>