http://git-wip-us.apache.org/repos/asf/atlas-website/blob/58bb55a6/api/v2/application.wadl ---------------------------------------------------------------------- diff --git a/api/v2/application.wadl b/api/v2/application.wadl index e1002ae..562cdeb 100644 --- a/api/v2/application.wadl +++ b/api/v2/application.wadl @@ -15,12 +15,55 @@ <wadl:doc><![CDATA[Create new entity or update existing entity in Atlas. Existing entity is matched using its unique guid if supplied or by its unique attributes eg: qualifiedName]]></wadl:doc> <wadl:request> - <wadl:representation mediaType="application/json"> + <wadl:representation mediaType="application/json;charset=UTF-8"> </wadl:representation> </wadl:request> <wadl:response> <wadl:doc><![CDATA[EntityMutationResponse]]></wadl:doc> - <wadl:representation mediaType="application/json"/> + <wadl:representation mediaType="application/json;charset=UTF-8"/> + </wadl:response> + </wadl:method> + </wadl:resource> + + <wadl:resource path="v2/glossary"> + <wadl:method name="GET"> + <wadl:doc><![CDATA[Retrieve all glossaries registered with Atlas]]></wadl:doc> + <wadl:request> + <wadl:param name="limit" style="query"> + <wadl:doc><![CDATA[page size - by default there is no paging]]></wadl:doc> + </wadl:param> + <wadl:param name="offset" style="query"> + <wadl:doc><![CDATA[offset for pagination purpose]]></wadl:doc> + </wadl:param> + <wadl:param name="sort" style="query"> + <wadl:doc><![CDATA[Sort order, ASC (default) or DESC]]></wadl:doc> + </wadl:param> + </wadl:request> + <wadl:response status="200"> + <wadl:doc><![CDATA[List of glossary entities fitting the above criteria]]></wadl:doc> + <wadl:representation mediaType="application/json;charset=UTF-8"/> + </wadl:response> + </wadl:method> + </wadl:resource> + + <wadl:resource path="v2/glossary"> + <wadl:method name="POST"> + <wadl:doc><![CDATA[Create a glossary]]></wadl:doc> + <wadl:request> + <wadl:doc><![CDATA[Glossary definition, terms & categories can be anchored to a glossary +using the anchor attribute when creating the Term/Category]]></wadl:doc> + <wadl:representation mediaType="application/json;charset=UTF-8"> + </wadl:representation> + </wadl:request> + <wadl:response status="400"> + <wadl:doc><![CDATA[If Glossary definition has invalid or missing information]]></wadl:doc> + </wadl:response> + <wadl:response status="409"> + <wadl:doc><![CDATA[If Glossary definition already exists (duplicate qualifiedName)]]></wadl:doc> + </wadl:response> + <wadl:response status="200"> + <wadl:doc><![CDATA[]]></wadl:doc> + <wadl:representation mediaType="application/json;charset=UTF-8"/> </wadl:response> </wadl:method> </wadl:resource> @@ -29,11 +72,12 @@ Existing entity is matched using its unique guid if supplied or by its unique at <wadl:method name="POST"> <wadl:doc><![CDATA[Create a new relationship between entities.]]></wadl:doc> <wadl:request> - <wadl:representation mediaType="application/json"> + <wadl:representation mediaType="application/json;charset=UTF-8"> </wadl:representation> </wadl:request> <wadl:response> - <wadl:representation mediaType="application/json"/> + <wadl:doc><![CDATA[]]></wadl:doc> + <wadl:representation mediaType="application/json;charset=UTF-8"/> </wadl:response> </wadl:method> </wadl:resource> @@ -42,11 +86,12 @@ Existing entity is matched using its unique guid if supplied or by its unique at <wadl:method name="PUT"> <wadl:doc><![CDATA[Update an existing relationship between entities.]]></wadl:doc> <wadl:request> - <wadl:representation mediaType="application/json"> + <wadl:representation mediaType="application/json;charset=UTF-8"> </wadl:representation> </wadl:request> <wadl:response> - <wadl:representation mediaType="application/json"/> + <wadl:doc><![CDATA[]]></wadl:doc> + <wadl:representation mediaType="application/json;charset=UTF-8"/> </wadl:response> </wadl:method> </wadl:resource> @@ -60,7 +105,8 @@ Existing entity is matched using its unique guid if supplied or by its unique at </wadl:param> </wadl:request> <wadl:response> - <wadl:representation mediaType="application/json"/> + <wadl:doc><![CDATA[]]></wadl:doc> + <wadl:representation mediaType="application/json;charset=UTF-8"/> </wadl:response> </wadl:method> </wadl:resource> @@ -70,11 +116,12 @@ Existing entity is matched using its unique guid if supplied or by its unique at <wadl:doc><![CDATA[Bulk API to create new entities or update existing entities in Atlas. Existing entity is matched using its unique guid if supplied or by its unique attributes eg: qualifiedName]]></wadl:doc> <wadl:request> - <wadl:representation mediaType="application/json"> + <wadl:representation mediaType="application/json;charset=UTF-8"> </wadl:representation> </wadl:request> <wadl:response> - <wadl:representation mediaType="application/json"/> + <wadl:doc><![CDATA[]]></wadl:doc> + <wadl:representation mediaType="application/json;charset=UTF-8"/> </wadl:response> </wadl:method> </wadl:resource> @@ -88,11 +135,148 @@ Existing entity is matched using its unique guid if supplied or by its unique at </wadl:param> </wadl:request> <wadl:response> - <wadl:representation mediaType="application/json"/> + <wadl:doc><![CDATA[]]></wadl:doc> + <wadl:representation mediaType="application/json;charset=UTF-8"/> + </wadl:response> + </wadl:method> + </wadl:resource> + + <wadl:resource path="v2/glossary/categories"> + <wadl:method name="POST"> + <wadl:doc><![CDATA[Create glossary category in bulk]]></wadl:doc> + <wadl:request> + <wadl:doc><![CDATA[glossary category definitions]]></wadl:doc> + <wadl:representation mediaType="application/json;charset=UTF-8"> + </wadl:representation> + </wadl:request> + <wadl:response status="400"> + <wadl:doc><![CDATA[If ANY Glossary category definition has invalid or missing information]]></wadl:doc> + </wadl:response> + <wadl:response status="200"> + <wadl:doc><![CDATA[]]></wadl:doc> + <wadl:representation mediaType="application/json;charset=UTF-8"/> + </wadl:response> + </wadl:method> + </wadl:resource> + + <wadl:resource path="v2/glossary/category"> + <wadl:method name="POST"> + <wadl:doc><![CDATA[Create glossary category]]></wadl:doc> + <wadl:request> + <wadl:doc><![CDATA[glossary category definition, a category must be anchored to a Glossary when creating +Optionally, terms belonging to the category and the hierarchy can also be defined during creation]]></wadl:doc> + <wadl:representation mediaType="application/json;charset=UTF-8"> + </wadl:representation> + </wadl:request> + <wadl:response status="400"> + <wadl:doc><![CDATA[If Glossary category definition has invalid or missing information]]></wadl:doc> + </wadl:response> + <wadl:response status="409"> + <wadl:doc><![CDATA[If Glossary category already exists (duplicate qualifiedName)]]></wadl:doc> + </wadl:response> + <wadl:response status="200"> + <wadl:doc><![CDATA[]]></wadl:doc> + <wadl:representation mediaType="application/json;charset=UTF-8"/> + </wadl:response> + </wadl:method> + </wadl:resource> + + <wadl:resource path="v2/glossary/term"> + <wadl:method name="POST"> + <wadl:doc><![CDATA[Create a glossary term]]></wadl:doc> + <wadl:request> + <wadl:doc><![CDATA[Glossary term definition, a term must be anchored to a Glossary at the time of creation +optionally it can be categorized as well]]></wadl:doc> + <wadl:representation mediaType="application/json;charset=UTF-8"> + </wadl:representation> + </wadl:request> + <wadl:response status="400"> + <wadl:doc><![CDATA[If Glossary term definition has invalid or missing information]]></wadl:doc> + </wadl:response> + <wadl:response status="409"> + <wadl:doc><![CDATA[If Glossary term already exists (duplicate qualifiedName)]]></wadl:doc> + </wadl:response> + <wadl:response status="200"> + <wadl:doc><![CDATA[]]></wadl:doc> + <wadl:representation mediaType="application/json;charset=UTF-8"/> </wadl:response> </wadl:method> </wadl:resource> + <wadl:resource path="v2/glossary/terms"> + <wadl:method name="POST"> + <wadl:doc><![CDATA[Create glossary terms in bulk]]></wadl:doc> + <wadl:request> + <wadl:doc><![CDATA[glossary term definitions]]></wadl:doc> + <wadl:representation mediaType="application/json;charset=UTF-8"> + </wadl:representation> + </wadl:request> + <wadl:response status="400"> + <wadl:doc><![CDATA[If any glossary term definition has invalid or missing information]]></wadl:doc> + </wadl:response> + <wadl:response status="200"> + <wadl:doc><![CDATA[]]></wadl:doc> + <wadl:representation mediaType="application/json;charset=UTF-8"/> + </wadl:response> + </wadl:method> + </wadl:resource> + + <wadl:resource path="v2/glossary/{glossaryGuid}"> + <wadl:method name="GET"> + <wadl:doc><![CDATA[Get a specific Glossary]]></wadl:doc> + <wadl:request> + </wadl:request> + <wadl:response status="404"> + <wadl:doc><![CDATA[If glossary GUID is invalid]]></wadl:doc> + </wadl:response> + <wadl:response status="200"> + <wadl:doc><![CDATA[Glossary]]></wadl:doc> + <wadl:representation mediaType="application/json;charset=UTF-8"/> + </wadl:response> + </wadl:method> + <wadl:param name="glossaryGuid" style="template"> + <wadl:doc><![CDATA[unique glossary identifier]]></wadl:doc> + </wadl:param> + </wadl:resource> + + <wadl:resource path="v2/glossary/{glossaryGuid}"> + <wadl:method name="PUT"> + <wadl:doc><![CDATA[Update the given glossary]]></wadl:doc> + <wadl:request> + <wadl:doc><![CDATA[Updated glossary definition]]></wadl:doc> + <wadl:representation mediaType="application/json;charset=UTF-8"> + </wadl:representation> + </wadl:request> + <wadl:response status="404"> + <wadl:doc><![CDATA[If glossary guid in invalid]]></wadl:doc> + </wadl:response> + <wadl:response status="400"> + <wadl:doc><![CDATA[If Glossary definition has invalid or missing information]]></wadl:doc> + </wadl:response> + <wadl:response status="200"> + <wadl:doc><![CDATA[Glossary]]></wadl:doc> + <wadl:representation mediaType="application/json;charset=UTF-8"/> + </wadl:response> + </wadl:method> + <wadl:param name="glossaryGuid" style="template"> + <wadl:doc><![CDATA[unique identifier for glossary]]></wadl:doc> + </wadl:param> + </wadl:resource> + + <wadl:resource path="v2/glossary/{glossaryGuid}"> + <wadl:method name="DELETE"> + <wadl:doc><![CDATA[Delete a glossary]]></wadl:doc> + <wadl:request> + </wadl:request> + <wadl:response status="404"> + <wadl:doc><![CDATA[If glossary guid in invalid]]></wadl:doc> + </wadl:response> + </wadl:method> + <wadl:param name="glossaryGuid" style="template"> + <wadl:doc><![CDATA[unique identifier for glossary]]></wadl:doc> + </wadl:param> + </wadl:resource> + <wadl:resource path="v2/lineage/{guid}"> <wadl:method name="GET"> <wadl:doc><![CDATA[Returns lineage info about entity.]]></wadl:doc> @@ -112,7 +296,7 @@ Existing entity is matched using its unique guid if supplied or by its unique at </wadl:response> <wadl:response status="200"> <wadl:doc><![CDATA[AtlasLineageInfo]]></wadl:doc> - <wadl:representation mediaType="application/json"/> + <wadl:representation mediaType="application/json;charset=UTF-8"/> </wadl:response> </wadl:method> <wadl:param name="guid" style="template"> @@ -145,7 +329,7 @@ Existing entity is matched using its unique guid if supplied or by its unique at </wadl:response> <wadl:response status="200"> <wadl:doc><![CDATA[Search results]]></wadl:doc> - <wadl:representation mediaType="application/json"/> + <wadl:representation mediaType="application/json;charset=UTF-8"/> </wadl:response> </wadl:method> </wadl:resource> @@ -178,7 +362,7 @@ Existing entity is matched using its unique guid if supplied or by its unique at </wadl:response> <wadl:response status="200"> <wadl:doc><![CDATA[Search results]]></wadl:doc> - <wadl:representation mediaType="application/json"/> + <wadl:representation mediaType="application/json;charset=UTF-8"/> </wadl:response> </wadl:method> </wadl:resource> @@ -188,7 +372,7 @@ Existing entity is matched using its unique guid if supplied or by its unique at <wadl:doc><![CDATA[Attribute based search for entities satisfying the search parameters]]></wadl:doc> <wadl:request> <wadl:doc><![CDATA[Search parameters]]></wadl:doc> - <wadl:representation mediaType="application/json"> + <wadl:representation mediaType="application/json;charset=UTF-8"> </wadl:representation> </wadl:request> <wadl:response status="400"> @@ -196,7 +380,7 @@ Existing entity is matched using its unique guid if supplied or by its unique at </wadl:response> <wadl:response status="200"> <wadl:doc><![CDATA[Atlas search result]]></wadl:doc> - <wadl:representation mediaType="application/json"/> + <wadl:representation mediaType="application/json;charset=UTF-8"/> </wadl:response> </wadl:method> </wadl:resource> @@ -226,7 +410,7 @@ Existing entity is matched using its unique guid if supplied or by its unique at </wadl:response> <wadl:response status="200"> <wadl:doc><![CDATA[Search results]]></wadl:doc> - <wadl:representation mediaType="application/json"/> + <wadl:representation mediaType="application/json;charset=UTF-8"/> </wadl:response> </wadl:method> </wadl:resource> @@ -253,7 +437,86 @@ Existing entity is matched using its unique guid if supplied or by its unique at </wadl:response> <wadl:response status="200"> <wadl:doc><![CDATA[Search results]]></wadl:doc> - <wadl:representation mediaType="application/json"/> + <wadl:representation mediaType="application/json;charset=UTF-8"/> + </wadl:response> + </wadl:method> + </wadl:resource> + + <wadl:resource path="v2/search/relationship"> + <wadl:method name="GET"> + <wadl:doc><![CDATA[Relationship search to search for related entities satisfying the search parameters]]></wadl:doc> + <wadl:request> + <wadl:param name="excludeDeletedEntities" style="query"> + <wadl:doc><![CDATA[]]></wadl:doc> + </wadl:param> + <wadl:param name="guid" style="query"> + <wadl:doc><![CDATA[Attribute name]]></wadl:doc> + </wadl:param> + <wadl:param name="limit" style="query"> + <wadl:doc><![CDATA[limit the result set to only include the specified number of entries]]></wadl:doc> + </wadl:param> + <wadl:param name="offset" style="query"> + <wadl:doc><![CDATA[start offset of the result set (useful for pagination)]]></wadl:doc> + </wadl:param> + <wadl:param name="relation" style="query"> + <wadl:doc><![CDATA[relationName]]></wadl:doc> + </wadl:param> + <wadl:param name="sortBy" style="query"> + <wadl:doc><![CDATA[sort the result using this attribute name, default value is 'name']]></wadl:doc> + </wadl:param> + <wadl:param name="sortOrder" style="query"> + <wadl:doc><![CDATA[sorting order]]></wadl:doc> + </wadl:param> + </wadl:request> + <wadl:response status="400"> + <wadl:doc><![CDATA[guid is not a valid entity type or attributeName is not a valid relationship attribute]]></wadl:doc> + </wadl:response> + <wadl:response status="200"> + <wadl:doc><![CDATA[Atlas search result]]></wadl:doc> + <wadl:representation mediaType="application/json;charset=UTF-8"/> + </wadl:response> + </wadl:method> + </wadl:resource> + + <wadl:resource path="v2/search/saved"> + <wadl:method name="POST"> + <wadl:doc><![CDATA[]]></wadl:doc> + <wadl:request> + <wadl:representation mediaType="application/json;charset=UTF-8"> + </wadl:representation> + </wadl:request> + <wadl:response> + <wadl:doc><![CDATA[the saved search-object]]></wadl:doc> + <wadl:representation mediaType="application/json;charset=UTF-8"/> + </wadl:response> + </wadl:method> + </wadl:resource> + + <wadl:resource path="v2/search/saved"> + <wadl:method name="PUT"> + <wadl:doc><![CDATA[]]></wadl:doc> + <wadl:request> + <wadl:representation mediaType="application/json;charset=UTF-8"> + </wadl:representation> + </wadl:request> + <wadl:response> + <wadl:doc><![CDATA[the updated search-object]]></wadl:doc> + <wadl:representation mediaType="application/json;charset=UTF-8"/> + </wadl:response> + </wadl:method> + </wadl:resource> + + <wadl:resource path="v2/search/saved"> + <wadl:method name="GET"> + <wadl:doc><![CDATA[]]></wadl:doc> + <wadl:request> + <wadl:param name="user" style="query"> + <wadl:doc><![CDATA[User for whom the search is retrieved]]></wadl:doc> + </wadl:param> + </wadl:request> + <wadl:response> + <wadl:doc><![CDATA[list of all saved searches for given user]]></wadl:doc> + <wadl:representation mediaType="application/json;charset=UTF-8"/> </wadl:response> </wadl:method> </wadl:resource> @@ -263,7 +526,7 @@ Existing entity is matched using its unique guid if supplied or by its unique at <wadl:doc><![CDATA[Bulk retrieval API for retrieving all type definitions in Atlas]]></wadl:doc> <wadl:response status="200"> <wadl:doc><![CDATA[A composite wrapper object with lists of all type definitions]]></wadl:doc> - <wadl:representation mediaType="application/json"/> + <wadl:representation mediaType="application/json;charset=UTF-8"/> </wadl:response> </wadl:method> </wadl:resource> @@ -274,7 +537,7 @@ Existing entity is matched using its unique guid if supplied or by its unique at Any changes to the existing definitions will be discarded]]></wadl:doc> <wadl:request> <wadl:doc><![CDATA[A composite wrapper object with corresponding lists of the type definition]]></wadl:doc> - <wadl:representation mediaType="application/json"> + <wadl:representation mediaType="application/json;charset=UTF-8"> </wadl:representation> </wadl:request> <wadl:response status="400"> @@ -283,7 +546,7 @@ Any changes to the existing definitions will be discarded]]></wadl:doc> <wadl:response status="200"> <wadl:doc><![CDATA[A composite wrapper object with lists of type definitions that were successfully created]]></wadl:doc> - <wadl:representation mediaType="application/json"/> + <wadl:representation mediaType="application/json;charset=UTF-8"/> </wadl:response> </wadl:method> </wadl:resource> @@ -293,7 +556,7 @@ created]]></wadl:doc> <wadl:doc><![CDATA[Bulk update API for all types, changes detected in the type definitions would be persisted]]></wadl:doc> <wadl:request> <wadl:doc><![CDATA[A composite object that captures all type definition changes]]></wadl:doc> - <wadl:representation mediaType="application/json"> + <wadl:representation mediaType="application/json;charset=UTF-8"> </wadl:representation> </wadl:request> <wadl:response status="400"> @@ -301,7 +564,7 @@ created]]></wadl:doc> </wadl:response> <wadl:response status="200"> <wadl:doc><![CDATA[A composite object with lists of type definitions that were updated]]></wadl:doc> - <wadl:representation mediaType="application/json"/> + <wadl:representation mediaType="application/json;charset=UTF-8"/> </wadl:response> </wadl:method> </wadl:resource> @@ -311,7 +574,7 @@ created]]></wadl:doc> <wadl:doc><![CDATA[Bulk delete API for all types]]></wadl:doc> <wadl:request> <wadl:doc><![CDATA[A composite object that captures all types to be deleted]]></wadl:doc> - <wadl:representation mediaType="application/json"> + <wadl:representation mediaType="application/json;charset=UTF-8"> </wadl:representation> </wadl:request> <wadl:response status="400"> @@ -326,6 +589,8 @@ created]]></wadl:doc> <wadl:request> <wadl:representation mediaType="application/json"> </wadl:representation> + <wadl:representation mediaType="application/json;charset=UTF-8"> + </wadl:representation> </wadl:request> </wadl:method> </wadl:resource> @@ -337,7 +602,7 @@ created]]></wadl:doc> </wadl:request> <wadl:response> <wadl:doc><![CDATA[AtlasEntity]]></wadl:doc> - <wadl:representation mediaType="application/json"/> + <wadl:representation mediaType="application/json;charset=UTF-8"/> </wadl:response> </wadl:method> <wadl:param name="guid" style="template"> @@ -352,14 +617,15 @@ Supports only uprimitive attribute type and entity references. does not support updation of complex types like arrays, maps Null updates are not possible]]></wadl:doc> <wadl:request> - <wadl:representation mediaType="application/json"> + <wadl:representation mediaType="application/json;charset=UTF-8"> </wadl:representation> <wadl:param name="name" style="query"> <wadl:doc><![CDATA[]]></wadl:doc> </wadl:param> </wadl:request> <wadl:response> - <wadl:representation mediaType="application/json"/> + <wadl:doc><![CDATA[]]></wadl:doc> + <wadl:representation mediaType="application/json;charset=UTF-8"/> </wadl:response> </wadl:method> <wadl:param name="guid" style="template"> @@ -374,7 +640,7 @@ Null updates are not possible]]></wadl:doc> </wadl:request> <wadl:response> <wadl:doc><![CDATA[EntityMutationResponse]]></wadl:doc> - <wadl:representation mediaType="application/json"/> + <wadl:representation mediaType="application/json;charset=UTF-8"/> </wadl:response> </wadl:method> <wadl:param name="guid" style="template"> @@ -382,13 +648,20 @@ Null updates are not possible]]></wadl:doc> </wadl:param> </wadl:resource> - <wadl:resource path="v2/relationship/guid/{guid}"> + <wadl:resource path="v2/entity/{guid}/audit"> <wadl:method name="GET"> - <wadl:doc><![CDATA[Get relationship information between entities using guid.]]></wadl:doc> + <wadl:doc><![CDATA[]]></wadl:doc> <wadl:request> + <wadl:param name="count" style="query"> + <wadl:doc><![CDATA[]]></wadl:doc> + </wadl:param> + <wadl:param name="startKey" style="query"> + <wadl:doc><![CDATA[]]></wadl:doc> + </wadl:param> </wadl:request> <wadl:response> - <wadl:representation mediaType="application/json"/> + <wadl:doc><![CDATA[]]></wadl:doc> + <wadl:representation mediaType="application/json;charset=UTF-8"/> </wadl:response> </wadl:method> <wadl:param name="guid" style="template"> @@ -396,111 +669,399 @@ Null updates are not possible]]></wadl:doc> </wadl:param> </wadl:resource> - <wadl:resource path="v2/relationship/guid/{guid}"> - <wadl:method name="DELETE"> - <wadl:doc><![CDATA[Delete a relationship between entities using guid.]]></wadl:doc> - <wadl:request> - </wadl:request> - </wadl:method> - <wadl:param name="guid" style="template"> - <wadl:doc><![CDATA[]]></wadl:doc> - </wadl:param> - </wadl:resource> - - <wadl:resource path="v2/types/typedefs/headers"> - <wadl:method name="GET"> - <wadl:doc><![CDATA[Bulk retrieval API for all type definitions returned as a list of minimal information header]]></wadl:doc> - <wadl:response status="200"> - <wadl:doc><![CDATA[List of AtlasTypeDefHeader AtlasTypeDefHeader]]></wadl:doc> - <wadl:representation mediaType="application/json"/> - </wadl:response> - </wadl:method> - </wadl:resource> - - <wadl:resource path="v2/entity/guid/{guid}/classifications"> + <wadl:resource path="v2/glossary/category/{categoryGuid}"> <wadl:method name="GET"> - <wadl:doc><![CDATA[Gets the list of classifications for a given entity represented by a guid.]]></wadl:doc> + <wadl:doc><![CDATA[Get specific glossary category]]></wadl:doc> <wadl:request> </wadl:request> - <wadl:response> - <wadl:doc><![CDATA[a list of classifications for the given entity guid]]></wadl:doc> - <wadl:representation mediaType="application/json"/> + <wadl:response status="404"> + <wadl:doc><![CDATA[If glossary category GUID is invalid]]></wadl:doc> + </wadl:response> + <wadl:response status="200"> + <wadl:doc><![CDATA[Glossary category]]></wadl:doc> + <wadl:representation mediaType="application/json;charset=UTF-8"/> </wadl:response> </wadl:method> - <wadl:param name="guid" style="template"> - <wadl:doc><![CDATA[globally unique identifier for the entity]]></wadl:doc> + <wadl:param name="categoryGuid" style="template"> + <wadl:doc><![CDATA[unique identifier for glossary category]]></wadl:doc> </wadl:param> </wadl:resource> - <wadl:resource path="v2/entity/guid/{guid}/classifications"> - <wadl:method name="POST"> - <wadl:doc><![CDATA[Adds classifications to an existing entity represented by a guid.]]></wadl:doc> + <wadl:resource path="v2/glossary/category/{categoryGuid}"> + <wadl:method name="PUT"> + <wadl:doc><![CDATA[Update the given glossary category]]></wadl:doc> <wadl:request> - <wadl:representation mediaType="application/json"> + <wadl:doc><![CDATA[updated glossary category]]></wadl:doc> + <wadl:representation mediaType="application/json;charset=UTF-8"> </wadl:representation> </wadl:request> + <wadl:response status="404"> + <wadl:doc><![CDATA[If glossary category guid in invalid]]></wadl:doc> + </wadl:response> + <wadl:response status="400"> + <wadl:doc><![CDATA[If Glossary category definition has invalid or missing information]]></wadl:doc> + </wadl:response> + <wadl:response status="200"> + <wadl:doc><![CDATA[glossary category]]></wadl:doc> + <wadl:representation mediaType="application/json;charset=UTF-8"/> + </wadl:response> </wadl:method> - <wadl:param name="guid" style="template"> - <wadl:doc><![CDATA[globally unique identifier for the entity]]></wadl:doc> + <wadl:param name="categoryGuid" style="template"> + <wadl:doc><![CDATA[unique identifier for glossary category]]></wadl:doc> </wadl:param> </wadl:resource> - <wadl:resource path="v2/entity/guid/{guid}/classifications"> - <wadl:method name="PUT"> - <wadl:doc><![CDATA[Updates classifications to an existing entity represented by a guid.]]></wadl:doc> + <wadl:resource path="v2/glossary/category/{categoryGuid}"> + <wadl:method name="DELETE"> + <wadl:doc><![CDATA[Delete a glossary category]]></wadl:doc> <wadl:request> - <wadl:representation mediaType="application/json"> - </wadl:representation> - <wadl:representation mediaType="application/xml" element="atlasClassification"> - </wadl:representation> </wadl:request> + <wadl:response status="404"> + <wadl:doc><![CDATA[If glossary category guid in invalid]]></wadl:doc> + </wadl:response> </wadl:method> - <wadl:param name="guid" style="template"> - <wadl:doc><![CDATA[globally unique identifier for the entity]]></wadl:doc> + <wadl:param name="categoryGuid" style="template"> + <wadl:doc><![CDATA[unique identifier for glossary category]]></wadl:doc> </wadl:param> </wadl:resource> - <wadl:resource path="v2/entity/uniqueAttribute/type/{typeName}"> + <wadl:resource path="v2/glossary/term/{termGuid}"> <wadl:method name="GET"> - <wadl:doc><![CDATA[Fetch complete definition of an entity given its type and unique attribute.]]></wadl:doc> + <wadl:doc><![CDATA[Get specific glossary term]]></wadl:doc> <wadl:request> </wadl:request> - <wadl:response> - <wadl:doc><![CDATA[AtlasEntityWithExtInfo]]></wadl:doc> - <wadl:representation mediaType="application/json"/> + <wadl:response status="404"> + <wadl:doc><![CDATA[If glossary term GUID is invalid]]></wadl:doc> + </wadl:response> + <wadl:response status="200"> + <wadl:doc><![CDATA[Glossary term]]></wadl:doc> + <wadl:representation mediaType="application/json;charset=UTF-8"/> </wadl:response> </wadl:method> - <wadl:param name="typeName" style="template"> - <wadl:doc><![CDATA[]]></wadl:doc> + <wadl:param name="termGuid" style="template"> + <wadl:doc><![CDATA[unique identifier for glossary term]]></wadl:doc> </wadl:param> </wadl:resource> - <wadl:resource path="v2/entity/uniqueAttribute/type/{typeName}"> + <wadl:resource path="v2/glossary/term/{termGuid}"> <wadl:method name="PUT"> - <wadl:doc><![CDATA[Entity Partial Update - Allows a subset of attributes to be updated on -an entity which is identified by its type and unique attribute eg: Referenceable.qualifiedName. -Null updates are not possible]]></wadl:doc> + <wadl:doc><![CDATA[Update the given glossary term]]></wadl:doc> <wadl:request> - <wadl:representation mediaType="application/json"> + <wadl:doc><![CDATA[updated glossary term]]></wadl:doc> + <wadl:representation mediaType="application/json;charset=UTF-8"> </wadl:representation> </wadl:request> - <wadl:response> - <wadl:representation mediaType="application/json"/> + <wadl:response status="404"> + <wadl:doc><![CDATA[If glossary term guid in invalid]]></wadl:doc> + </wadl:response> + <wadl:response status="400"> + <wadl:doc><![CDATA[If Glossary temr definition has invalid or missing information]]></wadl:doc> + </wadl:response> + <wadl:response status="200"> + <wadl:doc><![CDATA[Updated glossary term]]></wadl:doc> + <wadl:representation mediaType="application/json;charset=UTF-8"/> </wadl:response> </wadl:method> - <wadl:param name="typeName" style="template"> - <wadl:doc><![CDATA[]]></wadl:doc> + <wadl:param name="termGuid" style="template"> + <wadl:doc><![CDATA[unique identifier for glossary term]]></wadl:doc> </wadl:param> </wadl:resource> - <wadl:resource path="v2/entity/uniqueAttribute/type/{typeName}"> + <wadl:resource path="v2/glossary/term/{termGuid}"> <wadl:method name="DELETE"> - <wadl:doc><![CDATA[Delete an entity identified by its type and unique attributes.]]></wadl:doc> + <wadl:doc><![CDATA[Delete a glossary term]]></wadl:doc> <wadl:request> </wadl:request> - <wadl:response> - <wadl:doc><![CDATA[EntityMutationResponse]]></wadl:doc> - <wadl:representation mediaType="application/json"/> + <wadl:response status="404"> + <wadl:doc><![CDATA[If glossary term guid in invalid]]></wadl:doc> + </wadl:response> + </wadl:method> + <wadl:param name="termGuid" style="template"> + <wadl:doc><![CDATA[unique identifier for glossary term]]></wadl:doc> + </wadl:param> + </wadl:resource> + + <wadl:resource path="v2/glossary/{glossaryGuid}/categories"> + <wadl:method name="GET"> + <wadl:doc><![CDATA[Get the categories belonging to a specific glossary]]></wadl:doc> + <wadl:request> + <wadl:param name="limit" style="query"> + <wadl:doc><![CDATA[page size - by default there is no paging]]></wadl:doc> + </wadl:param> + <wadl:param name="offset" style="query"> + <wadl:doc><![CDATA[offset for pagination purpose]]></wadl:doc> + </wadl:param> + <wadl:param name="sort" style="query"> + <wadl:doc><![CDATA[ASC (default) or DESC]]></wadl:doc> + </wadl:param> + </wadl:request> + <wadl:response status="404"> + <wadl:doc><![CDATA[If glossary guid in invalid]]></wadl:doc> + </wadl:response> + <wadl:response status="200"> + <wadl:doc><![CDATA[List of associated categories]]></wadl:doc> + <wadl:representation mediaType="application/json;charset=UTF-8"/> + </wadl:response> + </wadl:method> + <wadl:param name="glossaryGuid" style="template"> + <wadl:doc><![CDATA[unique identifier for glossary term]]></wadl:doc> + </wadl:param> + </wadl:resource> + + <wadl:resource path="v2/glossary/{glossaryGuid}/detailed"> + <wadl:method name="GET"> + <wadl:doc><![CDATA[Get a specific Glossary]]></wadl:doc> + <wadl:request> + </wadl:request> + <wadl:response status="404"> + <wadl:doc><![CDATA[If glossary GUID is invalid]]></wadl:doc> + </wadl:response> + <wadl:response status="200"> + <wadl:doc><![CDATA[Glossary]]></wadl:doc> + <wadl:representation mediaType="application/json;charset=UTF-8"/> + </wadl:response> + </wadl:method> + <wadl:param name="glossaryGuid" style="template"> + <wadl:doc><![CDATA[unique glossary identifier]]></wadl:doc> + </wadl:param> + </wadl:resource> + + <wadl:resource path="v2/glossary/{glossaryGuid}/partial"> + <wadl:method name="PUT"> + <wadl:doc><![CDATA[Partially update the glossary]]></wadl:doc> + <wadl:request> + <wadl:doc><![CDATA[Map containing keys as attribute names and values as corresponding attribute values]]></wadl:doc> + <wadl:representation mediaType="application/json;charset=UTF-8"> + </wadl:representation> + </wadl:request> + <wadl:response status="404"> + <wadl:doc><![CDATA[If glossary guid in invalid]]></wadl:doc> + </wadl:response> + <wadl:response status="400"> + <wadl:doc><![CDATA[If partial update parameters are invalid]]></wadl:doc> + </wadl:response> + <wadl:response status="200"> + <wadl:doc><![CDATA[Updated glossary]]></wadl:doc> + <wadl:representation mediaType="application/json;charset=UTF-8"/> + </wadl:response> + </wadl:method> + <wadl:param name="glossaryGuid" style="template"> + <wadl:doc><![CDATA[unique identifier for glossary term]]></wadl:doc> + </wadl:param> + </wadl:resource> + + <wadl:resource path="v2/glossary/{glossaryGuid}/terms"> + <wadl:method name="GET"> + <wadl:doc><![CDATA[Get terms belonging to a specific glossary]]></wadl:doc> + <wadl:request> + <wadl:param name="limit" style="query"> + <wadl:doc><![CDATA[page size - by default there is no paging]]></wadl:doc> + </wadl:param> + <wadl:param name="offset" style="query"> + <wadl:doc><![CDATA[starting offset for loading terms]]></wadl:doc> + </wadl:param> + <wadl:param name="sort" style="query"> + <wadl:doc><![CDATA[ASC(default) or DESC]]></wadl:doc> + </wadl:param> + </wadl:request> + <wadl:response status="404"> + <wadl:doc><![CDATA[If glossary guid in invalid]]></wadl:doc> + </wadl:response> + <wadl:response status="200"> + <wadl:doc><![CDATA[List of terms associated with the glossary]]></wadl:doc> + <wadl:representation mediaType="application/json;charset=UTF-8"/> + </wadl:response> + </wadl:method> + <wadl:param name="glossaryGuid" style="template"> + <wadl:doc><![CDATA[unique identifier for glossary]]></wadl:doc> + </wadl:param> + </wadl:resource> + + <wadl:resource path="v2/relationship/guid/{guid}"> + <wadl:method name="GET"> + <wadl:doc><![CDATA[Get relationship information between entities using guid.]]></wadl:doc> + <wadl:request> + <wadl:param name="extendedInfo" style="query"> + <wadl:doc><![CDATA[]]></wadl:doc> + </wadl:param> + </wadl:request> + <wadl:response> + <wadl:doc><![CDATA[]]></wadl:doc> + <wadl:representation mediaType="application/json;charset=UTF-8"/> + </wadl:response> + </wadl:method> + <wadl:param name="guid" style="template"> + <wadl:doc><![CDATA[]]></wadl:doc> + </wadl:param> + </wadl:resource> + + <wadl:resource path="v2/relationship/guid/{guid}"> + <wadl:method name="DELETE"> + <wadl:doc><![CDATA[Delete a relationship between entities using guid.]]></wadl:doc> + <wadl:request> + </wadl:request> + </wadl:method> + <wadl:param name="guid" style="template"> + <wadl:doc><![CDATA[]]></wadl:doc> + </wadl:param> + </wadl:resource> + + <wadl:resource path="v2/search/saved/{guid}"> + <wadl:method name="DELETE"> + <wadl:doc><![CDATA[]]></wadl:doc> + <wadl:request> + </wadl:request> + </wadl:method> + <wadl:param name="guid" style="template"> + <wadl:doc><![CDATA[Name of the saved search]]></wadl:doc> + </wadl:param> + </wadl:resource> + + <wadl:resource path="v2/search/saved/{name}"> + <wadl:method name="GET"> + <wadl:doc><![CDATA[]]></wadl:doc> + <wadl:request> + <wadl:param name="user" style="query"> + <wadl:doc><![CDATA[User for whom the search is retrieved]]></wadl:doc> + </wadl:param> + </wadl:request> + <wadl:response> + <wadl:doc><![CDATA[]]></wadl:doc> + <wadl:representation mediaType="application/json;charset=UTF-8"/> + </wadl:response> + </wadl:method> + <wadl:param name="name" style="template"> + <wadl:doc><![CDATA[Name of the saved search]]></wadl:doc> + </wadl:param> + </wadl:resource> + + <wadl:resource path="v2/types/typedefs/headers"> + <wadl:method name="GET"> + <wadl:doc><![CDATA[Bulk retrieval API for all type definitions returned as a list of minimal information header]]></wadl:doc> + <wadl:response status="200"> + <wadl:doc><![CDATA[List of AtlasTypeDefHeader AtlasTypeDefHeader]]></wadl:doc> + <wadl:representation mediaType="application/json;charset=UTF-8"/> + </wadl:response> + </wadl:method> + </wadl:resource> + + <wadl:resource path="v2/entity/guid/{guid}/classifications"> + <wadl:method name="GET"> + <wadl:doc><![CDATA[Gets the list of classifications for a given entity represented by a guid.]]></wadl:doc> + <wadl:request> + </wadl:request> + <wadl:response> + <wadl:doc><![CDATA[a list of classifications for the given entity guid]]></wadl:doc> + <wadl:representation mediaType="application/json;charset=UTF-8"/> + </wadl:response> + </wadl:method> + <wadl:param name="guid" style="template"> + <wadl:doc><![CDATA[globally unique identifier for the entity]]></wadl:doc> + </wadl:param> + </wadl:resource> + + <wadl:resource path="v2/entity/guid/{guid}/classifications"> + <wadl:method name="POST"> + <wadl:doc><![CDATA[Adds classifications to an existing entity represented by a guid.]]></wadl:doc> + <wadl:request> + <wadl:representation mediaType="application/json"> + </wadl:representation> + <wadl:representation mediaType="application/json;charset=UTF-8"> + </wadl:representation> + </wadl:request> + </wadl:method> + <wadl:param name="guid" style="template"> + <wadl:doc><![CDATA[globally unique identifier for the entity]]></wadl:doc> + </wadl:param> + </wadl:resource> + + <wadl:resource path="v2/entity/guid/{guid}/classifications"> + <wadl:method name="PUT"> + <wadl:doc><![CDATA[Updates classifications to an existing entity represented by a guid.]]></wadl:doc> + <wadl:request> + <wadl:representation mediaType="application/json"> + </wadl:representation> + <wadl:representation mediaType="application/xml" element="atlasClassification"> + </wadl:representation> + </wadl:request> + </wadl:method> + <wadl:param name="guid" style="template"> + <wadl:doc><![CDATA[globally unique identifier for the entity]]></wadl:doc> + </wadl:param> + </wadl:resource> + + <wadl:resource path="v2/entity/uniqueAttribute/type/{typeName}"> + <wadl:method name="GET"> + <wadl:doc><![CDATA[Fetch complete definition of an entity given its type and unique attribute. + +In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format + +attr:<attrName>=<attrValue> + +NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName + +The REST request would look something like this + +GET /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue]]></wadl:doc> + <wadl:request> + </wadl:request> + <wadl:response> + <wadl:doc><![CDATA[AtlasEntityWithExtInfo]]></wadl:doc> + <wadl:representation mediaType="application/json;charset=UTF-8"/> + </wadl:response> + </wadl:method> + <wadl:param name="typeName" style="template"> + <wadl:doc><![CDATA[]]></wadl:doc> + </wadl:param> + </wadl:resource> + + <wadl:resource path="v2/entity/uniqueAttribute/type/{typeName}"> + <wadl:method name="PUT"> + <wadl:doc><![CDATA[Entity Partial Update - Allows a subset of attributes to be updated on +an entity which is identified by its type and unique attribute eg: Referenceable.qualifiedName. +Null updates are not possible + +In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format + +attr:<attrName>=<attrValue> + +NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName + +The REST request would look something like this + +PUT /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue]]></wadl:doc> + <wadl:request> + <wadl:representation mediaType="application/json;charset=UTF-8"> + </wadl:representation> + </wadl:request> + <wadl:response> + <wadl:doc><![CDATA[]]></wadl:doc> + <wadl:representation mediaType="application/json;charset=UTF-8"/> + </wadl:response> + </wadl:method> + <wadl:param name="typeName" style="template"> + <wadl:doc><![CDATA[]]></wadl:doc> + </wadl:param> + </wadl:resource> + + <wadl:resource path="v2/entity/uniqueAttribute/type/{typeName}"> + <wadl:method name="DELETE"> + <wadl:doc><![CDATA[Delete an entity identified by its type and unique attributes. + +In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format + +attr:<attrName>=<attrValue> + +NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName + +The REST request would look something like this + +DELETE /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue]]></wadl:doc> + <wadl:request> + </wadl:request> + <wadl:response> + <wadl:doc><![CDATA[EntityMutationResponse]]></wadl:doc> + <wadl:representation mediaType="application/json;charset=UTF-8"/> </wadl:response> </wadl:method> <wadl:param name="typeName" style="template"> @@ -508,6 +1069,271 @@ Null updates are not possible]]></wadl:doc> </wadl:param> </wadl:resource> + <wadl:resource path="v2/glossary/category/{categoryGuid}/partial"> + <wadl:method name="PUT"> + <wadl:doc><![CDATA[Partially update the glossary category]]></wadl:doc> + <wadl:request> + <wadl:doc><![CDATA[Map containing keys as attribute names and values as corresponding attribute values]]></wadl:doc> + <wadl:representation mediaType="application/json;charset=UTF-8"> + </wadl:representation> + </wadl:request> + <wadl:response status="404"> + <wadl:doc><![CDATA[If glossary category guid in invalid]]></wadl:doc> + </wadl:response> + <wadl:response status="400"> + <wadl:doc><![CDATA[If category attributes are invalid]]></wadl:doc> + </wadl:response> + <wadl:response status="200"> + <wadl:doc><![CDATA[Updated glossary category]]></wadl:doc> + <wadl:representation mediaType="application/json;charset=UTF-8"/> + </wadl:response> + </wadl:method> + <wadl:param name="categoryGuid" style="template"> + <wadl:doc><![CDATA[unique identifier for glossary term]]></wadl:doc> + </wadl:param> + </wadl:resource> + + <wadl:resource path="v2/glossary/category/{categoryGuid}/related"> + <wadl:method name="GET"> + <wadl:doc><![CDATA[Get all related categories (parent and children)]]></wadl:doc> + <wadl:request> + <wadl:param name="limit" style="query"> + <wadl:doc><![CDATA[page size - by default there is no paging]]></wadl:doc> + </wadl:param> + <wadl:param name="offset" style="query"> + <wadl:doc><![CDATA[offset for pagination purpose]]></wadl:doc> + </wadl:param> + <wadl:param name="sort" style="query"> + <wadl:doc><![CDATA[ASC (default) or DESC]]></wadl:doc> + </wadl:param> + </wadl:request> + <wadl:response> + <wadl:doc><![CDATA[List of related categories]]></wadl:doc> + <wadl:representation mediaType="application/json;charset=UTF-8"/> + </wadl:response> + </wadl:method> + <wadl:param name="categoryGuid" style="template"> + <wadl:doc><![CDATA[unique identifier for glossary category]]></wadl:doc> + </wadl:param> + </wadl:resource> + + <wadl:resource path="v2/glossary/category/{categoryGuid}/terms"> + <wadl:method name="GET"> + <wadl:doc><![CDATA[Get all terms associated with the specific category]]></wadl:doc> + <wadl:request> + <wadl:param name="limit" style="query"> + <wadl:doc><![CDATA[page size - by default there is no paging]]></wadl:doc> + </wadl:param> + <wadl:param name="offset" style="query"> + <wadl:doc><![CDATA[offset for pagination purpose]]></wadl:doc> + </wadl:param> + <wadl:param name="sort" style="query"> + <wadl:doc><![CDATA[ASC (default) or DESC]]></wadl:doc> + </wadl:param> + </wadl:request> + <wadl:response status="404"> + <wadl:doc><![CDATA[If glossary category guid in invalid]]></wadl:doc> + </wadl:response> + <wadl:response status="200"> + <wadl:doc><![CDATA[List of associated terms]]></wadl:doc> + <wadl:representation mediaType="application/json;charset=UTF-8"/> + </wadl:response> + </wadl:method> + <wadl:param name="categoryGuid" style="template"> + <wadl:doc><![CDATA[unique identifier for glossary category]]></wadl:doc> + </wadl:param> + </wadl:resource> + + <wadl:resource path="v2/glossary/term/{termGuid}/partial"> + <wadl:method name="PUT"> + <wadl:doc><![CDATA[Partially update the glossary term]]></wadl:doc> + <wadl:request> + <wadl:doc><![CDATA[Map containing keys as attribute names and values as corresponding attribute values]]></wadl:doc> + <wadl:representation mediaType="application/json;charset=UTF-8"> + </wadl:representation> + </wadl:request> + <wadl:response status="404"> + <wadl:doc><![CDATA[If glossary term guid in invalid]]></wadl:doc> + </wadl:response> + <wadl:response status="400"> + <wadl:doc><![CDATA[If partial attributes are invalid]]></wadl:doc> + </wadl:response> + <wadl:response status="200"> + <wadl:doc><![CDATA[Updated glossary term]]></wadl:doc> + <wadl:representation mediaType="application/json;charset=UTF-8"/> + </wadl:response> + </wadl:method> + <wadl:param name="termGuid" style="template"> + <wadl:doc><![CDATA[unique identifier for glossary term]]></wadl:doc> + </wadl:param> + </wadl:resource> + + <wadl:resource path="v2/glossary/terms/{termGuid}/assignedEntities"> + <wadl:method name="GET"> + <wadl:doc><![CDATA[Get all entity headers assigned with the specified term]]></wadl:doc> + <wadl:request> + <wadl:param name="limit" style="query"> + <wadl:doc><![CDATA[page size - by default there is no paging]]></wadl:doc> + </wadl:param> + <wadl:param name="offset" style="query"> + <wadl:doc><![CDATA[offset for pagination purpose]]></wadl:doc> + </wadl:param> + <wadl:param name="sort" style="query"> + <wadl:doc><![CDATA[ASC (default) or DESC]]></wadl:doc> + </wadl:param> + </wadl:request> + <wadl:response status="404"> + <wadl:doc><![CDATA[If glossary term guid in invalid]]></wadl:doc> + </wadl:response> + <wadl:response status="200"> + <wadl:doc><![CDATA[]]></wadl:doc> + <wadl:representation mediaType="application/json;charset=UTF-8"/> + </wadl:response> + </wadl:method> + <wadl:param name="termGuid" style="template"> + <wadl:doc><![CDATA[GUID of the term]]></wadl:doc> + </wadl:param> + </wadl:resource> + + <wadl:resource path="v2/glossary/terms/{termGuid}/assignedEntities"> + <wadl:method name="POST"> + <wadl:doc><![CDATA[Assign the given term to the provided list of entity headers]]></wadl:doc> + <wadl:request> + <wadl:doc><![CDATA[Related Entity IDs to which the term has to be associated]]></wadl:doc> + <wadl:representation mediaType="application/json;charset=UTF-8"> + </wadl:representation> + </wadl:request> + <wadl:response status="400"> + <wadl:doc><![CDATA[If ANY of the entity header is invalid]]></wadl:doc> + </wadl:response> + <wadl:response status="404"> + <wadl:doc><![CDATA[If glossary guid in invalid]]></wadl:doc> + </wadl:response> + </wadl:method> + <wadl:param name="termGuid" style="template"> + <wadl:doc><![CDATA[Glossary term GUID]]></wadl:doc> + </wadl:param> + </wadl:resource> + + <wadl:resource path="v2/glossary/terms/{termGuid}/assignedEntities"> + <wadl:method name="DELETE"> + <wadl:doc><![CDATA[Remove the term assignment for the given list of entity headers]]></wadl:doc> + <wadl:request> + <wadl:doc><![CDATA[List of related entity IDs from which the term has to be dissociated]]></wadl:doc> + <wadl:representation mediaType="application/json;charset=UTF-8"> + </wadl:representation> + </wadl:request> + <wadl:response status="400"> + <wadl:doc><![CDATA[If ANY of the entity header is invalid]]></wadl:doc> + </wadl:response> + <wadl:response status="404"> + <wadl:doc><![CDATA[If glossary term guid in invalid]]></wadl:doc> + </wadl:response> + </wadl:method> + <wadl:param name="termGuid" style="template"> + <wadl:doc><![CDATA[Glossary term GUID]]></wadl:doc> + </wadl:param> + </wadl:resource> + + <wadl:resource path="v2/glossary/terms/{termGuid}/related"> + <wadl:method name="GET"> + <wadl:doc><![CDATA[Get all related terms for a specific term]]></wadl:doc> + <wadl:request> + <wadl:param name="limit" style="query"> + <wadl:doc><![CDATA[page size - by default there is no paging]]></wadl:doc> + </wadl:param> + <wadl:param name="offset" style="query"> + <wadl:doc><![CDATA[offset for pagination purpose]]></wadl:doc> + </wadl:param> + <wadl:param name="sort" style="query"> + <wadl:doc><![CDATA[ASC (default) or DESC]]></wadl:doc> + </wadl:param> + </wadl:request> + <wadl:response status="404"> + <wadl:doc><![CDATA[If glossary term guid in invalid]]></wadl:doc> + </wadl:response> + <wadl:response status="200"> + <wadl:doc><![CDATA[List of all related terms]]></wadl:doc> + <wadl:representation mediaType="application/json;charset=UTF-8"/> + </wadl:response> + </wadl:method> + <wadl:param name="termGuid" style="template"> + <wadl:doc><![CDATA[unique identifier for glossary term]]></wadl:doc> + </wadl:param> + </wadl:resource> + + <wadl:resource path="v2/glossary/{glossaryGuid}/categories/headers"> + <wadl:method name="GET"> + <wadl:doc><![CDATA[Get the categories belonging to a specific glossary]]></wadl:doc> + <wadl:request> + <wadl:param name="limit" style="query"> + <wadl:doc><![CDATA[page size - by default there is no paging]]></wadl:doc> + </wadl:param> + <wadl:param name="offset" style="query"> + <wadl:doc><![CDATA[offset for pagination purpose]]></wadl:doc> + </wadl:param> + <wadl:param name="sort" style="query"> + <wadl:doc><![CDATA[ASC (default) or DESC]]></wadl:doc> + </wadl:param> + </wadl:request> + <wadl:response status="404"> + <wadl:doc><![CDATA[If glossary guid in invalid]]></wadl:doc> + </wadl:response> + <wadl:response status="200"> + <wadl:doc><![CDATA[List of associated categories]]></wadl:doc> + <wadl:representation mediaType="application/json;charset=UTF-8"/> + </wadl:response> + </wadl:method> + <wadl:param name="glossaryGuid" style="template"> + <wadl:doc><![CDATA[unique identifier for glossary term]]></wadl:doc> + </wadl:param> + </wadl:resource> + + <wadl:resource path="v2/glossary/{glossaryGuid}/terms/headers"> + <wadl:method name="GET"> + <wadl:doc><![CDATA[Get term headers belonging to a specific glossary]]></wadl:doc> + <wadl:request> + <wadl:param name="limit" style="query"> + <wadl:doc><![CDATA[page size - by default there is no paging]]></wadl:doc> + </wadl:param> + <wadl:param name="offset" style="query"> + <wadl:doc><![CDATA[starting offset for loading terms]]></wadl:doc> + </wadl:param> + <wadl:param name="sort" style="query"> + <wadl:doc><![CDATA[ASC(default) or DESC]]></wadl:doc> + </wadl:param> + </wadl:request> + <wadl:response status="404"> + <wadl:doc><![CDATA[If glossary guid in invalid]]></wadl:doc> + </wadl:response> + <wadl:response status="200"> + <wadl:doc><![CDATA[List of terms associated with the glossary]]></wadl:doc> + <wadl:representation mediaType="application/json;charset=UTF-8"/> + </wadl:response> + </wadl:method> + <wadl:param name="glossaryGuid" style="template"> + <wadl:doc><![CDATA[unique identifier for glossary]]></wadl:doc> + </wadl:param> + </wadl:resource> + + <wadl:resource path="v2/search/saved/execute/{name}"> + <wadl:method name="GET"> + <wadl:doc><![CDATA[Attribute based search for entities satisfying the search parameters]]></wadl:doc> + <wadl:request> + <wadl:param name="user" style="query"> + <wadl:doc><![CDATA[saved-search owner]]></wadl:doc> + </wadl:param> + </wadl:request> + <wadl:response> + <wadl:doc><![CDATA[Atlas search result]]></wadl:doc> + <wadl:representation mediaType="application/json;charset=UTF-8"/> + </wadl:response> + </wadl:method> + <wadl:param name="name" style="template"> + <wadl:doc><![CDATA[name of saved-search]]></wadl:doc> + </wadl:param> + </wadl:resource> + <wadl:resource path="v2/types/classificationdef/guid/{guid}"> <wadl:method name="GET"> <wadl:doc><![CDATA[Get the classification definition for the given guid]]></wadl:doc> @@ -518,7 +1344,7 @@ Null updates are not possible]]></wadl:doc> </wadl:response> <wadl:response status="200"> <wadl:doc><![CDATA[classification definition]]></wadl:doc> - <wadl:representation mediaType="application/json"/> + <wadl:representation mediaType="application/json;charset=UTF-8"/> </wadl:response> </wadl:method> <wadl:param name="guid" style="template"> @@ -536,7 +1362,7 @@ Null updates are not possible]]></wadl:doc> </wadl:response> <wadl:response status="200"> <wadl:doc><![CDATA[classification definition]]></wadl:doc> - <wadl:representation mediaType="application/json"/> + <wadl:representation mediaType="application/json;charset=UTF-8"/> </wadl:response> </wadl:method> <wadl:param name="name" style="template"> @@ -554,7 +1380,7 @@ Null updates are not possible]]></wadl:doc> </wadl:response> <wadl:response status="200"> <wadl:doc><![CDATA[Entity definition]]></wadl:doc> - <wadl:representation mediaType="application/json"/> + <wadl:representation mediaType="application/json;charset=UTF-8"/> </wadl:response> </wadl:method> <wadl:param name="guid" style="template"> @@ -572,7 +1398,7 @@ Null updates are not possible]]></wadl:doc> </wadl:response> <wadl:response status="200"> <wadl:doc><![CDATA[Entity definition]]></wadl:doc> - <wadl:representation mediaType="application/json"/> + <wadl:representation mediaType="application/json;charset=UTF-8"/> </wadl:response> </wadl:method> <wadl:param name="name" style="template"> @@ -590,7 +1416,7 @@ Null updates are not possible]]></wadl:doc> </wadl:response> <wadl:response status="200"> <wadl:doc><![CDATA[enum definition]]></wadl:doc> - <wadl:representation mediaType="application/json"/> + <wadl:representation mediaType="application/json;charset=UTF-8"/> </wadl:response> </wadl:method> <wadl:param name="guid" style="template"> @@ -608,7 +1434,7 @@ Null updates are not possible]]></wadl:doc> </wadl:response> <wadl:response status="200"> <wadl:doc><![CDATA[enum definition]]></wadl:doc> - <wadl:representation mediaType="application/json"/> + <wadl:representation mediaType="application/json;charset=UTF-8"/> </wadl:response> </wadl:method> <wadl:param name="name" style="template"> @@ -626,7 +1452,7 @@ Null updates are not possible]]></wadl:doc> </wadl:response> <wadl:response status="200"> <wadl:doc><![CDATA[relationship definition]]></wadl:doc> - <wadl:representation mediaType="application/json"/> + <wadl:representation mediaType="application/json;charset=UTF-8"/> </wadl:response> </wadl:method> <wadl:param name="guid" style="template"> @@ -644,7 +1470,7 @@ Null updates are not possible]]></wadl:doc> </wadl:response> <wadl:response status="200"> <wadl:doc><![CDATA[relationship definition]]></wadl:doc> - <wadl:representation mediaType="application/json"/> + <wadl:representation mediaType="application/json;charset=UTF-8"/> </wadl:response> </wadl:method> <wadl:param name="name" style="template"> @@ -662,7 +1488,7 @@ Null updates are not possible]]></wadl:doc> </wadl:response> <wadl:response status="200"> <wadl:doc><![CDATA[struct definition]]></wadl:doc> - <wadl:representation mediaType="application/json"/> + <wadl:representation mediaType="application/json;charset=UTF-8"/> </wadl:response> </wadl:method> <wadl:param name="guid" style="template"> @@ -680,7 +1506,7 @@ Null updates are not possible]]></wadl:doc> </wadl:response> <wadl:response status="200"> <wadl:doc><![CDATA[struct definition]]></wadl:doc> - <wadl:representation mediaType="application/json"/> + <wadl:representation mediaType="application/json;charset=UTF-8"/> </wadl:response> </wadl:method> <wadl:param name="name" style="template"> @@ -698,7 +1524,7 @@ Null updates are not possible]]></wadl:doc> </wadl:response> <wadl:response status="200"> <wadl:doc><![CDATA[Type definition]]></wadl:doc> - <wadl:representation mediaType="application/json"/> + <wadl:representation mediaType="application/json;charset=UTF-8"/> </wadl:response> </wadl:method> <wadl:param name="guid" style="template"> @@ -716,7 +1542,7 @@ Null updates are not possible]]></wadl:doc> </wadl:response> <wadl:response status="200"> <wadl:doc><![CDATA[Type definition]]></wadl:doc> - <wadl:representation mediaType="application/json"/> + <wadl:representation mediaType="application/json;charset=UTF-8"/> </wadl:response> </wadl:method> <wadl:param name="name" style="template"> @@ -731,7 +1557,7 @@ Null updates are not possible]]></wadl:doc> </wadl:request> <wadl:response> <wadl:doc><![CDATA[classification for the given entity guid]]></wadl:doc> - <wadl:representation mediaType="application/json"/> + <wadl:representation mediaType="application/json;charset=UTF-8"/> </wadl:response> </wadl:method> <wadl:param name="classificationName" style="template"> @@ -755,5 +1581,64 @@ Null updates are not possible]]></wadl:doc> <wadl:doc><![CDATA[globally unique identifier for the entity]]></wadl:doc> </wadl:param> </wadl:resource> + + <wadl:resource path="v2/entity/uniqueAttribute/type/{typeName}/classifications"> + <wadl:method name="POST"> + <wadl:doc><![CDATA[Adds classification to the entity identified by its type and unique attributes.]]></wadl:doc> + <wadl:request> + <wadl:representation mediaType="application/json"> + </wadl:representation> + <wadl:representation mediaType="application/json;charset=UTF-8"> + </wadl:representation> + </wadl:request> + </wadl:method> + <wadl:param name="typeName" style="template"> + <wadl:doc><![CDATA[]]></wadl:doc> + </wadl:param> + </wadl:resource> + + <wadl:resource path="v2/entity/uniqueAttribute/type/{typeName}/classifications"> + <wadl:method name="PUT"> + <wadl:doc><![CDATA[Updates classification on an entity identified by its type and unique attributes.]]></wadl:doc> + <wadl:request> + <wadl:representation mediaType="application/json"> + </wadl:representation> + <wadl:representation mediaType="application/json;charset=UTF-8"> + </wadl:representation> + </wadl:request> + </wadl:method> + <wadl:param name="typeName" style="template"> + <wadl:doc><![CDATA[]]></wadl:doc> + </wadl:param> + </wadl:resource> + + <wadl:resource path="v2/search/saved/execute/guid/{guid}"> + <wadl:method name="GET"> + <wadl:doc><![CDATA[Attribute based search for entities satisfying the search parameters]]></wadl:doc> + <wadl:request> + </wadl:request> + <wadl:response> + <wadl:doc><![CDATA[Atlas search result]]></wadl:doc> + <wadl:representation mediaType="application/json;charset=UTF-8"/> + </wadl:response> + </wadl:method> + <wadl:param name="guid" style="template"> + <wadl:doc><![CDATA[Guid identifying saved search]]></wadl:doc> + </wadl:param> + </wadl:resource> + + <wadl:resource path="v2/entity/uniqueAttribute/type/{typeName}/classification/{classificationName}"> + <wadl:method name="DELETE"> + <wadl:doc><![CDATA[Deletes a given classification from an entity identified by its type and unique attributes.]]></wadl:doc> + <wadl:request> + </wadl:request> + </wadl:method> + <wadl:param name="classificationName" style="template"> + <wadl:doc><![CDATA[name of the classification]]></wadl:doc> + </wadl:param> + <wadl:param name="typeName" style="template"> + <wadl:doc><![CDATA[]]></wadl:doc> + </wadl:param> + </wadl:resource> </wadl:resources> -</wadl:application> \ No newline at end of file +</wadl:application>
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/58bb55a6/api/v2/css/enunciate.css ---------------------------------------------------------------------- diff --git a/api/v2/css/enunciate.css b/api/v2/css/enunciate.css new file mode 100644 index 0000000..140d3b3 --- /dev/null +++ b/api/v2/css/enunciate.css @@ -0,0 +1,122 @@ +/* + * Base structure + */ + +/* Move down content because we have a fixed navbar that is 50px tall */ +body { + position:relative; + padding-top: 50px; +} + +.footer { + width: 100%; + /* Set the fixed height of the footer here */ + height: 60px; + background-color: #f5f5f5; +} + +/* + * Global add-ons + */ +.sub-header { + padding-bottom: 10px; + border-bottom: 1px solid #eee; +} + +/* + * Sidebar + */ + +/* Hide for mobile, show later */ +.sidebar { + display: none; +} +@media (min-width: 768px) { + .sidebar { + position: fixed; + top: 51px; + bottom: 0; + left: 0; + z-index: 1000; + display: block; + padding: 20px; + overflow-x: hidden; + overflow-y: auto; /* Scrollable contents if viewport is shorter than content. */ + background-color: #f5f5f5; + border-right: 1px solid #eee; + } +} + +/* Sidebar navigation */ +.nav-sidebar { + margin-right: -21px; /* 20px padding + 1px border */ + margin-bottom: 20px; + margin-left: -20px; +} +.nav-sidebar > li > a { + padding-right: 20px; + padding-left: 20px; +} +.sideoverflow { + display: block; + text-overflow: ellipsis; + white-space: nowrap; + overflow: hidden; + max-width:100%; +} +.nav-sidebar > .active > a, +.nav-sidebar > .active > a:hover, +.nav-sidebar > .active > a:focus { + color: #fff; + background-color: #428bca; +} + +/* + * Main content + */ +.main { + padding: 20px; +} +@media (min-width: 768px) { + .main { + padding-right: 40px; + padding-left: 40px; + } +} +.main .page-header { + margin-top: 0; +} +.footer > .container { + padding-top: 20px; + text-align: center; +} + +/* + * Row Links + */ +.table.rowlink td:not(.rowlink-skip), +.table .rowlink td:not(.rowlink-skip) { + cursor: pointer; +} +.table.rowlink td:not(.rowlink-skip) a, +.table .rowlink td:not(.rowlink-skip) a { + font: inherit; + color: inherit; + text-decoration: inherit; +} +.multi-row-description { + border-left: 1px solid #DDD; +} + +pre { + max-height: 40em; +} + +/* shift the anchors to accommodate fixed navbar. See https://github.com/twbs/bootstrap/issues/1768#issuecomment-46519033 */ +*[id]:before { + display: block; + content: " "; + margin-top: -70px; + height: 70px; + visibility: hidden; +} http://git-wip-us.apache.org/repos/asf/atlas-website/blob/58bb55a6/api/v2/data.html ---------------------------------------------------------------------- diff --git a/api/v2/data.html b/api/v2/data.html index 38aa078..2fb8ca1 100644 --- a/api/v2/data.html +++ b/api/v2/data.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]> @@ -50,8 +50,8 @@ <div class="row"> <div class="col-sm-3 col-md-2 sidebar" id="apinav"> <ul class="nav nav-sidebar"> - <li><a href="#syntax_json">JSON</a></li> - <li><a href="#syntax_xml">XML</a></li> + <li><a href="#syntax_json"><abbr title="JSON"><span class="sideoverflow">JSON</span></abbr></a></li> + <li><a href="#syntax_xml"><abbr title="XML"><span class="sideoverflow">XML</span></abbr></a></li> <li class="divider"></li> <li class="text-right"><a href="#top"><small>Back to Top</small></a></li> </ul> @@ -75,291 +75,34 @@ </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_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_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_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. - -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. - -RelationshipDefs have 2 ends, each of which specify cardinality, an EntityDef type name and name and optionally -whether the end is a container. -RelationshipDefs can have AttributeDefs - though only primitive types are allowed. -RelationshipDefs have a relationshipCategory specifying the UML type of relationship required -RelationshipDefs also have a PropogateTag - indicating which way tags could flow over the relationships. - -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. - -RelationshipDefs introduce new atributes to the entity instances. For example -EntityDef A might have attributes attr1,attr2,attr3 -EntityDef B might have attributes attr4,attr5,attr6 -RelationshipDef AtoB might define 2 ends -end1: type A, name attr7 -end1: type B, name attr8 - -When an instance of EntityDef A is created, it will have attributes attr1,attr2,attr3,attr7 -When an instance of EntityDef B is created, it will have attributes attr4,attr5,attr6,attr8 - -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_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_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_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_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_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_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> + <tr class="clickable-row" data-href="json_SearchFilter.html"> + <td> <span class="datatype-name">SearchFilter</span> </td> - <td> <span class="datatype-description">PropagateTags indicates whether tags should propagate across the relationship instance. -Tags can propagate: -NONE - not at all -ONE_TO_TWO - from end 1 to 2 -TWO_TO_ONE - from end 2 to 1 -BOTH - both ways - -Care needs to be taken when specifying. The use cases we are aware of where this flag is useful: - -- propagating confidentiality classifications from a table to columns - ONE_TO_TWO could be used here -- propagating classifications around Glossary synonyms - BOTH could be used here. - -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_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. -ASSOCIATION is a relationship with no containment. -COMPOSITION and AGGREGATION are containment relationships. -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_SearchParameters.html"> - <td> <span class="datatype-name">SearchParameters</span> -</td> - <td> <span class="datatype-description"></span> + <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_SortType.html"> @@ -368,22 +111,10 @@ of the container and children are totally independant.</span> <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> + <tr class="clickable-row" data-href="json_TimeBoundary.html"> + <td> <span class="datatype-name">TimeBoundary</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_TypeCategory.html"> - <td> <span class="datatype-name">TypeCategory</span> -</td> - <td> <span class="datatype-description"></span> + <td> <span class="datatype-description">Captures time-boundary details</span> </td> </tr> </tbody> @@ -418,6 +149,12 @@ of the container and children are totally independant.</span> <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="xml_ns0_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="xml_ns0_atlasClassification.html"> <td> <span class="datatype-name">atlasClassification</span> </td>
