http://git-wip-us.apache.org/repos/asf/atlas-website/blob/f415335a/api/v2/ui/swagger.json ---------------------------------------------------------------------- diff --git a/api/v2/ui/swagger.json b/api/v2/ui/swagger.json index 901b864..2715dbb 100644 --- a/api/v2/ui/swagger.json +++ b/api/v2/ui/swagger.json @@ -6,11 +6,9 @@ "url" : "http://www.apache.org/licenses/LICENSE-2.0.txt";, "name" : "The Apache Software License, Version 2.0" }, - "version" : "0.9-incubating-SNAPSHOT", + "version" : "0.9-SNAPSHOT", "title" : "Atlas REST API" }, - "host" : "localhost:21000", - "basePath" : "/api/atlas/", "schemes" : [], "tags" : [ { @@ -32,6 +30,12 @@ } , { + "name" : "RelationshipREST" + , + "description" : "REST interface for entity relationships." + } + , + { "name" : "TypesREST" , "description" : "REST interface for CRUD operations on type definitions." @@ -74,6 +78,10 @@ "description" : "", "type" : "boolean" }, + "defaultValue" : { +"description" : "", +"type" : "string" + }, "constraints" : { "description" : "", "type" : "array", @@ -91,6 +99,7 @@ "valuesMaxCount" : 12345, "isUnique" : true, "isIndexable" : true, + "defaultValue" : "...", "constraints" : [ { "type" : "...", "params" : { @@ -105,7 +114,7 @@ } } ] }, - "description" : "Details of a struct-attribute." + "description" : "class that captures details of a struct-attribute." } , "json_AtlasBaseTypeDef" : { @@ -161,7 +170,7 @@ } }, "example" : { - "category" : "MAP", + "category" : "STRUCT", "guid" : "...", "createdBy" : "...", "updatedBy" : "...", @@ -176,7 +185,7 @@ "property2" : "..." } }, - "description" : "Common-attributes for all Atlas types." + "description" : "Base class that captures common-attributes for all Atlas types." } , "json_AtlasClassification" : { @@ -224,11 +233,12 @@ "name" : "...", "typeName" : "...", "isOptional" : true, - "cardinality" : "SET", + "cardinality" : "SINGLE", "valuesMinCount" : 12345, "valuesMaxCount" : 12345, "isUnique" : true, "isIndexable" : true, + "defaultValue" : "...", "constraints" : [ { "type" : "...", "params" : { @@ -251,6 +261,7 @@ "valuesMaxCount" : 12345, "isUnique" : true, "isIndexable" : true, + "defaultValue" : "...", "constraints" : [ { "type" : "...", "params" : { @@ -265,7 +276,7 @@ } } ] } ], - "category" : "ARRAY", + "category" : "ENTITY", "guid" : "...", "createdBy" : "...", "updatedBy" : "...", @@ -280,7 +291,7 @@ "property2" : "..." } }, - "description" : "Details of a classification-type." + "description" : "class that captures details of a classification-type." } , "json_AtlasClassifications" : { @@ -298,7 +309,7 @@ "startIndex" : 12345, "pageSize" : 12345, "totalCount" : 12345, - "sortType" : "NONE", + "sortType" : "DESC", "sortBy" : "..." }, "description" : "REST serialization friendly list." @@ -327,7 +338,7 @@ "property2" : { } } }, - "description" : "Details of a constraint." + "description" : "class that captures details of a constraint." } , "json_AtlasEntitiesWithExtInfo" : { @@ -352,12 +363,16 @@ "example" : { "entities" : [ { "guid" : "...", - "status" : "DELETED", + "status" : "ACTIVE", "createdBy" : "...", "updatedBy" : "...", "createTime" : 12345, "updateTime" : 12345, "version" : 12345, + "relationshipAttributes" : { + "property1" : { }, + "property2" : { } + }, "classifications" : [ { "typeName" : "...", "attributes" : { @@ -384,6 +399,10 @@ "createTime" : 12345, "updateTime" : 12345, "version" : 12345, + "relationshipAttributes" : { + "property1" : { }, + "property2" : { } + }, "classifications" : [ { "typeName" : "...", "attributes" : { @@ -412,6 +431,10 @@ "createTime" : 12345, "updateTime" : 12345, "version" : 12345, + "relationshipAttributes" : { + "property1" : { }, + "property2" : { } + }, "classifications" : [ { "typeName" : "...", "attributes" : { @@ -433,12 +456,16 @@ }, "property2" : { "guid" : "...", - "status" : "ACTIVE", + "status" : "DELETED", "createdBy" : "...", "updatedBy" : "...", "createTime" : 12345, "updateTime" : 12345, "version" : 12345, + "relationshipAttributes" : { + "property1" : { }, + "property2" : { } + }, "classifications" : [ { "typeName" : "...", "attributes" : { @@ -460,7 +487,7 @@ } } }, - "description" : "List of Atlas entity along with the referred entities" + "description" : "An instance of an entity along with extended info - like hive_table, hive_database." } , "json_AtlasEntity" : { @@ -500,6 +527,13 @@ "description" : "", "type" : "number" }, + "relationshipAttributes" : { +"description" : "", +"type" : "object", +"additionalProperties" : { + "type" : "object" +} + }, "classifications" : { "description" : "", "type" : "array", @@ -518,6 +552,10 @@ "createTime" : 12345, "updateTime" : 12345, "version" : 12345, + "relationshipAttributes" : { + "property1" : { }, + "property2" : { } + }, "classifications" : [ { "typeName" : "...", "attributes" : { @@ -537,7 +575,7 @@ "property2" : { } } }, - "description" : "Atlas entity representation" + "description" : "An instance of an entity - like hive_table, hive_database." } , "json_AtlasEntityDef" : { @@ -570,6 +608,7 @@ "valuesMaxCount" : 12345, "isUnique" : true, "isIndexable" : true, + "defaultValue" : "...", "constraints" : [ { "type" : "...", "params" : { @@ -587,11 +626,12 @@ "name" : "...", "typeName" : "...", "isOptional" : true, - "cardinality" : "LIST", + "cardinality" : "SINGLE", "valuesMinCount" : 12345, "valuesMaxCount" : 12345, "isUnique" : true, "isIndexable" : true, + "defaultValue" : "...", "constraints" : [ { "type" : "...", "params" : { @@ -606,7 +646,7 @@ } } ] } ], - "category" : "ARRAY", + "category" : "ENTITY", "guid" : "...", "createdBy" : "...", "updatedBy" : "...", @@ -621,7 +661,7 @@ "property2" : "..." } }, - "description" : "Details of an entity-type." + "description" : "class that captures details of a entity-type." } , "json_AtlasEntityExtInfo" : { @@ -640,12 +680,16 @@ "referredEntities" : { "property1" : { "guid" : "...", - "status" : "DELETED", + "status" : "ACTIVE", "createdBy" : "...", "updatedBy" : "...", "createTime" : 12345, "updateTime" : 12345, "version" : 12345, + "relationshipAttributes" : { + "property1" : { }, + "property2" : { } + }, "classifications" : [ { "typeName" : "...", "attributes" : { @@ -673,6 +717,10 @@ "createTime" : 12345, "updateTime" : 12345, "version" : 12345, + "relationshipAttributes" : { + "property1" : { }, + "property2" : { } + }, "classifications" : [ { "typeName" : "...", "attributes" : { @@ -694,7 +742,7 @@ } } }, - "description" : "Entity representation along with extended info which included the entities being referred to" + "description" : "An instance of an entity along with extended info - like hive_table, hive_database." } , "json_AtlasEntityHeader" : { @@ -767,6 +815,10 @@ "createTime" : 12345, "updateTime" : 12345, "version" : 12345, + "relationshipAttributes" : { + "property1" : { }, + "property2" : { } + }, "classifications" : [ { "typeName" : "...", "attributes" : { @@ -795,6 +847,10 @@ "createTime" : 12345, "updateTime" : 12345, "version" : 12345, + "relationshipAttributes" : { + "property1" : { }, + "property2" : { } + }, "classifications" : [ { "typeName" : "...", "attributes" : { @@ -816,12 +872,16 @@ }, "property2" : { "guid" : "...", - "status" : "ACTIVE", + "status" : "DELETED", "createdBy" : "...", "updatedBy" : "...", "createTime" : 12345, "updateTime" : 12345, "version" : 12345, + "relationshipAttributes" : { + "property1" : { }, + "property2" : { } + }, "classifications" : [ { "typeName" : "...", "attributes" : { @@ -843,7 +903,7 @@ } } }, - "description" : "Entity with information about the referred entities" + "description" : "An instance of an entity along with extended info - like hive_table, hive_database." } , "json_AtlasEnumDef" : { @@ -880,7 +940,7 @@ "ordinal" : 12345 } ], "defaultValue" : "...", - "category" : "ENTITY", + "category" : "ENUM", "guid" : "...", "createdBy" : "...", "updatedBy" : "...", @@ -895,7 +955,7 @@ "property2" : "..." } }, - "description" : "Details of an enum-type." + "description" : "class that captures details of an enum-type." } , "json_AtlasEnumElementDef" : { @@ -920,7 +980,7 @@ "description" : "...", "ordinal" : 12345 }, - "description" : "Details of an enum-element." + "description" : "class that captures details of an enum-element." } , "json_AtlasFullTextResult" : { @@ -939,7 +999,7 @@ "example" : { "entity" : { "guid" : "...", - "status" : "ACTIVE", + "status" : "DELETED", "displayText" : "...", "classificationNames" : [ "...", "..." ], "typeName" : "...", @@ -950,7 +1010,7 @@ }, "score" : 12345.0 }, - "description" : "Search results for FullText APIs" + "description" : "" } , "json_AtlasLineageInfo" : { @@ -1000,7 +1060,7 @@ }, "property2" : { "guid" : "...", - "status" : "ACTIVE", + "status" : "DELETED", "displayText" : "...", "classificationNames" : [ "...", "..." ], "typeName" : "...", @@ -1017,10 +1077,41 @@ "fromEntityId" : "...", "toEntityId" : "..." } ], - "lineageDirection" : "OUTPUT", + "lineageDirection" : "BOTH", "lineageDepth" : 12345 }, - "description" : "Lineage information for a single entity" + "description" : "" + } + , + "json_AtlasObjectId" : { + "type" : "object", + "title" : "AtlasObjectId", + "properties" : { + "guid" : { +"description" : "", +"type" : "string" + }, + "typeName" : { +"description" : "", +"type" : "string" + }, + "uniqueAttributes" : { +"description" : "", +"type" : "object", +"additionalProperties" : { + "type" : "object" +} + } + }, + "example" : { + "guid" : "...", + "typeName" : "...", + "uniqueAttributes" : { + "property1" : { }, + "property2" : { } + } +}, + "description" : "Reference to an object-instance of an Atlas type - like entity." } , "json_AtlasQueryType" : { @@ -1030,166 +1121,158 @@ "DSL", "FULL_TEXT", "GREMLIN", - "BASIC" + "BASIC", + "ATTRIBUTE" ], - "description" : "Various querying mechanisms supported by Atlas" + "description" : "" } , - "json_AtlasSearchResult" : { + "json_AtlasRelationship" : { "type" : "object", - "title" : "AtlasSearchResult", + "title" : "AtlasRelationship", + "allOf" : [ + { + "$ref" : "#/definitions/json_AtlasStruct" + }, + { "properties" : { - "queryType" : { + "guid" : { "description" : "", -"$ref" : "#/definitions/json_AtlasQueryType" +"type" : "string" }, - "queryText" : { + "status" : { "description" : "", -"type" : "string" +"$ref" : "#/definitions/json_Status_AtlasRelationship" }, - "type" : { + "createdBy" : { "description" : "", "type" : "string" }, - "classification" : { + "updatedBy" : { "description" : "", "type" : "string" }, - "entities" : { + "createTime" : { "description" : "", -"type" : "array", -"items" : { - "$ref" : "#/definitions/json_AtlasEntityHeader" -} +"type" : "number" }, - "attributes" : { + "updateTime" : { "description" : "", -"$ref" : "#/definitions/json_AttributeSearchResult" +"type" : "number" }, - "fullTextResult" : { + "version" : { "description" : "", -"type" : "array", -"items" : { - "$ref" : "#/definitions/json_AtlasFullTextResult" -} +"type" : "number" + }, + "end1" : { +"description" : "", +"$ref" : "#/definitions/json_AtlasObjectId" + }, + "end2" : { +"description" : "", +"$ref" : "#/definitions/json_AtlasObjectId" + }, + "label" : { +"description" : "", +"type" : "string" } - }, + } + } + ], "example" : { - "queryType" : "DSL", - "queryText" : "...", - "type" : "...", - "classification" : "...", - "entities" : [ { + "guid" : "...", + "status" : "DELETED", + "createdBy" : "...", + "updatedBy" : "...", + "createTime" : 12345, + "updateTime" : 12345, + "version" : 12345, + "end1" : { "guid" : "...", - "status" : "ACTIVE", - "displayText" : "...", - "classificationNames" : [ "...", "..." ], "typeName" : "...", - "attributes" : { + "uniqueAttributes" : { "property1" : { }, "property2" : { } } - }, { + }, + "end2" : { "guid" : "...", - "status" : "DELETED", - "displayText" : "...", - "classificationNames" : [ "...", "..." ], "typeName" : "...", - "attributes" : { + "uniqueAttributes" : { "property1" : { }, "property2" : { } } - } ], - "attributes" : { - "name" : [ "...", "..." ], - "values" : [ ] }, - "fullTextResult" : [ { - "entity" : { - "guid" : "...", - "status" : "ACTIVE", - "displayText" : "...", - "classificationNames" : [ "...", "..." ], - "typeName" : "...", - "attributes" : { - "property1" : { }, - "property2" : { } - } - }, - "score" : 12345.0 - }, { - "entity" : { - "guid" : "...", - "status" : "DELETED", - "displayText" : "...", - "classificationNames" : [ "...", "..." ], - "typeName" : "...", - "attributes" : { - "property1" : { }, - "property2" : { } - } - }, - "score" : 12345.0 - } ] -}, - "description" : "Search results of the Discovery APIs" - } - , - "json_AtlasStruct" : { - "type" : "object", - "title" : "AtlasStruct", - "properties" : { - "typeName" : { -"description" : "", -"type" : "string" - }, - "attributes" : { -"description" : "", -"type" : "object", -"additionalProperties" : { - "type" : "object" -} - } - }, - "example" : { + "label" : "...", "typeName" : "...", "attributes" : { "property1" : { }, "property2" : { } } }, - "description" : "Details of a struct. Not instantiated directly, used only via AtlasEntity, AtlasClassification." + "description" : "Atlas relationship instance." } , - "json_AtlasStructDef" : { + "json_AtlasRelationshipDef" : { "type" : "object", - "title" : "AtlasStructDef", + "title" : "AtlasRelationshipDef", "allOf" : [ { - "$ref" : "#/definitions/json_AtlasBaseTypeDef" + "$ref" : "#/definitions/json_AtlasStructDef" }, { "properties" : { - "attributeDefs" : { + "relationshipCategory" : { "description" : "", -"type" : "array", -"items" : { - "$ref" : "#/definitions/json_AtlasAttributeDef" -} +"$ref" : "#/definitions/json_RelationshipCategory" + }, + "propagateTags" : { +"description" : "", +"$ref" : "#/definitions/json_PropagateTags" + }, + "endDef1" : { +"description" : "", +"$ref" : "#/definitions/json_AtlasRelationshipEndDef" + }, + "endDef2" : { +"description" : "", +"$ref" : "#/definitions/json_AtlasRelationshipEndDef" + }, + "relationshipLabel" : { +"description" : "", +"type" : "string" } } } ], "example" : { + "relationshipCategory" : "AGGREGATION", + "propagateTags" : "ONE_TO_TWO", + "endDef1" : { + "type" : "...", + "name" : "...", + "isContainer" : true, + "cardinality" : "SET", + "isLegacyAttribute" : true + }, + "endDef2" : { + "type" : "...", + "name" : "...", + "isContainer" : true, + "cardinality" : "LIST", + "isLegacyAttribute" : true + }, + "relationshipLabel" : "...", "attributeDefs" : [ { "name" : "...", "typeName" : "...", "isOptional" : true, - "cardinality" : "SINGLE", + "cardinality" : "LIST", "valuesMinCount" : 12345, "valuesMaxCount" : 12345, "isUnique" : true, "isIndexable" : true, + "defaultValue" : "...", "constraints" : [ { "type" : "...", "params" : { @@ -1207,11 +1290,12 @@ "name" : "...", "typeName" : "...", "isOptional" : true, - "cardinality" : "SINGLE", + "cardinality" : "LIST", "valuesMinCount" : 12345, "valuesMaxCount" : 12345, "isUnique" : true, "isIndexable" : true, + "defaultValue" : "...", "constraints" : [ { "type" : "...", "params" : { @@ -1226,7 +1310,7 @@ } } ] } ], - "category" : "STRUCT", + "category" : "PRIMITIVE", "guid" : "...", "createdBy" : "...", "updatedBy" : "...", @@ -1241,14 +1325,14 @@ "property2" : "..." } }, - "description" : "Details of a struct-type." + "description" : "AtlasRelationshipDef is a TypeDef that defines a relationship.\n\nAs with other typeDefs the AtlasRelationshipDef has a name. Once created the RelationshipDef has a guid.\nThe name and the guid are the 2 ways that the RelationshipDef is identified.\n\nRelationshipDefs have 2 ends, each of which specify cardinality, an EntityDef type name and name and optionally\nwhether the end is a container.\nRelationshipDefs can have AttributeDefs - though only primitive types are allowed.\nRelationshipDefs have a relationshipCategory specifying the UML type of relationship required\nRelationshipDefs also have a PropogateTag - indicating which way tags could flow over the relationships.\n\nThe way EntityDefs and RelationshipDefs are intended to be used is that EntityDefs will define AttributeDefs these AttributeDefs\nwill not specify an EntityDef type name as their types.\n\nRelationshipDefs introduce new atributes to the entity instances. For example\nEntityDef A might hav e attributes attr1,attr2,attr3\nEntityDef B might have attributes attr4,attr5,attr6\nRelationshipDef AtoB might define 2 ends\nend1: type A, name attr7\nend1: type B, name attr8\n\nWhen an instance of EntityDef A is created, it will have attributes attr1,attr2,attr3,attr7\nWhen an instance of EntityDef B is created, it will have attributes attr4,attr5,attr6,attr8\n\nIn this way relationshipDefs can be authored separately from entityDefs and can inject relationship attributes into\nthe entity instances" } , - "json_AtlasTypeDefHeader" : { + "json_AtlasRelationshipEndDef" : { "type" : "object", - "title" : "AtlasTypeDefHeader", + "title" : "AtlasRelationshipEndDef", "properties" : { - "guid" : { + "type" : { "description" : "", "type" : "string" }, @@ -1256,204 +1340,379 @@ "description" : "", "type" : "string" }, - "category" : { + "isContainer" : { "description" : "", -"$ref" : "#/definitions/json_TypeCategory" +"type" : "boolean" + }, + "cardinality" : { +"description" : "", +"$ref" : "#/definitions/json_Cardinality" + }, + "isLegacyAttribute" : { +"description" : "", +"type" : "boolean" } }, "example" : { - "guid" : "...", + "type" : "...", "name" : "...", - "category" : "ARRAY" + "isContainer" : true, + "cardinality" : "SINGLE", + "isLegacyAttribute" : true }, - "description" : "Minimal set of information about a type definition" + "description" : "The relationshipEndDef represents an end of the relationship. The end of the relationship is defined by a type, an\nattribute name, cardinality and whether it is the container end of the relationship." } , - "json_AtlasTypesDef" : { + "json_AtlasSearchResult" : { "type" : "object", - "title" : "AtlasTypesDef", + "title" : "AtlasSearchResult", "properties" : { - "enumDefs" : { + "queryType" : { "description" : "", -"type" : "array", -"items" : { - "$ref" : "#/definitions/json_AtlasEnumDef" -} +"$ref" : "#/definitions/json_AtlasQueryType" }, - "structDefs" : { + "searchParameters" : { "description" : "", -"type" : "array", -"items" : { - "$ref" : "#/definitions/json_AtlasStructDef" -} +"$ref" : "#/definitions/json_SearchParameters" }, - "classificationDefs" : { + "queryText" : { +"description" : "", +"type" : "string" + }, + "type" : { +"description" : "", +"type" : "string" + }, + "classification" : { +"description" : "", +"type" : "string" + }, + "entities" : { "description" : "", "type" : "array", "items" : { - "$ref" : "#/definitions/json_AtlasClassificationDef" + "$ref" : "#/definitions/json_AtlasEntityHeader" } }, - "entityDefs" : { + "attributes" : { +"description" : "", +"$ref" : "#/definitions/json_AttributeSearchResult" + }, + "fullTextResult" : { "description" : "", "type" : "array", "items" : { - "$ref" : "#/definitions/json_AtlasEntityDef" + "$ref" : "#/definitions/json_AtlasFullTextResult" } }, - "empty" : { + "referredEntities" : { "description" : "", -"type" : "boolean" +"type" : "object", +"additionalProperties" : { + "$ref" : "#/definitions/json_AtlasEntityHeader" +} } }, "example" : { - "enumDefs" : [ { - "elementDefs" : [ { - "value" : "...", - "description" : "...", - "ordinal" : 12345 - }, { - "value" : "...", - "description" : "...", - "ordinal" : 12345 - } ], - "defaultValue" : "...", - "category" : "ENUM", + "queryType" : "FULL_TEXT", + "searchParameters" : { + "query" : "...", + "typeName" : "...", + "classification" : "...", + "excludeDeletedEntities" : true, + "limit" : 12345, + "offset" : 12345, + "entityFilters" : { + "attributeName" : "...", + "operator" : "EQ", + "attributeValue" : "...", + "condition" : "AND", + "criterion" : [ { }, { } ] + }, + "tagFilters" : { + "attributeName" : "...", + "operator" : "EQ", + "attributeValue" : "...", + "condition" : "OR", + "criterion" : [ { }, { } ] + }, + "attributes" : [ "...", "..." ] + }, + "queryText" : "...", + "type" : "...", + "classification" : "...", + "entities" : [ { "guid" : "...", - "createdBy" : "...", - "updatedBy" : "...", - "createTime" : 12345, - "updateTime" : 12345, - "version" : 12345, - "name" : "...", - "description" : "...", - "typeVersion" : "...", - "options" : { - "property1" : "...", - "property2" : "..." + "status" : "DELETED", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } } }, { - "elementDefs" : [ { - "value" : "...", - "description" : "...", - "ordinal" : 12345 - }, { - "value" : "...", - "description" : "...", - "ordinal" : 12345 - } ], - "defaultValue" : "...", - "category" : "ARRAY", "guid" : "...", - "createdBy" : "...", - "updatedBy" : "...", - "createTime" : 12345, - "updateTime" : 12345, - "version" : 12345, - "name" : "...", - "description" : "...", - "typeVersion" : "...", - "options" : { - "property1" : "...", - "property2" : "..." + "status" : "ACTIVE", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } } } ], - "structDefs" : [ { - "attributeDefs" : [ { - "name" : "...", - "typeName" : "...", - "isOptional" : true, - "cardinality" : "LIST", - "valuesMinCount" : 12345, - "valuesMaxCount" : 12345, - "isUnique" : true, - "isIndexable" : true, - "constraints" : [ { }, { } ] - }, { - "name" : "...", + "attributes" : { + "name" : [ "...", "..." ], + "values" : [ ] + }, + "fullTextResult" : [ { + "entity" : { + "guid" : "...", + "status" : "DELETED", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], "typeName" : "...", - "isOptional" : true, - "cardinality" : "LIST", - "valuesMinCount" : 12345, - "valuesMaxCount" : 12345, - "isUnique" : true, - "isIndexable" : true, - "constraints" : [ { }, { } ] - } ], - "category" : "ARRAY", - "guid" : "...", - "createdBy" : "...", - "updatedBy" : "...", - "createTime" : 12345, - "updateTime" : 12345, - "version" : 12345, - "name" : "...", - "description" : "...", - "typeVersion" : "...", - "options" : { - "property1" : "...", - "property2" : "..." - } + "attributes" : { + "property1" : { }, + "property2" : { } + } + }, + "score" : 12345.0 }, { - "attributeDefs" : [ { - "name" : "...", - "typeName" : "...", - "isOptional" : true, - "cardinality" : "SINGLE", - "valuesMinCount" : 12345, - "valuesMaxCount" : 12345, - "isUnique" : true, - "isIndexable" : true, - "constraints" : [ { }, { } ] - }, { - "name" : "...", + "entity" : { + "guid" : "...", + "status" : "ACTIVE", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], "typeName" : "...", - "isOptional" : true, - "cardinality" : "SET", - "valuesMinCount" : 12345, - "valuesMaxCount" : 12345, - "isUnique" : true, - "isIndexable" : true, - "constraints" : [ { }, { } ] - } ], - "category" : "ARRAY", - "guid" : "...", - "createdBy" : "...", - "updatedBy" : "...", - "createTime" : 12345, - "updateTime" : 12345, - "version" : 12345, - "name" : "...", - "description" : "...", - "typeVersion" : "...", - "options" : { - "property1" : "...", - "property2" : "..." - } + "attributes" : { + "property1" : { }, + "property2" : { } + } + }, + "score" : 12345.0 } ], - "classificationDefs" : [ { - "superTypes" : [ "...", "..." ], - "attributeDefs" : [ { - "name" : "...", + "referredEntities" : { + "property1" : { + "guid" : "...", + "status" : "DELETED", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], "typeName" : "...", - "isOptional" : true, - "cardinality" : "SINGLE", - "valuesMinCount" : 12345, - "valuesMaxCount" : 12345, - "isUnique" : true, - "isIndexable" : true, - "constraints" : [ { }, { } ] - }, { - "name" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + }, + "property2" : { + "guid" : "...", + "status" : "DELETED", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], "typeName" : "...", - "isOptional" : true, - "cardinality" : "SINGLE", - "valuesMinCount" : 12345, - "valuesMaxCount" : 12345, - "isUnique" : true, - "isIndexable" : true, - "constraints" : [ { }, { } ] + "attributes" : { + "property1" : { }, + "property2" : { } + } + } + } +}, + "description" : "" + } + , + "json_AtlasStruct" : { + "type" : "object", + "title" : "AtlasStruct", + "properties" : { + "typeName" : { +"description" : "", +"type" : "string" + }, + "attributes" : { +"description" : "", +"type" : "object", +"additionalProperties" : { + "type" : "object" +} + } + }, + "example" : { + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } +}, + "description" : "Captures details of struct contents. Not instantiated directly, used only via AtlasEntity, AtlasClassification." + } + , + "json_AtlasStructDef" : { + "type" : "object", + "title" : "AtlasStructDef", + "allOf" : [ + { + "$ref" : "#/definitions/json_AtlasBaseTypeDef" + }, + { + "properties" : { + "attributeDefs" : { +"description" : "", +"type" : "array", +"items" : { + "$ref" : "#/definitions/json_AtlasAttributeDef" +} + } + } + } + ], + "example" : { + "attributeDefs" : [ { + "name" : "...", + "typeName" : "...", + "isOptional" : true, + "cardinality" : "SINGLE", + "valuesMinCount" : 12345, + "valuesMaxCount" : 12345, + "isUnique" : true, + "isIndexable" : true, + "defaultValue" : "...", + "constraints" : [ { + "type" : "...", + "params" : { + "property1" : { }, + "property2" : { } + } + }, { + "type" : "...", + "params" : { + "property1" : { }, + "property2" : { } + } + } ] + }, { + "name" : "...", + "typeName" : "...", + "isOptional" : true, + "cardinality" : "SINGLE", + "valuesMinCount" : 12345, + "valuesMaxCount" : 12345, + "isUnique" : true, + "isIndexable" : true, + "defaultValue" : "...", + "constraints" : [ { + "type" : "...", + "params" : { + "property1" : { }, + "property2" : { } + } + }, { + "type" : "...", + "params" : { + "property1" : { }, + "property2" : { } + } + } ] + } ], + "category" : "ENTITY", + "guid" : "...", + "createdBy" : "...", + "updatedBy" : "...", + "createTime" : 12345, + "updateTime" : 12345, + "version" : 12345, + "name" : "...", + "description" : "...", + "typeVersion" : "...", + "options" : { + "property1" : "...", + "property2" : "..." + } +}, + "description" : "class that captures details of a struct-type." + } + , + "json_AtlasTypeDefHeader" : { + "type" : "object", + "title" : "AtlasTypeDefHeader", + "properties" : { + "guid" : { +"description" : "", +"type" : "string" + }, + "name" : { +"description" : "", +"type" : "string" + }, + "category" : { +"description" : "", +"$ref" : "#/definitions/json_TypeCategory" + } + }, + "example" : { + "guid" : "...", + "name" : "...", + "category" : "ENTITY" +}, + "description" : "" + } + , + "json_AtlasTypesDef" : { + "type" : "object", + "title" : "AtlasTypesDef", + "properties" : { + "enumDefs" : { +"description" : "", +"type" : "array", +"items" : { + "$ref" : "#/definitions/json_AtlasEnumDef" +} + }, + "structDefs" : { +"description" : "", +"type" : "array", +"items" : { + "$ref" : "#/definitions/json_AtlasStructDef" +} + }, + "classificationDefs" : { +"description" : "", +"type" : "array", +"items" : { + "$ref" : "#/definitions/json_AtlasClassificationDef" +} + }, + "entityDefs" : { +"description" : "", +"type" : "array", +"items" : { + "$ref" : "#/definitions/json_AtlasEntityDef" +} + }, + "relationshipDefs" : { +"description" : "", +"type" : "array", +"items" : { + "$ref" : "#/definitions/json_AtlasRelationshipDef" +} + }, + "empty" : { +"description" : "", +"type" : "boolean" + } + }, + "example" : { + "enumDefs" : [ { + "elementDefs" : [ { + "value" : "...", + "description" : "...", + "ordinal" : 12345 + }, { + "value" : "...", + "description" : "...", + "ordinal" : 12345 } ], + "defaultValue" : "...", "category" : "MAP", "guid" : "...", "createdBy" : "...", @@ -1469,29 +1728,56 @@ "property2" : "..." } }, { - "superTypes" : [ "...", "..." ], + "elementDefs" : [ { + "value" : "...", + "description" : "...", + "ordinal" : 12345 + }, { + "value" : "...", + "description" : "...", + "ordinal" : 12345 + } ], + "defaultValue" : "...", + "category" : "OBJECT_ID_TYPE", + "guid" : "...", + "createdBy" : "...", + "updatedBy" : "...", + "createTime" : 12345, + "updateTime" : 12345, + "version" : 12345, + "name" : "...", + "description" : "...", + "typeVersion" : "...", + "options" : { + "property1" : "...", + "property2" : "..." + } + } ], + "structDefs" : [ { "attributeDefs" : [ { "name" : "...", "typeName" : "...", "isOptional" : true, - "cardinality" : "LIST", + "cardinality" : "SINGLE", "valuesMinCount" : 12345, "valuesMaxCount" : 12345, "isUnique" : true, "isIndexable" : true, + "defaultValue" : "...", "constraints" : [ { }, { } ] }, { "name" : "...", "typeName" : "...", "isOptional" : true, - "cardinality" : "LIST", + "cardinality" : "SET", "valuesMinCount" : 12345, "valuesMaxCount" : 12345, "isUnique" : true, "isIndexable" : true, + "defaultValue" : "...", "constraints" : [ { }, { } ] } ], - "category" : "STRUCT", + "category" : "MAP", "guid" : "...", "createdBy" : "...", "updatedBy" : "...", @@ -1505,9 +1791,7 @@ "property1" : "...", "property2" : "..." } - } ], - "entityDefs" : [ { - "superTypes" : [ "...", "..." ], + }, { "attributeDefs" : [ { "name" : "...", "typeName" : "...", @@ -1517,19 +1801,21 @@ "valuesMaxCount" : 12345, "isUnique" : true, "isIndexable" : true, + "defaultValue" : "...", "constraints" : [ { }, { } ] }, { "name" : "...", "typeName" : "...", "isOptional" : true, - "cardinality" : "SET", + "cardinality" : "LIST", "valuesMinCount" : 12345, "valuesMaxCount" : 12345, "isUnique" : true, "isIndexable" : true, + "defaultValue" : "...", "constraints" : [ { }, { } ] } ], - "category" : "CLASSIFICATION", + "category" : "PRIMITIVE", "guid" : "...", "createdBy" : "...", "updatedBy" : "...", @@ -1543,17 +1829,19 @@ "property1" : "...", "property2" : "..." } - }, { + } ], + "classificationDefs" : [ { "superTypes" : [ "...", "..." ], "attributeDefs" : [ { "name" : "...", "typeName" : "...", "isOptional" : true, - "cardinality" : "SET", + "cardinality" : "LIST", "valuesMinCount" : 12345, "valuesMaxCount" : 12345, "isUnique" : true, "isIndexable" : true, + "defaultValue" : "...", "constraints" : [ { }, { } ] }, { "name" : "...", @@ -1564,9 +1852,10 @@ "valuesMaxCount" : 12345, "isUnique" : true, "isIndexable" : true, + "defaultValue" : "...", "constraints" : [ { }, { } ] } ], - "category" : "ENTITY", + "category" : "PRIMITIVE", "guid" : "...", "createdBy" : "...", "updatedBy" : "...", @@ -1580,20 +1869,249 @@ "property1" : "...", "property2" : "..." } - } ], - "empty" : true -}, - "description" : "A collection of atlas enum, struct, classification and entity definitions (models)." - } - , - "json_AttributeSearchResult" : { - "type" : "object", - "title" : "AttributeSearchResult", - "properties" : { - "name" : { -"description" : "", -"type" : "array", -"items" : { + }, { + "superTypes" : [ "...", "..." ], + "attributeDefs" : [ { + "name" : "...", + "typeName" : "...", + "isOptional" : true, + "cardinality" : "LIST", + "valuesMinCount" : 12345, + "valuesMaxCount" : 12345, + "isUnique" : true, + "isIndexable" : true, + "defaultValue" : "...", + "constraints" : [ { }, { } ] + }, { + "name" : "...", + "typeName" : "...", + "isOptional" : true, + "cardinality" : "SINGLE", + "valuesMinCount" : 12345, + "valuesMaxCount" : 12345, + "isUnique" : true, + "isIndexable" : true, + "defaultValue" : "...", + "constraints" : [ { }, { } ] + } ], + "category" : "ARRAY", + "guid" : "...", + "createdBy" : "...", + "updatedBy" : "...", + "createTime" : 12345, + "updateTime" : 12345, + "version" : 12345, + "name" : "...", + "description" : "...", + "typeVersion" : "...", + "options" : { + "property1" : "...", + "property2" : "..." + } + } ], + "entityDefs" : [ { + "superTypes" : [ "...", "..." ], + "attributeDefs" : [ { + "name" : "...", + "typeName" : "...", + "isOptional" : true, + "cardinality" : "LIST", + "valuesMinCount" : 12345, + "valuesMaxCount" : 12345, + "isUnique" : true, + "isIndexable" : true, + "defaultValue" : "...", + "constraints" : [ { }, { } ] + }, { + "name" : "...", + "typeName" : "...", + "isOptional" : true, + "cardinality" : "LIST", + "valuesMinCount" : 12345, + "valuesMaxCount" : 12345, + "isUnique" : true, + "isIndexable" : true, + "defaultValue" : "...", + "constraints" : [ { }, { } ] + } ], + "category" : "ARRAY", + "guid" : "...", + "createdBy" : "...", + "updatedBy" : "...", + "createTime" : 12345, + "updateTime" : 12345, + "version" : 12345, + "name" : "...", + "description" : "...", + "typeVersion" : "...", + "options" : { + "property1" : "...", + "property2" : "..." + } + }, { + "superTypes" : [ "...", "..." ], + "attributeDefs" : [ { + "name" : "...", + "typeName" : "...", + "isOptional" : true, + "cardinality" : "SET", + "valuesMinCount" : 12345, + "valuesMaxCount" : 12345, + "isUnique" : true, + "isIndexable" : true, + "defaultValue" : "...", + "constraints" : [ { }, { } ] + }, { + "name" : "...", + "typeName" : "...", + "isOptional" : true, + "cardinality" : "SINGLE", + "valuesMinCount" : 12345, + "valuesMaxCount" : 12345, + "isUnique" : true, + "isIndexable" : true, + "defaultValue" : "...", + "constraints" : [ { }, { } ] + } ], + "category" : "STRUCT", + "guid" : "...", + "createdBy" : "...", + "updatedBy" : "...", + "createTime" : 12345, + "updateTime" : 12345, + "version" : 12345, + "name" : "...", + "description" : "...", + "typeVersion" : "...", + "options" : { + "property1" : "...", + "property2" : "..." + } + } ], + "relationshipDefs" : [ { + "relationshipCategory" : "AGGREGATION", + "propagateTags" : "BOTH", + "endDef1" : { + "type" : "...", + "name" : "...", + "isContainer" : true, + "cardinality" : "SET", + "isLegacyAttribute" : true + }, + "endDef2" : { + "type" : "...", + "name" : "...", + "isContainer" : true, + "cardinality" : "SINGLE", + "isLegacyAttribute" : true + }, + "relationshipLabel" : "...", + "attributeDefs" : [ { + "name" : "...", + "typeName" : "...", + "isOptional" : true, + "cardinality" : "SINGLE", + "valuesMinCount" : 12345, + "valuesMaxCount" : 12345, + "isUnique" : true, + "isIndexable" : true, + "defaultValue" : "...", + "constraints" : [ { }, { } ] + }, { + "name" : "...", + "typeName" : "...", + "isOptional" : true, + "cardinality" : "SET", + "valuesMinCount" : 12345, + "valuesMaxCount" : 12345, + "isUnique" : true, + "isIndexable" : true, + "defaultValue" : "...", + "constraints" : [ { }, { } ] + } ], + "category" : "ENUM", + "guid" : "...", + "createdBy" : "...", + "updatedBy" : "...", + "createTime" : 12345, + "updateTime" : 12345, + "version" : 12345, + "name" : "...", + "description" : "...", + "typeVersion" : "...", + "options" : { + "property1" : "...", + "property2" : "..." + } + }, { + "relationshipCategory" : "ASSOCIATION", + "propagateTags" : "ONE_TO_TWO", + "endDef1" : { + "type" : "...", + "name" : "...", + "isContainer" : true, + "cardinality" : "LIST", + "isLegacyAttribute" : true + }, + "endDef2" : { + "type" : "...", + "name" : "...", + "isContainer" : true, + "cardinality" : "SET", + "isLegacyAttribute" : true + }, + "relationshipLabel" : "...", + "attributeDefs" : [ { + "name" : "...", + "typeName" : "...", + "isOptional" : true, + "cardinality" : "LIST", + "valuesMinCount" : 12345, + "valuesMaxCount" : 12345, + "isUnique" : true, + "isIndexable" : true, + "defaultValue" : "...", + "constraints" : [ { }, { } ] + }, { + "name" : "...", + "typeName" : "...", + "isOptional" : true, + "cardinality" : "SINGLE", + "valuesMinCount" : 12345, + "valuesMaxCount" : 12345, + "isUnique" : true, + "isIndexable" : true, + "defaultValue" : "...", + "constraints" : [ { }, { } ] + } ], + "category" : "OBJECT_ID_TYPE", + "guid" : "...", + "createdBy" : "...", + "updatedBy" : "...", + "createTime" : 12345, + "updateTime" : 12345, + "version" : 12345, + "name" : "...", + "description" : "...", + "typeVersion" : "...", + "options" : { + "property1" : "...", + "property2" : "..." + } + } ], + "empty" : true +}, + "description" : "" + } + , + "json_AttributeSearchResult" : { + "type" : "object", + "title" : "AttributeSearchResult", + "properties" : { + "name" : { +"description" : "", +"type" : "array", +"items" : { "type" : "string" } }, @@ -1609,7 +2127,7 @@ "name" : [ "...", "..." ], "values" : [ ] }, - "description" : "Search results for attribute(s)" + "description" : "" } , "json_Cardinality" : { @@ -1620,7 +2138,7 @@ "LIST", "SET" ], - "description" : "Cardinality of an attribute i.e. single-valued or multi-valued." + "description" : "single-valued attribute or multi-valued attribute." } , "json_ClassificationAssociateRequest" : { @@ -1649,7 +2167,17 @@ }, "entityGuids" : [ "...", "..." ] }, - "description" : "Tag association request for a list of entities" + "description" : "" + } + , + "json_Condition" : { + "type" : "string", + "title" : "Condition", + "enum" : [ + "AND", + "OR" + ], + "description" : "" } , "json_EntityMutationResponse" : { @@ -1718,7 +2246,7 @@ "mutatedEntities" : { "property1" : [ { "guid" : "...", - "status" : "ACTIVE", + "status" : "DELETED", "displayText" : "...", "classificationNames" : [ "...", "..." ], "typeName" : "...", @@ -1728,7 +2256,7 @@ } }, { "guid" : "...", - "status" : "DELETED", + "status" : "ACTIVE", "displayText" : "...", "classificationNames" : [ "...", "..." ], "typeName" : "...", @@ -1749,7 +2277,7 @@ } }, { "guid" : "...", - "status" : "DELETED", + "status" : "ACTIVE", "displayText" : "...", "classificationNames" : [ "...", "..." ], "typeName" : "...", @@ -1775,7 +2303,7 @@ } }, { "guid" : "...", - "status" : "ACTIVE", + "status" : "DELETED", "displayText" : "...", "classificationNames" : [ "...", "..." ], "typeName" : "...", @@ -1796,7 +2324,7 @@ } }, { "guid" : "...", - "status" : "DELETED", + "status" : "ACTIVE", "displayText" : "...", "classificationNames" : [ "...", "..." ], "typeName" : "...", @@ -1807,7 +2335,7 @@ } ], "partialUpdatedEntities" : [ { "guid" : "...", - "status" : "ACTIVE", + "status" : "DELETED", "displayText" : "...", "classificationNames" : [ "...", "..." ], "typeName" : "...", @@ -1849,7 +2377,7 @@ } ], "firstEntityCreated" : { "guid" : "...", - "status" : "ACTIVE", + "status" : "DELETED", "displayText" : "...", "classificationNames" : [ "...", "..." ], "typeName" : "...", @@ -1860,7 +2388,7 @@ }, "firstEntityUpdated" : { "guid" : "...", - "status" : "DELETED", + "status" : "ACTIVE", "displayText" : "...", "classificationNames" : [ "...", "..." ], "typeName" : "...", @@ -1881,7 +2409,7 @@ } } }, - "description" : "Entity modification response. Contains entity headers for each successful modification (create/update/delete)" + "description" : "" } , "json_EntityOperation" : { @@ -1893,38 +2421,107 @@ "PARTIAL_UPDATE", "DELETE" ], - "description" : "Entity operations supported by Atlas via REST" - } - , - "json_LineageDirection" : { - "type" : "string", - "title" : "LineageDirection", - "enum" : [ - "INPUT", - "OUTPUT", - "BOTH" - ], - "description" : "Lineage direction" + "description" : "" } , - "json_LineageRelation" : { + "json_FilterCriteria" : { "type" : "object", - "title" : "LineageRelation", + "title" : "FilterCriteria", "properties" : { - "fromEntityId" : { + "attributeName" : { "description" : "", "type" : "string" }, - "toEntityId" : { + "operator" : { +"description" : "", +"$ref" : "#/definitions/json_Operator" + }, + "attributeValue" : { "description" : "", "type" : "string" - } - }, - "example" : { - "fromEntityId" : "...", - "toEntityId" : "..." -}, - "description" : "Lineage relation between two entities" + }, + "condition" : { +"description" : "", +"$ref" : "#/definitions/json_Condition" + }, + "criterion" : { +"description" : "", +"type" : "array", +"items" : { + "$ref" : "#/definitions/json_FilterCriteria" +} + } + }, + "example" : { + "attributeName" : "...", + "operator" : "LTE", + "attributeValue" : "...", + "condition" : "OR", + "criterion" : [ { + "attributeName" : "...", + "operator" : "LT", + "attributeValue" : "...", + "condition" : "AND", + "criterion" : [ { }, { } ] + }, { + "attributeName" : "...", + "operator" : "ENDS_WITH", + "attributeValue" : "...", + "condition" : "OR", + "criterion" : [ { }, { } ] + } ] +}, + "description" : "" + } + , + "json_LineageDirection" : { + "type" : "string", + "title" : "LineageDirection", + "enum" : [ + "INPUT", + "OUTPUT", + "BOTH" + ], + "description" : "" + } + , + "json_LineageRelation" : { + "type" : "object", + "title" : "LineageRelation", + "properties" : { + "fromEntityId" : { +"description" : "", +"type" : "string" + }, + "toEntityId" : { +"description" : "", +"type" : "string" + } + }, + "example" : { + "fromEntityId" : "...", + "toEntityId" : "..." +}, + "description" : "" + } + , + "json_Operator" : { + "type" : "string", + "title" : "Operator", + "enum" : [ + "LT", + "GT", + "LTE", + "GTE", + "EQ", + "NEQ", + "IN", + "LIKE", + "STARTS_WITH", + "ENDS_WITH", + "CONTAINS" + ], + "description" : "Supported search operations\nLogical comparision operators can only be used with numbers or dates\nIN, LIKE, startsWith, endsWith, CONTAINS can only be used with strings or text" } , "json_PList" : { @@ -1964,12 +2561,105 @@ "startIndex" : 12345, "pageSize" : 12345, "totalCount" : 12345, - "sortType" : "DESC", + "sortType" : "NONE", "sortBy" : "..." }, "description" : "Paginated-list, for returning search results." } , + "json_PropagateTags" : { + "type" : "string", + "title" : "PropagateTags", + "enum" : [ + "NONE", + "ONE_TO_TWO", + "TWO_TO_ONE", + "BOTH" + ], + "description" : "PropagateTags indicates whether tags should propagate across the relationship instance.\nTags can propagate:\nNONE - not at all\nONE_TO_TWO - from end 1 to 2\nTWO_TO_ONE - from end 2 to 1\nBOTH - both ways\n\nCare needs to be taken when specifying. The use cases we are aware of where this flag is useful:\n\n- propagating confidentiality classifications from a table to columns - ONE_TO_TWO could be used here\n- propagating classifications around Glossary synonyms - BOTH could be used here.\n\nThere is an expectation that further enhancements will allow more granular control of tag propagation and will\naddress how to resolve conflicts." + } + , + "json_RelationshipCategory" : { + "type" : "string", + "title" : "RelationshipCategory", + "enum" : [ + "ASSOCIATION", + "AGGREGATION", + "COMPOSITION" + ], + "description" : "The Relationship category determines the style of relationship around containment and lifecycle.\nUML terminology is used for the values.\nASSOCIATION is a relationship with no containment.\nCOMPOSITION and AGGREGATION are containment relationships.\nThe difference being in the lifecycles of the container and its children. In the COMPOSITION case,\nthe children cannot exist without the container. For AGGREGATION, the life cycles\nof the container and children are totally independant." + } + , + "json_SearchParameters" : { + "type" : "object", + "title" : "SearchParameters", + "properties" : { + "query" : { +"description" : "", +"type" : "string" + }, + "typeName" : { +"description" : "", +"type" : "string" + }, + "classification" : { +"description" : "", +"type" : "string" + }, + "excludeDeletedEntities" : { +"description" : "", +"type" : "boolean" + }, + "limit" : { +"description" : "", +"type" : "number" + }, + "offset" : { +"description" : "", +"type" : "number" + }, + "entityFilters" : { +"description" : "Entity attribute filters for the type (if type name is specified)", +"$ref" : "#/definitions/json_FilterCriteria" + }, + "tagFilters" : { +"description" : "Tag attribute filters for the classification/tag (if tag name is specified)", +"$ref" : "#/definitions/json_FilterCriteria" + }, + "attributes" : { +"description" : "Attribute values included in the results", +"type" : "array", +"items" : { + "type" : "string" +} + } + }, + "example" : { + "query" : "...", + "typeName" : "...", + "classification" : "...", + "excludeDeletedEntities" : true, + "limit" : 12345, + "offset" : 12345, + "entityFilters" : { + "attributeName" : "...", + "operator" : "GTE", + "attributeValue" : "...", + "condition" : "AND", + "criterion" : [ { }, { } ] + }, + "tagFilters" : { + "attributeName" : "...", + "operator" : "STARTS_WITH", + "attributeValue" : "...", + "condition" : "AND", + "criterion" : [ { }, { } ] + }, + "attributes" : [ "...", "..." ] +}, + "description" : "" + } + , "json_SortType" : { "type" : "string", "title" : "SortType", @@ -1978,7 +2668,7 @@ "ASC", "DESC" ], - "description" : "Type of sorting to be applied on the result set, defaults to NONE" + "description" : "to specify whether the result should be sorted? If yes, whether asc or desc." } , "json_Status" : { @@ -1988,7 +2678,17 @@ "ACTIVE", "DELETED" ], - "description" : "Status of the entity - can be active or deleted." + "description" : "Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store." + } + , + "json_Status_AtlasRelationship" : { + "type" : "string", + "title" : "Status", + "enum" : [ + "ACTIVE", + "DELETED" + ], + "description" : "" } , "json_TypeCategory" : { @@ -2002,25 +2702,190 @@ "CLASSIFICATION", "ENTITY", "ARRAY", - "MAP" + "MAP", + "RELATIONSHIP" + ], + "description" : "" + } + , + "xml_ns0_PList" : { + "type" : "object", + "title" : "PList", + "allOf" : [ + { + "properties" : { + "list" : { + "xml" : { + "namespace" : "" + }, +"description" : "", +"type" : "object" + }, + "pageSize" : { + "xml" : { + "namespace" : "" + }, +"description" : "", +"type" : "number" + }, + "sortBy" : { + "xml" : { + "namespace" : "" + }, +"description" : "", +"type" : "string" + }, + "sortType" : { + "xml" : { + "namespace" : "" + }, +"description" : "", +"$ref" : "#/definitions/xml_ns0_sortType" + }, + "startIndex" : { + "xml" : { + "namespace" : "" + }, +"description" : "", +"type" : "number" + }, + "totalCount" : { + "xml" : { + "namespace" : "" + }, +"description" : "", +"type" : "number" + } + } + } + ], + "description" : "Paginated-list, for returning search results." + } + , + "xml_ns0_searchFilter" : { + "type" : "object", + "title" : "searchFilter", + "allOf" : [ + { + "properties" : { + "getCount" : { + "xml" : { + "namespace" : "" + }, +"description" : "", +"type" : "boolean" + }, + "maxRows" : { + "xml" : { + "namespace" : "" + }, +"description" : "", +"type" : "number" + }, + "params" : { + "xml" : { + "namespace" : "" + }, +"description" : "", +"type" : "object" + }, + "sortBy" : { + "xml" : { + "namespace" : "" + }, +"description" : "", +"type" : "string" + }, + "sortType" : { + "xml" : { + "namespace" : "" + }, +"description" : "", +"$ref" : "#/definitions/xml_ns0_sortType" + }, + "startIndex" : { + "xml" : { + "namespace" : "" + }, +"description" : "", +"type" : "number" + } + } + } + ], + "description" : "Generic filter, to specify search criteria using name/value pairs." + } + , + "xml_ns0_sortType" : { + "type" : "string", + "title" : "sortType", + "enum" : [ + "NONE", + "ASC", + "DESC" ], - "description" : "Category of a defined type" + "description" : "to specify whether the result should be sorted? If yes, whether asc or desc." + } + , + "xml_ns0_atlasClassification" : { + "type" : "object", + "title" : "atlasClassification", + "allOf" : [ + { + "$ref" : "#/definitions/xml_ns0_atlasStruct" + }, + { + } + ], + "description" : "An instance of a classification; it doesn't have an identity, this object exists only when associated with an entity." + } + , + "xml_ns0_atlasStruct" : { + "type" : "object", + "title" : "atlasStruct", + "allOf" : [ + { + "properties" : { + "attributes" : { + "xml" : { + "namespace" : "" + }, +"description" : "", +"type" : "object" + }, + "typeName" : { + "xml" : { + "namespace" : "" + }, +"description" : "", +"type" : "string" + } + } + } + ], + "description" : "Captures details of struct contents. Not instantiated directly, used only via AtlasEntity, AtlasClassification." } }, "paths": { - "\/v2/search/basic" : { + "\/v2/search/attribute" : { "get" : { "tags" : [ "DiscoveryREST" ], - "summary" : "Retrieve data for the specified fulltext query.", - "description" : "Retrieve data for the specified fulltext query", - "operationId" : "resource_DiscoveryREST_searchUsingBasic_GET", + "summary" : "Retrieve data for the specified attribute search query.", + "description" : "Retrieve data for the specified attribute search query", + "operationId" : "resource_DiscoveryREST_searchUsingAttribute_GET", "produces" : [ "application/json;charset=UTF-8" ], "parameters" : [ { - "name" : "classification", + "name" : "attrName", "in" : "query", "type" : "string", - "description" : "limit the result to only entities tagged with the given classification or or its sub-types" + "description" : "Attribute name" + }, + { + "name" : "attrValuePrefix", + "in" : "query", + "type" : "string", + "description" : "Attibute value to search on" }, { "name" : "limit", @@ -2035,12 +2900,6 @@ "description" : "start offset of the result set (useful for pagination)" }, { - "name" : "query", - "in" : "query", - "type" : "string", - "description" : "Fulltext query" - }, - { "name" : "typeName", "in" : "query", "type" : "string", @@ -2057,7 +2916,30 @@ }, "examples" : { "application/json" : { - "queryType" : "GREMLIN", + "queryType" : "FULL_TEXT", + "searchParameters" : { + "query" : "...", + "typeName" : "...", + "classification" : "...", + "excludeDeletedEntities" : true, + "limit" : 12345, + "offset" : 12345, + "entityFilters" : { + "attributeName" : "...", + "operator" : "LIKE", + "attributeValue" : "...", + "condition" : "OR", + "criterion" : [ { }, { } ] + }, + "tagFilters" : { + "attributeName" : "...", + "operator" : "NEQ", + "attributeValue" : "...", + "condition" : "OR", + "criterion" : [ { }, { } ] + }, + "attributes" : [ "...", "..." ] + }, "queryText" : "...", "type" : "...", "classification" : "...", @@ -2073,7 +2955,7 @@ } }, { "guid" : "...", - "status" : "DELETED", + "status" : "ACTIVE", "displayText" : "...", "classificationNames" : [ "...", "..." ], "typeName" : "...", @@ -2102,7 +2984,7 @@ }, { "entity" : { "guid" : "...", - "status" : "ACTIVE", + "status" : "DELETED", "displayText" : "...", "classificationNames" : [ "...", "..." ], "typeName" : "...", @@ -2112,7 +2994,31 @@ } }, "score" : 12345.0 - } ] + } ], + "referredEntities" : { + "property1" : { + "guid" : "...", + "status" : "ACTIVE", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + }, + "property2" : { + "guid" : "...", + "status" : "DELETED", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + } + } } }, "description" : "On successful FullText lookup with some results, might return an empty list if execution succeeded\nwithout any results" @@ -2122,7 +3028,30 @@ }, "examples" : { "application/json" : { - "queryType" : "BASIC", + "queryType" : "GREMLIN", + "searchParameters" : { + "query" : "...", + "typeName" : "...", + "classification" : "...", + "excludeDeletedEntities" : true, + "limit" : 12345, + "offset" : 12345, + "entityFilters" : { + "attributeName" : "...", + "operator" : "IN", + "attributeValue" : "...", + "condition" : "AND", + "criterion" : [ { }, { } ] + }, + "tagFilters" : { + "attributeName" : "...", + "operator" : "NEQ", + "attributeValue" : "...", + "condition" : "AND", + "criterion" : [ { }, { } ] + }, + "attributes" : [ "...", "..." ] + }, "queryText" : "...", "type" : "...", "classification" : "...", @@ -2138,7 +3067,7 @@ } }, { "guid" : "...", - "status" : "DELETED", + "status" : "ACTIVE", "displayText" : "...", "classificationNames" : [ "...", "..." ], "typeName" : "...", @@ -2154,7 +3083,7 @@ "fullTextResult" : [ { "entity" : { "guid" : "...", - "status" : "DELETED", + "status" : "ACTIVE", "displayText" : "...", "classificationNames" : [ "...", "..." ], "typeName" : "...", @@ -2167,7 +3096,7 @@ }, { "entity" : { "guid" : "...", - "status" : "ACTIVE", + "status" : "DELETED", "displayText" : "...", "classificationNames" : [ "...", "..." ], "typeName" : "...", @@ -2177,21 +3106,45 @@ } }, "score" : 12345.0 - } ] + } ], + "referredEntities" : { + "property1" : { + "guid" : "...", + "status" : "ACTIVE", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + }, + "property2" : { + "guid" : "...", + "status" : "ACTIVE", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + } + } } }, - "description" : "Invalid fulltext or query parameters" + "description" : "Invalid wildcard or query parameters" } } } } , - "\/v2/search/dsl" : { + "\/v2/search/basic" : { "get" : { "tags" : [ "DiscoveryREST" ], - "summary" : "Retrieve data for the specified DSL.", - "description" : "Retrieve data for the specified DSL", - "operationId" : "resource_DiscoveryREST_searchUsingDSL_GET", + "summary" : "Retrieve data for the specified fulltext query.", + "description" : "Retrieve data for the specified fulltext query", + "operationId" : "resource_DiscoveryREST_searchUsingBasic_GET", "produces" : [ "application/json;charset=UTF-8" ], "parameters" : [ { @@ -2201,6 +3154,12 @@ "description" : "limit the result to only entities tagged with the given classification or or its sub-types" }, { + "name" : "excludeDeletedEntities", + "in" : "query", + "type" : "boolean", + "description" : "" + }, + { "name" : "limit", "in" : "query", "type" : "integer", @@ -2216,7 +3175,7 @@ "name" : "query", "in" : "query", "type" : "string", - "description" : "DSL query" + "description" : "Fulltext query" }, { "name" : "typeName", @@ -2235,13 +3194,36 @@ }, "examples" : { "application/json" : { - "queryType" : "DSL", + "queryType" : "FULL_TEXT", + "searchParameters" : { + "query" : "...", + "typeName" : "...", + "classification" : "...", + "excludeDeletedEntities" : true, + "limit" : 12345, + "offset" : 12345, + "entityFilters" : { + "attributeName" : "...", + "operator" : "GT", + "attributeValue" : "...", + "condition" : "AND", + "criterion" : [ { }, { } ] + }, + "tagFilters" : { + "attributeName" : "...", + "operator" : "LTE", + "attributeValue" : "...", + "condition" : "AND", + "criterion" : [ { }, { } ] + }, + "attributes" : [ "...", "..." ] + }, "queryText" : "...", "type" : "...", "classification" : "...", "entities" : [ { "guid" : "...", - "status" : "ACTIVE", + "status" : "DELETED", "displayText" : "...", "classificationNames" : [ "...", "..." ], "typeName" : "...", @@ -2267,7 +3249,7 @@ "fullTextResult" : [ { "entity" : { "guid" : "...", - "status" : "ACTIVE", + "status" : "DELETED", "displayText" : "...", "classificationNames" : [ "...", "..." ], "typeName" : "...", @@ -2290,23 +3272,70 @@ } }, "score" : 12345.0 - } ] + } ], + "referredEntities" : { + "property1" : { + "guid" : "...", + "status" : "ACTIVE", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + }, + "property2" : { + "guid" : "...", + "status" : "DELETED", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + } + } } }, - "description" : "On successful DSL execution with some results, might return an empty list if execution succeeded\nwithout any results" + "description" : "On successful FullText lookup with some results, might return an empty list if execution succeeded\nwithout any results" }, "400" : { "headers" : { }, "examples" : { "application/json" : { - "queryType" : "DSL", + "queryType" : "GREMLIN", + "searchParameters" : { + "query" : "...", + "typeName" : "...", + "classification" : "...", + "excludeDeletedEntities" : true, + "limit" : 12345, + "offset" : 12345, + "entityFilters" : { + "attributeName" : "...", + "operator" : "LTE", + "attributeValue" : "...", + "condition" : "OR", + "criterion" : [ { }, { } ] + }, + "tagFilters" : { + "attributeName" : "...", + "operator" : "CONTAINS", + "attributeValue" : "...", + "condition" : "AND", + "criterion" : [ { }, { } ] + }, + "attributes" : [ "...", "..." ] + }, "queryText" : "...", "type" : "...", "classification" : "...", "entities" : [ { "guid" : "...", - "status" : "ACTIVE", + "status" : "DELETED", "displayText" : "...", "classificationNames" : [ "...", "..." ], "typeName" : "...", @@ -2316,7 +3345,7 @@ } }, { "guid" : "...", - "status" : "DELETED", + "status" : "ACTIVE", "displayText" : "...", "classificationNames" : [ "...", "..." ], "typeName" : "...", @@ -2332,7 +3361,7 @@ "fullTextResult" : [ { "entity" : { "guid" : "...", - "status" : "ACTIVE", + "status" : "DELETED", "displayText" : "...", "classificationNames" : [ "...", "..." ], "typeName" : "...", @@ -2345,7 +3374,7 @@ }, { "entity" : { "guid" : "...", - "status" : "ACTIVE", + "status" : "DELETED", "displayText" : "...", "classificationNames" : [ "...", "..." ], "typeName" : "...", @@ -2355,40 +3384,54 @@ } }, "score" : 12345.0 - } ] + } ], + "referredEntities" : { + "property1" : { + "guid" : "...", + "status" : "DELETED", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + }, + "property2" : { + "guid" : "...", + "status" : "ACTIVE", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + } + } } }, - "description" : "Invalid DSL or query parameters" + "description" : "Invalid fulltext or query parameters" } } } - } - , - "\/v2/search/fulltext" : { - "get" : { + , + "post" : { "tags" : [ "DiscoveryREST" ], - "summary" : "Retrieve data for the specified fulltext query.", - "description" : "Retrieve data for the specified fulltext query", - "operationId" : "resource_DiscoveryREST_searchUsingFullText_GET", + "summary" : "Attribute based search for entities satisfying the search parameters.", + "description" : "Attribute based search for entities satisfying the search parameters", + "operationId" : "resource_DiscoveryREST_searchWithParameters_POST", + "consumes" : [ "application/json;charset=UTF-8" ], "produces" : [ "application/json;charset=UTF-8" ], "parameters" : [ { - "name" : "limit", - "in" : "query", - "type" : "integer", - "description" : "limit the result set to only include the specified number of entries" - }, - { - "name" : "offset", - "in" : "query", - "type" : "integer", - "description" : "start offset of the result set (useful for pagination)" - }, - { - "name" : "query", - "in" : "query", - "type" : "string", - "description" : "Fulltext query" + "name" : "body", + "in" : "body", + "schema" : { +"description" : "", +"$ref" : "#/definitions/json_SearchParameters" + }, + "description" : "Search parameters" } ], "responses" : { @@ -2401,13 +3444,36 @@ }, "examples" : { "application/json" : { - "queryType" : "FULL_TEXT", + "queryType" : "ATTRIBUTE", + "searchParameters" : { + "query" : "...", + "typeName" : "...", + "classification" : "...", + "excludeDeletedEntities" : true, + "limit" : 12345, + "offset" : 12345, + "entityFilters" : { + "attributeName" : "...", + "operator" : "LIKE", + "attributeValue" : "...", + "condition" : "OR", + "criterion" : [ { }, { } ] + }, + "tagFilters" : { + "attributeName" : "...", + "operator" : "STARTS_WITH", + "attributeValue" : "...", + "condition" : "AND", + "criterion" : [ { }, { } ] + }, + "attributes" : [ "...", "..." ] + }, "queryText" : "...", "type" : "...", "classification" : "...", "entities" : [ { "guid" : "...", - "status" : "DELETED", + "status" : "ACTIVE", "displayText" : "...", "classificationNames" : [ "...", "..." ], "typeName" : "...", @@ -2417,7 +3483,7 @@ } }, { "guid" : "...", - "status" : "ACTIVE", + "status" : "DELETED", "displayText" : "...", "classificationNames" : [ "...", "..." ], "typeName" : "...", @@ -2456,23 +3522,70 @@ } }, "score" : 12345.0 - } ] + } ], + "referredEntities" : { + "property1" : { + "guid" : "...", + "status" : "DELETED", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + }, + "property2" : { + "guid" : "...", + "status" : "DELETED", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + } + } } }, - "description" : "On successful FullText lookup with some results, might return an empty list if execution succeeded\nwithout any results" + "description" : "On successful search" }, "400" : { "headers" : { }, "examples" : { "application/json" : { - "queryType" : "BASIC", + "queryType" : "ATTRIBUTE", + "searchParameters" : { + "query" : "...", + "typeName" : "...", + "classification" : "...", + "excludeDeletedEntities" : true, + "limit" : 12345, + "offset" : 12345, + "entityFilters" : { + "attributeName" : "...", + "operator" : "IN", + "attributeValue" : "...", + "condition" : "AND", + "criterion" : [ { }, { } ] + }, + "tagFilters" : { + "attributeName" : "...", + "operator" : "EQ", + "attributeValue" : "...", + "condition" : "OR", + "criterion" : [ { }, { } ] + }, + "attributes" : [ "...", "..." ] + }, "queryText" : "...", "type" : "...", "classification" : "...", "entities" : [ { "guid" : "...", - "status" : "DELETED", + "status" : "ACTIVE", "displayText" : "...", "classificationNames" : [ "...", "..." ], "typeName" : "...", @@ -2482,7 +3595,7 @@ } }, { "guid" : "...", - "status" : "ACTIVE", + "status" : "DELETED", "displayText" : "...", "classificationNames" : [ "...", "..." ], "typeName" : "...", @@ -2511,7 +3624,7 @@ }, { "entity" : { "guid" : "...", - "status" : "ACTIVE", + "status" : "DELETED", "displayText" : "...", "classificationNames" : [ "...", "..." ], "typeName" : "...", @@ -2521,46 +3634,9 @@ } }, "score" : 12345.0 - } ] -} - }, - "description" : "Invalid fulltext or query parameters" - } - } - } - } - , - "\/v2/entity" : { - "post" : { - "tags" : [ "EntityREST" ], - "summary" : "Create new entity or update existing entity in Atlas.", - "description" : "Create new entity or update existing entity in Atlas.\nExisting entity is matched using its unique guid if supplied or by its unique attributes eg: qualifiedName", - "operationId" : "resource_EntityREST_createOrUpdate_POST", - "consumes" : [ "application/json;charset=UTF-8" ], - "produces" : [ "application/json;charset=UTF-8" ], - "parameters" : [ - { - "name" : "body", - "in" : "body", - "schema" : { -"description" : "", -"$ref" : "#/definitions/json_AtlasEntityWithExtInfo" - }, - "description" : "" - } - ], - "responses" : { - "201" : { - "schema" : { -"description" : "", -"$ref" : "#/definitions/json_EntityMutationResponse" - }, - "headers" : { - }, - "examples" : { - "application/json" : { - "mutatedEntities" : { - "property1" : [ { + } ], + "referredEntities" : { + "property1" : { "guid" : "...", "status" : "ACTIVE", "displayText" : "...", @@ -2570,7 +3646,8 @@ "property1" : { }, "property2" : { } } - }, { + }, + "property2" : { "guid" : "...", "status" : "DELETED", "displayText" : "...", @@ -2580,189 +3657,119 @@ "property1" : { }, "property2" : { } } - } ], - "property2" : [ { - "guid" : "...", - "status" : "ACTIVE", - "displayText" : "...", - "classificationNames" : [ "...", "..." ], - "typeName" : "...", - "attributes" : { - "property1" : { }, - "property2" : { } - } - }, { - "guid" : "...", - "status" : "ACTIVE", - "displayText" : "...", - "classificationNames" : [ "...", "..." ], - "typeName" : "...", - "attributes" : { - "property1" : { }, - "property2" : { } - } - } ] - }, - "guidAssignments" : { - "property1" : "...", - "property2" : "..." - }, - "createdEntities" : [ { - "guid" : "...", - "status" : "ACTIVE", - "displayText" : "...", - "classificationNames" : [ "...", "..." ], - "typeName" : "...", - "attributes" : { - "property1" : { }, - "property2" : { } - } - }, { - "guid" : "...", - "status" : "DELETED", - "displayText" : "...", - "classificationNames" : [ "...", "..." ], - "typeName" : "...", - "attributes" : { - "property1" : { }, - "property2" : { } - } - } ], - "updatedEntities" : [ { - "guid" : "...", - "status" : "DELETED", - "displayText" : "...", - "classificationNames" : [ "...", "..." ], - "typeName" : "...", - "attributes" : { - "property1" : { }, - "property2" : { } - } - }, { - "guid" : "...", - "status" : "ACTIVE", - "displayText" : "...", - "classificationNames" : [ "...", "..." ], - "typeName" : "...", - "attributes" : { - "property1" : { }, - "property2" : { } - } - } ], - "partialUpdatedEntities" : [ { - "guid" : "...", - "status" : "DELETED", - "displayText" : "...", - "classificationNames" : [ "...", "..." ], - "typeName" : "...", - "attributes" : { - "property1" : { }, - "property2" : { } - } - }, { - "guid" : "...", - "status" : "ACTIVE", - "displayText" : "...", - "classificationNames" : [ "...", "..." ], - "typeName" : "...", - "attributes" : { - "property1" : { }, - "property2" : { } - } - } ], - "deletedEntities" : [ { - "guid" : "...", - "status" : "ACTIVE", - "displayText" : "...", - "classificationNames" : [ "...", "..." ], - "typeName" : "...", - "attributes" : { - "property1" : { }, - "property2" : { } - } - }, { - "guid" : "...", - "status" : "DELETED", - "displayText" : "...", - "classificationNames" : [ "...", "..." ], - "typeName" : "...", - "attributes" : { - "property1" : { }, - "property2" : { } - } - } ], - "firstEntityCreated" : { - "guid" : "...", - "status" : "ACTIVE", - "displayText" : "...", - "classificationNames" : [ "...", "..." ], - "typeName" : "...", - "attributes" : { - "property1" : { }, - "property2" : { } - } - }, - "firstEntityUpdated" : { - "guid" : "...", - "status" : "DELETED", - "displayText" : "...", - "classificationNames" : [ "...", "..." ], - "typeName" : "...", - "attributes" : { - "property1" : { }, - "property2" : { } - } - }, - "firstEntityPartialUpdated" : { - "guid" : "...", - "status" : "ACTIVE", - "displayText" : "...", - "classificationNames" : [ "...", "..." ], - "typeName" : "...", - "attributes" : { - "property1" : { }, - "property2" : { } } } } }, - "description" : "Success" + "description" : "Tag/Entity doesn't exist or Tag/entity filter is present without tag/type name" } } } } , - "\/v2/entity/bulk" : { - "delete" : { - "tags" : [ "EntityREST" ], - "summary" : "Bulk API to delete list of entities identified by its GUIDs.", - "description" : "Bulk API to delete list of entities identified by its GUIDs", - "operationId" : "resource_EntityREST_deleteByGuids_DELETE", + "\/v2/search/dsl" : { + "get" : { + "tags" : [ "DiscoveryREST" ], + "summary" : "Retrieve data for the specified DSL.", + "description" : "Retrieve data for the specified DSL", + "operationId" : "resource_DiscoveryREST_searchUsingDSL_GET", "produces" : [ "application/json;charset=UTF-8" ], "parameters" : [ { - "name" : "guid", + "name" : "classification", "in" : "query", - "type" : "array", - "items" : { - "type" : "string" - }, - "collectionFormat" : "multi", - "description" : "" + "type" : "string", + "description" : "limit the result to only entities tagged with the given classification or or its sub-types" + }, + { + "name" : "limit", + "in" : "query", + "type" : "integer", + "description" : "limit the result set to only include the specified number of entries" + }, + { + "name" : "offset", + "in" : "query", + "type" : "integer", + "description" : "start offset of the result set (useful for pagination)" + }, + { + "name" : "query", + "in" : "query", + "type" : "string", + "description" : "DSL query" + }, + { + "name" : "typeName", + "in" : "query", + "type" : "string", + "description" : "limit the result to only entities of specified type or its sub-types" } ], "responses" : { - "204" : { + "200" : { "schema" : { "description" : "", -"$ref" : "#/definitions/json_EntityMutationResponse" +"$ref" : "#/definitions/json_AtlasSearchResult" }, "headers" : { }, "examples" : { "application/json" : { - "mutatedEntities" : { - "property1" : [ { + "queryType" : "BASIC", + "searchParameters" : { + "query" : "...", + "typeName" : "...", + "classification" : "...", + "excludeDeletedEntities" : true, + "limit" : 12345, + "offset" : 12345, + "entityFilters" : { + "attributeName" : "...", + "operator" : "LIKE", + "attributeValue" : "...", + "condition" : "AND", + "criterion" : [ { }, { } ] + }, + "tagFilters" : { + "attributeName" : "...", + "operator" : "EQ", + "attributeValue" : "...", + "condition" : "OR", + "criterion" : [ { }, { } ] + }, + "attributes" : [ "...", "..." ] + }, + "queryText" : "...", + "type" : "...", + "classification" : "...", + "entities" : [ { + "guid" : "...", + "status" : "ACTIVE", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + }, { + "guid" : "...", + "status" : "ACTIVE", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + } ], + "attributes" : { + "name" : [ "...", "..." ], + "values" : [ ] + }, + "fullTextResult" : [ { + "entity" : { "guid" : "...", "status" : "DELETED", "displayText" : "...", @@ -2772,7 +3779,10 @@ "property1" : { }, "property2" : { } } - }, { + }, + "score" : 12345.0 + }, { + "entity" : { "guid" : "...", "status" : "ACTIVE", "displayText" : "...", @@ -2782,10 +3792,13 @@ "property1" : { }, "property2" : { } } - } ], - "property2" : [ { + }, + "score" : 12345.0 + } ], + "referredEntities" : { + "property1" : { "guid" : "...", - "status" : "ACTIVE", + "status" : "DELETED", "displayText" : "...", "classificationNames" : [ "...", "..." ], "typeName" : "...", @@ -2793,7 +3806,8 @@ "property1" : { }, "property2" : { } } - }, { + }, + "property2" : { "guid" : "...", "status" : "ACTIVE", "displayText" : "...", @@ -2803,76 +3817,45 @@ "property1" : { }, "property2" : { } } - } ] - }, - "guidAssignments" : { - "property1" : "...", - "property2" : "..." - }, - "createdEntities" : [ { - "guid" : "...", - "status" : "ACTIVE", - "displayText" : "...", - "classificationNames" : [ "...", "..." ], - "typeName" : "...", - "attributes" : { - "property1" : { }, - "property2" : { } } - }, { - "guid" : "...", - "status" : "DELETED", - "displayText" : "...", - "classificationNames" : [ "...", "..." ], - "typeName" : "...", - "attributes" : { - "property1" : { }, - "property2" : { } - } - } ], - "updatedEntities" : [ { - "guid" : "...", - "status" : "DELETED", - "displayText" : "...", - "classificationNames" : [ "...", "..." ], - "typeName" : "...", - "attributes" : { - "property1" : { }, - "property2" : { } - } - }, { - "guid" : "...", - "status" : "ACTIVE", - "displayText" : "...", - "classificationNames" : [ "...", "..." ], - "typeName" : "...", - "attributes" : { - "property1" : { }, - "property2" : { } - } - } ], - "partialUpdatedEntities" : [ { - "guid" : "...", - "status" : "ACTIVE", - "displayText" : "...", - "classificationNames" : [ "...", "..." ], - "typeName" : "...", - "attributes" : { - "property1" : { }, - "property2" : { } - } - }, { - "guid" : "...", - "status" : "ACTIVE", - "displayText" : "...", - "classificationNames" : [ "...", "..." ], - "typeName" : "...", - "attributes" : { - "property1" : { }, - "property2" : { } - } - } ], - "deletedEntities" : [ { + } +} + }, + "description" : "On successful DSL execution with some results, might return an empty list if execution succeeded\nwithout any results" + }, + "400" : { + "headers" : { + }, + "examples" : { + "application/json" : { + "queryType" : "DSL", + "searchParameters" : { + "query" : "...", + "typeName" : "...", + "classification" : "...", + "excludeDeletedEntities" : true, + "limit" : 12345, + "offset" : 12345, + "entityFilters" : { + "attributeName" : "...", + "operator" : "GTE", + "attributeValue" : "...", + "condition" : "OR", + "criterion" : [ { }, { } ] + }, + "tagFilters" : { + "attributeName" : "...", + "operator" : "EQ", + "attributeValue" : "...", + "condition" : "OR", + "criterion" : [ { }, { } ] + }, + "attributes" : [ "...", "..." ] + }, + "queryText" : "...", + "type" : "...", + "classification" : "...", + "entities" : [ { "guid" : "...", "status" : "ACTIVE", "displayText" : "...", @@ -2893,95 +3876,144 @@ "property2" : { } } } ], - "firstEntityCreated" : { - "guid" : "...", - "status" : "DELETED", - "displayText" : "...", - "classificationNames" : [ "...", "..." ], - "typeName" : "...", - "attributes" : { - "property1" : { }, - "property2" : { } - } - }, - "firstEntityUpdated" : { - "guid" : "...", - "status" : "ACTIVE", - "displayText" : "...", - "classificationNames" : [ "...", "..." ], - "typeName" : "...", - "attributes" : { - "property1" : { }, - "property2" : { } - } + "attributes" : { + "name" :
<TRUNCATED>
