| <!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: JSON</title> |
| |
| <!-- Mobile viewport optimized: j.mp/bplateviewport --> |
| <meta name="viewport" content="width=device-width, initial-scale=1.0"> |
| |
| <!-- Bootstrap core CSS --> |
| <link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/3.4.1/css/bootstrap.min.css"> |
| |
| <!--custom css for these pages--> |
| <link rel="stylesheet" href="css/enunciate.css"> |
| |
| <!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries --> |
| <!--[if lt IE 9]> |
| <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script> |
| <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script> |
| <![endif]--> |
| </head> |
| |
| <body data-spy="scroll" data-target="#apinav"> |
| |
| <nav class="navbar navbar-inverse navbar-fixed-top"> |
| <div class="container-fluid"> |
| <div class="navbar-header"> |
| <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar"> |
| <span class="sr-only">Toggle navigation</span> |
| <span class="icon-bar"></span> |
| <span class="icon-bar"></span> |
| <span class="icon-bar"></span> |
| </button> |
| <a class="navbar-brand" href="index.html">Atlas REST API: JSON</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="dropdown"><a href="syntax_json.html">JSON</a></li> |
| </ol> |
| |
| <h1 class="page-header">JSON</h1> |
| |
| <table class="table table-hover datatypes"> |
| <thead> |
| <tr> |
| <th align="center">type</th> |
| <th align="center">description</th> |
| </tr> |
| </thead> |
| <tbody data-link="row" class="rowlink"> |
| <tr class="clickable-row" data-href="json_AtlasAggregationEntry.html"> |
| <td> <span class="datatype-name">AtlasAggregationEntry</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_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_AtlasBusinessMetadataDef.html"> |
| <td> <span class="datatype-name">AtlasBusinessMetadataDef</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_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_AtlasEntityHeaders.html"> |
| <td> <span class="datatype-name">AtlasEntityHeaders</span> |
| </td> |
| <td> <span class="datatype-description"></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_AtlasGlossaryTermHeader.html"> |
| <td> <span class="datatype-name">AtlasGlossaryTermHeader</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_AtlasQuickSearchResult.html"> |
| <td> <span class="datatype-name">AtlasQuickSearchResult</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_AtlasRelationshipAttributeDef.html"> |
| <td> <span class="datatype-name">AtlasRelationshipAttributeDef</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_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 attributes 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_AtlasRelationshipHeader.html"> |
| <td> <span class="datatype-name">AtlasRelationshipHeader</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_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_AtlasSuggestionsResult.html"> |
| <td> <span class="datatype-name">AtlasSuggestionsResult</span> |
| </td> |
| <td> <span class="datatype-description"></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_BulkImportResponse.html"> |
| <td> <span class="datatype-name">BulkImportResponse</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_ImportInfo.html"> |
| <td> <span class="datatype-name">ImportInfo</span> |
| </td> |
| <td> <span class="datatype-description"></span> |
| </td> |
| </tr> |
| <tr class="clickable-row" data-href="json_ImportStatus.html"> |
| <td> <span class="datatype-name">ImportStatus</span> |
| </td> |
| <td> <span class="datatype-description"></span> |
| </td> |
| </tr> |
| <tr class="clickable-row" data-href="json_IndexType.html"> |
| <td> <span class="datatype-name">IndexType</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_LineageInfoOnDemand.html"> |
| <td> <span class="datatype-name">LineageInfoOnDemand</span> |
| </td> |
| <td> <span class="datatype-description"></span> |
| </td> |
| </tr> |
| <tr class="clickable-row" data-href="json_LineageOnDemandConstraints.html"> |
| <td> <span class="datatype-name">LineageOnDemandConstraints</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">NOTE : The names added in the String array should always contain first value in lower case</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_QuickSearchParameters.html"> |
| <td> <span class="datatype-name">QuickSearchParameters</span> |
| </td> |
| <td> <span class="datatype-description"></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_RelationshipSearchParameters.html"> |
| <td> <span class="datatype-name">RelationshipSearchParameters</span> |
| </td> |
| <td> <span class="datatype-description"></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_SortOrder.html"> |
| <td> <span class="datatype-name">SortOrder</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> |
| |
| <footer class="footer"> |
| <div class="container"> |
| <p class="text-muted">Generated by <a href="http://enunciate.webcohesion.com">Enunciate</a>.</p> |
| </div> |
| </footer> |
| |
| </div> |
| </div> |
| </div> |
| |
| |
| <!-- JavaScript placed at the end of the document so the pages load faster. --> |
| <script src="https://code.jquery.com/jquery-1.12.2.min.js"></script> |
| |
| <!-- Bootstrap core JavaScript |
| ================================================== --> |
| <script src="https://stackpath.bootstrapcdn.com/bootstrap/3.4.1/js/bootstrap.min.js"></script> |
| |
| <!-- prettify code blocks. see http://code.google.com/p/google-code-prettify/ --> |
| <script src="https://cdn.jsdelivr.net/gh/google/code-prettify@master/loader/run_prettify.js" type="text/javascript"></script> |
| <script> |
| $(function() { |
| $(".clickable-row").click(function() { |
| window.document.location = $(this).data("href"); |
| }); |
| |
| $('[data-toggle="tooltip"]').tooltip() |
| }); |
| </script> |
| |
| </body> |
| </html> |