http://git-wip-us.apache.org/repos/asf/atlas-website/blob/3fad5df3/1.1.0/api/v2/index.html ---------------------------------------------------------------------- diff --git a/1.1.0/api/v2/index.html b/1.1.0/api/v2/index.html index 80c4261..23cf360 100644 --- a/1.1.0/api/v2/index.html +++ b/1.1.0/api/v2/index.html @@ -127,6 +127,7 @@ </samp></li><li><samp> <span class="resource-path">/v2/entity/guid/{guid}</span> </samp></li><li><samp> <span class="resource-path">/v2/entity/{guid}/audit</span> </samp></li><li><samp> <span class="resource-path">/v2/entity/guid/{guid}/classifications</span> +</samp></li><li><samp> <span class="resource-path">/v2/entity/guid/{guid}/header</span> </samp></li><li><samp> <span class="resource-path">/v2/entity/uniqueAttribute/type/{typeName}</span> </samp></li><li><samp> <span class="resource-path">/v2/entity/guid/{guid}/classification/{classificationName}</span> </samp></li><li><samp> <span class="resource-path">/v2/entity/uniqueAttribute/type/{typeName}/classifications</span> @@ -138,6 +139,7 @@ </samp></li><li><samp> <span class="label label-default resource-method">DELETE</span> <span class="label label-default resource-method">GET</span> <span class="label label-default resource-method">PUT</span> </samp></li><li><samp> <span class="label label-default resource-method">GET</span> </samp></li><li><samp> <span class="label label-default resource-method">GET</span> <span class="label label-default resource-method">POST</span> <span class="label label-default resource-method">PUT</span> +</samp></li><li><samp> <span class="label label-default resource-method">GET</span> </samp></li><li><samp> <span class="label label-default resource-method">DELETE</span> <span class="label label-default resource-method">GET</span> <span class="label label-default resource-method">PUT</span> </samp></li><li><samp> <span class="label label-default resource-method">DELETE</span> <span class="label label-default resource-method">GET</span> </samp></li><li><samp> <span class="label label-default resource-method">POST</span> <span class="label label-default resource-method">PUT</span> @@ -267,48 +269,494 @@ </tr> </thead> <tbody data-link="row" class="rowlink"> + <tr class="clickable-row" data-href="json_AtlasAttributeDef.html"> + <td> <span class="datatype-name">AtlasAttributeDef</span> +</td> + <td> <span class="datatype-description">class that captures details of a struct-attribute.</span> +</td> + </tr> + <tr class="clickable-row" data-href="json_AtlasBaseModelObject.html"> + <td> <span class="datatype-name">AtlasBaseModelObject</span> +</td> + <td> <span class="datatype-description"></span> +</td> + </tr> + <tr class="clickable-row" data-href="json_AtlasBaseTypeDef.html"> + <td> <span class="datatype-name">AtlasBaseTypeDef</span> +</td> + <td> <span class="datatype-description">Base class that captures common-attributes for all Atlas types.</span> +</td> + </tr> <tr class="clickable-row" data-href="json_AtlasClassification.html"> <td> <span class="datatype-name">AtlasClassification</span> </td> <td> <span class="datatype-description">An instance of a classification; it doesn't have an identity, this object exists only when associated with an entity.</span> </td> </tr> + <tr class="clickable-row" data-href="json_AtlasClassificationDef.html"> + <td> <span class="datatype-name">AtlasClassificationDef</span> +</td> + <td> <span class="datatype-description">class that captures details of a classification-type.</span> +</td> + </tr> + <tr class="clickable-row" data-href="json_AtlasClassifications.html"> + <td> <span class="datatype-name">AtlasClassifications</span> +</td> + <td> <span class="datatype-description">REST serialization friendly list.</span> +</td> + </tr> + <tr class="clickable-row" data-href="json_AtlasConstraintDef.html"> + <td> <span class="datatype-name">AtlasConstraintDef</span> +</td> + <td> <span class="datatype-description">class that captures details of a constraint.</span> +</td> + </tr> + <tr class="clickable-row" data-href="json_AtlasEntitiesWithExtInfo.html"> + <td> <span class="datatype-name">AtlasEntitiesWithExtInfo</span> +</td> + <td> <span class="datatype-description">An instance of an entity along with extended info - like hive_table, hive_database.</span> +</td> + </tr> + <tr class="clickable-row" data-href="json_AtlasEntity.html"> + <td> <span class="datatype-name">AtlasEntity</span> +</td> + <td> <span class="datatype-description">An instance of an entity - like hive_table, hive_database.</span> +</td> + </tr> + <tr class="clickable-row" data-href="json_AtlasEntityDef.html"> + <td> <span class="datatype-name">AtlasEntityDef</span> +</td> + <td> <span class="datatype-description">class that captures details of a entity-type.</span> +</td> + </tr> + <tr class="clickable-row" data-href="json_AtlasEntityExtInfo.html"> + <td> <span class="datatype-name">AtlasEntityExtInfo</span> +</td> + <td> <span class="datatype-description">An instance of an entity along with extended info - like hive_table, hive_database.</span> +</td> + </tr> + <tr class="clickable-row" data-href="json_AtlasEntityHeader.html"> + <td> <span class="datatype-name">AtlasEntityHeader</span> +</td> + <td> <span class="datatype-description">An instance of an entity - like hive_table, hive_database.</span> +</td> + </tr> + <tr class="clickable-row" data-href="json_AtlasEntityWithExtInfo.html"> + <td> <span class="datatype-name">AtlasEntityWithExtInfo</span> +</td> + <td> <span class="datatype-description">An instance of an entity along with extended info - like hive_table, hive_database.</span> +</td> + </tr> + <tr class="clickable-row" data-href="json_AtlasEnumDef.html"> + <td> <span class="datatype-name">AtlasEnumDef</span> +</td> + <td> <span class="datatype-description">class that captures details of an enum-type.</span> +</td> + </tr> + <tr class="clickable-row" data-href="json_AtlasEnumElementDef.html"> + <td> <span class="datatype-name">AtlasEnumElementDef</span> +</td> + <td> <span class="datatype-description">class that captures details of an enum-element.</span> +</td> + </tr> + <tr class="clickable-row" data-href="json_AtlasFullTextResult.html"> + <td> <span class="datatype-name">AtlasFullTextResult</span> +</td> + <td> <span class="datatype-description"></span> +</td> + </tr> + <tr class="clickable-row" data-href="json_AtlasGlossary.html"> + <td> <span class="datatype-name">AtlasGlossary</span> +</td> + <td> <span class="datatype-description"></span> +</td> + </tr> + <tr class="clickable-row" data-href="json_AtlasGlossaryBaseObject.html"> + <td> <span class="datatype-name">AtlasGlossaryBaseObject</span> +</td> + <td> <span class="datatype-description"></span> +</td> + </tr> + <tr class="clickable-row" data-href="json_AtlasGlossaryCategory.html"> + <td> <span class="datatype-name">AtlasGlossaryCategory</span> +</td> + <td> <span class="datatype-description"></span> +</td> + </tr> + <tr class="clickable-row" data-href="json_AtlasGlossaryExtInfo.html"> + <td> <span class="datatype-name">AtlasGlossaryExtInfo</span> +</td> + <td> <span class="datatype-description"></span> +</td> + </tr> + <tr class="clickable-row" data-href="json_AtlasGlossaryHeader.html"> + <td> <span class="datatype-name">AtlasGlossaryHeader</span> +</td> + <td> <span class="datatype-description"></span> +</td> + </tr> + <tr class="clickable-row" data-href="json_AtlasGlossaryTerm.html"> + <td> <span class="datatype-name">AtlasGlossaryTerm</span> +</td> + <td> <span class="datatype-description"></span> +</td> + </tr> + <tr class="clickable-row" data-href="json_AtlasLineageInfo.html"> + <td> <span class="datatype-name">AtlasLineageInfo</span> +</td> + <td> <span class="datatype-description"></span> +</td> + </tr> + <tr class="clickable-row" data-href="json_AtlasObjectId.html"> + <td> <span class="datatype-name">AtlasObjectId</span> +</td> + <td> <span class="datatype-description">Reference to an object-instance of an Atlas type - like entity.</span> +</td> + </tr> + <tr class="clickable-row" data-href="json_AtlasQueryType.html"> + <td> <span class="datatype-name">AtlasQueryType</span> +</td> + <td> <span class="datatype-description"></span> +</td> + </tr> + <tr class="clickable-row" data-href="json_AtlasRelatedCategoryHeader.html"> + <td> <span class="datatype-name">AtlasRelatedCategoryHeader</span> +</td> + <td> <span class="datatype-description"></span> +</td> + </tr> + <tr class="clickable-row" data-href="json_AtlasRelatedObjectId.html"> + <td> <span class="datatype-name">AtlasRelatedObjectId</span> +</td> + <td> <span class="datatype-description">Reference to an object-instance of AtlasEntity type used in relationship attribute values</span> +</td> + </tr> + <tr class="clickable-row" data-href="json_AtlasRelatedTermHeader.html"> + <td> <span class="datatype-name">AtlasRelatedTermHeader</span> +</td> + <td> <span class="datatype-description"></span> +</td> + </tr> + <tr class="clickable-row" data-href="json_AtlasRelationship.html"> + <td> <span class="datatype-name">AtlasRelationship</span> +</td> + <td> <span class="datatype-description">Atlas relationship instance.</span> +</td> + </tr> + <tr class="clickable-row" data-href="json_AtlasRelationshipDef.html"> + <td> <span class="datatype-name">AtlasRelationshipDef</span> +</td> + <td> <span class="datatype-description">AtlasRelationshipDef is a TypeDef that defines a relationship. +<p> +As with other typeDefs the AtlasRelationshipDef has a name. Once created the RelationshipDef has a guid. +The name and the guid are the 2 ways that the RelationshipDef is identified. +<p> +RelationshipDefs have 2 ends, each of which specify cardinality, an EntityDef type name and name and optionally +whether the end is a container. +<p> +RelationshipDefs can have AttributeDefs - though only primitive types are allowed. <br> +RelationshipDefs have a relationshipCategory specifying the UML type of relationship required <br> +RelationshipDefs also have a PropogateTag - indicating which way tags could flow over the relationships. +<p> +The way EntityDefs and RelationshipDefs are intended to be used is that EntityDefs will define AttributeDefs these AttributeDefs +will not specify an EntityDef type name as their types. +<p> +RelationshipDefs introduce new atributes to the entity instances. For example +<p> +EntityDef A might have attributes attr1,attr2,attr3 <br> +EntityDef B might have attributes attr4,attr5,attr6 <br> +RelationshipDef AtoB might define 2 ends <br> + +<pre> + end1: type A, name attr7 + end2: type B, name attr8 </pre> + +<p> +When an instance of EntityDef A is created, it will have attributes attr1,attr2,attr3,attr7 <br> +When an instance of EntityDef B is created, it will have attributes attr4,attr5,attr6,attr8 +<p> +In this way relationshipDefs can be authored separately from entityDefs and can inject relationship attributes into +the entity instances</span> +</td> + </tr> + <tr class="clickable-row" data-href="json_AtlasRelationshipEndDef.html"> + <td> <span class="datatype-name">AtlasRelationshipEndDef</span> +</td> + <td> <span class="datatype-description">The relationshipEndDef represents an end of the relationship. The end of the relationship is defined by a type, an +attribute name, cardinality and whether it is the container end of the relationship.</span> +</td> + </tr> + <tr class="clickable-row" data-href="json_AtlasRelationshipWithExtInfo.html"> + <td> <span class="datatype-name">AtlasRelationshipWithExtInfo</span> +</td> + <td> <span class="datatype-description"></span> +</td> + </tr> + <tr class="clickable-row" data-href="json_AtlasSearchResult.html"> + <td> <span class="datatype-name">AtlasSearchResult</span> +</td> + <td> <span class="datatype-description"></span> +</td> + </tr> <tr class="clickable-row" data-href="json_AtlasStruct.html"> <td> <span class="datatype-name">AtlasStruct</span> </td> <td> <span class="datatype-description">Captures details of struct contents. Not instantiated directly, used only via AtlasEntity, AtlasClassification.</span> </td> </tr> + <tr class="clickable-row" data-href="json_AtlasStructDef.html"> + <td> <span class="datatype-name">AtlasStructDef</span> +</td> + <td> <span class="datatype-description">class that captures details of a struct-type.</span> +</td> + </tr> + <tr class="clickable-row" data-href="json_AtlasTermAssignmentHeader.html"> + <td> <span class="datatype-name">AtlasTermAssignmentHeader</span> +</td> + <td> <span class="datatype-description"></span> +</td> + </tr> + <tr class="clickable-row" data-href="json_AtlasTermAssignmentStatus.html"> + <td> <span class="datatype-name">AtlasTermAssignmentStatus</span> +</td> + <td> <span class="datatype-description"></span> +</td> + </tr> + <tr class="clickable-row" data-href="json_AtlasTermCategorizationHeader.html"> + <td> <span class="datatype-name">AtlasTermCategorizationHeader</span> +</td> + <td> <span class="datatype-description"></span> +</td> + </tr> + <tr class="clickable-row" data-href="json_AtlasTermRelationshipStatus.html"> + <td> <span class="datatype-name">AtlasTermRelationshipStatus</span> +</td> + <td> <span class="datatype-description"></span> +</td> + </tr> + <tr class="clickable-row" data-href="json_AtlasTypeDefHeader.html"> + <td> <span class="datatype-name">AtlasTypeDefHeader</span> +</td> + <td> <span class="datatype-description"></span> +</td> + </tr> + <tr class="clickable-row" data-href="json_AtlasTypesDef.html"> + <td> <span class="datatype-name">AtlasTypesDef</span> +</td> + <td> <span class="datatype-description"></span> +</td> + </tr> + <tr class="clickable-row" data-href="json_AtlasUserSavedSearch.html"> + <td> <span class="datatype-name">AtlasUserSavedSearch</span> +</td> + <td> <span class="datatype-description"></span> +</td> + </tr> + <tr class="clickable-row" data-href="json_AttributeSearchResult.html"> + <td> <span class="datatype-name">AttributeSearchResult</span> +</td> + <td> <span class="datatype-description"></span> +</td> + </tr> + <tr class="clickable-row" data-href="json_Cardinality.html"> + <td> <span class="datatype-name">Cardinality</span> +</td> + <td> <span class="datatype-description">single-valued attribute or multi-valued attribute.</span> +</td> + </tr> <tr class="clickable-row" data-href="json_ClassificationAssociateRequest.html"> <td> <span class="datatype-name">ClassificationAssociateRequest</span> </td> <td> <span class="datatype-description"></span> </td> </tr> + <tr class="clickable-row" data-href="json_Condition.html"> + <td> <span class="datatype-name">Condition</span> +</td> + <td> <span class="datatype-description"></span> +</td> + </tr> + <tr class="clickable-row" data-href="json_DateFormat.html"> + <td> <span class="datatype-name">DateFormat</span> +</td> + <td> <span class="datatype-description"></span> +</td> + </tr> + <tr class="clickable-row" data-href="json_EntityAuditActionV2.html"> + <td> <span class="datatype-name">EntityAuditActionV2</span> +</td> + <td> <span class="datatype-description"></span> +</td> + </tr> + <tr class="clickable-row" data-href="json_EntityAuditEventV2.html"> + <td> <span class="datatype-name">EntityAuditEventV2</span> +</td> + <td> <span class="datatype-description">Structure of v2 entity audit event</span> +</td> + </tr> + <tr class="clickable-row" data-href="json_EntityAuditType.html"> + <td> <span class="datatype-name">EntityAuditType</span> +</td> + <td> <span class="datatype-description"></span> +</td> + </tr> + <tr class="clickable-row" data-href="json_EntityMutationResponse.html"> + <td> <span class="datatype-name">EntityMutationResponse</span> +</td> + <td> <span class="datatype-description"></span> +</td> + </tr> + <tr class="clickable-row" data-href="json_EntityOperation.html"> + <td> <span class="datatype-name">EntityOperation</span> +</td> + <td> <span class="datatype-description"></span> +</td> + </tr> + <tr class="clickable-row" data-href="json_FilterCriteria.html"> + <td> <span class="datatype-name">FilterCriteria</span> +</td> + <td> <span class="datatype-description"></span> +</td> + </tr> + <tr class="clickable-row" data-href="json_Format.html"> + <td> <span class="datatype-name">Format</span> +</td> + <td> <span class="datatype-description"></span> +</td> + </tr> + <tr class="clickable-row" data-href="json_LineageDirection.html"> + <td> <span class="datatype-name">LineageDirection</span> +</td> + <td> <span class="datatype-description"></span> +</td> + </tr> + <tr class="clickable-row" data-href="json_LineageRelation.html"> + <td> <span class="datatype-name">LineageRelation</span> +</td> + <td> <span class="datatype-description"></span> +</td> + </tr> + <tr class="clickable-row" data-href="json_NumberFormat.html"> + <td> <span class="datatype-name">NumberFormat</span> +</td> + <td> <span class="datatype-description"></span> +</td> + </tr> + <tr class="clickable-row" data-href="json_Operator.html"> + <td> <span class="datatype-name">Operator</span> +</td> + <td> <span class="datatype-description">Supported search operations +Logical comparision operators can only be used with numbers or dates +IN, LIKE, startsWith, endsWith, CONTAINS can only be used with strings or text</span> +</td> + </tr> <tr class="clickable-row" data-href="json_PList.html"> <td> <span class="datatype-name">PList</span> </td> <td> <span class="datatype-description">Paginated-list, for returning search results.</span> </td> </tr> + <tr class="clickable-row" data-href="json_PropagateTags.html"> + <td> <span class="datatype-name">PropagateTags</span> +</td> + <td> <span class="datatype-description">PropagateTags indicates whether tags should propagate across the relationship instance. +<p> +Tags can propagate: +<p> +NONE - not at all <br> +ONE_TO_TWO - from end 1 to 2 <br> +TWO_TO_ONE - from end 2 to 1 <br> +BOTH - both ways +<p> +Care needs to be taken when specifying. The use cases we are aware of where this flag is useful: +<p> +- propagating confidentiality classifications from a table to columns - ONE_TO_TWO could be used here <br> +- propagating classifications around Glossary synonyms - BOTH could be used here. +<p> +There is an expectation that further enhancements will allow more granular control of tag propagation and will +address how to resolve conflicts.</span> +</td> + </tr> + <tr class="clickable-row" data-href="json_Relation.html"> + <td> <span class="datatype-name">Relation</span> +</td> + <td> <span class="datatype-description"></span> +</td> + </tr> + <tr class="clickable-row" data-href="json_RelationshipCategory.html"> + <td> <span class="datatype-name">RelationshipCategory</span> +</td> + <td> <span class="datatype-description">The Relationship category determines the style of relationship around containment and lifecycle. +UML terminology is used for the values. +<p> +ASSOCIATION is a relationship with no containment. <br> +COMPOSITION and AGGREGATION are containment relationships. +<p> +The difference being in the lifecycles of the container and its children. In the COMPOSITION case, +the children cannot exist without the container. For AGGREGATION, the life cycles +of the container and children are totally independant.</span> +</td> + </tr> + <tr class="clickable-row" data-href="json_RoundingMode.html"> + <td> <span class="datatype-name">RoundingMode</span> +</td> + <td> <span class="datatype-description"></span> +</td> + </tr> + <tr class="clickable-row" data-href="json_SavedSearchType.html"> + <td> <span class="datatype-name">SavedSearchType</span> +</td> + <td> <span class="datatype-description"></span> +</td> + </tr> <tr class="clickable-row" data-href="json_SearchFilter.html"> <td> <span class="datatype-name">SearchFilter</span> </td> <td> <span class="datatype-description">Generic filter, to specify search criteria using name/value pairs.</span> </td> </tr> + <tr class="clickable-row" data-href="json_SearchParameters.html"> + <td> <span class="datatype-name">SearchParameters</span> +</td> + <td> <span class="datatype-description"></span> +</td> + </tr> <tr class="clickable-row" data-href="json_SortType.html"> <td> <span class="datatype-name">SortType</span> </td> <td> <span class="datatype-description">to specify whether the result should be sorted? If yes, whether asc or desc.</span> </td> </tr> + <tr class="clickable-row" data-href="json_Status.html"> + <td> <span class="datatype-name">Status</span> +</td> + <td> <span class="datatype-description">Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store.</span> +</td> + </tr> + <tr class="clickable-row" data-href="json_Status_AtlasRelationship.html"> + <td> <span class="datatype-name">Status</span> +</td> + <td> <span class="datatype-description"></span> +</td> + </tr> <tr class="clickable-row" data-href="json_TimeBoundary.html"> <td> <span class="datatype-name">TimeBoundary</span> </td> <td> <span class="datatype-description">Captures time-boundary details</span> </td> </tr> + <tr class="clickable-row" data-href="json_TimeZone.html"> + <td> <span class="datatype-name">TimeZone</span> +</td> + <td> <span class="datatype-description"></span> +</td> + </tr> + <tr class="clickable-row" data-href="json_TypeCategory.html"> + <td> <span class="datatype-name">TypeCategory</span> +</td> + <td> <span class="datatype-description"></span> +</td> + </tr> </tbody> </table> @@ -353,6 +801,12 @@ <td> <span class="datatype-description">An instance of a classification; it doesn't have an identity, this object exists only when associated with an entity.</span> </td> </tr> + <tr class="clickable-row" data-href="xml_ns0_status.html"> + <td> <span class="datatype-name">status</span> +</td> + <td> <span class="datatype-description">Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store.</span> +</td> + </tr> <tr class="clickable-row" data-href="xml_ns0_atlasStruct.html"> <td> <span class="datatype-name">atlasStruct</span> </td>
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/3fad5df3/1.1.0/api/v2/json_AtlasAttributeDef.html ---------------------------------------------------------------------- diff --git a/1.1.0/api/v2/json_AtlasAttributeDef.html b/1.1.0/api/v2/json_AtlasAttributeDef.html index 974b43d..ef93a3a 100644 --- a/1.1.0/api/v2/json_AtlasAttributeDef.html +++ b/1.1.0/api/v2/json_AtlasAttributeDef.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,25 @@ </thead> <tbody> <tr> - <td> <span class="property-name">name</span> + <td> <span id="prop-cardinality" class="property-name">cardinality</span> +</td> + <td> <span class="datatype-reference"><a href="json_Cardinality.html">Cardinality</a> +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span id="prop-constraints" class="property-name">constraints</span> +</td> + <td> <span class="datatype-reference">array of <a href="json_AtlasConstraintDef.html">AtlasConstraintDef</a> +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span id="prop-defaultValue" class="property-name">defaultValue</span> </td> <td> <span class="datatype-reference">string </span> @@ -88,7 +106,7 @@ </td> </tr> <tr> - <td> <span class="property-name">typeName</span> + <td> <span id="prop-description" class="property-name">description</span> </td> <td> <span class="datatype-reference">string </span> @@ -97,7 +115,7 @@ </td> </tr> <tr> - <td> <span class="property-name">isOptional</span> + <td> <span id="prop-includeInNotification" class="property-name">includeInNotification</span> </td> <td> <span class="datatype-reference">boolean </span> @@ -106,52 +124,52 @@ </td> </tr> <tr> - <td> <span class="property-name">cardinality</span> + <td> <span id="prop-isIndexable" class="property-name">isIndexable</span> </td> - <td> <span class="datatype-reference"><a href="json_Cardinality.html">Cardinality</a> + <td> <span class="datatype-reference">boolean </span> </td> <td> <span class="property-description"></span> </td> </tr> <tr> - <td> <span class="property-name">valuesMinCount</span> + <td> <span id="prop-isOptional" class="property-name">isOptional</span> </td> - <td> <span class="datatype-reference">number + <td> <span class="datatype-reference">boolean </span> </td> <td> <span class="property-description"></span> </td> </tr> <tr> - <td> <span class="property-name">valuesMaxCount</span> + <td> <span id="prop-isUnique" class="property-name">isUnique</span> </td> - <td> <span class="datatype-reference">number + <td> <span class="datatype-reference">boolean </span> </td> <td> <span class="property-description"></span> </td> </tr> <tr> - <td> <span class="property-name">isUnique</span> + <td> <span id="prop-name" class="property-name">name</span> </td> - <td> <span class="datatype-reference">boolean + <td> <span class="datatype-reference">string </span> </td> <td> <span class="property-description"></span> </td> </tr> <tr> - <td> <span class="property-name">isIndexable</span> + <td> <span id="prop-options" class="property-name">options</span> </td> - <td> <span class="datatype-reference">boolean + <td> <span class="datatype-reference">map of string </span> </td> <td> <span class="property-description"></span> </td> </tr> <tr> - <td> <span class="property-name">defaultValue</span> + <td> <span id="prop-typeName" class="property-name">typeName</span> </td> <td> <span class="datatype-reference">string </span> @@ -160,9 +178,18 @@ </td> </tr> <tr> - <td> <span class="property-name">constraints</span> + <td> <span id="prop-valuesMaxCount" class="property-name">valuesMaxCount</span> </td> - <td> <span class="datatype-reference">array of <a href="json_AtlasConstraintDef.html">AtlasConstraintDef</a> + <td> <span class="datatype-reference">number +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span id="prop-valuesMinCount" class="property-name">valuesMinCount</span> +</td> + <td> <span class="datatype-reference">number </span> </td> <td> <span class="property-description"></span> @@ -174,28 +201,34 @@ <p class="lead">Example</p> <pre class="prettyprint language-js example">{ - "name" : "...", - "typeName" : "...", - "isOptional" : true, - "cardinality" : "SINGLE", - "valuesMinCount" : 12345, - "valuesMaxCount" : 12345, - "isUnique" : true, - "isIndexable" : true, - "defaultValue" : "...", + "cardinality" : "SET", "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 }</pre> <footer class="footer"> http://git-wip-us.apache.org/repos/asf/atlas-website/blob/3fad5df3/1.1.0/api/v2/json_AtlasBaseModelObject.html ---------------------------------------------------------------------- diff --git a/1.1.0/api/v2/json_AtlasBaseModelObject.html b/1.1.0/api/v2/json_AtlasBaseModelObject.html new file mode 100644 index 0000000..322057b --- /dev/null +++ b/1.1.0/api/v2/json_AtlasBaseModelObject.html @@ -0,0 +1,136 @@ +<!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: AtlasBaseModelObject</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: AtlasBaseModelObject</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_AtlasBaseModelObject.html">AtlasBaseModelObject</a></li> + </ol> + + <h1 class="page-header">AtlasBaseModelObject <small>Data Type</small></h1> + + <p></p> + + <dl class="dl-horizontal"> + <dt>Abstract Type</dt> + <dd></dd> + <dt>Subtypes</dt> + <dd><a href="json_AtlasGlossaryBaseObject.html">AtlasGlossaryBaseObject</a>, <a href="json_AtlasUserSavedSearch.html">AtlasUserSavedSearch</a>, <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-guid" 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">{ + "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_AtlasBaseTypeDef.html ---------------------------------------------------------------------- diff --git a/1.1.0/api/v2/json_AtlasBaseTypeDef.html b/1.1.0/api/v2/json_AtlasBaseTypeDef.html index c7fe833..c7859f5 100644 --- a/1.1.0/api/v2/json_AtlasBaseTypeDef.html +++ b/1.1.0/api/v2/json_AtlasBaseTypeDef.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]> @@ -69,7 +69,7 @@ <dt>Abstract Type</dt> <dd></dd> <dt>Subtypes</dt> - <dd><a href="json_AtlasEntityDef.html">AtlasEntityDef</a>, <a href="json_AtlasStructDef.html">AtlasStructDef</a>, <a href="json_AtlasRelationshipDef.html">AtlasRelationshipDef</a>, <a href="json_AtlasEnumDef.html">AtlasEnumDef</a>, <a href="json_AtlasClassificationDef.html">AtlasClassificationDef</a></dd> + <dd><a href="json_AtlasEntityDef.html">AtlasEntityDef</a>, <a href="json_AtlasEnumDef.html">AtlasEnumDef</a>, <a href="json_AtlasStructDef.html">AtlasStructDef</a>, <a href="json_AtlasRelationshipDef.html">AtlasRelationshipDef</a>, <a href="json_AtlasClassificationDef.html">AtlasClassificationDef</a></dd> </dl> <table class="table datatype-properties"> @@ -83,7 +83,7 @@ </thead> <tbody> <tr> - <td> <span class="property-name">category</span> + <td> <span id="prop-category" class="property-name">category</span> </td> <td> <span class="datatype-reference"><a href="json_TypeCategory.html">TypeCategory</a> </span> @@ -92,16 +92,16 @@ </td> </tr> <tr> - <td> <span class="property-name">guid</span> + <td> <span id="prop-createTime" class="property-name">createTime</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">createdBy</span> + <td> <span id="prop-createdBy" class="property-name">createdBy</span> </td> <td> <span class="datatype-reference">string </span> @@ -110,7 +110,16 @@ </td> </tr> <tr> - <td> <span class="property-name">updatedBy</span> + <td> <span id="prop-dateFormatter" 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 id="prop-description" class="property-name">description</span> </td> <td> <span class="datatype-reference">string </span> @@ -119,34 +128,34 @@ </td> </tr> <tr> - <td> <span class="property-name">createTime</span> + <td> <span id="prop-guid" class="property-name">guid</span> </td> - <td> <span class="datatype-reference">number + <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> <span id="prop-name" class="property-name">name</span> </td> - <td> <span class="datatype-reference">number + <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> <span id="prop-options" class="property-name">options</span> </td> - <td> <span class="datatype-reference">number + <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> <span id="prop-typeVersion" class="property-name">typeVersion</span> </td> <td> <span class="datatype-reference">string </span> @@ -155,16 +164,16 @@ </td> </tr> <tr> - <td> <span class="property-name">description</span> + <td> <span id="prop-updateTime" class="property-name">updateTime</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">typeVersion</span> + <td> <span id="prop-updatedBy" class="property-name">updatedBy</span> </td> <td> <span class="datatype-reference">string </span> @@ -173,9 +182,9 @@ </td> </tr> <tr> - <td> <span class="property-name">options</span> + <td> <span id="prop-version" class="property-name">version</span> </td> - <td> <span class="datatype-reference">map of string + <td> <span class="datatype-reference">number </span> </td> <td> <span class="property-description"></span> @@ -189,20 +198,53 @@ <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">{ - "category" : "ENUM", - "guid" : "...", - "createdBy" : "...", - "updatedBy" : "...", + "category" : "PRIMITIVE", "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_AtlasClassification.html ---------------------------------------------------------------------- diff --git a/1.1.0/api/v2/json_AtlasClassification.html b/1.1.0/api/v2/json_AtlasClassification.html index e743429..6a33e25 100644 --- a/1.1.0/api/v2/json_AtlasClassification.html +++ b/1.1.0/api/v2/json_AtlasClassification.html @@ -79,7 +79,7 @@ </thead> <tbody> <tr> - <td> <span class="property-name">entityGuid</span> + <td> <span id="prop-entityGuid" class="property-name">entityGuid</span> </td> <td> <span class="datatype-reference">string </span> @@ -88,7 +88,16 @@ </td> </tr> <tr> - <td> <span class="property-name">propagate</span> + <td> <span id="prop-entityStatus" class="property-name">entityStatus</span> +</td> + <td> <span class="datatype-reference"><a href="json_Status.html">Status</a> +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span id="prop-propagate" class="property-name">propagate</span> </td> <td> <span class="datatype-reference">boolean </span> @@ -97,7 +106,16 @@ </td> </tr> <tr> - <td> <span class="property-name">validityPeriods</span> + <td> <span id="prop-removePropagationsOnEntityDelete" class="property-name">removePropagationsOnEntityDelete</span> +</td> + <td> <span class="datatype-reference">boolean +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span id="prop-validityPeriods" class="property-name">validityPeriods</span> </td> <td> <span class="datatype-reference">array of <a href="json_TimeBoundary.html">TimeBoundary</a> </span> @@ -111,14 +129,14 @@ </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> @@ -129,21 +147,23 @@ <pre class="prettyprint language-js example">{ "entityGuid" : "...", + "entityStatus" : "ACTIVE", "propagate" : true, + "removePropagationsOnEntityDelete" : true, "validityPeriods" : [ { - "startTime" : "...", "endTime" : "...", + "startTime" : "...", "timeZone" : "..." }, { - "startTime" : "...", "endTime" : "...", + "startTime" : "...", "timeZone" : "..." } ], - "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_AtlasClassificationDef.html ---------------------------------------------------------------------- diff --git a/1.1.0/api/v2/json_AtlasClassificationDef.html b/1.1.0/api/v2/json_AtlasClassificationDef.html index 69a58b7..9e76fea 100644 --- a/1.1.0/api/v2/json_AtlasClassificationDef.html +++ b/1.1.0/api/v2/json_AtlasClassificationDef.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,34 @@ </thead> <tbody> <tr> - <td> <span class="property-name">superTypes</span> + <td> <span id="prop-entityTypes" class="property-name">entityTypes</span> +</td> + <td> <span class="datatype-reference">array of string +</span> +</td> + <td> <span class="property-description">Specifying a list of entityType names in the classificationDef, ensures that classifications can +only be applied to those entityTypes. +<ul> +<li>Any subtypes of the entity types inherit the restriction</li> +<li>Any classificationDef subtypes inherit the parents entityTypes restrictions</li> +<li>Any classificationDef subtypes can further restrict the parents entityTypes restrictions by specifying a subset of the entityTypes</li> +<li>An empty entityTypes list when there are no parent restrictions means there are no restrictions</li> +<li>An empty entityTypes list when there are parent restrictions means that the subtype picks up the parents restrictions</li> +<li>If a list of entityTypes are supplied, where one inherits from another, this will be rejected. This should encourage cleaner classificationsDefs</li> +</ul></span> +</td> + </tr> + <tr> + <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 +137,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 +149,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 +208,115 @@ <p class="lead">Example</p> <pre class="prettyprint language-js example">{ + "entityTypes" : [ "...", "..." ], + "subTypes" : [ "...", "..." ], "superTypes" : [ "...", "..." ], "attributeDefs" : [ { - "name" : "...", - "typeName" : "...", - "isOptional" : true, "cardinality" : "SINGLE", - "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" : "LIST", - "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" : "STRUCT", - "guid" : "...", - "createdBy" : "...", - "updatedBy" : "...", "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_AtlasClassifications.html ---------------------------------------------------------------------- diff --git a/1.1.0/api/v2/json_AtlasClassifications.html b/1.1.0/api/v2/json_AtlasClassifications.html index 95e3bd3..d4b632a 100644 --- a/1.1.0/api/v2/json_AtlasClassifications.html +++ b/1.1.0/api/v2/json_AtlasClassifications.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]> @@ -90,32 +90,32 @@ <td><span class="property-description"></span></td> </tr> <tr> - <td><span class="property-name">startIndex</span></td> + <td><span class="property-name">pageSize</span></td> <td><span class="datatype-reference">number </span></td> <td><span class="property-description"></span></td> </tr> <tr> - <td><span class="property-name">pageSize</span></td> - <td><span class="datatype-reference">number + <td><span class="property-name">sortBy</span></td> + <td><span class="datatype-reference">string </span></td> <td><span class="property-description"></span></td> </tr> <tr> - <td><span class="property-name">totalCount</span></td> - <td><span class="datatype-reference">number + <td><span class="property-name">sortType</span></td> + <td><span class="datatype-reference"><a href="json_SortType.html">SortType</a> </span></td> <td><span class="property-description"></span></td> </tr> <tr> - <td><span class="property-name">sortType</span></td> - <td><span class="datatype-reference"><a href="json_SortType.html">SortType</a> + <td><span class="property-name">startIndex</span></td> + <td><span class="datatype-reference">number </span></td> <td><span class="property-description"></span></td> </tr> <tr> - <td><span class="property-name">sortBy</span></td> - <td><span class="datatype-reference">string + <td><span class="property-name">totalCount</span></td> + <td><span class="datatype-reference">number </span></td> <td><span class="property-description"></span></td> </tr> @@ -126,11 +126,11 @@ <pre class="prettyprint language-js example">{ "list" : [ { }, { } ], - "startIndex" : 12345, "pageSize" : 12345, - "totalCount" : 12345, - "sortType" : "DESC", - "sortBy" : "..." + "sortBy" : "...", + "sortType" : "ASC", + "startIndex" : 12345, + "totalCount" : 12345 }</pre> <footer class="footer"> http://git-wip-us.apache.org/repos/asf/atlas-website/blob/3fad5df3/1.1.0/api/v2/json_AtlasConstraintDef.html ---------------------------------------------------------------------- diff --git a/1.1.0/api/v2/json_AtlasConstraintDef.html b/1.1.0/api/v2/json_AtlasConstraintDef.html index cdbfec0..e0965b9 100644 --- a/1.1.0/api/v2/json_AtlasConstraintDef.html +++ b/1.1.0/api/v2/json_AtlasConstraintDef.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">type</span> + <td> <span id="prop-params" class="property-name">params</span> </td> - <td> <span class="datatype-reference">string + <td> <span class="datatype-reference">map of object </span> </td> <td> <span class="property-description"></span> </td> </tr> <tr> - <td> <span class="property-name">params</span> + <td> <span id="prop-type" class="property-name">type</span> </td> - <td> <span class="datatype-reference">map of object + <td> <span class="datatype-reference">string </span> </td> <td> <span class="property-description"></span> @@ -102,11 +102,11 @@ <p class="lead">Example</p> <pre class="prettyprint language-js example">{ - "type" : "...", "params" : { "property1" : { }, "property2" : { } - } + }, + "type" : "..." }</pre> <footer class="footer"> http://git-wip-us.apache.org/repos/asf/atlas-website/blob/3fad5df3/1.1.0/api/v2/json_AtlasEntitiesWithExtInfo.html ---------------------------------------------------------------------- diff --git a/1.1.0/api/v2/json_AtlasEntitiesWithExtInfo.html b/1.1.0/api/v2/json_AtlasEntitiesWithExtInfo.html index 5ce3fab..ad39601 100644 --- a/1.1.0/api/v2/json_AtlasEntitiesWithExtInfo.html +++ b/1.1.0/api/v2/json_AtlasEntitiesWithExtInfo.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">entities</span> + <td> <span id="prop-entities" class="property-name">entities</span> </td> <td> <span class="datatype-reference">array of <a href="json_AtlasEntity.html">AtlasEntity</a> </span> @@ -105,128 +105,268 @@ <pre class="prettyprint language-js example">{ "entities" : [ { - "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" : "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" : "DEPRECATED", + "steward" : "...", + "termGuid" : "..." + }, { + "confidence" : 12345, + "createdBy" : "...", + "description" : "...", + "displayText" : "...", + "expression" : "...", + "relationGuid" : "...", + "source" : "...", + "status" : "OTHER", + "steward" : "...", + "termGuid" : "..." + } ], + "proxy" : true, + "relationshipAttributes" : { "property1" : { }, "property2" : { } - } - }, { - "guid" : "...", + }, "status" : "DELETED", - "createdBy" : "...", - "updatedBy" : "...", - "createTime" : 12345, "updateTime" : 12345, + "updatedBy" : "...", "version" : 12345, - "relationshipAttributes" : { + "attributes" : { "property1" : { }, "property2" : { } }, + "typeName" : "..." + }, { "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" : "OBSOLETE", + "steward" : "...", + "termGuid" : "..." + }, { + "confidence" : 12345, + "createdBy" : "...", + "description" : "...", + "displayText" : "...", + "expression" : "...", + "relationGuid" : "...", + "source" : "...", + "status" : "DEPRECATED", + "steward" : "...", + "termGuid" : "..." } ], - "typeName" : "...", + "proxy" : true, + "relationshipAttributes" : { + "property1" : { }, + "property2" : { } + }, + "status" : "DELETED", + "updateTime" : 12345, + "updatedBy" : "...", + "version" : 12345, "attributes" : { "property1" : { }, "property2" : { } - } + }, + "typeName" : "..." } ], "referredEntities" : { "property1" : { - "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" : "..." } ], - "typeName" : "...", - "attributes" : { + "createTime" : 12345, + "createdBy" : "...", + "guid" : "...", + "homeId" : "...", + "meanings" : [ { + "confidence" : 12345, + "createdBy" : "...", + "description" : "...", + "displayText" : "...", + "expression" : "...", + "relationGuid" : "...", + "source" : "...", + "status" : "DEPRECATED", + "steward" : "...", + "termGuid" : "..." + }, { + "confidence" : 12345, + "createdBy" : "...", + "description" : "...", + "displayText" : "...", + "expression" : "...", + "relationGuid" : "...", + "source" : "...", + "status" : "OTHER", + "steward" : "...", + "termGuid" : "..." + } ], + "proxy" : true, + "relationshipAttributes" : { "property1" : { }, "property2" : { } - } - }, - "property2" : { - "guid" : "...", - "status" : "DELETED", - "createdBy" : "...", - "updatedBy" : "...", - "createTime" : 12345, + }, + "status" : "ACTIVE", "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" : "DISCOVERED", + "steward" : "...", + "termGuid" : "..." + }, { + "confidence" : 12345, + "createdBy" : "...", + "description" : "...", + "displayText" : "...", + "expression" : "...", + "relationGuid" : "...", + "source" : "...", + "status" : "OBSOLETE", + "steward" : "...", + "termGuid" : "..." } ], - "typeName" : "...", + "proxy" : true, + "relationshipAttributes" : { + "property1" : { }, + "property2" : { } + }, + "status" : "DELETED", + "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_AtlasEntity.html ---------------------------------------------------------------------- diff --git a/1.1.0/api/v2/json_AtlasEntity.html b/1.1.0/api/v2/json_AtlasEntity.html index f0554e3..bf80995 100644 --- a/1.1.0/api/v2/json_AtlasEntity.html +++ b/1.1.0/api/v2/json_AtlasEntity.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-classifications" class="property-name">classifications</span> </td> - <td> <span class="datatype-reference">string + <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">status</span> + <td> <span id="prop-createTime" class="property-name">createTime</span> </td> - <td> <span class="datatype-reference"><a href="json_Status.html">Status</a> + <td> <span class="datatype-reference">number </span> </td> <td> <span class="property-description"></span> </td> </tr> <tr> - <td> <span class="property-name">createdBy</span> + <td> <span id="prop-createdBy" class="property-name">createdBy</span> </td> <td> <span class="datatype-reference">string </span> @@ -106,7 +106,7 @@ </td> </tr> <tr> - <td> <span class="property-name">updatedBy</span> + <td> <span id="prop-guid" class="property-name">guid</span> </td> <td> <span class="datatype-reference">string </span> @@ -115,34 +115,34 @@ </td> </tr> <tr> - <td> <span class="property-name">createTime</span> + <td> <span id="prop-homeId" class="property-name">homeId</span> </td> - <td> <span class="datatype-reference">number + <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> <span id="prop-meanings" class="property-name">meanings</span> </td> - <td> <span class="datatype-reference">number + <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 class="property-name">version</span> + <td> <span id="prop-proxy" class="property-name">proxy</span> </td> - <td> <span class="datatype-reference">number + <td> <span class="datatype-reference">boolean </span> </td> <td> <span class="property-description"></span> </td> </tr> <tr> - <td> <span class="property-name">relationshipAttributes</span> + <td> <span id="prop-relationshipAttributes" class="property-name">relationshipAttributes</span> </td> <td> <span class="datatype-reference">map of object </span> @@ -151,9 +151,36 @@ </td> </tr> <tr> - <td> <span class="property-name">classifications</span> + <td> <span id="prop-status" class="property-name">status</span> </td> - <td> <span class="datatype-reference">array of <a href="json_AtlasClassification.html">AtlasClassification</a> + <td> <span class="datatype-reference"><a href="json_Status.html">Status</a> +</span> +</td> + <td> <span class="property-description"></span> +</td> + </tr> + <tr> + <td> <span id="prop-updateTime" 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 id="prop-updatedBy" 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 id="prop-version" class="property-name">version</span> +</td> + <td> <span class="datatype-reference">number </span> </td> <td> <span class="property-description"></span> @@ -165,14 +192,14 @@ </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> @@ -182,35 +209,86 @@ <p class="lead">Example</p> <pre class="prettyprint language-js example">{ - "guid" : "...", - "status" : "DELETED", - "createdBy" : "...", - "updatedBy" : "...", - "createTime" : 12345, - "updateTime" : 12345, - "version" : 12345, - "relationshipAttributes" : { - "property1" : { }, - "property2" : { } - }, "classifications" : [ { - "typeName" : "...", + "entityGuid" : "...", + "entityStatus" : "DELETED", + "propagate" : true, + "removePropagationsOnEntityDelete" : true, + "validityPeriods" : [ { + "endTime" : "...", + "startTime" : "...", + "timeZone" : "..." + }, { + "endTime" : "...", + "startTime" : "...", + "timeZone" : "..." + } ], "attributes" : { "property1" : { }, "property2" : { } - } + }, + "typeName" : "..." }, { - "typeName" : "...", + "entityGuid" : "...", + "entityStatus" : "ACTIVE", + "propagate" : true, + "removePropagationsOnEntityDelete" : true, + "validityPeriods" : [ { + "endTime" : "...", + "startTime" : "...", + "timeZone" : "..." + }, { + "endTime" : "...", + "startTime" : "...", + "timeZone" : "..." + } ], "attributes" : { "property1" : { }, "property2" : { } - } + }, + "typeName" : "..." + } ], + "createTime" : 12345, + "createdBy" : "...", + "guid" : "...", + "homeId" : "...", + "meanings" : [ { + "confidence" : 12345, + "createdBy" : "...", + "description" : "...", + "displayText" : "...", + "expression" : "...", + "relationGuid" : "...", + "source" : "...", + "status" : "PROPOSED", + "steward" : "...", + "termGuid" : "..." + }, { + "confidence" : 12345, + "createdBy" : "...", + "description" : "...", + "displayText" : "...", + "expression" : "...", + "relationGuid" : "...", + "source" : "...", + "status" : "OBSOLETE", + "steward" : "...", + "termGuid" : "..." } ], - "typeName" : "...", + "proxy" : true, + "relationshipAttributes" : { + "property1" : { }, + "property2" : { } + }, + "status" : "ACTIVE", + "updateTime" : 12345, + "updatedBy" : "...", + "version" : 12345, "attributes" : { "property1" : { }, "property2" : { } - } + }, + "typeName" : "..." }</pre> <footer class="footer">
