You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@atlas.apache.org by ap...@apache.org on 2017/10/25 23:12:13 UTC
[2/6] atlas-website git commit: Fix 0.8.1 docs
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/6e80db07/0.8.1/api/v2/ui/swagger.json
----------------------------------------------------------------------
diff --git a/0.8.1/api/v2/ui/swagger.json b/0.8.1/api/v2/ui/swagger.json
index c2ecdeb..7d01062 100644
--- a/0.8.1/api/v2/ui/swagger.json
+++ b/0.8.1/api/v2/ui/swagger.json
@@ -6,7 +6,7 @@
"url" : "http://www.apache.org/licenses/LICENSE-2.0.txt",
"name" : "The Apache Software License, Version 2.0"
},
- "version" : "0.8.1",
+ "version" : "0.8.2-SNAPSHOT",
"title" : "Atlas REST API"
},
"schemes" : [],
@@ -30,12 +30,6 @@
}
,
{
- "name" : "RelationshipREST"
- ,
- "description" : "REST interface for entity relationships."
- }
- ,
- {
"name" : "TypesREST"
,
"description" : "REST interface for CRUD operations on type definitions."
@@ -78,10 +72,6 @@
"description" : "",
"type" : "boolean"
},
- "defaultValue" : {
-"description" : "",
-"type" : "string"
- },
"constraints" : {
"description" : "",
"type" : "array",
@@ -94,12 +84,11 @@
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "SET",
+ "cardinality" : "LIST",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
- "defaultValue" : "...",
"constraints" : [ {
"type" : "...",
"params" : {
@@ -117,6 +106,21 @@
"description" : "class that captures details of a struct-attribute."
}
,
+ "json_AtlasBaseModelObject" : {
+ "type" : "object",
+ "title" : "AtlasBaseModelObject",
+ "properties" : {
+ "guid" : {
+"description" : "",
+"type" : "string"
+ }
+ },
+ "example" : {
+ "guid" : "..."
+},
+ "description" : ""
+ }
+ ,
"json_AtlasBaseTypeDef" : {
"type" : "object",
"title" : "AtlasBaseTypeDef",
@@ -233,12 +237,11 @@
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "LIST",
+ "cardinality" : "SINGLE",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
- "defaultValue" : "...",
"constraints" : [ {
"type" : "...",
"params" : {
@@ -256,12 +259,11 @@
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "LIST",
+ "cardinality" : "SINGLE",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
- "defaultValue" : "...",
"constraints" : [ {
"type" : "...",
"params" : {
@@ -276,7 +278,7 @@
}
} ]
} ],
- "category" : "CLASSIFICATION",
+ "category" : "ARRAY",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -309,7 +311,7 @@
"startIndex" : 12345,
"pageSize" : 12345,
"totalCount" : 12345,
- "sortType" : "NONE",
+ "sortType" : "DESC",
"sortBy" : "..."
},
"description" : "REST serialization friendly list."
@@ -369,10 +371,6 @@
"createTime" : 12345,
"updateTime" : 12345,
"version" : 12345,
- "relationshipAttributes" : {
- "property1" : { },
- "property2" : { }
- },
"classifications" : [ {
"typeName" : "...",
"attributes" : {
@@ -393,16 +391,12 @@
}
}, {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"createdBy" : "...",
"updatedBy" : "...",
"createTime" : 12345,
"updateTime" : 12345,
"version" : 12345,
- "relationshipAttributes" : {
- "property1" : { },
- "property2" : { }
- },
"classifications" : [ {
"typeName" : "...",
"attributes" : {
@@ -431,10 +425,6 @@
"createTime" : 12345,
"updateTime" : 12345,
"version" : 12345,
- "relationshipAttributes" : {
- "property1" : { },
- "property2" : { }
- },
"classifications" : [ {
"typeName" : "...",
"attributes" : {
@@ -456,16 +446,12 @@
},
"property2" : {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"createdBy" : "...",
"updatedBy" : "...",
"createTime" : 12345,
"updateTime" : 12345,
"version" : 12345,
- "relationshipAttributes" : {
- "property1" : { },
- "property2" : { }
- },
"classifications" : [ {
"typeName" : "...",
"attributes" : {
@@ -527,13 +513,6 @@
"description" : "",
"type" : "number"
},
- "relationshipAttributes" : {
-"description" : "",
-"type" : "object",
-"additionalProperties" : {
- "type" : "object"
-}
- },
"classifications" : {
"description" : "",
"type" : "array",
@@ -546,16 +525,12 @@
],
"example" : {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"createdBy" : "...",
"updatedBy" : "...",
"createTime" : 12345,
"updateTime" : 12345,
"version" : 12345,
- "relationshipAttributes" : {
- "property1" : { },
- "property2" : { }
- },
"classifications" : [ {
"typeName" : "...",
"attributes" : {
@@ -603,12 +578,11 @@
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "SET",
+ "cardinality" : "LIST",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
- "defaultValue" : "...",
"constraints" : [ {
"type" : "...",
"params" : {
@@ -631,7 +605,6 @@
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
- "defaultValue" : "...",
"constraints" : [ {
"type" : "...",
"params" : {
@@ -646,7 +619,7 @@
}
} ]
} ],
- "category" : "ENTITY",
+ "category" : "MAP",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -686,10 +659,6 @@
"createTime" : 12345,
"updateTime" : 12345,
"version" : 12345,
- "relationshipAttributes" : {
- "property1" : { },
- "property2" : { }
- },
"classifications" : [ {
"typeName" : "...",
"attributes" : {
@@ -711,16 +680,12 @@
},
"property2" : {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"createdBy" : "...",
"updatedBy" : "...",
"createTime" : 12345,
"updateTime" : 12345,
"version" : 12345,
- "relationshipAttributes" : {
- "property1" : { },
- "property2" : { }
- },
"classifications" : [ {
"typeName" : "...",
"attributes" : {
@@ -815,10 +780,6 @@
"createTime" : 12345,
"updateTime" : 12345,
"version" : 12345,
- "relationshipAttributes" : {
- "property1" : { },
- "property2" : { }
- },
"classifications" : [ {
"typeName" : "...",
"attributes" : {
@@ -841,16 +802,12 @@
"referredEntities" : {
"property1" : {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"createdBy" : "...",
"updatedBy" : "...",
"createTime" : 12345,
"updateTime" : 12345,
"version" : 12345,
- "relationshipAttributes" : {
- "property1" : { },
- "property2" : { }
- },
"classifications" : [ {
"typeName" : "...",
"attributes" : {
@@ -872,16 +829,12 @@
},
"property2" : {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"createdBy" : "...",
"updatedBy" : "...",
"createTime" : 12345,
"updateTime" : 12345,
"version" : 12345,
- "relationshipAttributes" : {
- "property1" : { },
- "property2" : { }
- },
"classifications" : [ {
"typeName" : "...",
"attributes" : {
@@ -940,7 +893,7 @@
"ordinal" : 12345
} ],
"defaultValue" : "...",
- "category" : "ARRAY",
+ "category" : "ENTITY",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -1049,7 +1002,7 @@
"guidEntityMap" : {
"property1" : {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -1060,7 +1013,7 @@
},
"property2" : {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -1077,43 +1030,12 @@
"fromEntityId" : "...",
"toEntityId" : "..."
} ],
- "lineageDirection" : "BOTH",
+ "lineageDirection" : "INPUT",
"lineageDepth" : 12345
},
"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" : {
"type" : "string",
"title" : "AtlasQueryType",
@@ -1128,344 +1050,108 @@
"description" : ""
}
,
- "json_AtlasRelationship" : {
+ "json_AtlasSearchResult" : {
"type" : "object",
- "title" : "AtlasRelationship",
- "allOf" : [
- {
- "$ref" : "#/definitions/json_AtlasStruct"
- },
- {
+ "title" : "AtlasSearchResult",
"properties" : {
- "guid" : {
+ "queryType" : {
"description" : "",
-"type" : "string"
+"$ref" : "#/definitions/json_AtlasQueryType"
},
- "status" : {
+ "searchParameters" : {
"description" : "",
-"$ref" : "#/definitions/json_Status_AtlasRelationship"
+"$ref" : "#/definitions/json_SearchParameters"
},
- "createdBy" : {
+ "queryText" : {
"description" : "",
"type" : "string"
},
- "updatedBy" : {
+ "type" : {
"description" : "",
"type" : "string"
},
- "createTime" : {
-"description" : "",
-"type" : "number"
- },
- "updateTime" : {
+ "classification" : {
"description" : "",
-"type" : "number"
+"type" : "string"
},
- "version" : {
+ "entities" : {
"description" : "",
-"type" : "number"
+"type" : "array",
+"items" : {
+ "$ref" : "#/definitions/json_AtlasEntityHeader"
+}
},
- "end1" : {
+ "attributes" : {
"description" : "",
-"$ref" : "#/definitions/json_AtlasObjectId"
+"$ref" : "#/definitions/json_AttributeSearchResult"
},
- "end2" : {
+ "fullTextResult" : {
"description" : "",
-"$ref" : "#/definitions/json_AtlasObjectId"
+"type" : "array",
+"items" : {
+ "$ref" : "#/definitions/json_AtlasFullTextResult"
+}
},
- "label" : {
+ "referredEntities" : {
"description" : "",
-"type" : "string"
+"type" : "object",
+"additionalProperties" : {
+ "$ref" : "#/definitions/json_AtlasEntityHeader"
+}
}
- }
- }
- ],
+ },
"example" : {
- "guid" : "...",
- "status" : "ACTIVE",
- "createdBy" : "...",
- "updatedBy" : "...",
- "createTime" : 12345,
- "updateTime" : 12345,
- "version" : 12345,
- "end1" : {
+ "queryType" : "GREMLIN",
+ "searchParameters" : {
+ "query" : "...",
+ "typeName" : "...",
+ "classification" : "...",
+ "excludeDeletedEntities" : true,
+ "limit" : 12345,
+ "offset" : 12345,
+ "entityFilters" : {
+ "attributeName" : "...",
+ "operator" : "NEQ",
+ "attributeValue" : "...",
+ "condition" : "OR",
+ "criterion" : [ { }, { } ]
+ },
+ "tagFilters" : {
+ "attributeName" : "...",
+ "operator" : "EQ",
+ "attributeValue" : "...",
+ "condition" : "OR",
+ "criterion" : [ { }, { } ]
+ },
+ "attributes" : [ "...", "..." ]
+ },
+ "queryText" : "...",
+ "type" : "...",
+ "classification" : "...",
+ "entities" : [ {
"guid" : "...",
+ "status" : "ACTIVE",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
"typeName" : "...",
- "uniqueAttributes" : {
+ "attributes" : {
"property1" : { },
"property2" : { }
}
- },
- "end2" : {
+ }, {
"guid" : "...",
+ "status" : "DELETED",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
"typeName" : "...",
- "uniqueAttributes" : {
+ "attributes" : {
"property1" : { },
"property2" : { }
}
- },
- "label" : "...",
- "typeName" : "...",
+ } ],
"attributes" : {
- "property1" : { },
- "property2" : { }
- }
-},
- "description" : "Atlas relationship instance."
- }
- ,
- "json_AtlasRelationshipDef" : {
- "type" : "object",
- "title" : "AtlasRelationshipDef",
- "allOf" : [
- {
- "$ref" : "#/definitions/json_AtlasStructDef"
- },
- {
- "properties" : {
- "relationshipCategory" : {
-"description" : "",
-"$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" : "COMPOSITION",
- "propagateTags" : "TWO_TO_ONE",
- "endDef1" : {
- "type" : "...",
- "name" : "...",
- "isContainer" : true,
- "cardinality" : "SET",
- "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" : [ {
- "type" : "...",
- "params" : {
- "property1" : { },
- "property2" : { }
- }
- }, {
- "type" : "...",
- "params" : {
- "property1" : { },
- "property2" : { }
- }
- } ]
- }, {
- "name" : "...",
- "typeName" : "...",
- "isOptional" : true,
- "cardinality" : "SET",
- "valuesMinCount" : 12345,
- "valuesMaxCount" : 12345,
- "isUnique" : true,
- "isIndexable" : true,
- "defaultValue" : "...",
- "constraints" : [ {
- "type" : "...",
- "params" : {
- "property1" : { },
- "property2" : { }
- }
- }, {
- "type" : "...",
- "params" : {
- "property1" : { },
- "property2" : { }
- }
- } ]
- } ],
- "category" : "ENUM",
- "guid" : "...",
- "createdBy" : "...",
- "updatedBy" : "...",
- "createTime" : 12345,
- "updateTime" : 12345,
- "version" : 12345,
- "name" : "...",
- "description" : "...",
- "typeVersion" : "...",
- "options" : {
- "property1" : "...",
- "property2" : "..."
- }
-},
- "description" : "AtlasRelationshipDef is a TypeDef that defines a relationship.\n<p>\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<p>\nRelationshipDefs have 2 ends, each of which specify cardinality, an EntityDef type name and name and optionally\nwhether the end is a container.\n<p>\nRelationshipDefs can have AttributeDefs - though only primitive types are allowed. <br>\nRelationshipDefs have a relationshipCategory specifying the UML type of relationship required <br>\nRelationshipDefs also have a PropogateTag - indicating which way tags could flow over the relationships.\n<p>\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<p>\nRelationshipDefs introduce new atributes to the entity instances. For exa
mple\n<p>\nEntityDef A might have attributes attr1,attr2,attr3 <br>\nEntityDef B might have attributes attr4,attr5,attr6 <br>\nRelationshipDef AtoB might define 2 ends <br>\n\n<pre>\n end1: type A, name attr7\n end2: type B, name attr8 <\/pre>\n\n<p>\nWhen an instance of EntityDef A is created, it will have attributes attr1,attr2,attr3,attr7 <br>\nWhen an instance of EntityDef B is created, it will have attributes attr4,attr5,attr6,attr8\n<p>\nIn this way relationshipDefs can be authored separately from entityDefs and can inject relationship attributes into\nthe entity instances"
- }
- ,
- "json_AtlasRelationshipEndDef" : {
- "type" : "object",
- "title" : "AtlasRelationshipEndDef",
- "properties" : {
- "type" : {
-"description" : "",
-"type" : "string"
- },
- "name" : {
-"description" : "",
-"type" : "string"
- },
- "isContainer" : {
-"description" : "",
-"type" : "boolean"
- },
- "cardinality" : {
-"description" : "",
-"$ref" : "#/definitions/json_Cardinality"
- },
- "isLegacyAttribute" : {
-"description" : "",
-"type" : "boolean"
- }
- },
- "example" : {
- "type" : "...",
- "name" : "...",
- "isContainer" : true,
- "cardinality" : "LIST",
- "isLegacyAttribute" : true
-},
- "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_AtlasSearchResult" : {
- "type" : "object",
- "title" : "AtlasSearchResult",
- "properties" : {
- "queryType" : {
-"description" : "",
-"$ref" : "#/definitions/json_AtlasQueryType"
- },
- "searchParameters" : {
-"description" : "",
-"$ref" : "#/definitions/json_SearchParameters"
- },
- "queryText" : {
-"description" : "",
-"type" : "string"
- },
- "type" : {
-"description" : "",
-"type" : "string"
- },
- "classification" : {
-"description" : "",
-"type" : "string"
- },
- "entities" : {
-"description" : "",
-"type" : "array",
-"items" : {
- "$ref" : "#/definitions/json_AtlasEntityHeader"
-}
- },
- "attributes" : {
-"description" : "",
-"$ref" : "#/definitions/json_AttributeSearchResult"
- },
- "fullTextResult" : {
-"description" : "",
-"type" : "array",
-"items" : {
- "$ref" : "#/definitions/json_AtlasFullTextResult"
-}
- },
- "referredEntities" : {
-"description" : "",
-"type" : "object",
-"additionalProperties" : {
- "$ref" : "#/definitions/json_AtlasEntityHeader"
-}
- }
- },
- "example" : {
- "queryType" : "FULL_TEXT",
- "searchParameters" : {
- "query" : "...",
- "typeName" : "...",
- "classification" : "...",
- "excludeDeletedEntities" : true,
- "limit" : 12345,
- "offset" : 12345,
- "entityFilters" : {
- "attributeName" : "...",
- "operator" : "ENDS_WITH",
- "attributeValue" : "...",
- "condition" : "OR",
- "criterion" : [ { }, { } ]
- },
- "tagFilters" : {
- "attributeName" : "...",
- "operator" : "STARTS_WITH",
- "attributeValue" : "...",
- "condition" : "OR",
- "criterion" : [ { }, { } ]
- },
- "attributes" : [ "...", "..." ]
- },
- "queryText" : "...",
- "type" : "...",
- "classification" : "...",
- "entities" : [ {
- "guid" : "...",
- "status" : "DELETED",
- "displayText" : "...",
- "classificationNames" : [ "...", "..." ],
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- }, {
- "guid" : "...",
- "status" : "ACTIVE",
- "displayText" : "...",
- "classificationNames" : [ "...", "..." ],
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- } ],
- "attributes" : {
- "name" : [ "...", "..." ],
- "values" : [ ]
+ "name" : [ "...", "..." ],
+ "values" : [ ]
},
"fullTextResult" : [ {
"entity" : {
@@ -1483,7 +1169,7 @@
}, {
"entity" : {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -1577,7 +1263,6 @@
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
- "defaultValue" : "...",
"constraints" : [ {
"type" : "...",
"params" : {
@@ -1600,7 +1285,6 @@
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
- "defaultValue" : "...",
"constraints" : [ {
"type" : "...",
"params" : {
@@ -1615,7 +1299,7 @@
}
} ]
} ],
- "category" : "CLASSIFICATION",
+ "category" : "OBJECT_ID_TYPE",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -1653,7 +1337,7 @@
"example" : {
"guid" : "...",
"name" : "...",
- "category" : "PRIMITIVE"
+ "category" : "CLASSIFICATION"
},
"description" : ""
}
@@ -1690,13 +1374,6 @@
"$ref" : "#/definitions/json_AtlasEntityDef"
}
},
- "relationshipDefs" : {
-"description" : "",
-"type" : "array",
-"items" : {
- "$ref" : "#/definitions/json_AtlasRelationshipDef"
-}
- },
"empty" : {
"description" : "",
"type" : "boolean"
@@ -1714,7 +1391,7 @@
"ordinal" : 12345
} ],
"defaultValue" : "...",
- "category" : "OBJECT_ID_TYPE",
+ "category" : "MAP",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -1739,7 +1416,7 @@
"ordinal" : 12345
} ],
"defaultValue" : "...",
- "category" : "ARRAY",
+ "category" : "CLASSIFICATION",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -1764,7 +1441,6 @@
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
- "defaultValue" : "...",
"constraints" : [ { }, { } ]
}, {
"name" : "...",
@@ -1775,10 +1451,9 @@
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
- "defaultValue" : "...",
"constraints" : [ { }, { } ]
} ],
- "category" : "STRUCT",
+ "category" : "MAP",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -1797,26 +1472,24 @@
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "LIST",
+ "cardinality" : "SINGLE",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
- "defaultValue" : "...",
"constraints" : [ { }, { } ]
}, {
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "SINGLE",
+ "cardinality" : "SET",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
- "defaultValue" : "...",
"constraints" : [ { }, { } ]
} ],
- "category" : "ENTITY",
+ "category" : "MAP",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -1842,21 +1515,19 @@
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
- "defaultValue" : "...",
"constraints" : [ { }, { } ]
}, {
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "SET",
+ "cardinality" : "SINGLE",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
- "defaultValue" : "...",
"constraints" : [ { }, { } ]
} ],
- "category" : "ARRAY",
+ "category" : "PRIMITIVE",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -1876,23 +1547,21 @@
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "SET",
+ "cardinality" : "SINGLE",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
- "defaultValue" : "...",
"constraints" : [ { }, { } ]
}, {
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "SET",
+ "cardinality" : "SINGLE",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
- "defaultValue" : "...",
"constraints" : [ { }, { } ]
} ],
"category" : "STRUCT",
@@ -1921,21 +1590,19 @@
"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" : "...",
@@ -1955,26 +1622,24 @@
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "SET",
+ "cardinality" : "SINGLE",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
- "defaultValue" : "...",
"constraints" : [ { }, { } ]
}, {
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "SET",
+ "cardinality" : "SINGLE",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
- "defaultValue" : "...",
"constraints" : [ { }, { } ]
} ],
- "category" : "ARRAY",
+ "category" : "RELATIONSHIP",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -1989,118 +1654,67 @@
"property2" : "..."
}
} ],
- "relationshipDefs" : [ {
- "relationshipCategory" : "ASSOCIATION",
- "propagateTags" : "BOTH",
- "endDef1" : {
- "type" : "...",
- "name" : "...",
- "isContainer" : true,
- "cardinality" : "SINGLE",
- "isLegacyAttribute" : true
- },
- "endDef2" : {
- "type" : "...",
- "name" : "...",
- "isContainer" : true,
- "cardinality" : "SINGLE",
- "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" : "SET",
- "valuesMinCount" : 12345,
- "valuesMaxCount" : 12345,
- "isUnique" : true,
- "isIndexable" : true,
- "defaultValue" : "...",
- "constraints" : [ { }, { } ]
- } ],
- "category" : "MAP",
- "guid" : "...",
- "createdBy" : "...",
- "updatedBy" : "...",
- "createTime" : 12345,
- "updateTime" : 12345,
- "version" : 12345,
- "name" : "...",
- "description" : "...",
- "typeVersion" : "...",
- "options" : {
- "property1" : "...",
- "property2" : "..."
+ "empty" : true
+},
+ "description" : ""
}
- }, {
- "relationshipCategory" : "ASSOCIATION",
- "propagateTags" : "ONE_TO_TWO",
- "endDef1" : {
- "type" : "...",
- "name" : "...",
- "isContainer" : true,
- "cardinality" : "SET",
- "isLegacyAttribute" : true
+ ,
+ "json_AtlasUserSavedSearch" : {
+ "type" : "object",
+ "title" : "AtlasUserSavedSearch",
+ "allOf" : [
+ {
+ "$ref" : "#/definitions/json_AtlasBaseModelObject"
+ },
+ {
+ "properties" : {
+ "ownerName" : {
+"description" : "",
+"type" : "string"
+ },
+ "name" : {
+"description" : "",
+"type" : "string"
+ },
+ "searchType" : {
+"description" : "",
+"$ref" : "#/definitions/json_SavedSearchType"
+ },
+ "searchParameters" : {
+"description" : "",
+"$ref" : "#/definitions/json_SearchParameters"
+ }
+ }
+ }
+ ],
+ "example" : {
+ "ownerName" : "...",
+ "name" : "...",
+ "searchType" : "BASIC",
+ "searchParameters" : {
+ "query" : "...",
+ "typeName" : "...",
+ "classification" : "...",
+ "excludeDeletedEntities" : true,
+ "limit" : 12345,
+ "offset" : 12345,
+ "entityFilters" : {
+ "attributeName" : "...",
+ "operator" : "CONTAINS",
+ "attributeValue" : "...",
+ "condition" : "OR",
+ "criterion" : [ { }, { } ]
},
- "endDef2" : {
- "type" : "...",
- "name" : "...",
- "isContainer" : true,
- "cardinality" : "SET",
- "isLegacyAttribute" : true
+ "tagFilters" : {
+ "attributeName" : "...",
+ "operator" : "CONTAINS_ALL",
+ "attributeValue" : "...",
+ "condition" : "AND",
+ "criterion" : [ { }, { } ]
},
- "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" : "PRIMITIVE",
- "guid" : "...",
- "createdBy" : "...",
- "updatedBy" : "...",
- "createTime" : 12345,
- "updateTime" : 12345,
- "version" : 12345,
- "name" : "...",
- "description" : "...",
- "typeVersion" : "...",
- "options" : {
- "property1" : "...",
- "property2" : "..."
- }
- } ],
- "empty" : true
+ "attributes" : [ "...", "..." ]
+ },
+ "guid" : "..."
},
"description" : ""
}
@@ -2257,7 +1871,7 @@
}
}, {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -2294,7 +1908,7 @@
},
"createdEntities" : [ {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -2315,7 +1929,7 @@
} ],
"updatedEntities" : [ {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -2357,7 +1971,7 @@
} ],
"deletedEntities" : [ {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -2367,7 +1981,7 @@
}
}, {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -2455,20 +2069,20 @@
},
"example" : {
"attributeName" : "...",
- "operator" : "EQ",
+ "operator" : "IN",
"attributeValue" : "...",
"condition" : "OR",
"criterion" : [ {
"attributeName" : "...",
- "operator" : "GTE",
+ "operator" : "CONTAINS_ANY",
"attributeValue" : "...",
"condition" : "OR",
"criterion" : [ { }, { } ]
}, {
"attributeName" : "...",
- "operator" : "GT",
+ "operator" : "LTE",
"attributeValue" : "...",
- "condition" : "OR",
+ "condition" : "AND",
"criterion" : [ { }, { } ]
} ]
},
@@ -2520,7 +2134,11 @@
"LIKE",
"STARTS_WITH",
"ENDS_WITH",
- "CONTAINS"
+ "CONTAINS",
+ "CONTAINS_ANY",
+ "CONTAINS_ALL",
+ "IS_NULL",
+ "NOT_NULL"
],
"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"
}
@@ -2562,33 +2180,20 @@
"startIndex" : 12345,
"pageSize" : 12345,
"totalCount" : 12345,
- "sortType" : "DESC",
+ "sortType" : "ASC",
"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.\n<p>\nTags can propagate:\n<p>\nNONE - not at all <br>\nONE_TO_TWO - from end 1 to 2 <br>\nTWO_TO_ONE - from end 2 to 1 <br>\nBOTH - both ways\n<p>\nCare needs to be taken when specifying. The use cases we are aware of where this flag is useful:\n<p>\n- propagating confidentiality classifications from a table to columns - ONE_TO_TWO could be used here <br>\n- propagating classifications around Glossary synonyms - BOTH could be used here.\n<p>\nThere is an expectation that further enhancements will allow more granular control of tag propagation and will\naddress how to resolve conflicts."
- }
- ,
- "json_RelationshipCategory" : {
+ "json_SavedSearchType" : {
"type" : "string",
- "title" : "RelationshipCategory",
+ "title" : "SavedSearchType",
"enum" : [
- "ASSOCIATION",
- "AGGREGATION",
- "COMPOSITION"
+ "BASIC",
+ "ADVANCED"
],
- "description" : "The Relationship category determines the style of relationship around containment and lifecycle.\nUML terminology is used for the values.\n<p>\nASSOCIATION is a relationship with no containment. <br>\nCOMPOSITION and AGGREGATION are containment relationships.\n<p>\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."
+ "description" : ""
}
,
"json_SearchParameters" : {
@@ -2644,16 +2249,16 @@
"offset" : 12345,
"entityFilters" : {
"attributeName" : "...",
- "operator" : "GTE",
+ "operator" : "STARTS_WITH",
"attributeValue" : "...",
- "condition" : "OR",
+ "condition" : "AND",
"criterion" : [ { }, { } ]
},
"tagFilters" : {
"attributeName" : "...",
- "operator" : "NEQ",
+ "operator" : "STARTS_WITH",
"attributeValue" : "...",
- "condition" : "OR",
+ "condition" : "AND",
"criterion" : [ { }, { } ]
},
"attributes" : [ "...", "..." ]
@@ -2682,16 +2287,6 @@
"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" : {
"type" : "string",
"title" : "TypeCategory",
@@ -2709,6 +2304,25 @@
"description" : ""
}
,
+ "xml_ns0_atlasBaseModelObject" : {
+ "type" : "object",
+ "title" : "atlasBaseModelObject",
+ "allOf" : [
+ {
+ "properties" : {
+ "guid" : {
+ "xml" : {
+ "namespace" : ""
+ },
+"description" : "",
+"type" : "string"
+ }
+ }
+ }
+ ],
+ "description" : ""
+ }
+ ,
"xml_ns0_PList" : {
"type" : "object",
"title" : "PList",
@@ -2917,7 +2531,7 @@
},
"examples" : {
"application/json" : {
- "queryType" : "FULL_TEXT",
+ "queryType" : "ATTRIBUTE",
"searchParameters" : {
"query" : "...",
"typeName" : "...",
@@ -2927,14 +2541,14 @@
"offset" : 12345,
"entityFilters" : {
"attributeName" : "...",
- "operator" : "LIKE",
+ "operator" : "NEQ",
"attributeValue" : "...",
- "condition" : "OR",
+ "condition" : "AND",
"criterion" : [ { }, { } ]
},
"tagFilters" : {
"attributeName" : "...",
- "operator" : "LIKE",
+ "operator" : "CONTAINS",
"attributeValue" : "...",
"condition" : "OR",
"criterion" : [ { }, { } ]
@@ -2956,7 +2570,7 @@
}
}, {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -2972,7 +2586,7 @@
"fullTextResult" : [ {
"entity" : {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -2985,7 +2599,7 @@
}, {
"entity" : {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -3010,7 +2624,7 @@
},
"property2" : {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -3029,7 +2643,7 @@
},
"examples" : {
"application/json" : {
- "queryType" : "ATTRIBUTE",
+ "queryType" : "BASIC",
"searchParameters" : {
"query" : "...",
"typeName" : "...",
@@ -3048,7 +2662,7 @@
"attributeName" : "...",
"operator" : "GTE",
"attributeValue" : "...",
- "condition" : "OR",
+ "condition" : "AND",
"criterion" : [ { }, { } ]
},
"attributes" : [ "...", "..." ]
@@ -3058,7 +2672,7 @@
"classification" : "...",
"entities" : [ {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -3084,7 +2698,7 @@
"fullTextResult" : [ {
"entity" : {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -3097,7 +2711,7 @@
}, {
"entity" : {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -3111,7 +2725,7 @@
"referredEntities" : {
"property1" : {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -3195,7 +2809,7 @@
},
"examples" : {
"application/json" : {
- "queryType" : "GREMLIN",
+ "queryType" : "ATTRIBUTE",
"searchParameters" : {
"query" : "...",
"typeName" : "...",
@@ -3205,16 +2819,16 @@
"offset" : 12345,
"entityFilters" : {
"attributeName" : "...",
- "operator" : "CONTAINS",
+ "operator" : "CONTAINS_ALL",
"attributeValue" : "...",
"condition" : "AND",
"criterion" : [ { }, { } ]
},
"tagFilters" : {
"attributeName" : "...",
- "operator" : "ENDS_WITH",
+ "operator" : "CONTAINS",
"attributeValue" : "...",
- "condition" : "AND",
+ "condition" : "OR",
"criterion" : [ { }, { } ]
},
"attributes" : [ "...", "..." ]
@@ -3234,7 +2848,7 @@
}
}, {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -3250,7 +2864,7 @@
"fullTextResult" : [ {
"entity" : {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -3277,7 +2891,7 @@
"referredEntities" : {
"property1" : {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -3307,7 +2921,7 @@
},
"examples" : {
"application/json" : {
- "queryType" : "FULL_TEXT",
+ "queryType" : "ATTRIBUTE",
"searchParameters" : {
"query" : "...",
"typeName" : "...",
@@ -3317,16 +2931,16 @@
"offset" : 12345,
"entityFilters" : {
"attributeName" : "...",
- "operator" : "EQ",
+ "operator" : "CONTAINS_ALL",
"attributeValue" : "...",
"condition" : "AND",
"criterion" : [ { }, { } ]
},
"tagFilters" : {
"attributeName" : "...",
- "operator" : "GT",
+ "operator" : "NOT_NULL",
"attributeValue" : "...",
- "condition" : "OR",
+ "condition" : "AND",
"criterion" : [ { }, { } ]
},
"attributes" : [ "...", "..." ]
@@ -3362,7 +2976,7 @@
"fullTextResult" : [ {
"entity" : {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -3375,7 +2989,7 @@
}, {
"entity" : {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -3389,7 +3003,7 @@
"referredEntities" : {
"property1" : {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -3400,7 +3014,7 @@
},
"property2" : {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -3445,7 +3059,7 @@
},
"examples" : {
"application/json" : {
- "queryType" : "DSL",
+ "queryType" : "GREMLIN",
"searchParameters" : {
"query" : "...",
"typeName" : "...",
@@ -3455,16 +3069,16 @@
"offset" : 12345,
"entityFilters" : {
"attributeName" : "...",
- "operator" : "IN",
+ "operator" : "GTE",
"attributeValue" : "...",
- "condition" : "OR",
+ "condition" : "AND",
"criterion" : [ { }, { } ]
},
"tagFilters" : {
"attributeName" : "...",
- "operator" : "IN",
+ "operator" : "STARTS_WITH",
"attributeValue" : "...",
- "condition" : "AND",
+ "condition" : "OR",
"criterion" : [ { }, { } ]
},
"attributes" : [ "...", "..." ]
@@ -3484,7 +3098,7 @@
}
}, {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -3500,7 +3114,7 @@
"fullTextResult" : [ {
"entity" : {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -3513,7 +3127,7 @@
}, {
"entity" : {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -3527,7 +3141,7 @@
"referredEntities" : {
"property1" : {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -3557,7 +3171,7 @@
},
"examples" : {
"application/json" : {
- "queryType" : "RELATIONSHIP",
+ "queryType" : "FULL_TEXT",
"searchParameters" : {
"query" : "...",
"typeName" : "...",
@@ -3567,16 +3181,16 @@
"offset" : 12345,
"entityFilters" : {
"attributeName" : "...",
- "operator" : "EQ",
+ "operator" : "CONTAINS_ALL",
"attributeValue" : "...",
"condition" : "AND",
"criterion" : [ { }, { } ]
},
"tagFilters" : {
"attributeName" : "...",
- "operator" : "CONTAINS",
+ "operator" : "CONTAINS_ALL",
"attributeValue" : "...",
- "condition" : "OR",
+ "condition" : "AND",
"criterion" : [ { }, { } ]
},
"attributes" : [ "...", "..." ]
@@ -3639,7 +3253,7 @@
"referredEntities" : {
"property1" : {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -3650,7 +3264,7 @@
},
"property2" : {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -3717,7 +3331,7 @@
},
"examples" : {
"application/json" : {
- "queryType" : "RELATIONSHIP",
+ "queryType" : "ATTRIBUTE",
"searchParameters" : {
"query" : "...",
"typeName" : "...",
@@ -3727,14 +3341,14 @@
"offset" : 12345,
"entityFilters" : {
"attributeName" : "...",
- "operator" : "NEQ",
+ "operator" : "IN",
"attributeValue" : "...",
"condition" : "OR",
"criterion" : [ { }, { } ]
},
"tagFilters" : {
"attributeName" : "...",
- "operator" : "EQ",
+ "operator" : "CONTAINS",
"attributeValue" : "...",
"condition" : "OR",
"criterion" : [ { }, { } ]
@@ -3746,7 +3360,7 @@
"classification" : "...",
"entities" : [ {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -3772,7 +3386,7 @@
"fullTextResult" : [ {
"entity" : {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -3829,7 +3443,7 @@
},
"examples" : {
"application/json" : {
- "queryType" : "BASIC",
+ "queryType" : "RELATIONSHIP",
"searchParameters" : {
"query" : "...",
"typeName" : "...",
@@ -3839,14 +3453,14 @@
"offset" : 12345,
"entityFilters" : {
"attributeName" : "...",
- "operator" : "STARTS_WITH",
+ "operator" : "GT",
"attributeValue" : "...",
- "condition" : "OR",
+ "condition" : "AND",
"criterion" : [ { }, { } ]
},
"tagFilters" : {
"attributeName" : "...",
- "operator" : "LIKE",
+ "operator" : "LT",
"attributeValue" : "...",
"condition" : "AND",
"criterion" : [ { }, { } ]
@@ -3911,7 +3525,7 @@
"referredEntities" : {
"property1" : {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -3983,7 +3597,7 @@
},
"examples" : {
"application/json" : {
- "queryType" : "BASIC",
+ "queryType" : "ATTRIBUTE",
"searchParameters" : {
"query" : "...",
"typeName" : "...",
@@ -3993,16 +3607,16 @@
"offset" : 12345,
"entityFilters" : {
"attributeName" : "...",
- "operator" : "EQ",
+ "operator" : "ENDS_WITH",
"attributeValue" : "...",
- "condition" : "AND",
+ "condition" : "OR",
"criterion" : [ { }, { } ]
},
"tagFilters" : {
"attributeName" : "...",
- "operator" : "NEQ",
+ "operator" : "GT",
"attributeValue" : "...",
- "condition" : "OR",
+ "condition" : "AND",
"criterion" : [ { }, { } ]
},
"attributes" : [ "...", "..." ]
@@ -4022,7 +3636,7 @@
}
}, {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -4065,7 +3679,7 @@
"referredEntities" : {
"property1" : {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -4095,7 +3709,7 @@
},
"examples" : {
"application/json" : {
- "queryType" : "BASIC",
+ "queryType" : "FULL_TEXT",
"searchParameters" : {
"query" : "...",
"typeName" : "...",
@@ -4105,14 +3719,14 @@
"offset" : 12345,
"entityFilters" : {
"attributeName" : "...",
- "operator" : "ENDS_WITH",
+ "operator" : "STARTS_WITH",
"attributeValue" : "...",
"condition" : "OR",
"criterion" : [ { }, { } ]
},
"tagFilters" : {
"attributeName" : "...",
- "operator" : "GTE",
+ "operator" : "CONTAINS_ANY",
"attributeValue" : "...",
"condition" : "OR",
"criterion" : [ { }, { } ]
@@ -4134,7 +3748,7 @@
}
}, {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -4150,7 +3764,7 @@
"fullTextResult" : [ {
"entity" : {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -4163,7 +3777,7 @@
}, {
"entity" : {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -4285,7 +3899,7 @@
},
"tagFilters" : {
"attributeName" : "...",
- "operator" : "LIKE",
+ "operator" : "NOT_NULL",
"attributeValue" : "...",
"condition" : "OR",
"criterion" : [ { }, { } ]
@@ -4336,7 +3950,7 @@
}, {
"entity" : {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -4361,7 +3975,7 @@
},
"property2" : {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -4380,7 +3994,7 @@
},
"examples" : {
"application/json" : {
- "queryType" : "ATTRIBUTE",
+ "queryType" : "RELATIONSHIP",
"searchParameters" : {
"query" : "...",
"typeName" : "...",
@@ -4390,14 +4004,14 @@
"offset" : 12345,
"entityFilters" : {
"attributeName" : "...",
- "operator" : "ENDS_WITH",
+ "operator" : "NEQ",
"attributeValue" : "...",
- "condition" : "AND",
+ "condition" : "OR",
"criterion" : [ { }, { } ]
},
"tagFilters" : {
"attributeName" : "...",
- "operator" : "LT",
+ "operator" : "CONTAINS",
"attributeValue" : "...",
"condition" : "OR",
"criterion" : [ { }, { } ]
@@ -4409,7 +4023,7 @@
"classification" : "...",
"entities" : [ {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -4419,7 +4033,7 @@
}
}, {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -4435,7 +4049,7 @@
"fullTextResult" : [ {
"entity" : {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -4462,7 +4076,7 @@
"referredEntities" : {
"property1" : {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -4491,12 +4105,71 @@
}
}
,
- "\/v2/entity" : {
+ "\/v2/search/saved" : {
+ "get" : {
+ "tags" : [ "DiscoveryREST" ],
+ "description" : "",
+ "operationId" : "resource_DiscoveryREST_getSavedSearches_GET",
+ "produces" : [ "application/json;charset=UTF-8" ],
+ "parameters" : [
+ {
+ "name" : "user",
+ "in" : "query",
+ "type" : "string",
+ "description" : "User for whom the search is retrieved"
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "schema" : {
+"description" : "",
+"type" : "array",
+"items" : {
+ "$ref" : "#/definitions/json_AtlasUserSavedSearch"
+}
+ },
+ "headers" : {
+ },
+ "examples" : {
+ "application/json" : {
+ "ownerName" : "...",
+ "name" : "...",
+ "searchType" : "ADVANCED",
+ "searchParameters" : {
+ "query" : "...",
+ "typeName" : "...",
+ "classification" : "...",
+ "excludeDeletedEntities" : true,
+ "limit" : 12345,
+ "offset" : 12345,
+ "entityFilters" : {
+ "attributeName" : "...",
+ "operator" : "GT",
+ "attributeValue" : "...",
+ "condition" : "AND",
+ "criterion" : [ { }, { } ]
+ },
+ "tagFilters" : {
+ "attributeName" : "...",
+ "operator" : "ENDS_WITH",
+ "attributeValue" : "...",
+ "condition" : "AND",
+ "criterion" : [ { }, { } ]
+ },
+ "attributes" : [ "...", "..." ]
+ },
+ "guid" : "..."
+}
+ },
+ "description" : "Success"
+ }
+ }
+ }
+ ,
"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",
+ "tags" : [ "DiscoveryREST" ],
+ "description" : "",
+ "operationId" : "resource_DiscoveryREST_addSavedSearch_POST",
"consumes" : [ "application/json;charset=UTF-8" ],
"produces" : [ "application/json;charset=UTF-8" ],
"parameters" : [
@@ -4505,7 +4178,7 @@
"in" : "body",
"schema" : {
"description" : "",
-"$ref" : "#/definitions/json_AtlasEntityWithExtInfo"
+"$ref" : "#/definitions/json_AtlasUserSavedSearch"
},
"description" : ""
}
@@ -4514,177 +4187,192 @@
"201" : {
"schema" : {
"description" : "",
-"$ref" : "#/definitions/json_EntityMutationResponse"
+"$ref" : "#/definitions/json_AtlasUserSavedSearch"
},
"headers" : {
},
"examples" : {
"application/json" : {
- "mutatedEntities" : {
- "property1" : [ {
- "guid" : "...",
- "status" : "ACTIVE",
- "displayText" : "...",
- "classificationNames" : [ "...", "..." ],
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- }, {
- "guid" : "...",
- "status" : "ACTIVE",
- "displayText" : "...",
- "classificationNames" : [ "...", "..." ],
- "typeName" : "...",
- "attributes" : {
- "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" : [ "...", "..." ],
+ "ownerName" : "...",
+ "name" : "...",
+ "searchType" : "BASIC",
+ "searchParameters" : {
+ "query" : "...",
"typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- }, {
- "guid" : "...",
- "status" : "DELETED",
- "displayText" : "...",
- "classificationNames" : [ "...", "..." ],
+ "classification" : "...",
+ "excludeDeletedEntities" : true,
+ "limit" : 12345,
+ "offset" : 12345,
+ "entityFilters" : {
+ "attributeName" : "...",
+ "operator" : "GTE",
+ "attributeValue" : "...",
+ "condition" : "AND",
+ "criterion" : [ { }, { } ]
+ },
+ "tagFilters" : {
+ "attributeName" : "...",
+ "operator" : "IN",
+ "attributeValue" : "...",
+ "condition" : "OR",
+ "criterion" : [ { }, { } ]
+ },
+ "attributes" : [ "...", "..." ]
+ },
+ "guid" : "..."
+}
+ },
+ "description" : "Success"
+ }
+ }
+ }
+ ,
+ "put" : {
+ "tags" : [ "DiscoveryREST" ],
+ "description" : "",
+ "operationId" : "resource_DiscoveryREST_updateSavedSearch_PUT",
+ "consumes" : [ "application/json;charset=UTF-8" ],
+ "produces" : [ "application/json;charset=UTF-8" ],
+ "parameters" : [
+ {
+ "name" : "body",
+ "in" : "body",
+ "schema" : {
+"description" : "",
+"$ref" : "#/definitions/json_AtlasUserSavedSearch"
+ },
+ "description" : ""
+ }
+ ],
+ "responses" : {
+ "204" : {
+ "schema" : {
+"description" : "",
+"$ref" : "#/definitions/json_AtlasUserSavedSearch"
+ },
+ "headers" : {
+ },
+ "examples" : {
+ "application/json" : {
+ "ownerName" : "...",
+ "name" : "...",
+ "searchType" : "BASIC",
+ "searchParameters" : {
+ "query" : "...",
"typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
+ "classification" : "...",
+ "excludeDeletedEntities" : true,
+ "limit" : 12345,
+ "offset" : 12345,
+ "entityFilters" : {
+ "attributeName" : "...",
+ "operator" : "NEQ",
+ "attributeValue" : "...",
+ "condition" : "AND",
+ "criterion" : [ { }, { } ]
+ },
+ "tagFilters" : {
+ "attributeName" : "...",
+ "operator" : "CONTAINS_ANY",
+ "attributeValue" : "...",
+ "condition" : "OR",
+ "criterion" : [ { }, { } ]
+ },
+ "attributes" : [ "...", "..." ]
+ },
+ "guid" : "..."
+}
+ },
+ "description" : "Success"
+ }
+ }
+ }
}
- } ],
- "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" : "DELETED",
- "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" : "DELETED",
- "displayText" : "...",
- "classificationNames" : [ "...", "..." ],
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
+ ,
+ "\/v2/search/saved/{guid}" : {
+ "delete" : {
+ "tags" : [ "DiscoveryREST" ],
+ "description" : "",
+ "operationId" : "resource_DiscoveryREST_deleteSavedSearch_DELETE",
+ "parameters" : [
+ {
+ "name" : "guid",
+ "in" : "path",
+ "required" : true,
+ "type" : "string",
+ "description" : "Name of the saved search"
+ }
+ ],
+ "responses" : {
+ "204" : {
+ "headers" : {
+ },
+ "examples" : {
+ },
+ "description" : "Success"
+ }
+ }
+ }
}
- },
- "firstEntityUpdated" : {
- "guid" : "...",
- "status" : "ACTIVE",
- "displayText" : "...",
- "classificationNames" : [ "...", "..." ],
+ ,
+ "\/v2/search/saved/{name}" : {
+ "get" : {
+ "tags" : [ "DiscoveryREST" ],
+ "description" : "",
+ "operationId" : "resource_DiscoveryREST_getSavedSearch_GET",
+ "produces" : [ "application/json;charset=UTF-8" ],
+ "parameters" : [
+ {
+ "name" : "name",
+ "in" : "path",
+ "required" : true,
+ "type" : "string",
+ "description" : "Name of the saved search"
+ },
+ {
+ "name" : "user",
+ "in" : "query",
+ "type" : "string",
+ "description" : "User for whom the search is retrieved"
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "schema" : {
+"description" : "",
+"$ref" : "#/definitions/json_AtlasUserSavedSearch"
+ },
+ "headers" : {
+ },
+ "examples" : {
+ "application/json" : {
+ "ownerName" : "...",
+ "name" : "...",
+ "searchType" : "ADVANCED",
+ "searchParameters" : {
+ "query" : "...",
"typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
+ "classification" : "...",
+ "excludeDeletedEntities" : true,
+ "limit" : 12345,
+ "offset" : 12345,
+ "entityFilters" : {
+ "attributeName" : "...",
+ "operator" : "CONTAINS_ALL",
+ "attributeValue" : "...",
+ "condition" : "AND",
+ "criterion" : [ { }, { } ]
+ },
+ "tagFilters" : {
+ "attributeName" : "...",
+ "operator" : "GTE",
+ "attributeValue" : "...",
+ "condition" : "OR",
+ "criterion" : [ { }, { } ]
+ },
+ "attributes" : [ "...", "..." ]
},
- "firstEntityPartialUpdated" : {
- "guid" : "...",
- "status" : "DELETED",
- "displayText" : "...",
- "classificationNames" : [ "...", "..." ],
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- }
+ "guid" : "..."
}
},
"description" : "Success"
@@ -4693,149 +4381,68 @@
}
}
,
- "\/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/saved/execute/{name}" : {
+ "get" : {
+ "tags" : [ "DiscoveryREST" ],
+ "summary" : "Attribute based search for entities satisfying the search parameters.",
+ "description" : "Attribute based search for entities satisfying the search parameters",
+ "operationId" : "resource_DiscoveryREST_executeSavedSearchByName_GET",
"produces" : [ "application/json;charset=UTF-8" ],
"parameters" : [
{
- "name" : "guid",
+ "name" : "name",
+ "in" : "path",
+ "required" : true,
+ "type" : "string",
+ "description" : "name of saved-search"
+ },
+ {
+ "name" : "user",
"in" : "query",
- "type" : "array",
- "items" : {
- "type" : "string"
- },
- "collectionFormat" : "multi",
- "description" : ""
+ "type" : "string",
+ "description" : "saved-search owner"
}
],
"responses" : {
- "204" : {
+ "200" : {
"schema" : {
"description" : "",
-"$ref" : "#/definitions/json_EntityMutationResponse"
+"$ref" : "#/definitions/json_AtlasSearchResult"
},
"headers" : {
},
"examples" : {
"application/json" : {
- "mutatedEntities" : {
- "property1" : [ {
- "guid" : "...",
- "status" : "ACTIVE",
- "displayText" : "...",
- "classificationNames" : [ "...", "..." ],
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- }, {
- "guid" : "...",
- "status" : "DELETED",
- "displayText" : "...",
- "classificationNames" : [ "...", "..." ],
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- } ],
- "property2" : [ {
- "guid" : "...",
- "status" : "ACTIVE",
- "displayText" : "...",
- "classificationNames" : [ "...", "..." ],
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- }, {
- "guid" : "...",
- "status" : "DELETED",
- "displayText" : "...",
- "classificationNames" : [ "...", "..." ],
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- } ]
- },
- "guidAssignments" : {
- "property1" : "...",
- "property2" : "..."
- },
- "createdEntities" : [ {
- "guid" : "...",
- "status" : "DELETED",
- "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" : "DELETED",
- "displayText" : "...",
- "classificationNames" : [ "...", "..." ],
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- } ],
- "partialUpdatedEntities" : [ {
- "guid" : "...",
- "status" : "ACTIVE",
- "displayText" : "...",
- "classificationNames" : [ "...", "..." ],
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- }, {
- "guid" : "...",
- "status" : "DELETED",
- "displayText" : "...",
- "classificationNames" : [ "...", "..." ],
+ "queryType" : "FULL_TEXT",
+ "searchParameters" : {
+ "query" : "...",
"typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- } ],
- "deletedEntities" : [ {
+ "classification" : "...",
+ "excludeDeletedEntities" : true,
+ "limit" : 12345,
+ "offset" : 12345,
+ "entityFilters" : {
+ "attributeName" : "...",
+ "operator" : "GTE",
+ "attributeValue" : "...",
+ "condition" : "OR",
+ "criterion" : [ { }, { } ]
+ },
+ "tagFilters" : {
+ "attributeName" : "...",
+ "operator" : "CONTAINS_ANY",
+ "attributeValue" : "...",
+ "condition" : "AND",
+ "criterion" : [ { }, { } ]
+ },
+ "attributes" : [ "...", "..." ]
+ },
+ "queryText" : "...",
+ "type" : "...",
+ "classification" : "...",
+ "entities" : [ {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -4854,37 +4461,59 @@
"property2" : { }
}
} ],
- "firstEntityCreated" : {
- "guid" : "...",
- "status" : "ACTIVE",
- "displayText" : "...",
- "classificationNames" : [ "...", "..." ],
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- },
- "firstEntityUpdated" : {
- "guid" : "...",
- "status" : "ACTIVE",
- "displayText" : "...",
- "classificationNames" : [ "...", "..." ],
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
+ "attributes" : {
+ "name" : [ "...", "..." ],
+ "values" : [ ]
},
- "firstEntityPartialUpdated" : {
- "guid" : "...",
- "status" : "DELETED",
- "displayText" : "...",
- "classificationNames" : [ "...", "..." ],
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
+ "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
+ } ],
+ "referredEntities" : {
+ "property1" : {
+ "guid" : "...",
+ "status" : "DELETED",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ },
+ "property2" : {
+ "guid" : "...",
+ "status" : "ACTIVE",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
}
}
}
@@ -4893,60 +4522,66 @@
}
}
}
- ,
+ }
+ ,
+ "\/v2/search/saved/execute/guid/{guid}" : {
"get" : {
- "tags" : [ "EntityREST" ],
- "summary" : "Bulk API to retrieve list of entities identified by its GUIDs.",
- "description" : "Bulk API to retrieve list of entities identified by its GUIDs.",
- "operationId" : "resource_EntityREST_getByGuids_GET",
+ "tags" : [ "DiscoveryREST" ],
+ "summary" : "Attribute based search for entities satisfying the search parameters.",
+ "description" : "Attribute based search for entities satisfying the search parameters",
+ "operationId" : "resource_DiscoveryREST_executeSavedSearchByGuid_GET",
"produces" : [ "application/json;charset=UTF-8" ],
"parameters" : [
{
"name" : "guid",
- "in" : "query",
- "type" : "array",
- "items" : {
- "type" : "string"
- },
- "collectionFormat" : "multi",
- "description" : ""
+ "in" : "path",
+ "required" : true,
+ "type" : "string",
+ "description" : "Guid identifying saved search"
}
],
"responses" : {
"200" : {
"schema" : {
"description" : "",
-"$ref" : "#/definitions/json_AtlasEntitiesWithExtInfo"
+"$ref" : "#/definitions/json_AtlasSearchResult"
},
"headers" : {
},
"examples" : {
"application/json" : {
+ "queryType" : "GREMLIN",
+ "searchParameters" : {
+ "query" : "...",
+ "typeName" : "...",
+ "classification" : "...",
+ "excludeDeletedEntities" : true,
+ "limit" : 12345,
+ "offset" : 12345,
+ "entityFilters" : {
+ "attributeName" : "...",
+ "operator" : "GTE",
+ "attributeValue" : "...",
+ "condition" : "AND",
+ "criterion" : [ { }, { } ]
+ },
+ "tagFilters" : {
+ "attributeName" : "...",
+ "operator" : "LT",
+ "attributeValue" : "...",
+ "condition" : "AND",
+ "criterion" : [ { }, { } ]
+ },
+ "attributes" : [ "...", "..." ]
+ },
+ "queryText" : "...",
+ "type" : "...",
+ "classification" : "...",
"entities" : [ {
"guid" : "...",
"status" : "ACTIVE",
- "createdBy" : "...",
- "updatedBy" : "...",
- "createTime" : 12345,
- "updateTime" : 12345,
- "version" : 12345,
- "relationshipAttributes" : {
- "property1" : { },
- "property2" : { }
- },
- "classifications" : [ {
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- }, {
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- } ],
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
"typeName" : "...",
"attributes" : {
"property1" : { },
@@ -4955,60 +4590,51 @@
}, {
"guid" : "...",
"status" : "DELETED",
- "createdBy" : "...",
- "updatedBy" : "...",
- "createTime" : 12345,
- "updateTime" : 12345,
- "version" : 12345,
- "relationshipAttributes" : {
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "typeName" : "...",
+ "attributes" : {
"property1" : { },
"property2" : { }
- },
- "classifications" : [ {
+ }
+ } ],
+ "attributes" : {
+ "name" : [ "...", "..." ],
+ "values" : [ ]
+ },
+ "fullTextResult" : [ {
+ "entity" : {
+ "guid" : "...",
+ "status" : "ACTIVE",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
"typeName" : "...",
"attributes" : {
"property1" : { },
"property2" : { }
}
- }, {
+ },
+ "score" : 12345.0
+ }, {
+ "entity" : {
+ "guid" : "...",
+ "status" : "ACTIVE",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
"typeName" : "...",
"attributes" : {
"property1" : { },
"property2" : { }
}
- } ],
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
+ },
+ "score" : 12345.0
} ],
"referredEntities" : {
"property1" : {
"guid" : "...",
- "status" : "DELETED",
- "createdBy" : "...",
- "updatedBy" : "...",
- "createTime" : 12345,
- "updateTime" : 12345,
- "version" : 12345,
- "relationshipAttributes" : {
- "property1" : { },
- "property2" : { }
- },
- "classifications" : [ {
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- }, {
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- } ],
+ "status" : "ACTIVE",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
"typeName" : "...",
"attributes" : {
"property1" : { },
@@ -5017,29 +4643,9 @@
},
"property2" : {
"guid" : "...",
- "status" : "DELETED",
- "createdBy" : "...",
- "updatedBy" : "...",
- "createTime" : 12345,
- "updateTime" : 12345,
- "version" : 12345,
- "relationshipAttributes" : {
- "property1" : { },
- "property2" : { }
- },
- "classifications" : [ {
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- }, {
- "typeName" : "...",
- "attributes" : {
- "property1" : { },
- "property2" : { }
- }
- } ],
+ "status" : "ACTIVE",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
"typeName" : "...",
"attributes" : {
"property1" : { },
@@ -5053,11 +4659,13 @@
}
}
}
- ,
+ }
+ ,
+ "\/v2/entity" : {
"post" : {
"tags" : [ "EntityREST" ],
- "summary" : "Bulk API to create new entities or update existing entities in Atlas.",
- "description" : "Bulk API to create new entities or update existing entities in Atlas.\nExisting entity is matched using its unique guid if supplied or by its unique attributes eg: qualifiedName",
+ "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" ],
@@ -5067,7 +4675,7 @@
"in" : "body",
"schema" : {
"description" : "",
-"$ref" : "#/definitions/json_AtlasEntitiesWithExtInfo"
+"$ref" : "#/definitions/json_AtlasEntityWithExtInfo"
},
"description" : ""
}
@@ -5106,7 +4714,7 @@
} ],
"property2" : [ {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -5132,7 +4740,7 @@
},
"createdEntities" : [ {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -5153,7 +4761,7 @@
} ],
"updatedEntities" : [ {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -5205,7 +4813,7 @@
}
}, {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -5216,7 +4824,7 @@
} ],
"firstEntityCreated" : {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -5227,7 +4835,7 @@
},
"firstEntityUpdated" : {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -5255,50 +4863,23 @@
}
}
,
- "\/v2/entity/bulk/classification" : {
- "post" : {
- "tags" : [ "EntityREST" ],
- "summary" : "Bulk API to associate a tag to multiple entities.",
- "description" : "Bulk API to associate a tag to multiple entities",
- "operationId" : "resource_EntityREST_addClassification_POST",
- "consumes" : [ "application/json;charset=UTF-8" ],
- "parameters" : [
- {
- "name" : "body",
- "in" : "body",
- "schema" : {
-"description" : "",
-"$ref" : "#/definitions/json_ClassificationAssociateRequest"
- },
- "description" : ""
- }
- ],
- "responses" : {
- "201" : {
- "headers" : {
- },
- "examples" : {
- },
- "description" : "Success"
- }
- }
- }
- }
- ,
- "\/v2/entity/guid/{guid}" : {
+ "\/v2/entity/bulk" : {
"delete" : {
"tags" : [ "EntityREST" ],
- "summary" : "Delete an entity identified by its GUID.",
- "description" : "Delete an entity identified by its GUID.",
- "operationId" : "resource_EntityREST_deleteByGuid_DELETE",
+ "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",
"produces" : [ "application/json;charset=UTF-8" ],
"parameters" : [
{
"name" : "guid",
- "in" : "path",
- "required" : true,
- "type" : "string",
- "description" : "GUID for the entity"
+ "in" : "query",
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ },
+ "collectionFormat" : "multi",
+ "description" : ""
}
],
"responses" : {
@@ -5314,7 +4895,7 @@
"mutatedEntities" : {
"property1" : [ {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -5335,7 +4916,7 @@
} ],
"property2" : [ {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -5345,7 +4926,7 @@
}
}, {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -5371,7 +4952,7 @@
}
}, {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -5392,7 +4973,7 @@
}
}, {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -5434,7 +5015,7 @@
}
}, {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -5456,7 +5037,7 @@
},
"firstEntityUpdated" : {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -5485,30 +5066,33 @@
,
"get" : {
"tags" : [ "EntityREST" ],
- "summary" : "Fetch complete definition of an entity given its GUID.",
- "description" : "Fetch complete definition of an entity given its GUID.",
- "operationId" : "resource_EntityREST_getById_GET",
+ "summary" : "Bulk API to retrieve list of entities identified by its GUIDs.",
+ "description" : "Bulk API to retrieve list of entities identified by its GUIDs.",
+ "operationId" : "resource_EntityREST_getByGuids_GET",
"produces" : [ "application/json;charset=UTF-8" ],
"parameters" : [
{
"name" : "guid",
- "in" : "path",
- "required" : true,
- "type" : "string",
- "description" : "GUID for the entity"
+ "in" : "query",
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ },
+ "collectionFormat" : "multi",
+ "description" : ""
}
],
"responses" : {
"200" : {
"schema" : {
"description" : "",
-"$ref" : "#/definitions/json_AtlasEntityWithExtInfo"
+"$ref" : "#/definitions/json_AtlasEntitiesWithExtInfo"
},
"headers" : {
},
"examples" : {
"application/json" : {
- "entity" : {
+ "entities" : [ {
"guid" : "...",
"status" : "DELETED",
"createdBy" : "...",
@@ -5516,10 +5100,32 @@
"createTime" : 12345,
"updateTime" : 12345,
"version" : 12345,
- "relationshipAttributes" : {
+ "classifications" : [ {
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ }, {
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ } ],
+ "typeName" : "...",
+ "attributes" : {
"property1" : { },
"property2" : { }
- },
+ }
+ }, {
+ "guid" : "...",
+ "status" : "ACTIVE",
+ "createdBy" : "...",
+ "updatedBy" : "...",
+ "createTime" : 12345,
+ "updateTime" : 12345,
+ "version" : 12345,
"classifications" : [ {
"typeName" : "...",
"attributes" : {
@@ -5538,20 +5144,16 @@
"property1" : { },
"property2" : { }
}
- },
+ } ],
"referredEntities" : {
"property1" : {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"createdBy" : "...",
"updatedBy" : "...",
"createTime" : 12345,
"updateTime" : 12345,
"version" : 12345,
- "relationshipAttributes" : {
- "property1" : { },
- "property2" : { }
- },
"classifications" : [ {
"typeName" : "...",
"attributes" : {
@@ -5579,10 +5181,6 @@
"createTime" : 12345,
"updateTime" : 12345,
"version" : 12345,
- "relationshipAttributes" : {
- "property1" : { },
- "property2" : { }
- },
"classifications" : [ {
"typeName" : "...",
"attributes" : {
@@ -5610,39 +5208,26 @@
}
}
,
- "put" : {
+ "post" : {
"tags" : [ "EntityREST" ],
- "summary" : "Entity Partial Update - Add/Update entity attribute identified by its GUID.",
- "description" : "Entity Partial Update - Add/Update entity attribute identified by its GUID.\nSupports only uprimitive attribute type and entity references.\ndoes not support updation of complex types like arrays, maps\nNull updates are not possible",
- "operationId" : "resource_EntityREST_partialUpdateEntityAttrByGuid_PUT",
+ "summary" : "Bulk API to create new entities or update existing entities in Atlas.",
+ "description" : "Bulk API to create new entities or update existing entities 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" :
<TRUNCATED>