http://git-wip-us.apache.org/repos/asf/atlas-website/blob/58bb55a6/api/v2/ui/swagger.json ---------------------------------------------------------------------- diff --git a/api/v2/ui/swagger.json b/api/v2/ui/swagger.json index 2715dbb..4ce3caf 100644 --- a/api/v2/ui/swagger.json +++ b/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.9-SNAPSHOT", + "version" : "1.0.0", "title" : "Atlas REST API" }, "schemes" : [], @@ -24,6 +24,10 @@ } , { + "name" : "GlossaryREST" + } + , + { "name" : "LineageREST" , "description" : "REST interface for an entity's lineage information." @@ -42,6224 +46,2118 @@ } ], "definitions" : { - "json_AtlasAttributeDef" : { + "json_AtlasClassification" : { "type" : "object", - "title" : "AtlasAttributeDef", + "title" : "AtlasClassification", + "allOf" : [ + { + "$ref" : "#/definitions/json_AtlasStruct" + }, + { "properties" : { - "name" : { -"description" : "", -"type" : "string" - }, - "typeName" : { + "entityGuid" : { + "readOnly" : false, "description" : "", "type" : "string" }, - "isOptional" : { -"description" : "", -"type" : "boolean" - }, - "cardinality" : { -"description" : "", -"$ref" : "#/definitions/json_Cardinality" - }, - "valuesMinCount" : { -"description" : "", -"type" : "number" - }, - "valuesMaxCount" : { -"description" : "", -"type" : "number" - }, - "isUnique" : { -"description" : "", -"type" : "boolean" - }, - "isIndexable" : { + "propagate" : { + "readOnly" : false, "description" : "", "type" : "boolean" }, - "defaultValue" : { -"description" : "", -"type" : "string" - }, - "constraints" : { + "validityPeriods" : { + "readOnly" : false, "description" : "", "type" : "array", "items" : { - "$ref" : "#/definitions/json_AtlasConstraintDef" + "$ref" : "#/definitions/json_TimeBoundary" } } - }, + } + } + ], "example" : { - "name" : "...", - "typeName" : "...", - "isOptional" : true, - "cardinality" : "LIST", - "valuesMinCount" : 12345, - "valuesMaxCount" : 12345, - "isUnique" : true, - "isIndexable" : true, - "defaultValue" : "...", - "constraints" : [ { - "type" : "...", - "params" : { - "property1" : { }, - "property2" : { } - } + "entityGuid" : "...", + "propagate" : true, + "validityPeriods" : [ { + "startTime" : "...", + "endTime" : "...", + "timeZone" : "..." }, { - "type" : "...", - "params" : { - "property1" : { }, - "property2" : { } - } - } ] + "startTime" : "...", + "endTime" : "...", + "timeZone" : "..." + } ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } }, - "description" : "class that captures details of a struct-attribute." + "description" : "An instance of a classification; it doesn't have an identity, this object exists only when associated with an entity." } , - "json_AtlasBaseTypeDef" : { + "json_AtlasStruct" : { "type" : "object", - "title" : "AtlasBaseTypeDef", + "title" : "AtlasStruct", "properties" : { - "category" : { -"description" : "", -"$ref" : "#/definitions/json_TypeCategory" - }, - "guid" : { -"description" : "", -"type" : "string" - }, - "createdBy" : { -"description" : "", -"type" : "string" - }, - "updatedBy" : { -"description" : "", -"type" : "string" - }, - "createTime" : { -"description" : "", -"type" : "number" - }, - "updateTime" : { -"description" : "", -"type" : "number" - }, - "version" : { -"description" : "", -"type" : "number" - }, - "name" : { -"description" : "", -"type" : "string" - }, - "description" : { -"description" : "", -"type" : "string" - }, - "typeVersion" : { + "typeName" : { + "readOnly" : false, "description" : "", "type" : "string" }, - "options" : { + "attributes" : { + "readOnly" : false, "description" : "", "type" : "object", "additionalProperties" : { - "type" : "string" + "type" : "object" } } }, "example" : { - "category" : "STRUCT", - "guid" : "...", - "createdBy" : "...", - "updatedBy" : "...", - "createTime" : 12345, - "updateTime" : 12345, - "version" : 12345, - "name" : "...", - "description" : "...", - "typeVersion" : "...", - "options" : { - "property1" : "...", - "property2" : "..." - } -}, - "description" : "Base class that captures common-attributes for all Atlas types." - } - , - "json_AtlasClassification" : { - "type" : "object", - "title" : "AtlasClassification", - "allOf" : [ - { - "$ref" : "#/definitions/json_AtlasStruct" - }, - { - } - ], - "example" : { "typeName" : "...", "attributes" : { "property1" : { }, "property2" : { } } }, - "description" : "An instance of a classification; it doesn't have an identity, this object exists only when associated with an entity." + "description" : "Captures details of struct contents. Not instantiated directly, used only via AtlasEntity, AtlasClassification." } , - "json_AtlasClassificationDef" : { + "json_ClassificationAssociateRequest" : { "type" : "object", - "title" : "AtlasClassificationDef", - "allOf" : [ - { - "$ref" : "#/definitions/json_AtlasStructDef" - }, - { + "title" : "ClassificationAssociateRequest", "properties" : { - "superTypes" : { + "classification" : { + "readOnly" : false, +"$ref" : "#/definitions/json_AtlasClassification" + }, + "entityGuids" : { + "readOnly" : false, "description" : "", "type" : "array", "items" : { "type" : "string" } } - } - } - ], + }, "example" : { - "superTypes" : [ "...", "..." ], - "attributeDefs" : [ { - "name" : "...", - "typeName" : "...", - "isOptional" : true, - "cardinality" : "SINGLE", - "valuesMinCount" : 12345, - "valuesMaxCount" : 12345, - "isUnique" : true, - "isIndexable" : true, - "defaultValue" : "...", - "constraints" : [ { - "type" : "...", - "params" : { - "property1" : { }, - "property2" : { } - } + "classification" : { + "entityGuid" : "...", + "propagate" : true, + "validityPeriods" : [ { + "startTime" : "...", + "endTime" : "...", + "timeZone" : "..." }, { - "type" : "...", - "params" : { - "property1" : { }, - "property2" : { } - } - } ] - }, { - "name" : "...", + "startTime" : "...", + "endTime" : "...", + "timeZone" : "..." + } ], "typeName" : "...", - "isOptional" : true, - "cardinality" : "SINGLE", - "valuesMinCount" : 12345, - "valuesMaxCount" : 12345, - "isUnique" : true, - "isIndexable" : true, - "defaultValue" : "...", - "constraints" : [ { - "type" : "...", - "params" : { - "property1" : { }, - "property2" : { } - } - }, { - "type" : "...", - "params" : { - "property1" : { }, - "property2" : { } - } - } ] - } ], - "category" : "ENTITY", - "guid" : "...", - "createdBy" : "...", - "updatedBy" : "...", - "createTime" : 12345, - "updateTime" : 12345, - "version" : 12345, - "name" : "...", - "description" : "...", - "typeVersion" : "...", - "options" : { - "property1" : "...", - "property2" : "..." - } + "attributes" : { + "property1" : { }, + "property2" : { } + } + }, + "entityGuids" : [ "...", "..." ] }, - "description" : "class that captures details of a classification-type." + "description" : "" } , - "json_AtlasClassifications" : { + "json_PList" : { "type" : "object", - "title" : "AtlasClassifications", - "allOf" : [ - { - "$ref" : "#/definitions/json_PList" - }, - { - } - ], + "title" : "PList", + "properties" : { + "list" : { + "readOnly" : false, +"description" : "", +"type" : "array", +"items" : { + "type" : "object" +} + }, + "startIndex" : { + "readOnly" : false, +"description" : "", +"type" : "number" + }, + "pageSize" : { + "readOnly" : false, +"description" : "", +"type" : "number" + }, + "totalCount" : { + "readOnly" : false, +"description" : "", +"type" : "number" + }, + "sortType" : { + "readOnly" : false, +"$ref" : "#/definitions/json_SortType" + }, + "sortBy" : { + "readOnly" : false, +"description" : "", +"type" : "string" + } + }, "example" : { "list" : [ { }, { } ], "startIndex" : 12345, "pageSize" : 12345, "totalCount" : 12345, - "sortType" : "DESC", + "sortType" : "ASC", "sortBy" : "..." }, - "description" : "REST serialization friendly list." + "description" : "Paginated-list, for returning search results." } , - "json_AtlasConstraintDef" : { + "json_SearchFilter" : { "type" : "object", - "title" : "AtlasConstraintDef", + "title" : "SearchFilter", "properties" : { - "type" : { -"description" : "", -"type" : "string" - }, "params" : { + "readOnly" : false, "description" : "", "type" : "object", "additionalProperties" : { - "type" : "object" +"type" : "array", +"items" : { + "type" : "string" } +} + }, + "startIndex" : { + "readOnly" : false, +"description" : "", +"type" : "number" + }, + "maxRows" : { + "readOnly" : false, +"description" : "", +"type" : "number" + }, + "getCount" : { + "readOnly" : false, +"description" : "", +"type" : "boolean" + }, + "sortBy" : { + "readOnly" : false, +"description" : "", +"type" : "string" + }, + "sortType" : { + "readOnly" : false, +"$ref" : "#/definitions/json_SortType" } }, "example" : { - "type" : "...", "params" : { - "property1" : { }, - "property2" : { } - } + "property1" : [ "...", "..." ], + "property2" : [ "...", "..." ] + }, + "startIndex" : 12345, + "maxRows" : 12345, + "getCount" : true, + "sortBy" : "...", + "sortType" : "ASC" +}, + "description" : "Generic filter, to specify search criteria using name/value pairs." + } + , + "json_SortType" : { + "type" : "string", + "title" : "SortType", + "enum" : [ + "NONE", + "ASC", + "DESC" + ], + "description" : "to specify whether the result should be sorted? If yes, whether asc or desc." + } + , + "json_TimeBoundary" : { + "type" : "object", + "title" : "TimeBoundary", + "properties" : { + "startTime" : { + "readOnly" : false, +"description" : "", +"type" : "string" + }, + "endTime" : { + "readOnly" : false, +"description" : "", +"type" : "string" + }, + "timeZone" : { + "readOnly" : false, +"description" : "", +"type" : "string" + } + }, + "example" : { + "startTime" : "...", + "endTime" : "...", + "timeZone" : "..." }, - "description" : "class that captures details of a constraint." + "description" : "Captures time-boundary details" } , - "json_AtlasEntitiesWithExtInfo" : { + "xml_ns0_PList" : { "type" : "object", - "title" : "AtlasEntitiesWithExtInfo", + "xml" : { + "name" : "PList", + "namespace" : "" + }, + "title" : "PList", "allOf" : [ { - "$ref" : "#/definitions/json_AtlasEntityExtInfo" - }, - { "properties" : { - "entities" : { + "list" : { + "xml" : { + "namespace" : "" + }, + "readOnly" : false, "description" : "", "type" : "array", "items" : { - "$ref" : "#/definitions/json_AtlasEntity" + "type" : "object" } - } - } - } - ], - "example" : { - "entities" : [ { - "guid" : "...", - "status" : "ACTIVE", - "createdBy" : "...", - "updatedBy" : "...", - "createTime" : 12345, - "updateTime" : 12345, - "version" : 12345, - "relationshipAttributes" : { - "property1" : { }, - "property2" : { } - }, - "classifications" : [ { - "typeName" : "...", - "attributes" : { - "property1" : { }, - "property2" : { } - } - }, { - "typeName" : "...", - "attributes" : { - "property1" : { }, - "property2" : { } - } - } ], - "typeName" : "...", - "attributes" : { - "property1" : { }, - "property2" : { } - } - }, { - "guid" : "...", - "status" : "DELETED", - "createdBy" : "...", - "updatedBy" : "...", - "createTime" : 12345, - "updateTime" : 12345, - "version" : 12345, - "relationshipAttributes" : { - "property1" : { }, - "property2" : { } - }, - "classifications" : [ { - "typeName" : "...", - "attributes" : { - "property1" : { }, - "property2" : { } - } - }, { - "typeName" : "...", - "attributes" : { - "property1" : { }, - "property2" : { } - } - } ], - "typeName" : "...", - "attributes" : { - "property1" : { }, - "property2" : { } - } - } ], - "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" : { } - } - } ], - "typeName" : "...", - "attributes" : { - "property1" : { }, - "property2" : { } - } - }, - "property2" : { - "guid" : "...", - "status" : "DELETED", - "createdBy" : "...", - "updatedBy" : "...", - "createTime" : 12345, - "updateTime" : 12345, - "version" : 12345, - "relationshipAttributes" : { - "property1" : { }, - "property2" : { } - }, - "classifications" : [ { - "typeName" : "...", - "attributes" : { - "property1" : { }, - "property2" : { } - } - }, { - "typeName" : "...", - "attributes" : { - "property1" : { }, - "property2" : { } + }, + "pageSize" : { + "xml" : { + "namespace" : "" + }, + "readOnly" : false, +"description" : "", +"type" : "integer", +"format" : "int32" + }, + "sortBy" : { + "xml" : { + "namespace" : "" + }, + "readOnly" : false, +"description" : "", +"type" : "string" + }, + "sortType" : { + "xml" : { + "namespace" : "" + }, + "readOnly" : false, +"$ref" : "#/definitions/xml_ns0_sortType" + }, + "startIndex" : { + "xml" : { + "namespace" : "" + }, + "readOnly" : false, +"description" : "", +"type" : "integer", +"format" : "int64" + }, + "totalCount" : { + "xml" : { + "namespace" : "" + }, + "readOnly" : false, +"description" : "", +"type" : "integer", +"format" : "int64" + } + } } - } ], - "typeName" : "...", - "attributes" : { - "property1" : { }, - "property2" : { } - } - } - } -}, - "description" : "An instance of an entity along with extended info - like hive_table, hive_database." + ], + "description" : "Paginated-list, for returning search results." } , - "json_AtlasEntity" : { + "xml_ns0_searchFilter" : { "type" : "object", - "title" : "AtlasEntity", + "xml" : { + "name" : "searchFilter", + "namespace" : "" + }, + "title" : "searchFilter", "allOf" : [ { - "$ref" : "#/definitions/json_AtlasStruct" - }, - { "properties" : { - "guid" : { + "getCount" : { + "xml" : { + "namespace" : "" + }, + "readOnly" : false, "description" : "", -"type" : "string" +"type" : "boolean" }, - "status" : { + "maxRows" : { + "xml" : { + "namespace" : "" + }, + "readOnly" : false, "description" : "", -"$ref" : "#/definitions/json_Status" +"type" : "integer", +"format" : "int64" }, - "createdBy" : { + "params" : { + "xml" : { + "namespace" : "" + }, + "readOnly" : false, "description" : "", -"type" : "string" +"type" : "object" }, - "updatedBy" : { + "sortBy" : { + "xml" : { + "namespace" : "" + }, + "readOnly" : false, "description" : "", "type" : "string" }, - "createTime" : { -"description" : "", -"type" : "number" - }, - "updateTime" : { -"description" : "", -"type" : "number" - }, - "version" : { -"description" : "", -"type" : "number" - }, - "relationshipAttributes" : { -"description" : "", -"type" : "object", -"additionalProperties" : { - "type" : "object" -} + "sortType" : { + "xml" : { + "namespace" : "" + }, + "readOnly" : false, +"$ref" : "#/definitions/xml_ns0_sortType" }, - "classifications" : { + "startIndex" : { + "xml" : { + "namespace" : "" + }, + "readOnly" : false, "description" : "", -"type" : "array", -"items" : { - "$ref" : "#/definitions/json_AtlasClassification" -} +"type" : "integer", +"format" : "int64" } } } ], - "example" : { - "guid" : "...", - "status" : "ACTIVE", - "createdBy" : "...", - "updatedBy" : "...", - "createTime" : 12345, - "updateTime" : 12345, - "version" : 12345, - "relationshipAttributes" : { - "property1" : { }, - "property2" : { } - }, - "classifications" : [ { - "typeName" : "...", - "attributes" : { - "property1" : { }, - "property2" : { } - } - }, { - "typeName" : "...", - "attributes" : { - "property1" : { }, - "property2" : { } + "description" : "Generic filter, to specify search criteria using name/value pairs." } - } ], - "typeName" : "...", - "attributes" : { - "property1" : { }, - "property2" : { } - } -}, - "description" : "An instance of an entity - like hive_table, hive_database." + , + "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." } , - "json_AtlasEntityDef" : { + "xml_ns0_timeBoundary" : { "type" : "object", - "title" : "AtlasEntityDef", + "xml" : { + "name" : "timeBoundary", + "namespace" : "" + }, + "title" : "timeBoundary", "allOf" : [ { - "$ref" : "#/definitions/json_AtlasStructDef" - }, - { "properties" : { - "superTypes" : { + "endTime" : { + "xml" : { + "namespace" : "" + }, + "readOnly" : false, "description" : "", -"type" : "array", -"items" : { - "type" : "string" -} +"type" : "string" + }, + "startTime" : { + "xml" : { + "namespace" : "" + }, + "readOnly" : false, +"description" : "", +"type" : "string" + }, + "timeZone" : { + "xml" : { + "namespace" : "" + }, + "readOnly" : false, +"description" : "", +"type" : "string" } } } ], - "example" : { - "superTypes" : [ "...", "..." ], - "attributeDefs" : [ { - "name" : "...", - "typeName" : "...", - "isOptional" : true, - "cardinality" : "SINGLE", - "valuesMinCount" : 12345, - "valuesMaxCount" : 12345, - "isUnique" : true, - "isIndexable" : true, - "defaultValue" : "...", - "constraints" : [ { - "type" : "...", - "params" : { - "property1" : { }, - "property2" : { } - } - }, { - "type" : "...", - "params" : { - "property1" : { }, - "property2" : { } - } - } ] - }, { - "name" : "...", - "typeName" : "...", - "isOptional" : true, - "cardinality" : "SINGLE", - "valuesMinCount" : 12345, - "valuesMaxCount" : 12345, - "isUnique" : true, - "isIndexable" : true, - "defaultValue" : "...", - "constraints" : [ { - "type" : "...", - "params" : { - "property1" : { }, - "property2" : { } - } - }, { - "type" : "...", - "params" : { - "property1" : { }, - "property2" : { } - } - } ] - } ], - "category" : "ENTITY", - "guid" : "...", - "createdBy" : "...", - "updatedBy" : "...", - "createTime" : 12345, - "updateTime" : 12345, - "version" : 12345, - "name" : "...", - "description" : "...", - "typeVersion" : "...", - "options" : { - "property1" : "...", - "property2" : "..." - } -}, - "description" : "class that captures details of a entity-type." + "description" : "Captures time-boundary details" } , - "json_AtlasEntityExtInfo" : { + "xml_ns0_atlasClassification" : { "type" : "object", - "title" : "AtlasEntityExtInfo", - "properties" : { - "referredEntities" : { -"description" : "", -"type" : "object", -"additionalProperties" : { - "$ref" : "#/definitions/json_AtlasEntity" -} - } - }, - "example" : { - "referredEntities" : { - "property1" : { - "guid" : "...", - "status" : "ACTIVE", - "createdBy" : "...", - "updatedBy" : "...", - "createTime" : 12345, - "updateTime" : 12345, - "version" : 12345, - "relationshipAttributes" : { - "property1" : { }, - "property2" : { } - }, - "classifications" : [ { - "typeName" : "...", - "attributes" : { - "property1" : { }, - "property2" : { } - } - }, { - "typeName" : "...", - "attributes" : { - "property1" : { }, - "property2" : { } - } - } ], - "typeName" : "...", - "attributes" : { - "property1" : { }, - "property2" : { } - } - }, - "property2" : { - "guid" : "...", - "status" : "ACTIVE", - "createdBy" : "...", - "updatedBy" : "...", - "createTime" : 12345, - "updateTime" : 12345, - "version" : 12345, - "relationshipAttributes" : { - "property1" : { }, - "property2" : { } + "xml" : { + "name" : "atlasClassification", + "namespace" : "" }, - "classifications" : [ { - "typeName" : "...", - "attributes" : { - "property1" : { }, - "property2" : { } - } - }, { - "typeName" : "...", - "attributes" : { - "property1" : { }, - "property2" : { } - } - } ], - "typeName" : "...", - "attributes" : { - "property1" : { }, - "property2" : { } - } - } - } -}, - "description" : "An instance of an entity along with extended info - like hive_table, hive_database." - } - , - "json_AtlasEntityHeader" : { - "type" : "object", - "title" : "AtlasEntityHeader", + "title" : "atlasClassification", "allOf" : [ { - "$ref" : "#/definitions/json_AtlasStruct" + "$ref" : "#/definitions/xml_ns0_atlasStruct" }, { "properties" : { - "guid" : { + "entityGuid" : { + "xml" : { + "namespace" : "" + }, + "readOnly" : false, "description" : "", "type" : "string" }, - "status" : { -"description" : "", -"$ref" : "#/definitions/json_Status" - }, - "displayText" : { + "propagate" : { + "xml" : { + "namespace" : "" + }, + "readOnly" : false, "description" : "", -"type" : "string" +"type" : "boolean" }, - "classificationNames" : { + "validityPeriods" : { + "xml" : { + "namespace" : "" + }, + "readOnly" : false, "description" : "", "type" : "array", "items" : { - "type" : "string" + "$ref" : "#/definitions/xml_ns0_timeBoundary" } } } } ], - "example" : { - "guid" : "...", - "status" : "ACTIVE", - "displayText" : "...", - "classificationNames" : [ "...", "..." ], - "typeName" : "...", - "attributes" : { - "property1" : { }, - "property2" : { } - } -}, - "description" : "An instance of an entity - like hive_table, hive_database." + "description" : "An instance of a classification; it doesn't have an identity, this object exists only when associated with an entity." } , - "json_AtlasEntityWithExtInfo" : { + "xml_ns0_atlasStruct" : { "type" : "object", - "title" : "AtlasEntityWithExtInfo", + "xml" : { + "name" : "atlasStruct", + "namespace" : "" + }, + "title" : "atlasStruct", "allOf" : [ { - "$ref" : "#/definitions/json_AtlasEntityExtInfo" - }, - { "properties" : { - "entity" : { + "attributes" : { + "xml" : { + "namespace" : "" + }, + "readOnly" : false, +"description" : "", +"type" : "object" + }, + "typeName" : { + "xml" : { + "namespace" : "" + }, + "readOnly" : false, "description" : "", -"$ref" : "#/definitions/json_AtlasEntity" +"type" : "string" } } } ], - "example" : { - "entity" : { - "guid" : "...", - "status" : "ACTIVE", - "createdBy" : "...", - "updatedBy" : "...", - "createTime" : 12345, - "updateTime" : 12345, - "version" : 12345, - "relationshipAttributes" : { - "property1" : { }, - "property2" : { } - }, - "classifications" : [ { - "typeName" : "...", - "attributes" : { - "property1" : { }, - "property2" : { } - } - }, { - "typeName" : "...", - "attributes" : { - "property1" : { }, - "property2" : { } - } - } ], - "typeName" : "...", - "attributes" : { - "property1" : { }, - "property2" : { } + "description" : "Captures details of struct contents. Not instantiated directly, used only via AtlasEntity, AtlasClassification." } }, - "referredEntities" : { - "property1" : { - "guid" : "...", - "status" : "ACTIVE", - "createdBy" : "...", - "updatedBy" : "...", - "createTime" : 12345, - "updateTime" : 12345, - "version" : 12345, - "relationshipAttributes" : { - "property1" : { }, - "property2" : { } - }, - "classifications" : [ { - "typeName" : "...", - "attributes" : { - "property1" : { }, - "property2" : { } - } - }, { - "typeName" : "...", - "attributes" : { - "property1" : { }, - "property2" : { } - } - } ], - "typeName" : "...", - "attributes" : { - "property1" : { }, - "property2" : { } - } - }, - "property2" : { - "guid" : "...", - "status" : "DELETED", - "createdBy" : "...", - "updatedBy" : "...", - "createTime" : 12345, - "updateTime" : 12345, - "version" : 12345, - "relationshipAttributes" : { - "property1" : { }, - "property2" : { } - }, - "classifications" : [ { - "typeName" : "...", - "attributes" : { - "property1" : { }, - "property2" : { } - } - }, { - "typeName" : "...", - "attributes" : { - "property1" : { }, - "property2" : { } + "paths": { + "\/v2/entity" : { + "post" : { + "tags" : [ "EntityREST" ], + "summary" : "Create new entity or update existing entity in Atlas.", + "description" : "Create new entity or update existing entity in Atlas.\nExisting entity is matched using its unique guid if supplied or by its unique attributes eg: qualifiedName", + "operationId" : "createOrUpdate", + "consumes" : [ "application/json;charset=UTF-8" ], + "produces" : [ "application/json;charset=UTF-8" ], + "parameters" : [ + { + "name" : "body", + "in" : "body", + "type" : "file", + "description" : "" + } + ], + "responses" : { + "201" : { + "description" : "EntityMutationResponse" + } } - } ], - "typeName" : "...", - "attributes" : { - "property1" : { }, - "property2" : { } } } - } -}, - "description" : "An instance of an entity along with extended info - like hive_table, hive_database." - } , - "json_AtlasEnumDef" : { - "type" : "object", - "title" : "AtlasEnumDef", - "allOf" : [ - { - "$ref" : "#/definitions/json_AtlasBaseTypeDef" - }, - { - "properties" : { - "elementDefs" : { -"description" : "", -"type" : "array", -"items" : { - "$ref" : "#/definitions/json_AtlasEnumElementDef" -} + "\/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" : "deleteByGuids", + "produces" : [ "application/json;charset=UTF-8" ], + "parameters" : [ + { + "name" : "guid", + "in" : "query", + "type" : "array", + "items" : { + "type" : "string" }, - "defaultValue" : { -"description" : "", -"type" : "string" - } + "collectionFormat" : "multi", + "description" : "" + } + ], + "responses" : { + "204" : { + "description" : "" } } - ], - "example" : { - "elementDefs" : [ { - "value" : "...", - "description" : "...", - "ordinal" : 12345 - }, { - "value" : "...", - "description" : "...", - "ordinal" : 12345 - } ], - "defaultValue" : "...", - "category" : "ENUM", - "guid" : "...", - "createdBy" : "...", - "updatedBy" : "...", - "createTime" : 12345, - "updateTime" : 12345, - "version" : 12345, - "name" : "...", - "description" : "...", - "typeVersion" : "...", - "options" : { - "property1" : "...", - "property2" : "..." - } -}, - "description" : "class that captures details of an enum-type." - } - , - "json_AtlasEnumElementDef" : { - "type" : "object", - "title" : "AtlasEnumElementDef", - "properties" : { - "value" : { -"description" : "", -"type" : "string" - }, - "description" : { -"description" : "", -"type" : "string" - }, - "ordinal" : { -"description" : "", -"type" : "number" - } - }, - "example" : { - "value" : "...", - "description" : "...", - "ordinal" : 12345 -}, - "description" : "class that captures details of an enum-element." - } - , - "json_AtlasFullTextResult" : { - "type" : "object", - "title" : "AtlasFullTextResult", - "properties" : { - "entity" : { -"description" : "", -"$ref" : "#/definitions/json_AtlasEntityHeader" - }, - "score" : { -"description" : "", -"type" : "number" - } - }, - "example" : { - "entity" : { - "guid" : "...", - "status" : "DELETED", - "displayText" : "...", - "classificationNames" : [ "...", "..." ], - "typeName" : "...", - "attributes" : { - "property1" : { }, - "property2" : { } - } - }, - "score" : 12345.0 -}, - "description" : "" - } - , - "json_AtlasLineageInfo" : { - "type" : "object", - "title" : "AtlasLineageInfo", - "properties" : { - "baseEntityGuid" : { -"description" : "", -"type" : "string" - }, - "guidEntityMap" : { -"description" : "", -"type" : "object", -"additionalProperties" : { - "$ref" : "#/definitions/json_AtlasEntityHeader" -} - }, - "relations" : { -"description" : "", -"type" : "array", -"items" : { - "$ref" : "#/definitions/json_LineageRelation" -} - }, - "lineageDirection" : { -"description" : "", -"$ref" : "#/definitions/json_LineageDirection" - }, - "lineageDepth" : { -"description" : "", -"type" : "number" - } - }, - "example" : { - "baseEntityGuid" : "...", - "guidEntityMap" : { - "property1" : { - "guid" : "...", - "status" : "ACTIVE", - "displayText" : "...", - "classificationNames" : [ "...", "..." ], - "typeName" : "...", - "attributes" : { - "property1" : { }, - "property2" : { } - } - }, - "property2" : { - "guid" : "...", - "status" : "DELETED", - "displayText" : "...", - "classificationNames" : [ "...", "..." ], - "typeName" : "...", - "attributes" : { - "property1" : { }, - "property2" : { } } - } - }, - "relations" : [ { - "fromEntityId" : "...", - "toEntityId" : "..." - }, { - "fromEntityId" : "...", - "toEntityId" : "..." - } ], - "lineageDirection" : "BOTH", - "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", - "enum" : [ - "DSL", - "FULL_TEXT", - "GREMLIN", - "BASIC", - "ATTRIBUTE" - ], - "description" : "" - } - , - "json_AtlasRelationship" : { - "type" : "object", - "title" : "AtlasRelationship", - "allOf" : [ - { - "$ref" : "#/definitions/json_AtlasStruct" - }, - { - "properties" : { - "guid" : { -"description" : "", -"type" : "string" - }, - "status" : { -"description" : "", -"$ref" : "#/definitions/json_Status_AtlasRelationship" - }, - "createdBy" : { -"description" : "", -"type" : "string" - }, - "updatedBy" : { -"description" : "", -"type" : "string" - }, - "createTime" : { -"description" : "", -"type" : "number" - }, - "updateTime" : { -"description" : "", -"type" : "number" - }, - "version" : { -"description" : "", -"type" : "number" - }, - "end1" : { -"description" : "", -"$ref" : "#/definitions/json_AtlasObjectId" - }, - "end2" : { -"description" : "", -"$ref" : "#/definitions/json_AtlasObjectId" + , + "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" : "getByGuids", + "produces" : [ "application/json;charset=UTF-8" ], + "parameters" : [ + { + "name" : "guid", + "in" : "query", + "type" : "array", + "items" : { + "type" : "string" }, - "label" : { -"description" : "", -"type" : "string" - } + "collectionFormat" : "multi", + "description" : "" + } + ], + "responses" : { + "200" : { + "description" : "" } } - ], - "example" : { - "guid" : "...", - "status" : "DELETED", - "createdBy" : "...", - "updatedBy" : "...", - "createTime" : 12345, - "updateTime" : 12345, - "version" : 12345, - "end1" : { - "guid" : "...", - "typeName" : "...", - "uniqueAttributes" : { - "property1" : { }, - "property2" : { } - } - }, - "end2" : { - "guid" : "...", - "typeName" : "...", - "uniqueAttributes" : { - "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" : "AGGREGATION", - "propagateTags" : "ONE_TO_TWO", - "endDef1" : { - "type" : "...", - "name" : "...", - "isContainer" : true, - "cardinality" : "SET", - "isLegacyAttribute" : true - }, - "endDef2" : { - "type" : "...", - "name" : "...", - "isContainer" : true, - "cardinality" : "LIST", - "isLegacyAttribute" : true - }, - "relationshipLabel" : "...", - "attributeDefs" : [ { - "name" : "...", - "typeName" : "...", - "isOptional" : true, - "cardinality" : "LIST", - "valuesMinCount" : 12345, - "valuesMaxCount" : 12345, - "isUnique" : true, - "isIndexable" : true, - "defaultValue" : "...", - "constraints" : [ { - "type" : "...", - "params" : { - "property1" : { }, - "property2" : { } - } - }, { - "type" : "...", - "params" : { - "property1" : { }, - "property2" : { } - } - } ] - }, { - "name" : "...", - "typeName" : "...", - "isOptional" : true, - "cardinality" : "LIST", - "valuesMinCount" : 12345, - "valuesMaxCount" : 12345, - "isUnique" : true, - "isIndexable" : true, - "defaultValue" : "...", - "constraints" : [ { - "type" : "...", - "params" : { - "property1" : { }, - "property2" : { } - } - }, { - "type" : "...", - "params" : { - "property1" : { }, - "property2" : { } - } - } ] - } ], - "category" : "PRIMITIVE", - "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\nAs with other typeDefs the AtlasRelationshipDef has a name. Once created the RelationshipDef has a guid.\nThe name and the guid are the 2 ways that the RelationshipDef is identified.\n\nRelationshipDefs have 2 ends, each of which specify cardinality, an EntityDef type name and name and optionally\nwhether the end is a container.\nRelationshipDefs can have AttributeDefs - though only primitive types are allowed.\nRelationshipDefs have a relationshipCategory specifying the UML type of relationship required\nRelationshipDefs also have a PropogateTag - indicating which way tags could flow over the relationships.\n\nThe way EntityDefs and RelationshipDefs are intended to be used is that EntityDefs will define AttributeDefs these AttributeDefs\nwill not specify an EntityDef type name as their types.\n\nRelationshipDefs introduce new atributes to the entity instances. For example\nEntityDef A might hav e attributes attr1,attr2,attr3\nEntityDef B might have attributes attr4,attr5,attr6\nRelationshipDef AtoB might define 2 ends\nend1: type A, name attr7\nend1: type B, name attr8\n\nWhen an instance of EntityDef A is created, it will have attributes attr1,attr2,attr3,attr7\nWhen an instance of EntityDef B is created, it will have attributes attr4,attr5,attr6,attr8\n\nIn this way relationshipDefs can be authored separately from entityDefs and can inject relationship attributes into\nthe entity instances" - } - , - "json_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" : "SINGLE", - "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" : "EQ", - "attributeValue" : "...", - "condition" : "AND", - "criterion" : [ { }, { } ] - }, - "tagFilters" : { - "attributeName" : "...", - "operator" : "EQ", - "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" : [ ] - }, - "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 - } ], - "referredEntities" : { - "property1" : { - "guid" : "...", - "status" : "DELETED", - "displayText" : "...", - "classificationNames" : [ "...", "..." ], - "typeName" : "...", - "attributes" : { - "property1" : { }, - "property2" : { } - } - }, - "property2" : { - "guid" : "...", - "status" : "DELETED", - "displayText" : "...", - "classificationNames" : [ "...", "..." ], - "typeName" : "...", - "attributes" : { - "property1" : { }, - "property2" : { } - } - } - } -}, - "description" : "" - } - , - "json_AtlasStruct" : { - "type" : "object", - "title" : "AtlasStruct", - "properties" : { - "typeName" : { -"description" : "", -"type" : "string" - }, - "attributes" : { -"description" : "", -"type" : "object", -"additionalProperties" : { - "type" : "object" -} - } - }, - "example" : { - "typeName" : "...", - "attributes" : { - "property1" : { }, - "property2" : { } - } -}, - "description" : "Captures details of struct contents. Not instantiated directly, used only via AtlasEntity, AtlasClassification." - } - , - "json_AtlasStructDef" : { - "type" : "object", - "title" : "AtlasStructDef", - "allOf" : [ - { - "$ref" : "#/definitions/json_AtlasBaseTypeDef" - }, - { - "properties" : { - "attributeDefs" : { -"description" : "", -"type" : "array", -"items" : { - "$ref" : "#/definitions/json_AtlasAttributeDef" -} - } - } - } - ], - "example" : { - "attributeDefs" : [ { - "name" : "...", - "typeName" : "...", - "isOptional" : true, - "cardinality" : "SINGLE", - "valuesMinCount" : 12345, - "valuesMaxCount" : 12345, - "isUnique" : true, - "isIndexable" : true, - "defaultValue" : "...", - "constraints" : [ { - "type" : "...", - "params" : { - "property1" : { }, - "property2" : { } - } - }, { - "type" : "...", - "params" : { - "property1" : { }, - "property2" : { } - } - } ] - }, { - "name" : "...", - "typeName" : "...", - "isOptional" : true, - "cardinality" : "SINGLE", - "valuesMinCount" : 12345, - "valuesMaxCount" : 12345, - "isUnique" : true, - "isIndexable" : true, - "defaultValue" : "...", - "constraints" : [ { - "type" : "...", - "params" : { - "property1" : { }, - "property2" : { } - } - }, { - "type" : "...", - "params" : { - "property1" : { }, - "property2" : { } } - } ] - } ], - "category" : "ENTITY", - "guid" : "...", - "createdBy" : "...", - "updatedBy" : "...", - "createTime" : 12345, - "updateTime" : 12345, - "version" : 12345, - "name" : "...", - "description" : "...", - "typeVersion" : "...", - "options" : { - "property1" : "...", - "property2" : "..." - } -}, - "description" : "class that captures details of a struct-type." - } - , - "json_AtlasTypeDefHeader" : { - "type" : "object", - "title" : "AtlasTypeDefHeader", - "properties" : { - "guid" : { -"description" : "", -"type" : "string" - }, - "name" : { -"description" : "", -"type" : "string" - }, - "category" : { -"description" : "", -"$ref" : "#/definitions/json_TypeCategory" - } - }, - "example" : { - "guid" : "...", - "name" : "...", - "category" : "ENTITY" -}, - "description" : "" - } - , - "json_AtlasTypesDef" : { - "type" : "object", - "title" : "AtlasTypesDef", - "properties" : { - "enumDefs" : { -"description" : "", -"type" : "array", -"items" : { - "$ref" : "#/definitions/json_AtlasEnumDef" -} - }, - "structDefs" : { -"description" : "", -"type" : "array", -"items" : { - "$ref" : "#/definitions/json_AtlasStructDef" -} - }, - "classificationDefs" : { -"description" : "", -"type" : "array", -"items" : { - "$ref" : "#/definitions/json_AtlasClassificationDef" -} - }, - "entityDefs" : { -"description" : "", -"type" : "array", -"items" : { - "$ref" : "#/definitions/json_AtlasEntityDef" -} - }, - "relationshipDefs" : { -"description" : "", -"type" : "array", -"items" : { - "$ref" : "#/definitions/json_AtlasRelationshipDef" -} - }, - "empty" : { -"description" : "", -"type" : "boolean" - } - }, - "example" : { - "enumDefs" : [ { - "elementDefs" : [ { - "value" : "...", - "description" : "...", - "ordinal" : 12345 - }, { - "value" : "...", - "description" : "...", - "ordinal" : 12345 - } ], - "defaultValue" : "...", - "category" : "MAP", - "guid" : "...", - "createdBy" : "...", - "updatedBy" : "...", - "createTime" : 12345, - "updateTime" : 12345, - "version" : 12345, - "name" : "...", - "description" : "...", - "typeVersion" : "...", - "options" : { - "property1" : "...", - "property2" : "..." - } - }, { - "elementDefs" : [ { - "value" : "...", - "description" : "...", - "ordinal" : 12345 - }, { - "value" : "...", - "description" : "...", - "ordinal" : 12345 - } ], - "defaultValue" : "...", - "category" : "OBJECT_ID_TYPE", - "guid" : "...", - "createdBy" : "...", - "updatedBy" : "...", - "createTime" : 12345, - "updateTime" : 12345, - "version" : 12345, - "name" : "...", - "description" : "...", - "typeVersion" : "...", - "options" : { - "property1" : "...", - "property2" : "..." - } - } ], - "structDefs" : [ { - "attributeDefs" : [ { - "name" : "...", - "typeName" : "...", - "isOptional" : true, - "cardinality" : "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" : "MAP", - "guid" : "...", - "createdBy" : "...", - "updatedBy" : "...", - "createTime" : 12345, - "updateTime" : 12345, - "version" : 12345, - "name" : "...", - "description" : "...", - "typeVersion" : "...", - "options" : { - "property1" : "...", - "property2" : "..." - } - }, { - "attributeDefs" : [ { - "name" : "...", - "typeName" : "...", - "isOptional" : true, - "cardinality" : "SET", - "valuesMinCount" : 12345, - "valuesMaxCount" : 12345, - "isUnique" : true, - "isIndexable" : true, - "defaultValue" : "...", - "constraints" : [ { }, { } ] - }, { - "name" : "...", - "typeName" : "...", - "isOptional" : true, - "cardinality" : "LIST", - "valuesMinCount" : 12345, - "valuesMaxCount" : 12345, - "isUnique" : true, - "isIndexable" : true, - "defaultValue" : "...", - "constraints" : [ { }, { } ] - } ], - "category" : "PRIMITIVE", - "guid" : "...", - "createdBy" : "...", - "updatedBy" : "...", - "createTime" : 12345, - "updateTime" : 12345, - "version" : 12345, - "name" : "...", - "description" : "...", - "typeVersion" : "...", - "options" : { - "property1" : "...", - "property2" : "..." - } - } ], - "classificationDefs" : [ { - "superTypes" : [ "...", "..." ], - "attributeDefs" : [ { - "name" : "...", - "typeName" : "...", - "isOptional" : true, - "cardinality" : "LIST", - "valuesMinCount" : 12345, - "valuesMaxCount" : 12345, - "isUnique" : true, - "isIndexable" : true, - "defaultValue" : "...", - "constraints" : [ { }, { } ] - }, { - "name" : "...", - "typeName" : "...", - "isOptional" : true, - "cardinality" : "SINGLE", - "valuesMinCount" : 12345, - "valuesMaxCount" : 12345, - "isUnique" : true, - "isIndexable" : true, - "defaultValue" : "...", - "constraints" : [ { }, { } ] - } ], - "category" : "PRIMITIVE", - "guid" : "...", - "createdBy" : "...", - "updatedBy" : "...", - "createTime" : 12345, - "updateTime" : 12345, - "version" : 12345, - "name" : "...", - "description" : "...", - "typeVersion" : "...", - "options" : { - "property1" : "...", - "property2" : "..." - } - }, { - "superTypes" : [ "...", "..." ], - "attributeDefs" : [ { - "name" : "...", - "typeName" : "...", - "isOptional" : true, - "cardinality" : "LIST", - "valuesMinCount" : 12345, - "valuesMaxCount" : 12345, - "isUnique" : true, - "isIndexable" : true, - "defaultValue" : "...", - "constraints" : [ { }, { } ] - }, { - "name" : "...", - "typeName" : "...", - "isOptional" : true, - "cardinality" : "SINGLE", - "valuesMinCount" : 12345, - "valuesMaxCount" : 12345, - "isUnique" : true, - "isIndexable" : true, - "defaultValue" : "...", - "constraints" : [ { }, { } ] - } ], - "category" : "ARRAY", - "guid" : "...", - "createdBy" : "...", - "updatedBy" : "...", - "createTime" : 12345, - "updateTime" : 12345, - "version" : 12345, - "name" : "...", - "description" : "...", - "typeVersion" : "...", - "options" : { - "property1" : "...", - "property2" : "..." - } - } ], - "entityDefs" : [ { - "superTypes" : [ "...", "..." ], - "attributeDefs" : [ { - "name" : "...", - "typeName" : "...", - "isOptional" : true, - "cardinality" : "LIST", - "valuesMinCount" : 12345, - "valuesMaxCount" : 12345, - "isUnique" : true, - "isIndexable" : true, - "defaultValue" : "...", - "constraints" : [ { }, { } ] - }, { - "name" : "...", - "typeName" : "...", - "isOptional" : true, - "cardinality" : "LIST", - "valuesMinCount" : 12345, - "valuesMaxCount" : 12345, - "isUnique" : true, - "isIndexable" : true, - "defaultValue" : "...", - "constraints" : [ { }, { } ] - } ], - "category" : "ARRAY", - "guid" : "...", - "createdBy" : "...", - "updatedBy" : "...", - "createTime" : 12345, - "updateTime" : 12345, - "version" : 12345, - "name" : "...", - "description" : "...", - "typeVersion" : "...", - "options" : { - "property1" : "...", - "property2" : "..." - } - }, { - "superTypes" : [ "...", "..." ], - "attributeDefs" : [ { - "name" : "...", - "typeName" : "...", - "isOptional" : true, - "cardinality" : "SET", - "valuesMinCount" : 12345, - "valuesMaxCount" : 12345, - "isUnique" : true, - "isIndexable" : true, - "defaultValue" : "...", - "constraints" : [ { }, { } ] - }, { - "name" : "...", - "typeName" : "...", - "isOptional" : true, - "cardinality" : "SINGLE", - "valuesMinCount" : 12345, - "valuesMaxCount" : 12345, - "isUnique" : true, - "isIndexable" : true, - "defaultValue" : "...", - "constraints" : [ { }, { } ] - } ], - "category" : "STRUCT", - "guid" : "...", - "createdBy" : "...", - "updatedBy" : "...", - "createTime" : 12345, - "updateTime" : 12345, - "version" : 12345, - "name" : "...", - "description" : "...", - "typeVersion" : "...", - "options" : { - "property1" : "...", - "property2" : "..." - } - } ], - "relationshipDefs" : [ { - "relationshipCategory" : "AGGREGATION", - "propagateTags" : "BOTH", - "endDef1" : { - "type" : "...", - "name" : "...", - "isContainer" : true, - "cardinality" : "SET", - "isLegacyAttribute" : true - }, - "endDef2" : { - "type" : "...", - "name" : "...", - "isContainer" : true, - "cardinality" : "SINGLE", - "isLegacyAttribute" : true - }, - "relationshipLabel" : "...", - "attributeDefs" : [ { - "name" : "...", - "typeName" : "...", - "isOptional" : true, - "cardinality" : "SINGLE", - "valuesMinCount" : 12345, - "valuesMaxCount" : 12345, - "isUnique" : true, - "isIndexable" : true, - "defaultValue" : "...", - "constraints" : [ { }, { } ] - }, { - "name" : "...", - "typeName" : "...", - "isOptional" : true, - "cardinality" : "SET", - "valuesMinCount" : 12345, - "valuesMaxCount" : 12345, - "isUnique" : true, - "isIndexable" : true, - "defaultValue" : "...", - "constraints" : [ { }, { } ] - } ], - "category" : "ENUM", - "guid" : "...", - "createdBy" : "...", - "updatedBy" : "...", - "createTime" : 12345, - "updateTime" : 12345, - "version" : 12345, - "name" : "...", - "description" : "...", - "typeVersion" : "...", - "options" : { - "property1" : "...", - "property2" : "..." - } - }, { - "relationshipCategory" : "ASSOCIATION", - "propagateTags" : "ONE_TO_TWO", - "endDef1" : { - "type" : "...", - "name" : "...", - "isContainer" : true, - "cardinality" : "LIST", - "isLegacyAttribute" : true - }, - "endDef2" : { - "type" : "...", - "name" : "...", - "isContainer" : true, - "cardinality" : "SET", - "isLegacyAttribute" : true - }, - "relationshipLabel" : "...", - "attributeDefs" : [ { - "name" : "...", - "typeName" : "...", - "isOptional" : true, - "cardinality" : "LIST", - "valuesMinCount" : 12345, - "valuesMaxCount" : 12345, - "isUnique" : true, - "isIndexable" : true, - "defaultValue" : "...", - "constraints" : [ { }, { } ] - }, { - "name" : "...", - "typeName" : "...", - "isOptional" : true, - "cardinality" : "SINGLE", - "valuesMinCount" : 12345, - "valuesMaxCount" : 12345, - "isUnique" : true, - "isIndexable" : true, - "defaultValue" : "...", - "constraints" : [ { }, { } ] - } ], - "category" : "OBJECT_ID_TYPE", - "guid" : "...", - "createdBy" : "...", - "updatedBy" : "...", - "createTime" : 12345, - "updateTime" : 12345, - "version" : 12345, - "name" : "...", - "description" : "...", - "typeVersion" : "...", - "options" : { - "property1" : "...", - "property2" : "..." - } - } ], - "empty" : true -}, - "description" : "" - } - , - "json_AttributeSearchResult" : { - "type" : "object", - "title" : "AttributeSearchResult", - "properties" : { - "name" : { -"description" : "", -"type" : "array", -"items" : { - "type" : "string" -} - }, - "values" : { -"description" : "", -"type" : "array", -"items" : { - "type" : "object" -} - } - }, - "example" : { - "name" : [ "...", "..." ], - "values" : [ ] -}, - "description" : "" - } - , - "json_Cardinality" : { - "type" : "string", - "title" : "Cardinality", - "enum" : [ - "SINGLE", - "LIST", - "SET" - ], - "description" : "single-valued attribute or multi-valued attribute." - } - , - "json_ClassificationAssociateRequest" : { - "type" : "object", - "title" : "ClassificationAssociateRequest", - "properties" : { - "classification" : { -"description" : "", -"$ref" : "#/definitions/json_AtlasClassification" - }, - "entityGuids" : { -"description" : "", -"type" : "array", -"items" : { - "type" : "string" -} - } - }, - "example" : { - "classification" : { - "typeName" : "...", - "attributes" : { - "property1" : { }, - "property2" : { } - } - }, - "entityGuids" : [ "...", "..." ] -}, - "description" : "" - } - , - "json_Condition" : { - "type" : "string", - "title" : "Condition", - "enum" : [ - "AND", - "OR" - ], - "description" : "" - } - , - "json_EntityMutationResponse" : { - "type" : "object", - "title" : "EntityMutationResponse", - "properties" : { - "mutatedEntities" : { -"description" : "", -"type" : "object", -"additionalProperties" : { -"type" : "array", -"items" : { - "$ref" : "#/definitions/json_AtlasEntityHeader" -} -} - }, - "guidAssignments" : { -"description" : "", -"type" : "object", -"additionalProperties" : { - "type" : "string" -} - }, - "createdEntities" : { -"description" : "", -"type" : "array", -"items" : { - "$ref" : "#/definitions/json_AtlasEntityHeader" -} - }, - "updatedEntities" : { -"description" : "", -"type" : "array", -"items" : { - "$ref" : "#/definitions/json_AtlasEntityHeader" -} - }, - "partialUpdatedEntities" : { -"description" : "", -"type" : "array", -"items" : { - "$ref" : "#/definitions/json_AtlasEntityHeader" -} - }, - "deletedEntities" : { -"description" : "", -"type" : "array", -"items" : { - "$ref" : "#/definitions/json_AtlasEntityHeader" -} - }, - "firstEntityCreated" : { -"description" : "", -"$ref" : "#/definitions/json_AtlasEntityHeader" - }, - "firstEntityUpdated" : { -"description" : "", -"$ref" : "#/definitions/json_AtlasEntityHeader" - }, - "firstEntityPartialUpdated" : { -"description" : "", -"$ref" : "#/definitions/json_AtlasEntityHeader" - } - }, - "example" : { - "mutatedEntities" : { - "property1" : [ { - "guid" : "...", - "status" : "DELETED", - "displayText" : "...", - "classificationNames" : [ "...", "..." ], - "typeName" : "...", - "attributes" : { - "property1" : { }, - "property2" : { } - } - }, { - "guid" : "...", - "status" : "ACTIVE", - "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" : "ACTIVE", - "displayText" : "...", - "classificationNames" : [ "...", "..." ], - "typeName" : "...", - "attributes" : { - "property1" : { }, - "property2" : { } - } - } ], - "partialUpdatedEntities" : [ { - "guid" : "...", - "status" : "DELETED", - "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" : "ACTIVE", - "displayText" : "...", - "classificationNames" : [ "...", "..." ], - "typeName" : "...", - "attributes" : { - "property1" : { }, - "property2" : { } - } - } ], - "firstEntityCreated" : { - "guid" : "...", - "status" : "DELETED", - "displayText" : "...", - "classificationNames" : [ "...", "..." ], - "typeName" : "...", - "attributes" : { - "property1" : { }, - "property2" : { } - } - }, - "firstEntityUpdated" : { - "guid" : "...", - "status" : "ACTIVE", - "displayText" : "...", - "classificationNames" : [ "...", "..." ], - "typeName" : "...", - "attributes" : { - "property1" : { }, - "property2" : { } - } - }, - "firstEntityPartialUpdated" : { - "guid" : "...", - "status" : "ACTIVE", - "displayText" : "...", - "classificationNames" : [ "...", "..." ], - "typeName" : "...", - "attributes" : { - "property1" : { }, - "property2" : { } - } - } -}, - "description" : "" - } - , - "json_EntityOperation" : { - "type" : "string", - "title" : "EntityOperation", - "enum" : [ - "CREATE", - "UPDATE", - "PARTIAL_UPDATE", - "DELETE" - ], - "description" : "" - } - , - "json_FilterCriteria" : { - "type" : "object", - "title" : "FilterCriteria", - "properties" : { - "attributeName" : { -"description" : "", -"type" : "string" - }, - "operator" : { -"description" : "", -"$ref" : "#/definitions/json_Operator" - }, - "attributeValue" : { -"description" : "", -"type" : "string" - }, - "condition" : { -"description" : "", -"$ref" : "#/definitions/json_Condition" - }, - "criterion" : { -"description" : "", -"type" : "array", -"items" : { - "$ref" : "#/definitions/json_FilterCriteria" -} - } - }, - "example" : { - "attributeName" : "...", - "operator" : "LTE", - "attributeValue" : "...", - "condition" : "OR", - "criterion" : [ { - "attributeName" : "...", - "operator" : "LT", - "attributeValue" : "...", - "condition" : "AND", - "criterion" : [ { }, { } ] - }, { - "attributeName" : "...", - "operator" : "ENDS_WITH", - "attributeValue" : "...", - "condition" : "OR", - "criterion" : [ { }, { } ] - } ] -}, - "description" : "" - } - , - "json_LineageDirection" : { - "type" : "string", - "title" : "LineageDirection", - "enum" : [ - "INPUT", - "OUTPUT", - "BOTH" - ], - "description" : "" - } - , - "json_LineageRelation" : { - "type" : "object", - "title" : "LineageRelation", - "properties" : { - "fromEntityId" : { -"description" : "", -"type" : "string" - }, - "toEntityId" : { -"description" : "", -"type" : "string" - } - }, - "example" : { - "fromEntityId" : "...", - "toEntityId" : "..." -}, - "description" : "" - } - , - "json_Operator" : { - "type" : "string", - "title" : "Operator", - "enum" : [ - "LT", - "GT", - "LTE", - "GTE", - "EQ", - "NEQ", - "IN", - "LIKE", - "STARTS_WITH", - "ENDS_WITH", - "CONTAINS" - ], - "description" : "Supported search operations\nLogical comparision operators can only be used with numbers or dates\nIN, LIKE, startsWith, endsWith, CONTAINS can only be used with strings or text" - } - , - "json_PList" : { - "type" : "object", - "title" : "PList", - "properties" : { - "list" : { -"description" : "", -"type" : "array", -"items" : { - "type" : "object" -} - }, - "startIndex" : { -"description" : "", -"type" : "number" - }, - "pageSize" : { -"description" : "", -"type" : "number" - }, - "totalCount" : { -"description" : "", -"type" : "number" - }, - "sortType" : { -"description" : "", -"$ref" : "#/definitions/json_SortType" - }, - "sortBy" : { -"description" : "", -"type" : "string" - } - }, - "example" : { - "list" : [ { }, { } ], - "startIndex" : 12345, - "pageSize" : 12345, - "totalCount" : 12345, - "sortType" : "NONE", - "sortBy" : "..." -}, - "description" : "Paginated-list, for returning search results." - } - , - "json_PropagateTags" : { - "type" : "string", - "title" : "PropagateTags", - "enum" : [ - "NONE", - "ONE_TO_TWO", - "TWO_TO_ONE", - "BOTH" - ], - "description" : "PropagateTags indicates whether tags should propagate across the relationship instance.\nTags can propagate:\nNONE - not at all\nONE_TO_TWO - from end 1 to 2\nTWO_TO_ONE - from end 2 to 1\nBOTH - both ways\n\nCare needs to be taken when specifying. The use cases we are aware of where this flag is useful:\n\n- propagating confidentiality classifications from a table to columns - ONE_TO_TWO could be used here\n- propagating classifications around Glossary synonyms - BOTH could be used here.\n\nThere is an expectation that further enhancements will allow more granular control of tag propagation and will\naddress how to resolve conflicts." - } - , - "json_RelationshipCategory" : { - "type" : "string", - "title" : "RelationshipCategory", - "enum" : [ - "ASSOCIATION", - "AGGREGATION", - "COMPOSITION" - ], - "description" : "The Relationship category determines the style of relationship around containment and lifecycle.\nUML terminology is used for the values.\nASSOCIATION is a relationship with no containment.\nCOMPOSITION and AGGREGATION are containment relationships.\nThe difference being in the lifecycles of the container and its children. In the COMPOSITION case,\nthe children cannot exist without the container. For AGGREGATION, the life cycles\nof the container and children are totally independant." - } - , - "json_SearchParameters" : { - "type" : "object", - "title" : "SearchParameters", - "properties" : { - "query" : { -"description" : "", -"type" : "string" - }, - "typeName" : { -"description" : "", -"type" : "string" - }, - "classification" : { -"description" : "", -"type" : "string" - }, - "excludeDeletedEntities" : { -"description" : "", -"type" : "boolean" - }, - "limit" : { -"description" : "", -"type" : "number" - }, - "offset" : { -"description" : "", -"type" : "number" - }, - "entityFilters" : { -"description" : "Entity attribute filters for the type (if type name is specified)", -"$ref" : "#/definitions/json_FilterCriteria" - }, - "tagFilters" : { -"description" : "Tag attribute filters for the classification/tag (if tag name is specified)", -"$ref" : "#/definitions/json_FilterCriteria" - }, - "attributes" : { -"description" : "Attribute values included in the results", -"type" : "array", -"items" : { - "type" : "string" -} - } - }, - "example" : { - "query" : "...", - "typeName" : "...", - "classification" : "...", - "excludeDeletedEntities" : true, - "limit" : 12345, - "offset" : 12345, - "entityFilters" : { - "attributeName" : "...", - "operator" : "GTE", - "attributeValue" : "...", - "condition" : "AND", - "criterion" : [ { }, { } ] - }, - "tagFilters" : { - "attributeName" : "...", - "operator" : "STARTS_WITH", - "attributeValue" : "...", - "condition" : "AND", - "criterion" : [ { }, { } ] - }, - "attributes" : [ "...", "..." ] -}, - "description" : "" - } - , - "json_SortType" : { - "type" : "string", - "title" : "SortType", - "enum" : [ - "NONE", - "ASC", - "DESC" - ], - "description" : "to specify whether the result should be sorted? If yes, whether asc or desc." - } - , - "json_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." - } - , - "json_Status_AtlasRelationship" : { - "type" : "string", - "title" : "Status", - "enum" : [ - "ACTIVE", - "DELETED" - ], - "description" : "" - } - , - "json_TypeCategory" : { - "type" : "string", - "title" : "TypeCategory", - "enum" : [ - "PRIMITIVE", - "OBJECT_ID_TYPE", - "ENUM", - "STRUCT", - "CLASSIFICATION", - "ENTITY", - "ARRAY", - "MAP", - "RELATIONSHIP" - ], - "description" : "" - } - , - "xml_ns0_PList" : { - "type" : "object", - "title" : "PList", - "allOf" : [ - { - "properties" : { - "list" : { - "xml" : { - "namespace" : "" - }, -"description" : "", -"type" : "object" - }, - "pageSize" : { - "xml" : { - "namespace" : "" - }, -"description" : "", -"type" : "number" - }, - "sortBy" : { - "xml" : { - "namespace" : "" - }, -"description" : "", -"type" : "string" - }, - "sortType" : { - "xml" : { - "namespace" : "" - }, -"description" : "", -"$ref" : "#/definitions/xml_ns0_sortType" - }, - "startIndex" : { - "xml" : { - "namespace" : "" - }, -"description" : "", -"type" : "number" - }, - "totalCount" : { - "xml" : { - "namespace" : "" - }, -"description" : "", -"type" : "number" - } - } - } - ], - "description" : "Paginated-list, for returning search results." - } - , - "xml_ns0_searchFilter" : { - "type" : "object", - "title" : "searchFilter", - "allOf" : [ - { - "properties" : { - "getCount" : { - "xml" : { - "namespace" : "" - }, -"description" : "", -"type" : "boolean" - }, - "maxRows" : { - "xml" : { - "namespace" : "" - }, -"description" : "", -"type" : "number" - }, - "params" : { - "xml" : { - "namespace" : "" - }, -"description" : "", -"type" : "object" - }, - "sortBy" : { - "xml" : { - "namespace" : "" - }, -"description" : "", -"type" : "string" - }, - "sortType" : { - "xml" : { - "namespace" : "" - }, -"description" : "", -"$ref" : "#/definitions/xml_ns0_sortType" - }, - "startIndex" : { - "xml" : { - "namespace" : "" - }, -"description" : "", -"type" : "number" - } - } - } - ], - "description" : "Generic filter, to specify search criteria using name/value pairs." - } - , - "xml_ns0_sortType" : { - "type" : "string", - "title" : "sortType", - "enum" : [ - "NONE", - "ASC", - "DESC" - ], - "description" : "to specify whether the result should be sorted? If yes, whether asc or desc." - } - , - "xml_ns0_atlasClassification" : { - "type" : "object", - "title" : "atlasClassification", - "allOf" : [ - { - "$ref" : "#/definitions/xml_ns0_atlasStruct" - }, - { + , + "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", + "operationId" : "createOrUpdate", + "consumes" : [ "application/json;charset=UTF-8" ], + "produces" : [ "application/json;charset=UTF-8" ], + "parameters" : [ + { + "name" : "body", + "in" : "body", + "type" : "file", + "description" : "" + } + ], + "responses" : { + "201" : { + "description" : "" + } } - ], - "description" : "An instance of a classification; it doesn't have an identity, this object exists only when associated with an entity." + } } , - "xml_ns0_atlasStruct" : { - "type" : "object", - "title" : "atlasStruct", - "allOf" : [ - { - "properties" : { - "attributes" : { - "xml" : { - "namespace" : "" - }, -"description" : "", -"type" : "object" + "\/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" : "addClassification", + "consumes" : [ "application/json", "application/json;charset=UTF-8" ], + "parameters" : [ + { + "name" : "body", + "in" : "body", + "schema" : { +"$ref" : "#/definitions/json_ClassificationAssociateRequest" }, - "typeName" : { - "xml" : { - "namespace" : "" - }, -"description" : "", -"type" : "string" - } + "description" : "" + } + ], + "responses" : { + "201" : { + "description" : "Success" } } - ], - "description" : "Captures details of struct contents. Not instantiated directly, used only via AtlasEntity, AtlasClassification." + } } - }, - "paths": { - "\/v2/search/attribute" : { - "get" : { - "tags" : [ "DiscoveryREST" ], - "summary" : "Retrieve data for the specified attribute search query.", - "description" : "Retrieve data for the specified attribute search query", - "operationId" : "resource_DiscoveryREST_searchUsingAttribute_GET", + , + "\/v2/entity/guid/{guid}" : { + "delete" : { + "tags" : [ "EntityREST" ], + "summary" : "Delete an entity identified by its GUID.", + "description" : "Delete an entity identified by its GUID.", + "operationId" : "deleteByGuid", "produces" : [ "application/json;charset=UTF-8" ], "parameters" : [ { - "name" : "attrName", - "in" : "query", - "type" : "string", - "description" : "Attribute name" - }, - { - "name" : "attrValuePrefix", - "in" : "query", + "name" : "guid", + "in" : "path", + "required" : true, "type" : "string", - "description" : "Attibute value to search on" - }, - { - "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)" - }, + "description" : "GUID for the entity" + } + ], + "responses" : { + "204" : { + "description" : "EntityMutationResponse" + } + } + } + , + "get" : { + "tags" : [ "EntityREST" ], + "summary" : "Fetch complete definition of an entity given its GUID.", + "description" : "Fetch complete definition of an entity given its GUID.", + "operationId" : "getById", + "produces" : [ "application/json;charset=UTF-8" ], + "parameters" : [ { - "name" : "typeName", - "in" : "query", + "name" : "guid", + "in" : "path", + "required" : true, "type" : "string", - "description" : "limit the result to only entities of specified type or its sub-types" + "description" : "GUID for the entity" } ], "responses" : { "200" : { - "schema" : { -"description" : "", -"$ref" : "#/definitions/json_AtlasSearchResult" - }, - "headers" : { - }, - "examples" : { - "application/json" : { - "queryType" : "FULL_TEXT", - "searchParameters" : { - "query" : "...", - "typeName" : "...", - "classification" : "...", - "excludeDeletedEntities" : true, - "limit" : 12345, - "offset" : 12345, - "entityFilters" : { - "attributeName" : "...", - "operator" : "LIKE", - "attributeValue" : "...", - "condition" : "OR", - "criterion" : [ { }, { } ] - }, - "tagFilters" : { - "attributeName" : "...", - "operator" : "NEQ", - "attributeValue" : "...", - "condition" : "OR", - "criterion" : [ { }, { } ] - }, - "attributes" : [ "...", "..." ] - }, - "queryText" : "...", - "type" : "...", - "classification" : "...", - "entities" : [ { - "guid" : "...", - "status" : "ACTIVE", - "displayText" : "...", - "classificationNames" : [ "...", "..." ], - "typeName" : "...", - "attributes" : { - "property1" : { }, - "property2" : { } - } - }, { - "guid" : "...", - "status" : "ACTIVE", - "displayText" : "...", - "classificationNames" : [ "...", "..." ], - "typeName" : "...", - "attributes" : { - "property1" : { }, - "property2" : { } - } - } ], - "attributes" : { - "name" : [ "...", "..." ], - "values" : [ ] - }, - "fullTextResult" : [ { - "entity" : { - "guid" : "...", - "status" : "DELETED", - "displayText" : "...", - "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" : "ACTIVE", - "displayText" : "...", - "classificationNames" : [ "...", "..." ], - "typeName" : "...", - "attributes" : { - "property1" : { }, - "property2" : { } - } - }, - "property2" : { - "guid" : "...", - "status" : "DELETED", - "displayText" : "...", - "classificationNames" : [ "...", "..." ], - "typeName" : "...", - "attributes" : { - "property1" : { }, - "property2" : { } - } - } - } -} - }, - "description" : "On successful FullText lookup with some results, might return an empty list if execution succeeded\nwithout any results" - }, - "400" : { - "headers" : { - }, - "examples" : { - "application/json" : { - "queryType" : "GREMLIN", - "searchParameters" : { - "query" : "...", - "typeName" : "...", - "classification" : "...", - "excludeDeletedEntities" : true, - "limit" : 12345, - "offset" : 12345, - "entityFilters" : { - "attributeName" : "...",
<TRUNCATED>
