You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@atlas.apache.org by ma...@apache.org on 2017/03/17 06:00:07 UTC
[04/38] incubator-atlas-website git commit: added documentation to
0.8-incubating release folder
http://git-wip-us.apache.org/repos/asf/incubator-atlas-website/blob/b4557f9c/api/v2/ui/swagger.json
----------------------------------------------------------------------
diff --git a/api/v2/ui/swagger.json b/api/v2/ui/swagger.json
index bd68433..901b864 100644
--- a/api/v2/ui/swagger.json
+++ b/api/v2/ui/swagger.json
@@ -6,9 +6,11 @@
"url" : "http://www.apache.org/licenses/LICENSE-2.0.txt",
"name" : "The Apache Software License, Version 2.0"
},
- "version" : "0.8-incubating-SNAPSHOT",
+ "version" : "0.9-incubating-SNAPSHOT",
"title" : "Atlas REST API"
},
+ "host" : "localhost:21000",
+ "basePath" : "/api/atlas/",
"schemes" : [],
"tags" : [
{
@@ -84,7 +86,7 @@
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "SINGLE",
+ "cardinality" : "LIST",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
@@ -103,7 +105,7 @@
}
} ]
},
- "description" : "class that captures details of a struct-attribute."
+ "description" : "Details of a struct-attribute."
}
,
"json_AtlasBaseTypeDef" : {
@@ -174,7 +176,7 @@
"property2" : "..."
}
},
- "description" : "Base class that captures common-attributes for all Atlas types."
+ "description" : "Common-attributes for all Atlas types."
}
,
"json_AtlasClassification" : {
@@ -222,7 +224,7 @@
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "LIST",
+ "cardinality" : "SET",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
@@ -263,7 +265,7 @@
}
} ]
} ],
- "category" : "CLASSIFICATION",
+ "category" : "ARRAY",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -278,7 +280,7 @@
"property2" : "..."
}
},
- "description" : "class that captures details of a classification-type."
+ "description" : "Details of a classification-type."
}
,
"json_AtlasClassifications" : {
@@ -325,7 +327,7 @@
"property2" : { }
}
},
- "description" : "class that captures details of a constraint."
+ "description" : "Details of a constraint."
}
,
"json_AtlasEntitiesWithExtInfo" : {
@@ -458,7 +460,7 @@
}
}
},
- "description" : "An instance of an entity along with extended info - like hive_table, hive_database."
+ "description" : "List of Atlas entity along with the referred entities"
}
,
"json_AtlasEntity" : {
@@ -535,7 +537,7 @@
"property2" : { }
}
},
- "description" : "An instance of an entity - like hive_table, hive_database."
+ "description" : "Atlas entity representation"
}
,
"json_AtlasEntityDef" : {
@@ -563,7 +565,7 @@
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "LIST",
+ "cardinality" : "SINGLE",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
@@ -619,7 +621,7 @@
"property2" : "..."
}
},
- "description" : "class that captures details of a entity-type."
+ "description" : "Details of an entity-type."
}
,
"json_AtlasEntityExtInfo" : {
@@ -638,7 +640,7 @@
"referredEntities" : {
"property1" : {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"createdBy" : "...",
"updatedBy" : "...",
"createTime" : 12345,
@@ -665,7 +667,7 @@
},
"property2" : {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"createdBy" : "...",
"updatedBy" : "...",
"createTime" : 12345,
@@ -692,7 +694,7 @@
}
}
},
- "description" : "An instance of an entity along with extended info - like hive_table, hive_database."
+ "description" : "Entity representation along with extended info which included the entities being referred to"
}
,
"json_AtlasEntityHeader" : {
@@ -787,7 +789,7 @@
"referredEntities" : {
"property1" : {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"createdBy" : "...",
"updatedBy" : "...",
"createTime" : 12345,
@@ -814,7 +816,7 @@
},
"property2" : {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"createdBy" : "...",
"updatedBy" : "...",
"createTime" : 12345,
@@ -841,7 +843,7 @@
}
}
},
- "description" : "An instance of an entity along with extended info - like hive_table, hive_database."
+ "description" : "Entity with information about the referred entities"
}
,
"json_AtlasEnumDef" : {
@@ -878,7 +880,7 @@
"ordinal" : 12345
} ],
"defaultValue" : "...",
- "category" : "STRUCT",
+ "category" : "ENTITY",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -893,7 +895,7 @@
"property2" : "..."
}
},
- "description" : "class that captures details of an enum-type."
+ "description" : "Details of an enum-type."
}
,
"json_AtlasEnumElementDef" : {
@@ -918,7 +920,7 @@
"description" : "...",
"ordinal" : 12345
},
- "description" : "class that captures details of an enum-element."
+ "description" : "Details of an enum-element."
}
,
"json_AtlasFullTextResult" : {
@@ -937,7 +939,7 @@
"example" : {
"entity" : {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -948,7 +950,7 @@
},
"score" : 12345.0
},
- "description" : ""
+ "description" : "Search results for FullText APIs"
}
,
"json_AtlasLineageInfo" : {
@@ -998,7 +1000,7 @@
},
"property2" : {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -1015,10 +1017,10 @@
"fromEntityId" : "...",
"toEntityId" : "..."
} ],
- "lineageDirection" : "INPUT",
+ "lineageDirection" : "OUTPUT",
"lineageDepth" : 12345
},
- "description" : ""
+ "description" : "Lineage information for a single entity"
}
,
"json_AtlasQueryType" : {
@@ -1027,22 +1029,31 @@
"enum" : [
"DSL",
"FULL_TEXT",
- "GREMLIN"
+ "GREMLIN",
+ "BASIC"
],
- "description" : ""
+ "description" : "Various querying mechanisms supported by Atlas"
}
,
"json_AtlasSearchResult" : {
"type" : "object",
"title" : "AtlasSearchResult",
"properties" : {
+ "queryType" : {
+"description" : "",
+"$ref" : "#/definitions/json_AtlasQueryType"
+ },
"queryText" : {
"description" : "",
"type" : "string"
},
- "queryType" : {
+ "type" : {
"description" : "",
-"$ref" : "#/definitions/json_AtlasQueryType"
+"type" : "string"
+ },
+ "classification" : {
+"description" : "",
+"type" : "string"
},
"entities" : {
"description" : "",
@@ -1064,8 +1075,10 @@
}
},
"example" : {
- "queryText" : "...",
"queryType" : "DSL",
+ "queryText" : "...",
+ "type" : "...",
+ "classification" : "...",
"entities" : [ {
"guid" : "...",
"status" : "ACTIVE",
@@ -1078,7 +1091,7 @@
}
}, {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -1094,7 +1107,7 @@
"fullTextResult" : [ {
"entity" : {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -1119,7 +1132,7 @@
"score" : 12345.0
} ]
},
- "description" : ""
+ "description" : "Search results of the Discovery APIs"
}
,
"json_AtlasStruct" : {
@@ -1145,7 +1158,7 @@
"property2" : { }
}
},
- "description" : "Captures details of struct contents. Not instantiated directly, used only via AtlasEntity, AtlasClassification."
+ "description" : "Details of a struct. Not instantiated directly, used only via AtlasEntity, AtlasClassification."
}
,
"json_AtlasStructDef" : {
@@ -1213,7 +1226,7 @@
}
} ]
} ],
- "category" : "MAP",
+ "category" : "STRUCT",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -1228,7 +1241,7 @@
"property2" : "..."
}
},
- "description" : "class that captures details of a struct-type."
+ "description" : "Details of a struct-type."
}
,
"json_AtlasTypeDefHeader" : {
@@ -1251,9 +1264,9 @@
"example" : {
"guid" : "...",
"name" : "...",
- "category" : "MAP"
+ "category" : "ARRAY"
},
- "description" : ""
+ "description" : "Minimal set of information about a type definition"
}
,
"json_AtlasTypesDef" : {
@@ -1305,7 +1318,7 @@
"ordinal" : 12345
} ],
"defaultValue" : "...",
- "category" : "ARRAY",
+ "category" : "ENUM",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -1330,7 +1343,7 @@
"ordinal" : 12345
} ],
"defaultValue" : "...",
- "category" : "OBJECT_ID_TYPE",
+ "category" : "ARRAY",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -1350,7 +1363,7 @@
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "SET",
+ "cardinality" : "LIST",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
@@ -1367,7 +1380,7 @@
"isIndexable" : true,
"constraints" : [ { }, { } ]
} ],
- "category" : "PRIMITIVE",
+ "category" : "ARRAY",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -1396,14 +1409,14 @@
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "LIST",
+ "cardinality" : "SET",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
"constraints" : [ { }, { } ]
} ],
- "category" : "MAP",
+ "category" : "ARRAY",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -1424,7 +1437,7 @@
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "LIST",
+ "cardinality" : "SINGLE",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
@@ -1434,14 +1447,14 @@
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "SET",
+ "cardinality" : "SINGLE",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
"constraints" : [ { }, { } ]
} ],
- "category" : "STRUCT",
+ "category" : "MAP",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -1471,14 +1484,14 @@
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "SET",
+ "cardinality" : "LIST",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
"constraints" : [ { }, { } ]
} ],
- "category" : "ENUM",
+ "category" : "STRUCT",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -1509,14 +1522,14 @@
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "SINGLE",
+ "cardinality" : "SET",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
"constraints" : [ { }, { } ]
} ],
- "category" : "PRIMITIVE",
+ "category" : "CLASSIFICATION",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -1536,7 +1549,7 @@
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "SINGLE",
+ "cardinality" : "SET",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
@@ -1546,14 +1559,14 @@
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "LIST",
+ "cardinality" : "SINGLE",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
"constraints" : [ { }, { } ]
} ],
- "category" : "ARRAY",
+ "category" : "ENTITY",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -1570,7 +1583,7 @@
} ],
"empty" : true
},
- "description" : ""
+ "description" : "A collection of atlas enum, struct, classification and entity definitions (models)."
}
,
"json_AttributeSearchResult" : {
@@ -1596,7 +1609,7 @@
"name" : [ "...", "..." ],
"values" : [ ]
},
- "description" : ""
+ "description" : "Search results for attribute(s)"
}
,
"json_Cardinality" : {
@@ -1607,7 +1620,7 @@
"LIST",
"SET"
],
- "description" : "single-valued attribute or multi-valued attribute."
+ "description" : "Cardinality of an attribute i.e. single-valued or multi-valued."
}
,
"json_ClassificationAssociateRequest" : {
@@ -1636,7 +1649,7 @@
},
"entityGuids" : [ "...", "..." ]
},
- "description" : ""
+ "description" : "Tag association request for a list of entities"
}
,
"json_EntityMutationResponse" : {
@@ -1705,7 +1718,7 @@
"mutatedEntities" : {
"property1" : [ {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -1726,7 +1739,7 @@
} ],
"property2" : [ {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -1736,7 +1749,7 @@
}
}, {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -1794,7 +1807,7 @@
} ],
"partialUpdatedEntities" : [ {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -1847,7 +1860,7 @@
},
"firstEntityUpdated" : {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -1868,7 +1881,7 @@
}
}
},
- "description" : ""
+ "description" : "Entity modification response. Contains entity headers for each successful modification (create/update/delete)"
}
,
"json_EntityOperation" : {
@@ -1880,7 +1893,7 @@
"PARTIAL_UPDATE",
"DELETE"
],
- "description" : ""
+ "description" : "Entity operations supported by Atlas via REST"
}
,
"json_LineageDirection" : {
@@ -1891,7 +1904,7 @@
"OUTPUT",
"BOTH"
],
- "description" : ""
+ "description" : "Lineage direction"
}
,
"json_LineageRelation" : {
@@ -1911,7 +1924,7 @@
"fromEntityId" : "...",
"toEntityId" : "..."
},
- "description" : ""
+ "description" : "Lineage relation between two entities"
}
,
"json_PList" : {
@@ -1951,7 +1964,7 @@
"startIndex" : 12345,
"pageSize" : 12345,
"totalCount" : 12345,
- "sortType" : "ASC",
+ "sortType" : "DESC",
"sortBy" : "..."
},
"description" : "Paginated-list, for returning search results."
@@ -1965,7 +1978,7 @@
"ASC",
"DESC"
],
- "description" : "to specify whether the result should be sorted? If yes, whether asc or desc."
+ "description" : "Type of sorting to be applied on the result set, defaults to NONE"
}
,
"json_Status" : {
@@ -1975,7 +1988,7 @@
"ACTIVE",
"DELETED"
],
- "description" : "Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store."
+ "description" : "Status of the entity - can be active or deleted."
}
,
"json_TypeCategory" : {
@@ -1991,1023 +2004,188 @@
"ARRAY",
"MAP"
],
- "description" : ""
+ "description" : "Category of a defined type"
}
- ,
- "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"
- }
+ },
+ "paths": {
+ "\/v2/search/basic" : {
+ "get" : {
+ "tags" : [ "DiscoveryREST" ],
+ "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" : [
+ {
+ "name" : "classification",
+ "in" : "query",
+ "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" : "Fulltext query"
+ },
+ {
+ "name" : "typeName",
+ "in" : "query",
+ "type" : "string",
+ "description" : "limit the result to only entities of specified type or its sub-types"
}
- }
- ],
- "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" : ""
- },
+ ],
+ "responses" : {
+ "200" : {
+ "schema" : {
"description" : "",
-"type" : "number"
+"$ref" : "#/definitions/json_AtlasSearchResult"
},
- "params" : {
- "xml" : {
- "namespace" : ""
- },
-"description" : "",
-"type" : "object"
+ "headers" : {
},
- "sortBy" : {
- "xml" : {
- "namespace" : ""
- },
-"description" : "",
-"type" : "string"
+ "examples" : {
+ "application/json" : {
+ "queryType" : "GREMLIN",
+ "queryText" : "...",
+ "type" : "...",
+ "classification" : "...",
+ "entities" : [ {
+ "guid" : "...",
+ "status" : "ACTIVE",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ }, {
+ "guid" : "...",
+ "status" : "DELETED",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ } ],
+ "attributes" : {
+ "name" : [ "...", "..." ],
+ "values" : [ ]
+ },
+ "fullTextResult" : [ {
+ "entity" : {
+ "guid" : "...",
+ "status" : "DELETED",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ },
+ "score" : 12345.0
+ }, {
+ "entity" : {
+ "guid" : "...",
+ "status" : "ACTIVE",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ },
+ "score" : 12345.0
+ } ]
+}
},
- "sortType" : {
- "xml" : {
- "namespace" : ""
- },
-"description" : "",
-"$ref" : "#/definitions/xml_ns0_sortType"
+ "description" : "On successful FullText lookup with some results, might return an empty list if execution succeeded\nwithout any results"
+ },
+ "400" : {
+ "headers" : {
},
- "startIndex" : {
- "xml" : {
- "namespace" : ""
- },
-"description" : "",
-"type" : "number"
- }
- }
- }
- ],
- "description" : "Generic filter, to specify search criteria using name/value pairs."
+ "examples" : {
+ "application/json" : {
+ "queryType" : "BASIC",
+ "queryText" : "...",
+ "type" : "...",
+ "classification" : "...",
+ "entities" : [ {
+ "guid" : "...",
+ "status" : "ACTIVE",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
}
- ,
- "xml_ns0_sortType" : {
- "type" : "string",
- "title" : "sortType",
- "enum" : [
- "NONE",
- "ASC",
- "DESC"
- ],
- "description" : "to specify whether the result should be sorted? If yes, whether asc or desc."
- }
- ,
- "xml_ns0_typeCategory" : {
- "type" : "string",
- "title" : "typeCategory",
- "enum" : [
- "PRIMITIVE",
- "OBJECT_ID_TYPE",
- "ENUM",
- "STRUCT",
- "CLASSIFICATION",
- "ENTITY",
- "ARRAY",
- "MAP"
- ],
- "description" : ""
- }
- ,
- "xml_ns0_atlasSearchResult" : {
- "type" : "object",
- "title" : "atlasSearchResult",
- "allOf" : [
- {
- "properties" : {
- "attributes" : {
- "xml" : {
- "namespace" : ""
- },
-"description" : "",
-"$ref" : "#/definitions/xml_ns0_attributeSearchResult"
- },
- "entities" : {
- "xml" : {
- "namespace" : ""
- },
-"description" : "",
-"$ref" : "#/definitions/xml_ns0_atlasEntityHeader"
- },
- "fullTextResult" : {
- "xml" : {
- "namespace" : ""
- },
-"description" : "",
-"$ref" : "#/definitions/xml_ns0_atlasFullTextResult"
- },
- "queryText" : {
- "xml" : {
- "namespace" : ""
- },
-"description" : "",
-"type" : "string"
- },
- "queryType" : {
- "xml" : {
- "namespace" : ""
- },
-"description" : "",
-"$ref" : "#/definitions/xml_ns0_atlasQueryType"
- }
- }
- }
- ],
- "description" : ""
- }
- ,
- "xml_ns0_atlasFullTextResult" : {
- "type" : "object",
- "title" : "atlasFullTextResult",
- "allOf" : [
- {
- "properties" : {
- "entity" : {
- "xml" : {
- "namespace" : ""
- },
-"description" : "",
-"$ref" : "#/definitions/xml_ns0_atlasEntityHeader"
- },
- "score" : {
- "xml" : {
- "namespace" : ""
- },
-"description" : "",
-"type" : "number"
- }
- }
- }
- ],
- "description" : ""
- }
- ,
- "xml_ns0_atlasQueryType" : {
- "type" : "string",
- "title" : "atlasQueryType",
- "enum" : [
- "DSL",
- "FULL_TEXT",
- "GREMLIN"
- ],
- "description" : ""
- }
- ,
- "xml_ns0_attributeSearchResult" : {
- "type" : "object",
- "title" : "attributeSearchResult",
- "allOf" : [
- {
- "properties" : {
- "name" : {
- "xml" : {
- "namespace" : ""
- },
-"description" : "",
-"type" : "string"
- },
- "values" : {
- "xml" : {
- "namespace" : ""
- },
-"description" : "",
-"type" : "object"
- }
- }
- }
- ],
- "description" : ""
- }
- ,
- "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_atlasEntity" : {
- "type" : "object",
- "title" : "atlasEntity",
- "allOf" : [
- {
- "$ref" : "#/definitions/xml_ns0_atlasStruct"
- },
- {
- "properties" : {
- "classifications" : {
- "xml" : {
- "namespace" : ""
- },
-"description" : "",
-"$ref" : "#/definitions/xml_ns0_atlasClassification"
- },
- "createTime" : {
- "xml" : {
- "namespace" : ""
- },
-"description" : "",
-"type" : "string"
- },
- "createdBy" : {
- "xml" : {
- "namespace" : ""
- },
-"description" : "",
-"type" : "string"
- },
- "guid" : {
- "xml" : {
- "namespace" : ""
- },
-"description" : "",
-"type" : "string"
- },
- "status" : {
- "xml" : {
- "namespace" : ""
- },
-"description" : "",
-"$ref" : "#/definitions/xml_ns0_status"
- },
- "updateTime" : {
- "xml" : {
- "namespace" : ""
- },
-"description" : "",
-"type" : "string"
- },
- "updatedBy" : {
- "xml" : {
- "namespace" : ""
- },
-"description" : "",
-"type" : "string"
- },
- "version" : {
- "xml" : {
- "namespace" : ""
- },
-"description" : "",
-"type" : "number"
- }
- }
- }
- ],
- "description" : "An instance of an entity - like hive_table, hive_database."
- }
- ,
- "xml_ns0_status" : {
- "type" : "string",
- "title" : "status",
- "enum" : [
- "ACTIVE",
- "DELETED"
- ],
- "description" : "Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store."
- }
- ,
- "xml_ns0_atlasEntityHeader" : {
- "type" : "object",
- "title" : "atlasEntityHeader",
- "allOf" : [
- {
- "$ref" : "#/definitions/xml_ns0_atlasStruct"
- },
- {
- "properties" : {
- "classificationNames" : {
- "xml" : {
- "namespace" : ""
- },
-"description" : "",
-"type" : "string"
- },
- "displayText" : {
- "xml" : {
- "namespace" : ""
- },
-"description" : "",
-"type" : "string"
- },
- "guid" : {
- "xml" : {
- "namespace" : ""
- },
-"description" : "",
-"type" : "string"
- },
- "status" : {
- "xml" : {
- "namespace" : ""
- },
-"description" : "",
-"$ref" : "#/definitions/xml_ns0_status"
- }
- }
- }
- ],
- "description" : "An instance of an entity - like hive_table, hive_database."
- }
- ,
- "xml_ns0_atlasObjectId" : {
- "type" : "object",
- "title" : "atlasObjectId",
- "allOf" : [
- {
- "properties" : {
- "guid" : {
- "xml" : {
- "namespace" : ""
- },
-"description" : "",
-"type" : "string"
- },
- "typeName" : {
- "xml" : {
- "namespace" : ""
- },
-"description" : "",
-"type" : "string"
- },
- "uniqueAttributes" : {
- "xml" : {
- "namespace" : ""
- },
-"description" : "",
-"type" : "object"
- }
- }
- }
- ],
- "description" : "Reference to an object-instance of an Atlas type - like 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."
- }
- ,
- "xml_ns0_classificationAssociateRequest" : {
- "type" : "object",
- "title" : "classificationAssociateRequest",
- "allOf" : [
- {
- "properties" : {
- "classification" : {
- "xml" : {
- "namespace" : ""
- },
-"description" : "",
-"$ref" : "#/definitions/xml_ns0_atlasClassification"
- },
- "entityGuids" : {
- "xml" : {
- "namespace" : ""
- },
-"description" : "",
-"type" : "string"
- }
- }
- }
- ],
- "description" : ""
- }
- ,
- "xml_ns0_entityMutationResponse" : {
- "type" : "object",
- "title" : "entityMutationResponse",
- "allOf" : [
- {
- "properties" : {
- "guidAssignments" : {
- "xml" : {
- "namespace" : ""
- },
-"description" : "",
-"type" : "object"
- },
- "mutatedEntities" : {
- "xml" : {
- "namespace" : ""
- },
-"description" : "",
-"type" : "object"
- }
- }
- }
- ],
- "description" : ""
- }
- ,
- "xml_ns0_entityMutations" : {
- "type" : "object",
- "title" : "entityMutations",
- "allOf" : [
- {
- }
- ],
- "description" : ""
- }
- ,
- "xml_ns0_entityOperation" : {
- "type" : "string",
- "title" : "entityOperation",
- "enum" : [
- "CREATE",
- "UPDATE",
- "PARTIAL_UPDATE",
- "DELETE"
- ],
- "description" : ""
- }
- ,
- "xml_ns0_guidMapping" : {
- "type" : "object",
- "title" : "guidMapping",
- "allOf" : [
- {
- "properties" : {
- "guidAssignments" : {
- "xml" : {
- "namespace" : ""
- },
-"description" : "",
-"type" : "object"
- }
- }
- }
- ],
- "description" : "This stores a mapping of guid assignments that were made during the processing\nof a create or update entity request.\n."
- }
- ,
- "xml_ns0_atlasLineageInfo" : {
- "type" : "object",
- "title" : "atlasLineageInfo",
- "allOf" : [
- {
- "properties" : {
- "baseEntityGuid" : {
- "xml" : {
- "namespace" : ""
- },
-"description" : "",
-"type" : "string"
- },
- "guidEntityMap" : {
- "xml" : {
- "namespace" : ""
- },
-"description" : "",
-"type" : "object"
- },
- "lineageDepth" : {
- "xml" : {
- "namespace" : ""
- },
-"description" : "",
-"type" : "number"
- },
- "lineageDirection" : {
- "xml" : {
- "namespace" : ""
- },
-"description" : "",
-"$ref" : "#/definitions/xml_ns0_lineageDirection"
- },
- "relations" : {
- "xml" : {
- "namespace" : ""
- },
-"description" : "",
-"$ref" : "#/definitions/xml_ns0_lineageRelation"
- }
- }
- }
- ],
- "description" : ""
- }
- ,
- "xml_ns0_lineageDirection" : {
- "type" : "string",
- "title" : "lineageDirection",
- "enum" : [
- "INPUT",
- "OUTPUT",
- "BOTH"
- ],
- "description" : ""
- }
- ,
- "xml_ns0_lineageRelation" : {
- "type" : "object",
- "title" : "lineageRelation",
- "allOf" : [
- {
- "properties" : {
- "fromEntityId" : {
- "xml" : {
- "namespace" : ""
- },
-"description" : "",
-"type" : "string"
- },
- "toEntityId" : {
- "xml" : {
- "namespace" : ""
- },
-"description" : "",
-"type" : "string"
- }
- }
- }
- ],
- "description" : ""
- }
- ,
- "xml_ns0_atlasBaseTypeDef" : {
- "type" : "object",
- "title" : "atlasBaseTypeDef",
- "allOf" : [
- {
- "properties" : {
- "createTime" : {
- "xml" : {
- "namespace" : ""
- },
-"description" : "",
-"type" : "string"
- },
- "createdBy" : {
- "xml" : {
- "namespace" : ""
- },
-"description" : "",
-"type" : "string"
- },
- "description" : {
- "xml" : {
- "namespace" : ""
- },
-"description" : "",
-"type" : "string"
- },
- "guid" : {
- "xml" : {
- "namespace" : ""
- },
-"description" : "",
-"type" : "string"
- },
- "name" : {
- "xml" : {
- "namespace" : ""
- },
-"description" : "",
-"type" : "string"
- },
- "options" : {
- "xml" : {
- "namespace" : ""
- },
-"description" : "",
-"type" : "object"
- },
- "typeVersion" : {
- "xml" : {
- "namespace" : ""
- },
-"description" : "",
-"type" : "string"
- },
- "updateTime" : {
- "xml" : {
- "namespace" : ""
- },
-"description" : "",
-"type" : "string"
- },
- "updatedBy" : {
- "xml" : {
- "namespace" : ""
- },
-"description" : "",
-"type" : "string"
- },
- "version" : {
- "xml" : {
- "namespace" : ""
- },
-"description" : "",
-"type" : "number"
- }
- }
- }
- ],
- "description" : "Base class that captures common-attributes for all Atlas types."
- }
- ,
- "xml_ns0_atlasClassificationDef" : {
- "type" : "object",
- "title" : "atlasClassificationDef",
- "allOf" : [
- {
- "$ref" : "#/definitions/xml_ns0_atlasStructDef"
- },
- {
- "properties" : {
- "superTypes" : {
- "xml" : {
- "namespace" : ""
- },
-"description" : "",
-"type" : "string"
- }
- }
- }
- ],
- "description" : "class that captures details of a classification-type."
- }
- ,
- "xml_ns0_atlasEntityDef" : {
- "type" : "object",
- "title" : "atlasEntityDef",
- "allOf" : [
- {
- "$ref" : "#/definitions/xml_ns0_atlasStructDef"
- },
- {
- "properties" : {
- "superTypes" : {
- "xml" : {
- "namespace" : ""
- },
-"description" : "",
-"type" : "string"
- }
- }
- }
- ],
- "description" : "class that captures details of a entity-type."
- }
- ,
- "xml_ns0_atlasEnumDef" : {
- "type" : "object",
- "title" : "atlasEnumDef",
- "allOf" : [
- {
- "$ref" : "#/definitions/xml_ns0_atlasBaseTypeDef"
- },
- {
- "properties" : {
- "defaultValue" : {
- "xml" : {
- "namespace" : ""
- },
-"description" : "",
-"type" : "string"
- },
- "elementDefs" : {
- "xml" : {
- "namespace" : ""
- },
-"description" : "",
-"$ref" : "#/definitions/xml_ns0_atlasEnumElementDef"
- }
- }
- }
- ],
- "description" : "class that captures details of an enum-type."
- }
- ,
- "xml_ns0_atlasEnumElementDef" : {
- "type" : "object",
- "title" : "atlasEnumElementDef",
- "allOf" : [
- {
- "properties" : {
- "description" : {
- "xml" : {
- "namespace" : ""
- },
-"description" : "",
-"type" : "string"
- },
- "ordinal" : {
- "xml" : {
- "namespace" : ""
- },
-"description" : "",
-"type" : "number"
- },
- "value" : {
- "xml" : {
- "namespace" : ""
- },
-"description" : "",
-"type" : "string"
- }
- }
- }
- ],
- "description" : "class that captures details of an enum-element."
- }
- ,
- "xml_ns0_atlasStructDef" : {
- "type" : "object",
- "title" : "atlasStructDef",
- "allOf" : [
- {
- "$ref" : "#/definitions/xml_ns0_atlasBaseTypeDef"
- },
- {
- "properties" : {
- "attributeDefs" : {
- "xml" : {
- "namespace" : ""
- },
-"description" : "",
-"$ref" : "#/definitions/xml_ns0_atlasAttributeDef"
- }
- }
- }
- ],
- "description" : "class that captures details of a struct-type."
- }
- ,
- "xml_ns0_atlasAttributeDef" : {
- "type" : "object",
- "title" : "atlasAttributeDef",
- "allOf" : [
- {
- "properties" : {
- "cardinality" : {
- "xml" : {
- "namespace" : ""
- },
-"description" : "",
-"$ref" : "#/definitions/xml_ns0_cardinality"
- },
- "constraints" : {
- "xml" : {
- "namespace" : ""
- },
-"description" : "",
-"$ref" : "#/definitions/xml_ns0_atlasConstraintDef"
- },
- "isIndexable" : {
- "xml" : {
- "namespace" : ""
- },
-"description" : "",
-"type" : "boolean"
- },
- "isOptional" : {
- "xml" : {
- "namespace" : ""
- },
-"description" : "",
-"type" : "boolean"
- },
- "isUnique" : {
- "xml" : {
- "namespace" : ""
- },
-"description" : "",
-"type" : "boolean"
- },
- "name" : {
- "xml" : {
- "namespace" : ""
- },
-"description" : "",
-"type" : "string"
- },
- "typeName" : {
- "xml" : {
- "namespace" : ""
- },
-"description" : "",
-"type" : "string"
- },
- "valuesMaxCount" : {
- "xml" : {
- "namespace" : ""
- },
-"description" : "",
-"type" : "number"
- },
- "valuesMinCount" : {
- "xml" : {
- "namespace" : ""
- },
-"description" : "",
-"type" : "number"
- }
- }
- }
- ],
- "description" : "class that captures details of a struct-attribute."
- }
- ,
- "xml_ns0_cardinality" : {
- "type" : "string",
- "title" : "cardinality",
- "enum" : [
- "SINGLE",
- "LIST",
- "SET"
- ],
- "description" : "single-valued attribute or multi-valued attribute."
- }
- ,
- "xml_ns0_atlasConstraintDef" : {
- "type" : "object",
- "title" : "atlasConstraintDef",
- "allOf" : [
- {
- "properties" : {
- "params" : {
- "xml" : {
- "namespace" : ""
- },
-"description" : "",
-"type" : "object"
- },
- "type" : {
- "xml" : {
- "namespace" : ""
- },
-"description" : "",
-"type" : "string"
- }
- }
- }
- ],
- "description" : "class that captures details of a constraint."
+ }, {
+ "guid" : "...",
+ "status" : "DELETED",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
}
- ,
- "xml_ns0_atlasTypeDefHeader" : {
- "type" : "object",
- "title" : "atlasTypeDefHeader",
- "allOf" : [
- {
- "properties" : {
- "category" : {
- "xml" : {
- "namespace" : ""
- },
-"description" : "",
-"$ref" : "#/definitions/xml_ns0_typeCategory"
- },
- "guid" : {
- "xml" : {
- "namespace" : ""
- },
-"description" : "",
-"type" : "string"
+ } ],
+ "attributes" : {
+ "name" : [ "...", "..." ],
+ "values" : [ ]
+ },
+ "fullTextResult" : [ {
+ "entity" : {
+ "guid" : "...",
+ "status" : "DELETED",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ },
+ "score" : 12345.0
+ }, {
+ "entity" : {
+ "guid" : "...",
+ "status" : "ACTIVE",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ },
+ "score" : 12345.0
+ } ]
+}
},
- "name" : {
- "xml" : {
- "namespace" : ""
- },
-"description" : "",
-"type" : "string"
- }
+ "description" : "Invalid fulltext or query parameters"
}
}
- ],
- "description" : ""
+ }
}
,
- "xml_ns0_atlasTypesDef" : {
- "type" : "object",
- "title" : "atlasTypesDef",
- "allOf" : [
- {
- "properties" : {
- "classificationDefs" : {
- "xml" : {
- "namespace" : ""
- },
-"description" : "",
-"$ref" : "#/definitions/xml_ns0_atlasClassificationDef"
- },
- "entityDefs" : {
- "xml" : {
- "namespace" : ""
- },
-"description" : "",
-"$ref" : "#/definitions/xml_ns0_atlasEntityDef"
- },
- "enumDefs" : {
- "xml" : {
- "namespace" : ""
- },
-"description" : "",
-"$ref" : "#/definitions/xml_ns0_atlasEnumDef"
- },
- "structDefs" : {
- "xml" : {
- "namespace" : ""
- },
-"description" : "",
-"$ref" : "#/definitions/xml_ns0_atlasStructDef"
- }
- }
- }
- ],
- "description" : ""
- }
- },
- "paths": {
"\/v2/search/dsl" : {
"get" : {
"tags" : [ "DiscoveryREST" ],
@@ -3017,6 +2195,12 @@
"produces" : [ "application/json;charset=UTF-8" ],
"parameters" : [
{
+ "name" : "classification",
+ "in" : "query",
+ "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",
@@ -3033,6 +2217,12 @@
"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" : {
@@ -3045,8 +2235,10 @@
},
"examples" : {
"application/json" : {
+ "queryType" : "DSL",
"queryText" : "...",
- "queryType" : "FULL_TEXT",
+ "type" : "...",
+ "classification" : "...",
"entities" : [ {
"guid" : "...",
"status" : "ACTIVE",
@@ -3059,7 +2251,7 @@
}
}, {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -3075,7 +2267,7 @@
"fullTextResult" : [ {
"entity" : {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -3088,7 +2280,7 @@
}, {
"entity" : {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -3108,11 +2300,13 @@
},
"examples" : {
"application/json" : {
+ "queryType" : "DSL",
"queryText" : "...",
- "queryType" : "FULL_TEXT",
+ "type" : "...",
+ "classification" : "...",
"entities" : [ {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -3138,7 +2332,7 @@
"fullTextResult" : [ {
"entity" : {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -3151,7 +2345,7 @@
}, {
"entity" : {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -3207,11 +2401,13 @@
},
"examples" : {
"application/json" : {
+ "queryType" : "FULL_TEXT",
"queryText" : "...",
- "queryType" : "DSL",
+ "type" : "...",
+ "classification" : "...",
"entities" : [ {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -3237,7 +2433,7 @@
"fullTextResult" : [ {
"entity" : {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -3250,7 +2446,7 @@
}, {
"entity" : {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -3270,11 +2466,13 @@
},
"examples" : {
"application/json" : {
+ "queryType" : "BASIC",
"queryText" : "...",
- "queryType" : "FULL_TEXT",
+ "type" : "...",
+ "classification" : "...",
"entities" : [ {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -3374,7 +2572,7 @@
}
}, {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -3411,7 +2609,7 @@
},
"createdEntities" : [ {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -3442,7 +2640,7 @@
}
}, {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -3453,7 +2651,7 @@
} ],
"partialUpdatedEntities" : [ {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -3463,7 +2661,7 @@
}
}, {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -3474,7 +2672,7 @@
} ],
"deletedEntities" : [ {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -3484,7 +2682,7 @@
}
}, {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -3506,7 +2704,7 @@
},
"firstEntityUpdated" : {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -3517,7 +2715,7 @@
},
"firstEntityPartialUpdated" : {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -3566,7 +2764,7 @@
"mutatedEntities" : {
"property1" : [ {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -3576,7 +2774,7 @@
}
}, {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -3587,7 +2785,7 @@
} ],
"property2" : [ {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -3623,7 +2821,7 @@
}
}, {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -3644,7 +2842,7 @@
}
}, {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -3655,7 +2853,7 @@
} ],
"partialUpdatedEntities" : [ {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -3665,7 +2863,7 @@
}
}, {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -3676,7 +2874,7 @@
} ],
"deletedEntities" : [ {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -3719,7 +2917,7 @@
},
"firstEntityPartialUpdated" : {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -3791,7 +2989,7 @@
}
}, {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"createdBy" : "...",
"updatedBy" : "...",
"createTime" : 12345,
@@ -3819,7 +3017,7 @@
"referredEntities" : {
"property1" : {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"createdBy" : "...",
"updatedBy" : "...",
"createTime" : 12345,
@@ -3910,7 +3108,7 @@
"mutatedEntities" : {
"property1" : [ {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -3920,7 +3118,7 @@
}
}, {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -3931,7 +3129,7 @@
} ],
"property2" : [ {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -3941,7 +3139,7 @@
}
}, {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -3957,7 +3155,7 @@
},
"createdEntities" : [ {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -3967,7 +3165,7 @@
}
}, {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -3978,7 +3176,7 @@
} ],
"updatedEntities" : [ {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -3999,7 +3197,7 @@
} ],
"partialUpdatedEntities" : [ {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -4009,7 +3207,7 @@
}
}, {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -4030,7 +3228,7 @@
}
}, {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -4063,7 +3261,7 @@
},
"firstEntityPartialUpdated" : {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -4217,7 +3415,7 @@
}
}, {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -4228,7 +3426,7 @@
} ],
"partialUpdatedEntities" : [ {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -4238,7 +3436,7 @@
}
}, {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -4249,7 +3447,7 @@
} ],
"deletedEntities" : [ {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -4281,7 +3479,7 @@
},
"firstEntityUpdated" : {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -4422,14 +3620,13 @@
}
}
}
- }
- ,
- "\/v2/entity/guid/{guid}/classifications" : {
- "get" : {
+ ,
+ "put" : {
"tags" : [ "EntityREST" ],
- "summary" : "Gets the list of classifications for a given entity represented by a guid.",
- "description" : "Gets the list of classifications for a given entity represented by a guid.",
- "operationId" : "resource_EntityREST_getClassifications_GET",
+ "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",
+ "consumes" : [ "application/json;charset=UTF-8" ],
"produces" : [ "application/json;charset=UTF-8" ],
"parameters" : [
{
@@ -4437,38 +3634,214 @@
"in" : "path",
"required" : true,
"type" : "string",
- "description" : "globally unique identifier for the entity"
+ "description" : ""
+ },
+ {
+ "name" : "name",
+ "in" : "query",
+ "type" : "string",
+ "description" : ""
+ },
+ {
+ "name" : "body",
+ "in" : "body",
+ "schema" : {
+"description" : "",
+"type" : "file"
+ },
+ "description" : ""
}
],
"responses" : {
- "200" : {
+ "204" : {
"schema" : {
"description" : "",
-"$ref" : "#/definitions/json_AtlasClassifications"
+"$ref" : "#/definitions/json_EntityMutationResponse"
},
"headers" : {
},
"examples" : {
"application/json" : {
- "list" : [ { }, { } ],
- "startIndex" : 12345,
- "pageSize" : 12345,
- "totalCount" : 12345,
- "sortType" : "NONE",
- "sortBy" : "..."
+ "mutatedEntities" : {
+ "property1" : [ {
+ "guid" : "...",
+ "status" : "DELETED",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ }, {
+ "guid" : "...",
+ "status" : "DELETED",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ } ],
+ "property2" : [ {
+ "guid" : "...",
+ "status" : "DELETED",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ }, {
+ "guid" : "...",
+ "status" : "ACTIVE",
+ "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" : "ACTIVE",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ } ],
+ "deletedEntities" : [ {
+ "guid" : "...",
+ "status" : "ACTIVE",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ }, {
+ "guid" : "...",
+ "status" : "ACTIVE",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ } ],
+ "firstEntityCreated" : {
+ "guid" : "...",
+ "status" : "DELETED",
+ "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"
}
}
}
- ,
- "post" : {
+ }
+ ,
+ "\/v2/entity/guid/{guid}/classifications" : {
+ "get" : {
"tags" : [ "EntityREST" ],
- "summary" : "Adds classifications to an existing entity represented by a guid.",
- "description" : "Adds classifications to an existing entity represented by a guid.",
- "operationId" : "resource_EntityREST_addClassifications_POST",
- "consumes" : [ "application/json;charset=UTF-8" ],
+ "summary" : "Gets the list of classifications for a given entity represented by a guid.",
+ "description" : "Gets the list of classifications for a given entity represented by a guid.",
+ "operationId" : "resource_EntityREST_getClassifications_GET",
+ "produces" : [ "application/json;charset=UTF-8" ],
"parameters" : [
{
"name" : "guid",
@@ -4476,36 +3849,36 @@
"required" : true,
"type" : "string",
"description" : "globally unique identifier for the entity"
- },
- {
- "name" : "body",
- "in" : "body",
- "schema" : {
-"description" : "",
-"type" : "array",
-"items" : {
- "$ref" : "#/definitions/json_AtlasClassification"
-}
- },
- "description" : ""
}
],
"responses" : {
- "201" : {
+ "200" : {
+ "schema" : {
+"description" : "",
+"$ref" : "#/definitions/json_AtlasClassifications"
+ },
"headers" : {
},
"examples" : {
+ "application/json" : {
+ "list" : [ { }, { } ],
+ "startIndex" : 12345,
+ "pageSize" : 12345,
+ "totalCount" : 12345,
+ "sortType" : "DESC",
+ "sortBy" : "..."
+}
},
"description" : "Success"
}
}
}
,
- "put" : {
+ "post" : {
"tags" : [ "EntityREST" ],
- "summary" : "Update classification(s) for an entity represented by a guid.",
- "description" : "Update classification(s) for an entity represented by a guid.\nClassifications are identified by their guid or name",
- "operationId" : "resource_EntityREST_updateClassifications_PUT",
+ "summary" : "Adds classifications to an existing entity represented by a guid.",
+ "description" : "Adds classifications to an existing entity represented by a guid.",
+ "operationId" : "resource_EntityREST_addClassifications_POST",
"consumes" : [ "application/json;charset=UTF-8" ],
"parameters" : [
{
@@ -4529,7 +3902,7 @@
}
],
"responses" : {
- "204" : {
+ "201" : {
"headers" : {
},
"examples" : {
@@ -4569,7 +3942,7 @@
"mutatedEntities" : {
"property1" : [ {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -4590,7 +3963,7 @@
} ],
"property2" : [ {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -4616,7 +3989,7 @@
},
"createdEntities" : [ {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -4626,7 +3999,7 @@
}
}, {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -4647,7 +4020,7 @@
}
}, {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -4668,7 +4041,7 @@
}
}, {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -4679,7 +4052,7 @@
} ],
"deletedEntities" : [ {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -4689,7 +4062,7 @@
}
}, {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -4711,7 +4084,7 @@
},
"firstEntityUpdated" : {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -4857,7 +4230,7 @@
"tags" : [ "EntityREST" ],
"summary" : "Entity Partial Update - Allows a subset of attributes to be updated on\nan entity which is identified by its type and unique attribute eg: Referenceable.",
"description" : "Entity Partial Update - Allows a subset of attributes to be updated on\nan entity which is identified by its type and unique attribute eg: Referenceable.qualifiedName.\nNull updates are not possible",
- "operationId" : "resource_EntityREST_partialUpdateByUniqueAttributes_PUT",
+ "operationId" : "resource_EntityREST_partialUpdateEntityByUniqueAttrs_PUT",
"consumes" : [ "application/json;charset=UTF-8" ],
"produces" : [ "application/json;charset=UTF-8" ],
"parameters" : [
@@ -4873,7 +4246,7 @@
"in" : "body",
"schema" : {
"description" : "",
-"$ref" : "#/definitions/json_AtlasEntity"
+"$ref" : "#/definitions/json_AtlasEntityWithExtInfo"
},
"description" : ""
}
@@ -4901,7 +4274,7 @@
}
}, {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -4912,7 +4285,7 @@
} ],
"property2" : [ {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -4938,7 +4311,7 @@
},
"createdEntities" : [ {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -5022,7 +4395,7 @@
} ],
"firstEntityCreated" : {
"guid" : "...",
- "status" : "ACTIVE",
+ "status" : "DELETED",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -5033,7 +4406,7 @@
},
"firstEntityUpdated" : {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -5073,7 +4446,7 @@
"in" : "path",
"required" : true,
"type" : "string",
- "description" : "name of the trait"
+ "description" : "name of the classifcation"
},
{
"name" : "guid",
@@ -5195,7 +4568,7 @@
},
"property2" : {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -5212,7 +4585,7 @@
"fromEntityId" : "...",
"toEntityId" : "..."
} ],
- "lineageDirection" : "OUTPUT",
+ "lineageDirection" : "BOTH",
"lineageDepth" : 12345
}
},
@@ -5227,7 +4600,7 @@
"guidEntityMap" : {
"property1" : {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -5255,7 +4628,7 @@
"fromEntityId" : "...",
"toEntityId" : "..."
} ],
- "lineageDirection" : "OUTPUT",
+ "lineageDirection" : "BOTH",
"lineageDepth" : 12345
}
},
@@ -5281,7 +4654,7 @@
},
"property2" : {
"guid" : "...",
- "status" : "DELETED",
+ "status" : "ACTIVE",
"displayText" : "...",
"classificationNames" : [ "...", "..." ],
"typeName" : "...",
@@ -5373,7 +4746,7 @@
"ordinal" : 12345
} ],
"defaultValue" : "...",
- "category" : "STRUCT",
+ "category" : "OBJECT_ID_TYPE",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -5398,7 +4771,7 @@
"ordinal" : 12345
} ],
"defaultValue" : "...",
- "category" : "PRIMITIVE",
+ "category" : "ENUM",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -5435,7 +4808,7 @@
"isIndexable" : true,
"constraints" : [ { }, { } ]
} ],
- "category" : "STRUCT",
+ "category" : "OBJECT_ID_TYPE",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -5454,7 +4827,7 @@
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "SINGLE",
+ "cardinality" : "SET",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
@@ -5464,14 +4837,14 @@
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "SINGLE",
+ "cardinality" : "LIST",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
"constraints" : [ { }, { } ]
} ],
- "category" : "ENUM",
+ "category" : "PRIMITIVE",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -5502,7 +4875,7 @@
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "LIST",
+ "cardinality" : "SINGLE",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
@@ -5539,14 +4912,14 @@
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "LIST",
+ "cardinality" : "SET",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
"constraints" : [ { }, { } ]
} ],
- "category" : "MAP",
+ "category" : "PRIMITIVE",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -5567,7 +4940,7 @@
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "LIST",
+ "cardinality" : "SINGLE",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
@@ -5577,14 +4950,14 @@
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "SINGLE",
+ "cardinality" : "LIST",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
"constraints" : [ { }, { } ]
} ],
- "category" : "ENTITY",
+ "category" : "ENUM",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -5614,14 +4987,14 @@
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "SET",
+ "cardinality" : "SINGLE",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
"constraints" : [ { }, { } ]
} ],
- "category" : "STRUCT",
+ "category" : "ENUM",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -5683,7 +5056,7 @@
"ordinal" : 12345
} ],
"defaultValue" : "...",
- "category" : "PRIMITIVE",
+ "category" : "STRUCT",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -5728,7 +5101,7 @@
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "SET",
+ "cardinality" : "SINGLE",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
@@ -5764,7 +5137,7 @@
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "SET",
+ "cardinality" : "LIST",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
@@ -5774,14 +5147,14 @@
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "SET",
+ "cardinality" : "SINGLE",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
"constraints" : [ { }, { } ]
} ],
- "category" : "CLASSIFICATION",
+ "category" : "ENUM",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -5819,7 +5192,7 @@
"isIndexable" : true,
"constraints" : [ { }, { } ]
} ],
- "category" : "ARRAY",
+ "category" : "CLASSIFICATION",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -5856,7 +5229,7 @@
"isIndexable" : true,
"constraints" : [ { }, { } ]
} ],
- "category" : "ENTITY",
+ "category" : "MAP",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -5877,7 +5250,7 @@
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "LIST",
+ "cardinality" : "SINGLE",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
@@ -5894,7 +5267,7 @@
"isIndexable" : true,
"constraints" : [ { }, { } ]
} ],
- "category" : "ARRAY",
+ "category" : "OBJECT_ID_TYPE",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -5914,7 +5287,7 @@
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "SET",
+ "cardinality" : "SINGLE",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
@@ -5924,7 +5297,7 @@
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "SINGLE",
+ "cardinality" : "LIST",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
@@ -5967,7 +5340,7 @@
"ordinal" : 12345
} ],
"defaultValue" : "...",
- "category" : "ENTITY",
+ "category" : "ARRAY",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -5992,7 +5365,7 @@
"ordinal" : 12345
} ],
"defaultValue" : "...",
- "category" : "ENTITY",
+ "category" : "MAP",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -6012,7 +5385,7 @@
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "SET",
+ "cardinality" : "LIST",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
@@ -6022,14 +5395,14 @@
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "LIST",
+ "cardinality" : "SET",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
"constraints" : [ { }, { } ]
} ],
- "category" : "PRIMITIVE",
+ "category" : "CLASSIFICATION",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -6065,7 +5438,7 @@
"isIndexable" : true,
"constraints" : [ { }, { } ]
} ],
- "category" : "ENTITY",
+ "category" : "PRIMITIVE",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -6086,7 +5459,7 @@
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "SINGLE",
+ "cardinality" : "SET",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
@@ -6096,14 +5469,14 @@
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "SET",
+ "cardinality" : "SINGLE",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
"constraints" : [ { }, { } ]
} ],
- "category" : "PRIMITIVE",
+ "category" : "OBJECT_ID_TYPE",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -6133,14 +5506,14 @@
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "SINGLE",
+ "cardinality" : "SET",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
"constraints" : [ { }, { } ]
} ],
- "category" : "OBJECT_ID_TYPE",
+ "category" : "ENUM",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -6178,7 +5551,7 @@
"isIndexable" : true,
"constraints" : [ { }, { } ]
} ],
- "category" : "ENTITY",
+ "category" : "ARRAY",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -6198,7 +5571,7 @@
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "SINGLE",
+ "cardinality" : "LIST",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
@@ -6208,14 +5581,14 @@
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "LIST",
+ "cardinality" : "SET",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
"constraints" : [ { }, { } ]
} ],
- "category" : "OBJECT_ID_TYPE",
+ "category" : "ENTITY",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -6277,7 +5650,7 @@
"ordinal" : 12345
} ],
"defaultValue" : "...",
- "category" : "MAP",
+ "category" : "OBJECT_ID_TYPE",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -6322,7 +5695,7 @@
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "SET",
+ "cardinality" : "SINGLE",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
@@ -6339,7 +5712,7 @@
"isIndexable" : true,
"constraints" : [ { }, { } ]
} ],
- "category" : "CLASSIFICATION",
+ "category" : "PRIMITIVE",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -6358,7 +5731,7 @@
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "SET",
+ "cardinality" : "SINGLE",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
@@ -6368,14 +5741,14 @@
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "LIST",
+ "cardinality" : "SET",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
"constraints" : [ { }, { } ]
} ],
- "category" : "OBJECT_ID_TYPE",
+ "category" : "ENTITY",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -6396,7 +5769,7 @@
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "SET",
+ "cardinality" : "LIST",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
@@ -6406,14 +5779,14 @@
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "SET",
+ "cardinality" : "SINGLE",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
"constraints" : [ { }, { } ]
} ],
- "category" : "MAP",
+ "category" : "ENTITY",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -6433,7 +5806,7 @@
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "SET",
+ "cardinality" : "LIST",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
@@ -6443,14 +5816,14 @@
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "LIST",
+ "cardinality" : "SET",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
"constraints" : [ { }, { } ]
} ],
- "category" : "ARRAY",
+ "category" : "ENTITY",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -6471,7 +5844,7 @@
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "LIST",
+ "cardinality" : "SET",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
@@ -6481,14 +5854,14 @@
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "LIST",
+ "cardinality" : "SET",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
"constraints" : [ { }, { } ]
} ],
- "category" : "ARRAY",
+ "category" : "OBJECT_ID_TYPE",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -6508,7 +5881,7 @@
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "SINGLE",
+ "cardinality" : "LIST",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
@@ -6561,7 +5934,7 @@
"ordinal" : 12345
} ],
"defaultValue" : "...",
- "category" : "MAP",
+ "category" : "ARRAY",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -6586,7 +5959,7 @@
"ordinal" : 12345
} ],
"defaultValue" : "...",
- "category" : "ARRAY",
+ "category" : "STRUCT",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -6606,7 +5979,7 @@
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "SET",
+ "cardinality" : "LIST",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
@@ -6623,7 +5996,7 @@
"isIndexable" : true,
"constraints" : [ { }, { } ]
} ],
- "category" : "ARRAY",
+ "category" : "PRIMITIVE",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -6652,14 +6025,14 @@
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "LIST",
+ "cardinality" : "SINGLE",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
"constraints" : [ { }, { } ]
} ],
- "category" : "ENTITY",
+ "category" : "ARRAY",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -6697,7 +6070,7 @@
"isIndexable" : true,
"constraints" : [ { }, { } ]
} ],
- "category" : "STRUCT",
+ "category" : "OBJECT_ID_TYPE",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -6717,7 +6090,7 @@
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "SINGLE",
+ "cardinality" : "SET",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
@@ -6727,14 +6100,14 @@
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "LIST",
+ "cardinality" : "SET",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
"constraints" : [ { }, { } ]
} ],
- "category" : "OBJECT_ID_TYPE",
+ "category" : "PRIMITIVE",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -6765,14 +6138,14 @@
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "SET",
+ "cardinality" : "LIST",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
"constraints" : [ { }, { } ]
} ],
- "category" : "ARRAY",
+ "category" : "ENUM",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -6792,7 +6165,7 @@
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "SET",
+ "cardinality" : "LIST",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
@@ -6802,14 +6175,14 @@
"name" : "...",
"typeName" : "...",
"isOptional" : true,
- "cardinality" : "SET",
+ "cardinality" : "SINGLE",
"valuesMinCount" : 12345,
"valuesMaxCount" : 12345,
"isUnique" : true,
"isIndexable" : true,
"constraints" : [ { }, { } ]
} ],
- "category" : "STRUCT",
+ "category" : "ARRAY",
"guid" : "...",
"createdBy" : "...",
"updatedBy" : "...",
@@ -6919,7 +6292,7 @@
<TRUNCATED>