http://git-wip-us.apache.org/repos/asf/incubator-atlas-website/blob/b4557f9c/0.8.0-incubating/api/v2/ui/swagger.json ---------------------------------------------------------------------- diff --git a/0.8.0-incubating/api/v2/ui/swagger.json b/0.8.0-incubating/api/v2/ui/swagger.json new file mode 100644 index 0000000..901b864 --- /dev/null +++ b/0.8.0-incubating/api/v2/ui/swagger.json @@ -0,0 +1,7539 @@ +{ + "swagger": "2.0", + "info" : { + "description" : "Atlas exposes a variety of REST endpoints to work with types, entities, lineage and data discovery.", + "license" : { + "url" : "http://www.apache.org/licenses/LICENSE-2.0.txt";, + "name" : "The Apache Software License, Version 2.0" + }, + "version" : "0.9-incubating-SNAPSHOT", + "title" : "Atlas REST API" + }, + "host" : "localhost:21000", + "basePath" : "/api/atlas/", + "schemes" : [], + "tags" : [ + { + "name" : "DiscoveryREST" + , + "description" : "REST interface for data discovery using dsl or full text search." + } + , + { + "name" : "EntityREST" + , + "description" : "REST for a single entity." + } + , + { + "name" : "LineageREST" + , + "description" : "REST interface for an entity's lineage information." + } + , + { + "name" : "TypesREST" + , + "description" : "REST interface for CRUD operations on type definitions." + } + ], + "definitions" : { + "json_AtlasAttributeDef" : { + "type" : "object", + "title" : "AtlasAttributeDef", + "properties" : { + "name" : { +"description" : "", +"type" : "string" + }, + "typeName" : { +"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" : { +"description" : "", +"type" : "boolean" + }, + "constraints" : { +"description" : "", +"type" : "array", +"items" : { + "$ref" : "#/definitions/json_AtlasConstraintDef" +} + } + }, + "example" : { + "name" : "...", + "typeName" : "...", + "isOptional" : true, + "cardinality" : "LIST", + "valuesMinCount" : 12345, + "valuesMaxCount" : 12345, + "isUnique" : true, + "isIndexable" : true, + "constraints" : [ { + "type" : "...", + "params" : { + "property1" : { }, + "property2" : { } + } + }, { + "type" : "...", + "params" : { + "property1" : { }, + "property2" : { } + } + } ] +}, + "description" : "Details of a struct-attribute." + } + , + "json_AtlasBaseTypeDef" : { + "type" : "object", + "title" : "AtlasBaseTypeDef", + "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" : { +"description" : "", +"type" : "string" + }, + "options" : { +"description" : "", +"type" : "object", +"additionalProperties" : { + "type" : "string" +} + } + }, + "example" : { + "category" : "MAP", + "guid" : "...", + "createdBy" : "...", + "updatedBy" : "...", + "createTime" : 12345, + "updateTime" : 12345, + "version" : 12345, + "name" : "...", + "description" : "...", + "typeVersion" : "...", + "options" : { + "property1" : "...", + "property2" : "..." + } +}, + "description" : "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." + } + , + "json_AtlasClassificationDef" : { + "type" : "object", + "title" : "AtlasClassificationDef", + "allOf" : [ + { + "$ref" : "#/definitions/json_AtlasStructDef" + }, + { + "properties" : { + "superTypes" : { +"description" : "", +"type" : "array", +"items" : { + "type" : "string" +} + } + } + } + ], + "example" : { + "superTypes" : [ "...", "..." ], + "attributeDefs" : [ { + "name" : "...", + "typeName" : "...", + "isOptional" : true, + "cardinality" : "SET", + "valuesMinCount" : 12345, + "valuesMaxCount" : 12345, + "isUnique" : true, + "isIndexable" : true, + "constraints" : [ { + "type" : "...", + "params" : { + "property1" : { }, + "property2" : { } + } + }, { + "type" : "...", + "params" : { + "property1" : { }, + "property2" : { } + } + } ] + }, { + "name" : "...", + "typeName" : "...", + "isOptional" : true, + "cardinality" : "SINGLE", + "valuesMinCount" : 12345, + "valuesMaxCount" : 12345, + "isUnique" : true, + "isIndexable" : true, + "constraints" : [ { + "type" : "...", + "params" : { + "property1" : { }, + "property2" : { } + } + }, { + "type" : "...", + "params" : { + "property1" : { }, + "property2" : { } + } + } ] + } ], + "category" : "ARRAY", + "guid" : "...", + "createdBy" : "...", + "updatedBy" : "...", + "createTime" : 12345, + "updateTime" : 12345, + "version" : 12345, + "name" : "...", + "description" : "...", + "typeVersion" : "...", + "options" : { + "property1" : "...", + "property2" : "..." + } +}, + "description" : "Details of a classification-type." + } + , + "json_AtlasClassifications" : { + "type" : "object", + "title" : "AtlasClassifications", + "allOf" : [ + { + "$ref" : "#/definitions/json_PList" + }, + { + } + ], + "example" : { + "list" : [ { }, { } ], + "startIndex" : 12345, + "pageSize" : 12345, + "totalCount" : 12345, + "sortType" : "NONE", + "sortBy" : "..." +}, + "description" : "REST serialization friendly list." + } + , + "json_AtlasConstraintDef" : { + "type" : "object", + "title" : "AtlasConstraintDef", + "properties" : { + "type" : { +"description" : "", +"type" : "string" + }, + "params" : { +"description" : "", +"type" : "object", +"additionalProperties" : { + "type" : "object" +} + } + }, + "example" : { + "type" : "...", + "params" : { + "property1" : { }, + "property2" : { } + } +}, + "description" : "Details of a constraint." + } + , + "json_AtlasEntitiesWithExtInfo" : { + "type" : "object", + "title" : "AtlasEntitiesWithExtInfo", + "allOf" : [ + { + "$ref" : "#/definitions/json_AtlasEntityExtInfo" + }, + { + "properties" : { + "entities" : { +"description" : "", +"type" : "array", +"items" : { + "$ref" : "#/definitions/json_AtlasEntity" +} + } + } + } + ], + "example" : { + "entities" : [ { + "guid" : "...", + "status" : "DELETED", + "createdBy" : "...", + "updatedBy" : "...", + "createTime" : 12345, + "updateTime" : 12345, + "version" : 12345, + "classifications" : [ { + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + }, { + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + } ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + }, { + "guid" : "...", + "status" : "DELETED", + "createdBy" : "...", + "updatedBy" : "...", + "createTime" : 12345, + "updateTime" : 12345, + "version" : 12345, + "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, + "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, + "classifications" : [ { + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + }, { + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + } ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + } + } +}, + "description" : "List of Atlas entity along with the referred entities" + } + , + "json_AtlasEntity" : { + "type" : "object", + "title" : "AtlasEntity", + "allOf" : [ + { + "$ref" : "#/definitions/json_AtlasStruct" + }, + { + "properties" : { + "guid" : { +"description" : "", +"type" : "string" + }, + "status" : { +"description" : "", +"$ref" : "#/definitions/json_Status" + }, + "createdBy" : { +"description" : "", +"type" : "string" + }, + "updatedBy" : { +"description" : "", +"type" : "string" + }, + "createTime" : { +"description" : "", +"type" : "number" + }, + "updateTime" : { +"description" : "", +"type" : "number" + }, + "version" : { +"description" : "", +"type" : "number" + }, + "classifications" : { +"description" : "", +"type" : "array", +"items" : { + "$ref" : "#/definitions/json_AtlasClassification" +} + } + } + } + ], + "example" : { + "guid" : "...", + "status" : "ACTIVE", + "createdBy" : "...", + "updatedBy" : "...", + "createTime" : 12345, + "updateTime" : 12345, + "version" : 12345, + "classifications" : [ { + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + }, { + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + } ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } +}, + "description" : "Atlas entity representation" + } + , + "json_AtlasEntityDef" : { + "type" : "object", + "title" : "AtlasEntityDef", + "allOf" : [ + { + "$ref" : "#/definitions/json_AtlasStructDef" + }, + { + "properties" : { + "superTypes" : { +"description" : "", +"type" : "array", +"items" : { + "type" : "string" +} + } + } + } + ], + "example" : { + "superTypes" : [ "...", "..." ], + "attributeDefs" : [ { + "name" : "...", + "typeName" : "...", + "isOptional" : true, + "cardinality" : "SINGLE", + "valuesMinCount" : 12345, + "valuesMaxCount" : 12345, + "isUnique" : true, + "isIndexable" : true, + "constraints" : [ { + "type" : "...", + "params" : { + "property1" : { }, + "property2" : { } + } + }, { + "type" : "...", + "params" : { + "property1" : { }, + "property2" : { } + } + } ] + }, { + "name" : "...", + "typeName" : "...", + "isOptional" : true, + "cardinality" : "LIST", + "valuesMinCount" : 12345, + "valuesMaxCount" : 12345, + "isUnique" : true, + "isIndexable" : true, + "constraints" : [ { + "type" : "...", + "params" : { + "property1" : { }, + "property2" : { } + } + }, { + "type" : "...", + "params" : { + "property1" : { }, + "property2" : { } + } + } ] + } ], + "category" : "ARRAY", + "guid" : "...", + "createdBy" : "...", + "updatedBy" : "...", + "createTime" : 12345, + "updateTime" : 12345, + "version" : 12345, + "name" : "...", + "description" : "...", + "typeVersion" : "...", + "options" : { + "property1" : "...", + "property2" : "..." + } +}, + "description" : "Details of an entity-type." + } + , + "json_AtlasEntityExtInfo" : { + "type" : "object", + "title" : "AtlasEntityExtInfo", + "properties" : { + "referredEntities" : { +"description" : "", +"type" : "object", +"additionalProperties" : { + "$ref" : "#/definitions/json_AtlasEntity" +} + } + }, + "example" : { + "referredEntities" : { + "property1" : { + "guid" : "...", + "status" : "DELETED", + "createdBy" : "...", + "updatedBy" : "...", + "createTime" : 12345, + "updateTime" : 12345, + "version" : 12345, + "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, + "classifications" : [ { + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + }, { + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + } ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + } + } +}, + "description" : "Entity representation along with extended info which included the entities being referred to" + } + , + "json_AtlasEntityHeader" : { + "type" : "object", + "title" : "AtlasEntityHeader", + "allOf" : [ + { + "$ref" : "#/definitions/json_AtlasStruct" + }, + { + "properties" : { + "guid" : { +"description" : "", +"type" : "string" + }, + "status" : { +"description" : "", +"$ref" : "#/definitions/json_Status" + }, + "displayText" : { +"description" : "", +"type" : "string" + }, + "classificationNames" : { +"description" : "", +"type" : "array", +"items" : { + "type" : "string" +} + } + } + } + ], + "example" : { + "guid" : "...", + "status" : "ACTIVE", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } +}, + "description" : "An instance of an entity - like hive_table, hive_database." + } + , + "json_AtlasEntityWithExtInfo" : { + "type" : "object", + "title" : "AtlasEntityWithExtInfo", + "allOf" : [ + { + "$ref" : "#/definitions/json_AtlasEntityExtInfo" + }, + { + "properties" : { + "entity" : { +"description" : "", +"$ref" : "#/definitions/json_AtlasEntity" + } + } + } + ], + "example" : { + "entity" : { + "guid" : "...", + "status" : "ACTIVE", + "createdBy" : "...", + "updatedBy" : "...", + "createTime" : 12345, + "updateTime" : 12345, + "version" : 12345, + "classifications" : [ { + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + }, { + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + } ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + }, + "referredEntities" : { + "property1" : { + "guid" : "...", + "status" : "ACTIVE", + "createdBy" : "...", + "updatedBy" : "...", + "createTime" : 12345, + "updateTime" : 12345, + "version" : 12345, + "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, + "classifications" : [ { + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + }, { + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + } ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + } + } +}, + "description" : "Entity with information about the referred entities" + } + , + "json_AtlasEnumDef" : { + "type" : "object", + "title" : "AtlasEnumDef", + "allOf" : [ + { + "$ref" : "#/definitions/json_AtlasBaseTypeDef" + }, + { + "properties" : { + "elementDefs" : { +"description" : "", +"type" : "array", +"items" : { + "$ref" : "#/definitions/json_AtlasEnumElementDef" +} + }, + "defaultValue" : { +"description" : "", +"type" : "string" + } + } + } + ], + "example" : { + "elementDefs" : [ { + "value" : "...", + "description" : "...", + "ordinal" : 12345 + }, { + "value" : "...", + "description" : "...", + "ordinal" : 12345 + } ], + "defaultValue" : "...", + "category" : "ENTITY", + "guid" : "...", + "createdBy" : "...", + "updatedBy" : "...", + "createTime" : 12345, + "updateTime" : 12345, + "version" : 12345, + "name" : "...", + "description" : "...", + "typeVersion" : "...", + "options" : { + "property1" : "...", + "property2" : "..." + } +}, + "description" : "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" : "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" : "ACTIVE", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + }, + "score" : 12345.0 +}, + "description" : "Search results for FullText APIs" + } + , + "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" : "ACTIVE", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + } + }, + "relations" : [ { + "fromEntityId" : "...", + "toEntityId" : "..." + }, { + "fromEntityId" : "...", + "toEntityId" : "..." + } ], + "lineageDirection" : "OUTPUT", + "lineageDepth" : 12345 +}, + "description" : "Lineage information for a single entity" + } + , + "json_AtlasQueryType" : { + "type" : "string", + "title" : "AtlasQueryType", + "enum" : [ + "DSL", + "FULL_TEXT", + "GREMLIN", + "BASIC" + ], + "description" : "Various querying mechanisms supported by Atlas" + } + , + "json_AtlasSearchResult" : { + "type" : "object", + "title" : "AtlasSearchResult", + "properties" : { + "queryType" : { +"description" : "", +"$ref" : "#/definitions/json_AtlasQueryType" + }, + "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" +} + } + }, + "example" : { + "queryType" : "DSL", + "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" : "ACTIVE", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + }, + "score" : 12345.0 + }, { + "entity" : { + "guid" : "...", + "status" : "DELETED", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + }, + "score" : 12345.0 + } ] +}, + "description" : "Search results of the Discovery APIs" + } + , + "json_AtlasStruct" : { + "type" : "object", + "title" : "AtlasStruct", + "properties" : { + "typeName" : { +"description" : "", +"type" : "string" + }, + "attributes" : { +"description" : "", +"type" : "object", +"additionalProperties" : { + "type" : "object" +} + } + }, + "example" : { + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } +}, + "description" : "Details of a struct. 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, + "constraints" : [ { + "type" : "...", + "params" : { + "property1" : { }, + "property2" : { } + } + }, { + "type" : "...", + "params" : { + "property1" : { }, + "property2" : { } + } + } ] + }, { + "name" : "...", + "typeName" : "...", + "isOptional" : true, + "cardinality" : "SINGLE", + "valuesMinCount" : 12345, + "valuesMaxCount" : 12345, + "isUnique" : true, + "isIndexable" : true, + "constraints" : [ { + "type" : "...", + "params" : { + "property1" : { }, + "property2" : { } + } + }, { + "type" : "...", + "params" : { + "property1" : { }, + "property2" : { } + } + } ] + } ], + "category" : "STRUCT", + "guid" : "...", + "createdBy" : "...", + "updatedBy" : "...", + "createTime" : 12345, + "updateTime" : 12345, + "version" : 12345, + "name" : "...", + "description" : "...", + "typeVersion" : "...", + "options" : { + "property1" : "...", + "property2" : "..." + } +}, + "description" : "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" : "ARRAY" +}, + "description" : "Minimal set of information about a type definition" + } + , + "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" +} + }, + "empty" : { +"description" : "", +"type" : "boolean" + } + }, + "example" : { + "enumDefs" : [ { + "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" : "..." + } + }, { + "elementDefs" : [ { + "value" : "...", + "description" : "...", + "ordinal" : 12345 + }, { + "value" : "...", + "description" : "...", + "ordinal" : 12345 + } ], + "defaultValue" : "...", + "category" : "ARRAY", + "guid" : "...", + "createdBy" : "...", + "updatedBy" : "...", + "createTime" : 12345, + "updateTime" : 12345, + "version" : 12345, + "name" : "...", + "description" : "...", + "typeVersion" : "...", + "options" : { + "property1" : "...", + "property2" : "..." + } + } ], + "structDefs" : [ { + "attributeDefs" : [ { + "name" : "...", + "typeName" : "...", + "isOptional" : true, + "cardinality" : "LIST", + "valuesMinCount" : 12345, + "valuesMaxCount" : 12345, + "isUnique" : true, + "isIndexable" : true, + "constraints" : [ { }, { } ] + }, { + "name" : "...", + "typeName" : "...", + "isOptional" : true, + "cardinality" : "LIST", + "valuesMinCount" : 12345, + "valuesMaxCount" : 12345, + "isUnique" : true, + "isIndexable" : true, + "constraints" : [ { }, { } ] + } ], + "category" : "ARRAY", + "guid" : "...", + "createdBy" : "...", + "updatedBy" : "...", + "createTime" : 12345, + "updateTime" : 12345, + "version" : 12345, + "name" : "...", + "description" : "...", + "typeVersion" : "...", + "options" : { + "property1" : "...", + "property2" : "..." + } + }, { + "attributeDefs" : [ { + "name" : "...", + "typeName" : "...", + "isOptional" : true, + "cardinality" : "SINGLE", + "valuesMinCount" : 12345, + "valuesMaxCount" : 12345, + "isUnique" : true, + "isIndexable" : true, + "constraints" : [ { }, { } ] + }, { + "name" : "...", + "typeName" : "...", + "isOptional" : true, + "cardinality" : "SET", + "valuesMinCount" : 12345, + "valuesMaxCount" : 12345, + "isUnique" : true, + "isIndexable" : true, + "constraints" : [ { }, { } ] + } ], + "category" : "ARRAY", + "guid" : "...", + "createdBy" : "...", + "updatedBy" : "...", + "createTime" : 12345, + "updateTime" : 12345, + "version" : 12345, + "name" : "...", + "description" : "...", + "typeVersion" : "...", + "options" : { + "property1" : "...", + "property2" : "..." + } + } ], + "classificationDefs" : [ { + "superTypes" : [ "...", "..." ], + "attributeDefs" : [ { + "name" : "...", + "typeName" : "...", + "isOptional" : true, + "cardinality" : "SINGLE", + "valuesMinCount" : 12345, + "valuesMaxCount" : 12345, + "isUnique" : true, + "isIndexable" : true, + "constraints" : [ { }, { } ] + }, { + "name" : "...", + "typeName" : "...", + "isOptional" : true, + "cardinality" : "SINGLE", + "valuesMinCount" : 12345, + "valuesMaxCount" : 12345, + "isUnique" : true, + "isIndexable" : true, + "constraints" : [ { }, { } ] + } ], + "category" : "MAP", + "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, + "constraints" : [ { }, { } ] + }, { + "name" : "...", + "typeName" : "...", + "isOptional" : true, + "cardinality" : "LIST", + "valuesMinCount" : 12345, + "valuesMaxCount" : 12345, + "isUnique" : true, + "isIndexable" : true, + "constraints" : [ { }, { } ] + } ], + "category" : "STRUCT", + "guid" : "...", + "createdBy" : "...", + "updatedBy" : "...", + "createTime" : 12345, + "updateTime" : 12345, + "version" : 12345, + "name" : "...", + "description" : "...", + "typeVersion" : "...", + "options" : { + "property1" : "...", + "property2" : "..." + } + } ], + "entityDefs" : [ { + "superTypes" : [ "...", "..." ], + "attributeDefs" : [ { + "name" : "...", + "typeName" : "...", + "isOptional" : true, + "cardinality" : "SET", + "valuesMinCount" : 12345, + "valuesMaxCount" : 12345, + "isUnique" : true, + "isIndexable" : true, + "constraints" : [ { }, { } ] + }, { + "name" : "...", + "typeName" : "...", + "isOptional" : true, + "cardinality" : "SET", + "valuesMinCount" : 12345, + "valuesMaxCount" : 12345, + "isUnique" : true, + "isIndexable" : true, + "constraints" : [ { }, { } ] + } ], + "category" : "CLASSIFICATION", + "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, + "constraints" : [ { }, { } ] + }, { + "name" : "...", + "typeName" : "...", + "isOptional" : true, + "cardinality" : "SINGLE", + "valuesMinCount" : 12345, + "valuesMaxCount" : 12345, + "isUnique" : true, + "isIndexable" : true, + "constraints" : [ { }, { } ] + } ], + "category" : "ENTITY", + "guid" : "...", + "createdBy" : "...", + "updatedBy" : "...", + "createTime" : 12345, + "updateTime" : 12345, + "version" : 12345, + "name" : "...", + "description" : "...", + "typeVersion" : "...", + "options" : { + "property1" : "...", + "property2" : "..." + } + } ], + "empty" : true +}, + "description" : "A collection of atlas enum, struct, classification and entity definitions (models)." + } + , + "json_AttributeSearchResult" : { + "type" : "object", + "title" : "AttributeSearchResult", + "properties" : { + "name" : { +"description" : "", +"type" : "array", +"items" : { + "type" : "string" +} + }, + "values" : { +"description" : "", +"type" : "array", +"items" : { + "type" : "object" +} + } + }, + "example" : { + "name" : [ "...", "..." ], + "values" : [ ] +}, + "description" : "Search results for attribute(s)" + } + , + "json_Cardinality" : { + "type" : "string", + "title" : "Cardinality", + "enum" : [ + "SINGLE", + "LIST", + "SET" + ], + "description" : "Cardinality of an attribute i.e. single-valued or multi-valued." + } + , + "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" : "Tag association request for a list of entities" + } + , + "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" : "ACTIVE", + "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" : "DELETED", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + } ] + }, + "guidAssignments" : { + "property1" : "...", + "property2" : "..." + }, + "createdEntities" : [ { + "guid" : "...", + "status" : "DELETED", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + }, { + "guid" : "...", + "status" : "ACTIVE", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + } ], + "updatedEntities" : [ { + "guid" : "...", + "status" : "DELETED", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + }, { + "guid" : "...", + "status" : "DELETED", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + } ], + "partialUpdatedEntities" : [ { + "guid" : "...", + "status" : "ACTIVE", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + }, { + "guid" : "...", + "status" : "DELETED", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "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" : "ACTIVE", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + }, + "firstEntityUpdated" : { + "guid" : "...", + "status" : "DELETED", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + }, + "firstEntityPartialUpdated" : { + "guid" : "...", + "status" : "ACTIVE", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + } +}, + "description" : "Entity modification response. Contains entity headers for each successful modification (create/update/delete)" + } + , + "json_EntityOperation" : { + "type" : "string", + "title" : "EntityOperation", + "enum" : [ + "CREATE", + "UPDATE", + "PARTIAL_UPDATE", + "DELETE" + ], + "description" : "Entity operations supported by Atlas via REST" + } + , + "json_LineageDirection" : { + "type" : "string", + "title" : "LineageDirection", + "enum" : [ + "INPUT", + "OUTPUT", + "BOTH" + ], + "description" : "Lineage direction" + } + , + "json_LineageRelation" : { + "type" : "object", + "title" : "LineageRelation", + "properties" : { + "fromEntityId" : { +"description" : "", +"type" : "string" + }, + "toEntityId" : { +"description" : "", +"type" : "string" + } + }, + "example" : { + "fromEntityId" : "...", + "toEntityId" : "..." +}, + "description" : "Lineage relation between two entities" + } + , + "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" : "DESC", + "sortBy" : "..." +}, + "description" : "Paginated-list, for returning search results." + } + , + "json_SortType" : { + "type" : "string", + "title" : "SortType", + "enum" : [ + "NONE", + "ASC", + "DESC" + ], + "description" : "Type of sorting to be applied on the result set, defaults to NONE" + } + , + "json_Status" : { + "type" : "string", + "title" : "Status", + "enum" : [ + "ACTIVE", + "DELETED" + ], + "description" : "Status of the entity - can be active or deleted." + } + , + "json_TypeCategory" : { + "type" : "string", + "title" : "TypeCategory", + "enum" : [ + "PRIMITIVE", + "OBJECT_ID_TYPE", + "ENUM", + "STRUCT", + "CLASSIFICATION", + "ENTITY", + "ARRAY", + "MAP" + ], + "description" : "Category of a defined type" + } + }, + "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" + } + ], + "responses" : { + "200" : { + "schema" : { +"description" : "", +"$ref" : "#/definitions/json_AtlasSearchResult" + }, + "headers" : { + }, + "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 + } ] +} + }, + "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" : "BASIC", + "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 + } ] +} + }, + "description" : "Invalid fulltext or query parameters" + } + } + } + } + , + "\/v2/search/dsl" : { + "get" : { + "tags" : [ "DiscoveryREST" ], + "summary" : "Retrieve data for the specified DSL.", + "description" : "Retrieve data for the specified DSL", + "operationId" : "resource_DiscoveryREST_searchUsingDSL_GET", + "produces" : [ "application/json;charset=UTF-8" ], + "parameters" : [ + { + "name" : "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" : "DSL query" + }, + { + "name" : "typeName", + "in" : "query", + "type" : "string", + "description" : "limit the result to only entities of specified type or its sub-types" + } + ], + "responses" : { + "200" : { + "schema" : { +"description" : "", +"$ref" : "#/definitions/json_AtlasSearchResult" + }, + "headers" : { + }, + "examples" : { + "application/json" : { + "queryType" : "DSL", + "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" : "ACTIVE", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + }, + "score" : 12345.0 + }, { + "entity" : { + "guid" : "...", + "status" : "ACTIVE", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + }, + "score" : 12345.0 + } ] +} + }, + "description" : "On successful DSL execution with some results, might return an empty list if execution succeeded\nwithout any results" + }, + "400" : { + "headers" : { + }, + "examples" : { + "application/json" : { + "queryType" : "DSL", + "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" : "ACTIVE", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + }, + "score" : 12345.0 + }, { + "entity" : { + "guid" : "...", + "status" : "ACTIVE", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + }, + "score" : 12345.0 + } ] +} + }, + "description" : "Invalid DSL or query parameters" + } + } + } + } + , + "\/v2/search/fulltext" : { + "get" : { + "tags" : [ "DiscoveryREST" ], + "summary" : "Retrieve data for the specified fulltext query.", + "description" : "Retrieve data for the specified fulltext query", + "operationId" : "resource_DiscoveryREST_searchUsingFullText_GET", + "produces" : [ "application/json;charset=UTF-8" ], + "parameters" : [ + { + "name" : "limit", + "in" : "query", + "type" : "integer", + "description" : "limit the result set to only include the specified number of entries" + }, + { + "name" : "offset", + "in" : "query", + "type" : "integer", + "description" : "start offset of the result set (useful for pagination)" + }, + { + "name" : "query", + "in" : "query", + "type" : "string", + "description" : "Fulltext query" + } + ], + "responses" : { + "200" : { + "schema" : { +"description" : "", +"$ref" : "#/definitions/json_AtlasSearchResult" + }, + "headers" : { + }, + "examples" : { + "application/json" : { + "queryType" : "FULL_TEXT", + "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" : "ACTIVE", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + }, + "score" : 12345.0 + }, { + "entity" : { + "guid" : "...", + "status" : "ACTIVE", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + }, + "score" : 12345.0 + } ] +} + }, + "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" : "BASIC", + "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" : "ACTIVE", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + }, + "score" : 12345.0 + }, { + "entity" : { + "guid" : "...", + "status" : "ACTIVE", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + }, + "score" : 12345.0 + } ] +} + }, + "description" : "Invalid fulltext or query parameters" + } + } + } + } + , + "\/v2/entity" : { + "post" : { + "tags" : [ "EntityREST" ], + "summary" : "Create new entity or update existing entity in Atlas.", + "description" : "Create new entity or update existing entity in Atlas.\nExisting entity is matched using its unique guid if supplied or by its unique attributes eg: qualifiedName", + "operationId" : "resource_EntityREST_createOrUpdate_POST", + "consumes" : [ "application/json;charset=UTF-8" ], + "produces" : [ "application/json;charset=UTF-8" ], + "parameters" : [ + { + "name" : "body", + "in" : "body", + "schema" : { +"description" : "", +"$ref" : "#/definitions/json_AtlasEntityWithExtInfo" + }, + "description" : "" + } + ], + "responses" : { + "201" : { + "schema" : { +"description" : "", +"$ref" : "#/definitions/json_EntityMutationResponse" + }, + "headers" : { + }, + "examples" : { + "application/json" : { + "mutatedEntities" : { + "property1" : [ { + "guid" : "...", + "status" : "ACTIVE", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + }, { + "guid" : "...", + "status" : "DELETED", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + } ], + "property2" : [ { + "guid" : "...", + "status" : "ACTIVE", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + }, { + "guid" : "...", + "status" : "ACTIVE", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + } ] + }, + "guidAssignments" : { + "property1" : "...", + "property2" : "..." + }, + "createdEntities" : [ { + "guid" : "...", + "status" : "ACTIVE", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + }, { + "guid" : "...", + "status" : "DELETED", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + } ], + "updatedEntities" : [ { + "guid" : "...", + "status" : "DELETED", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + }, { + "guid" : "...", + "status" : "ACTIVE", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + } ], + "partialUpdatedEntities" : [ { + "guid" : "...", + "status" : "DELETED", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + }, { + "guid" : "...", + "status" : "ACTIVE", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + } ], + "deletedEntities" : [ { + "guid" : "...", + "status" : "ACTIVE", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + }, { + "guid" : "...", + "status" : "DELETED", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + } ], + "firstEntityCreated" : { + "guid" : "...", + "status" : "ACTIVE", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + }, + "firstEntityUpdated" : { + "guid" : "...", + "status" : "DELETED", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + }, + "firstEntityPartialUpdated" : { + "guid" : "...", + "status" : "ACTIVE", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + } +} + }, + "description" : "Success" + } + } + } + } + , + "\/v2/entity/bulk" : { + "delete" : { + "tags" : [ "EntityREST" ], + "summary" : "Bulk API to delete list of entities identified by its GUIDs.", + "description" : "Bulk API to delete list of entities identified by its GUIDs", + "operationId" : "resource_EntityREST_deleteByGuids_DELETE", + "produces" : [ "application/json;charset=UTF-8" ], + "parameters" : [ + { + "name" : "guid", + "in" : "query", + "type" : "array", + "items" : { + "type" : "string" + }, + "collectionFormat" : "multi", + "description" : "" + } + ], + "responses" : { + "204" : { + "schema" : { +"description" : "", +"$ref" : "#/definitions/json_EntityMutationResponse" + }, + "headers" : { + }, + "examples" : { + "application/json" : { + "mutatedEntities" : { + "property1" : [ { + "guid" : "...", + "status" : "DELETED", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + }, { + "guid" : "...", + "status" : "ACTIVE", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + } ], + "property2" : [ { + "guid" : "...", + "status" : "ACTIVE", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + }, { + "guid" : "...", + "status" : "ACTIVE", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + } ] + }, + "guidAssignments" : { + "property1" : "...", + "property2" : "..." + }, + "createdEntities" : [ { + "guid" : "...", + "status" : "ACTIVE", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + }, { + "guid" : "...", + "status" : "DELETED", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + } ], + "updatedEntities" : [ { + "guid" : "...", + "status" : "DELETED", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + }, { + "guid" : "...", + "status" : "ACTIVE", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + } ], + "partialUpdatedEntities" : [ { + "guid" : "...", + "status" : "ACTIVE", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + }, { + "guid" : "...", + "status" : "ACTIVE", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + } ], + "deletedEntities" : [ { + "guid" : "...", + "status" : "ACTIVE", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + }, { + "guid" : "...", + "status" : "DELETED", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + } ], + "firstEntityCreated" : { + "guid" : "...", + "status" : "DELETED", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + }, + "firstEntityUpdated" : { + "guid" : "...", + "status" : "ACTIVE", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + }, + "firstEntityPartialUpdated" : { + "guid" : "...", + "status" : "ACTIVE", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + } +} + }, + "description" : "Success" + } + } + } + , + "get" : { + "tags" : [ "EntityREST" ], + "summary" : "Bulk API to retrieve list of entities identified by its GUIDs.", + "description" : "Bulk API to retrieve list of entities identified by its GUIDs.", + "operationId" : "resource_EntityREST_getByGuids_GET", + "produces" : [ "application/json;charset=UTF-8" ], + "parameters" : [ + { + "name" : "guid", + "in" : "query", + "type" : "array", + "items" : { + "type" : "string" + }, + "collectionFormat" : "multi", + "description" : "" + } + ], + "responses" : { + "200" : { + "schema" : { +"description" : "", +"$ref" : "#/definitions/json_AtlasEntitiesWithExtInfo" + }, + "headers" : { + }, + "examples" : { + "application/json" : { + "entities" : [ { + "guid" : "...", + "status" : "DELETED", + "createdBy" : "...", + "updatedBy" : "...", + "createTime" : 12345, + "updateTime" : 12345, + "version" : 12345, + "classifications" : [ { + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + }, { + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + } ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + }, { + "guid" : "...", + "status" : "ACTIVE", + "createdBy" : "...", + "updatedBy" : "...", + "createTime" : 12345, + "updateTime" : 12345, + "version" : 12345, + "classifications" : [ { + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + }, { + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + } ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + } ], + "referredEntities" : { + "property1" : { + "guid" : "...", + "status" : "DELETED", + "createdBy" : "...", + "updatedBy" : "...", + "createTime" : 12345, + "updateTime" : 12345, + "version" : 12345, + "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, + "classifications" : [ { + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + }, { + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + } ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + } + } +} + }, + "description" : "Success" + } + } + } + , + "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" : "resource_EntityREST_createOrUpdate_POST", + "consumes" : [ "application/json;charset=UTF-8" ], + "produces" : [ "application/json;charset=UTF-8" ], + "parameters" : [ + { + "name" : "body", + "in" : "body", + "schema" : { +"description" : "", +"$ref" : "#/definitions/json_AtlasEntitiesWithExtInfo" + }, + "description" : "" + } + ], + "responses" : { + "201" : { + "schema" : { +"description" : "", +"$ref" : "#/definitions/json_EntityMutationResponse" + }, + "headers" : { + }, + "examples" : { + "application/json" : { + "mutatedEntities" : { + "property1" : [ { + "guid" : "...", + "status" : "ACTIVE", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + }, { + "guid" : "...", + "status" : "ACTIVE", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + } ], + "property2" : [ { + "guid" : "...", + "status" : "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" : "ACTIVE", + "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" : "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" : "DELETED", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + } ], + "firstEntityCreated" : { + "guid" : "...", + "status" : "ACTIVE", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + }, + "firstEntityUpdated" : { + "guid" : "...", + "status" : "ACTIVE", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + }, + "firstEntityPartialUpdated" : { + "guid" : "...", + "status" : "DELETED", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + } +} + }, + "description" : "Success" + } + } + } + } + , + "\/v2/entity/bulk/classification" : { + "post" : { + "tags" : [ "EntityREST" ], + "summary" : "Bulk API to associate a tag to multiple entities.", + "description" : "Bulk API to associate a tag to multiple entities", + "operationId" : "resource_EntityREST_addClassification_POST", + "consumes" : [ "application/json;charset=UTF-8" ], + "parameters" : [ + { + "name" : "body", + "in" : "body", + "schema" : { +"description" : "", +"$ref" : "#/definitions/json_ClassificationAssociateRequest" + }, + "description" : "" + } + ], + "responses" : { + "201" : { + "headers" : { + }, + "examples" : { + }, + "description" : "Success" + } + } + } + } + , + "\/v2/entity/guid/{guid}" : { + "delete" : { + "tags" : [ "EntityREST" ], + "summary" : "Delete an entity identified by its GUID.", + "description" : "Delete an entity identified by its GUID.", + "operationId" : "resource_EntityREST_deleteByGuid_DELETE", + "produces" : [ "application/json;charset=UTF-8" ], + "parameters" : [ + { + "name" : "guid", + "in" : "path", + "required" : true, + "type" : "string", + "description" : "GUID for the entity" + } + ], + "responses" : { + "204" : { + "schema" : { +"description" : "", +"$ref" : "#/definitions/json_EntityMutationResponse" + }, + "headers" : { + }, + "examples" : { + "application/json" : { + "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" : "DELETED", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + } ] + }, + "guidAssignments" : { + "property1" : "...", + "property2" : "..." + }, + "createdEntities" : [ { + "guid" : "...", + "status" : "ACTIVE", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + }, { + "guid" : "...", + "status" : "DELETED", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + } ], + "updatedEntities" : [ { + "guid" : "...", + "status" : "ACTIVE", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + }, { + "guid" : "...", + "status" : "DELETED", + "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" : "DELETED", + "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" + } + } + } + , + "get" : { + "tags" : [ "EntityREST" ], + "summary" : "Fetch complete definition of an entity given its GUID.", + "description" : "Fetch complete definition of an entity given its GUID.", + "operationId" : "resource_EntityREST_getById_GET", + "produces" : [ "application/json;charset=UTF-8" ], + "parameters" : [ + { + "name" : "guid", + "in" : "path", + "required" : true, + "type" : "string", + "description" : "GUID for the entity" + } + ], + "responses" : { + "200" : { + "schema" : { +"description" : "", +"$ref" : "#/definitions/json_AtlasEntityWithExtInfo" + }, + "headers" : { + }, + "examples" : { + "application/json" : { + "entity" : { + "guid" : "...", + "status" : "ACTIVE", + "createdBy" : "...", + "updatedBy" : "...", + "createTime" : 12345, + "updateTime" : 12345, + "version" : 12345, + "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, + "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, + "classifications" : [ { + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + }, { + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + } ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + } + } +} + }, + "description" : "Success" + } + } + } + , + "put" : { + "tags" : [ "EntityREST" ], + "summary" : "Entity Partial Update - Add/Update entity attribute identified by its GUID.", + "description" : "Entity Partial Update - Add/Update entity attribute identified by its GUID.\nSupports only uprimitive attribute type and entity references.\ndoes not support updation of complex types like arrays, maps\nNull updates are not possible", + "operationId" : "resource_EntityREST_partialUpdateEntityAttrByGuid_PUT", + "consumes" : [ "application/json;charset=UTF-8" ], + "produces" : [ "application/json;charset=UTF-8" ], + "parameters" : [ + { + "name" : "guid", + "in" : "path", + "required" : true, + "type" : "string", + "description" : "" + }, + { + "name" : "name", + "in" : "query", + "type" : "string", + "description" : "" + }, + { + "name" : "body", +
<TRUNCATED>
