You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@atlas.apache.org by ma...@apache.org on 2017/02/18 01:53:27 UTC
[02/27] incubator-atlas-website git commit: Added V2 REST API
documentation (apoorvnaik via mneethiraj)
http://git-wip-us.apache.org/repos/asf/incubator-atlas-website/blob/4164eb06/api/v2/ui/swagger.json
----------------------------------------------------------------------
diff --git a/api/v2/ui/swagger.json b/api/v2/ui/swagger.json
new file mode 100644
index 0000000..9e98e1d
--- /dev/null
+++ b/api/v2/ui/swagger.json
@@ -0,0 +1,9129 @@
+{
+ "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.8-incubating-SNAPSHOT",
+ "title" : "Atlas REST API"
+ },
+ "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" : "SINGLE",
+ "valuesMinCount" : 12345,
+ "valuesMaxCount" : 12345,
+ "isUnique" : true,
+ "isIndexable" : true,
+ "constraints" : [ {
+ "type" : "...",
+ "params" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ }, {
+ "type" : "...",
+ "params" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ } ]
+},
+ "description" : "class that captures 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" : "ENTITY",
+ "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."
+ }
+ ,
+ "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" : "OBJECT_ID_TYPE",
+ "guid" : "...",
+ "createdBy" : "...",
+ "updatedBy" : "...",
+ "createTime" : 12345,
+ "updateTime" : 12345,
+ "version" : 12345,
+ "name" : "...",
+ "description" : "...",
+ "typeVersion" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ }
+},
+ "description" : "class that captures 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" : "class that captures 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" : { }
+ }
+ } ],
+ "unassigned" : true,
+ "assigned" : true,
+ "atlasObjectId" : {
+ "guid" : "...",
+ "typeName" : "...",
+ "uniqueAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "validGuid" : true,
+ "assignedGuid" : true,
+ "unAssignedGuid" : true,
+ "valid" : true
+ },
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ }, {
+ "guid" : "...",
+ "status" : "ACTIVE",
+ "createdBy" : "...",
+ "updatedBy" : "...",
+ "createTime" : 12345,
+ "updateTime" : 12345,
+ "version" : 12345,
+ "classifications" : [ {
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ }, {
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ } ],
+ "unassigned" : true,
+ "assigned" : true,
+ "atlasObjectId" : {
+ "guid" : "...",
+ "typeName" : "...",
+ "uniqueAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "validGuid" : true,
+ "assignedGuid" : true,
+ "unAssignedGuid" : true,
+ "valid" : true
+ },
+ "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" : { }
+ }
+ } ],
+ "unassigned" : true,
+ "assigned" : true,
+ "atlasObjectId" : {
+ "guid" : "...",
+ "typeName" : "...",
+ "uniqueAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "validGuid" : true,
+ "assignedGuid" : true,
+ "unAssignedGuid" : true,
+ "valid" : true
+ },
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ },
+ "property2" : {
+ "guid" : "...",
+ "status" : "DELETED",
+ "createdBy" : "...",
+ "updatedBy" : "...",
+ "createTime" : 12345,
+ "updateTime" : 12345,
+ "version" : 12345,
+ "classifications" : [ {
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ }, {
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ } ],
+ "unassigned" : true,
+ "assigned" : true,
+ "atlasObjectId" : {
+ "guid" : "...",
+ "typeName" : "...",
+ "uniqueAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "validGuid" : true,
+ "assignedGuid" : true,
+ "unAssignedGuid" : true,
+ "valid" : true
+ },
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ }
+ }
+},
+ "description" : "An instance of an entity along with extended info - like hive_table, hive_database."
+ }
+ ,
+ "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"
+}
+ },
+ "unassigned" : {
+"description" : "",
+"type" : "boolean"
+ },
+ "assigned" : {
+"description" : "",
+"type" : "boolean"
+ },
+ "atlasObjectId" : {
+"description" : "",
+"$ref" : "#/definitions/json_AtlasObjectId"
+ }
+ }
+ }
+ ],
+ "example" : {
+ "guid" : "...",
+ "status" : "DELETED",
+ "createdBy" : "...",
+ "updatedBy" : "...",
+ "createTime" : 12345,
+ "updateTime" : 12345,
+ "version" : 12345,
+ "classifications" : [ {
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ }, {
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ } ],
+ "unassigned" : true,
+ "assigned" : true,
+ "atlasObjectId" : {
+ "guid" : "...",
+ "typeName" : "...",
+ "uniqueAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "validGuid" : true,
+ "assignedGuid" : true,
+ "unAssignedGuid" : true,
+ "valid" : true
+ },
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+},
+ "description" : "An instance of an entity - like hive_table, hive_database."
+ }
+ ,
+ "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" : "LIST",
+ "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" : "OBJECT_ID_TYPE",
+ "guid" : "...",
+ "createdBy" : "...",
+ "updatedBy" : "...",
+ "createTime" : 12345,
+ "updateTime" : 12345,
+ "version" : 12345,
+ "name" : "...",
+ "description" : "...",
+ "typeVersion" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ }
+},
+ "description" : "class that captures details of a entity-type."
+ }
+ ,
+ "json_AtlasEntityExtInfo" : {
+ "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,
+ "classifications" : [ {
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ }, {
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ } ],
+ "unassigned" : true,
+ "assigned" : true,
+ "atlasObjectId" : {
+ "guid" : "...",
+ "typeName" : "...",
+ "uniqueAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "validGuid" : true,
+ "assignedGuid" : true,
+ "unAssignedGuid" : true,
+ "valid" : true
+ },
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ },
+ "property2" : {
+ "guid" : "...",
+ "status" : "DELETED",
+ "createdBy" : "...",
+ "updatedBy" : "...",
+ "createTime" : 12345,
+ "updateTime" : 12345,
+ "version" : 12345,
+ "classifications" : [ {
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ }, {
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ } ],
+ "unassigned" : true,
+ "assigned" : true,
+ "atlasObjectId" : {
+ "guid" : "...",
+ "typeName" : "...",
+ "uniqueAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "validGuid" : true,
+ "assignedGuid" : true,
+ "unAssignedGuid" : true,
+ "valid" : true
+ },
+ "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",
+ "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"
+}
+ },
+ "atlasObjectId" : {
+"description" : "",
+"$ref" : "#/definitions/json_AtlasObjectId"
+ }
+ }
+ }
+ ],
+ "example" : {
+ "guid" : "...",
+ "status" : "DELETED",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "atlasObjectId" : {
+ "guid" : "...",
+ "typeName" : "...",
+ "uniqueAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "validGuid" : true,
+ "assignedGuid" : true,
+ "unAssignedGuid" : true,
+ "valid" : true
+ },
+ "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" : "DELETED",
+ "createdBy" : "...",
+ "updatedBy" : "...",
+ "createTime" : 12345,
+ "updateTime" : 12345,
+ "version" : 12345,
+ "classifications" : [ {
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ }, {
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ } ],
+ "unassigned" : true,
+ "assigned" : true,
+ "atlasObjectId" : {
+ "guid" : "...",
+ "typeName" : "...",
+ "uniqueAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "validGuid" : true,
+ "assignedGuid" : true,
+ "unAssignedGuid" : true,
+ "valid" : true
+ },
+ "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" : { }
+ }
+ } ],
+ "unassigned" : true,
+ "assigned" : true,
+ "atlasObjectId" : {
+ "guid" : "...",
+ "typeName" : "...",
+ "uniqueAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "validGuid" : true,
+ "assignedGuid" : true,
+ "unAssignedGuid" : true,
+ "valid" : true
+ },
+ "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" : { }
+ }
+ } ],
+ "unassigned" : true,
+ "assigned" : true,
+ "atlasObjectId" : {
+ "guid" : "...",
+ "typeName" : "...",
+ "uniqueAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "validGuid" : true,
+ "assignedGuid" : true,
+ "unAssignedGuid" : true,
+ "valid" : true
+ },
+ "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"
+}
+ },
+ "defaultValue" : {
+"description" : "",
+"type" : "string"
+ }
+ }
+ }
+ ],
+ "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" : [ "...", "..." ],
+ "atlasObjectId" : {
+ "guid" : "...",
+ "typeName" : "...",
+ "uniqueAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "validGuid" : true,
+ "assignedGuid" : true,
+ "unAssignedGuid" : true,
+ "valid" : true
+ },
+ "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" : "DELETED",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "atlasObjectId" : {
+ "guid" : "...",
+ "typeName" : "...",
+ "uniqueAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "validGuid" : true,
+ "assignedGuid" : true,
+ "unAssignedGuid" : true,
+ "valid" : true
+ },
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ },
+ "property2" : {
+ "guid" : "...",
+ "status" : "DELETED",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "atlasObjectId" : {
+ "guid" : "...",
+ "typeName" : "...",
+ "uniqueAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "validGuid" : true,
+ "assignedGuid" : true,
+ "unAssignedGuid" : true,
+ "valid" : true
+ },
+ "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"
+}
+ },
+ "validGuid" : {
+"description" : "",
+"type" : "boolean"
+ },
+ "assignedGuid" : {
+"description" : "",
+"type" : "boolean"
+ },
+ "unAssignedGuid" : {
+"description" : "",
+"type" : "boolean"
+ },
+ "valid" : {
+"description" : "",
+"type" : "boolean"
+ }
+ },
+ "example" : {
+ "guid" : "...",
+ "typeName" : "...",
+ "uniqueAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "validGuid" : true,
+ "assignedGuid" : true,
+ "unAssignedGuid" : true,
+ "valid" : true
+},
+ "description" : "Reference to an object-instance of an Atlas type - like entity."
+ }
+ ,
+ "json_AtlasQueryType" : {
+ "type" : "string",
+ "title" : "AtlasQueryType",
+ "enum" : [
+ "DSL",
+ "FULL_TEXT",
+ "GREMLIN"
+ ],
+ "description" : ""
+ }
+ ,
+ "json_AtlasSearchResult" : {
+ "type" : "object",
+ "title" : "AtlasSearchResult",
+ "properties" : {
+ "queryText" : {
+"description" : "",
+"type" : "string"
+ },
+ "queryType" : {
+"description" : "",
+"$ref" : "#/definitions/json_AtlasQueryType"
+ },
+ "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" : {
+ "queryText" : "...",
+ "queryType" : "GREMLIN",
+ "entities" : [ {
+ "guid" : "...",
+ "status" : "DELETED",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "atlasObjectId" : {
+ "guid" : "...",
+ "typeName" : "...",
+ "uniqueAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "validGuid" : true,
+ "assignedGuid" : true,
+ "unAssignedGuid" : true,
+ "valid" : true
+ },
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ }, {
+ "guid" : "...",
+ "status" : "ACTIVE",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "atlasObjectId" : {
+ "guid" : "...",
+ "typeName" : "...",
+ "uniqueAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "validGuid" : true,
+ "assignedGuid" : true,
+ "unAssignedGuid" : true,
+ "valid" : true
+ },
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ } ],
+ "attributes" : {
+ "name" : [ "...", "..." ],
+ "values" : [ ]
+ },
+ "fullTextResult" : [ {
+ "entity" : {
+ "guid" : "...",
+ "status" : "ACTIVE",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "atlasObjectId" : { },
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ },
+ "score" : 12345.0
+ }, {
+ "entity" : {
+ "guid" : "...",
+ "status" : "DELETED",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "atlasObjectId" : { },
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ },
+ "score" : 12345.0
+ } ]
+},
+ "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" : "LIST",
+ "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" : "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" : "ARRAY"
+},
+ "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"
+}
+ },
+ "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" : "ENTITY",
+ "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,
+ "constraints" : [ { }, { } ]
+ }, {
+ "name" : "...",
+ "typeName" : "...",
+ "isOptional" : true,
+ "cardinality" : "SINGLE",
+ "valuesMinCount" : 12345,
+ "valuesMaxCount" : 12345,
+ "isUnique" : true,
+ "isIndexable" : true,
+ "constraints" : [ { }, { } ]
+ } ],
+ "category" : "OBJECT_ID_TYPE",
+ "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,
+ "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" : "..."
+ }
+ } ],
+ "classificationDefs" : [ {
+ "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" : "PRIMITIVE",
+ "guid" : "...",
+ "createdBy" : "...",
+ "updatedBy" : "...",
+ "createTime" : 12345,
+ "updateTime" : 12345,
+ "version" : 12345,
+ "name" : "...",
+ "description" : "...",
+ "typeVersion" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ }
+ }, {
+ "superTypes" : [ "...", "..." ],
+ "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" : "MAP",
+ "guid" : "...",
+ "createdBy" : "...",
+ "updatedBy" : "...",
+ "createTime" : 12345,
+ "updateTime" : 12345,
+ "version" : 12345,
+ "name" : "...",
+ "description" : "...",
+ "typeVersion" : "...",
+ "options" : {
+ "property1" : "...",
+ "property2" : "..."
+ }
+ } ],
+ "entityDefs" : [ {
+ "superTypes" : [ "...", "..." ],
+ "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" : "..."
+ }
+ }, {
+ "superTypes" : [ "...", "..." ],
+ "attributeDefs" : [ {
+ "name" : "...",
+ "typeName" : "...",
+ "isOptional" : true,
+ "cardinality" : "SINGLE",
+ "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" : "..."
+ }
+ } ],
+ "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_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" : [ "...", "..." ],
+ "atlasObjectId" : {
+ "guid" : "...",
+ "typeName" : "...",
+ "uniqueAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "validGuid" : true,
+ "assignedGuid" : true,
+ "unAssignedGuid" : true,
+ "valid" : true
+ },
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ }, {
+ "guid" : "...",
+ "status" : "DELETED",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "atlasObjectId" : {
+ "guid" : "...",
+ "typeName" : "...",
+ "uniqueAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "validGuid" : true,
+ "assignedGuid" : true,
+ "unAssignedGuid" : true,
+ "valid" : true
+ },
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ } ],
+ "property2" : [ {
+ "guid" : "...",
+ "status" : "DELETED",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "atlasObjectId" : {
+ "guid" : "...",
+ "typeName" : "...",
+ "uniqueAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "validGuid" : true,
+ "assignedGuid" : true,
+ "unAssignedGuid" : true,
+ "valid" : true
+ },
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ }, {
+ "guid" : "...",
+ "status" : "DELETED",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "atlasObjectId" : {
+ "guid" : "...",
+ "typeName" : "...",
+ "uniqueAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "validGuid" : true,
+ "assignedGuid" : true,
+ "unAssignedGuid" : true,
+ "valid" : true
+ },
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ } ]
+ },
+ "guidAssignments" : {
+ "property1" : "...",
+ "property2" : "..."
+ },
+ "createdEntities" : [ {
+ "guid" : "...",
+ "status" : "DELETED",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "atlasObjectId" : {
+ "guid" : "...",
+ "typeName" : "...",
+ "uniqueAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "validGuid" : true,
+ "assignedGuid" : true,
+ "unAssignedGuid" : true,
+ "valid" : true
+ },
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ }, {
+ "guid" : "...",
+ "status" : "DELETED",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "atlasObjectId" : {
+ "guid" : "...",
+ "typeName" : "...",
+ "uniqueAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "validGuid" : true,
+ "assignedGuid" : true,
+ "unAssignedGuid" : true,
+ "valid" : true
+ },
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ } ],
+ "updatedEntities" : [ {
+ "guid" : "...",
+ "status" : "ACTIVE",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "atlasObjectId" : {
+ "guid" : "...",
+ "typeName" : "...",
+ "uniqueAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "validGuid" : true,
+ "assignedGuid" : true,
+ "unAssignedGuid" : true,
+ "valid" : true
+ },
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ }, {
+ "guid" : "...",
+ "status" : "ACTIVE",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "atlasObjectId" : {
+ "guid" : "...",
+ "typeName" : "...",
+ "uniqueAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "validGuid" : true,
+ "assignedGuid" : true,
+ "unAssignedGuid" : true,
+ "valid" : true
+ },
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ } ],
+ "partialUpdatedEntities" : [ {
+ "guid" : "...",
+ "status" : "ACTIVE",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "atlasObjectId" : {
+ "guid" : "...",
+ "typeName" : "...",
+ "uniqueAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "validGuid" : true,
+ "assignedGuid" : true,
+ "unAssignedGuid" : true,
+ "valid" : true
+ },
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ }, {
+ "guid" : "...",
+ "status" : "DELETED",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "atlasObjectId" : {
+ "guid" : "...",
+ "typeName" : "...",
+ "uniqueAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "validGuid" : true,
+ "assignedGuid" : true,
+ "unAssignedGuid" : true,
+ "valid" : true
+ },
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ } ],
+ "deletedEntities" : [ {
+ "guid" : "...",
+ "status" : "ACTIVE",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "atlasObjectId" : {
+ "guid" : "...",
+ "typeName" : "...",
+ "uniqueAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "validGuid" : true,
+ "assignedGuid" : true,
+ "unAssignedGuid" : true,
+ "valid" : true
+ },
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ }, {
+ "guid" : "...",
+ "status" : "ACTIVE",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "atlasObjectId" : {
+ "guid" : "...",
+ "typeName" : "...",
+ "uniqueAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "validGuid" : true,
+ "assignedGuid" : true,
+ "unAssignedGuid" : true,
+ "valid" : true
+ },
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ } ],
+ "firstEntityCreated" : {
+ "guid" : "...",
+ "status" : "DELETED",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "atlasObjectId" : {
+ "guid" : "...",
+ "typeName" : "...",
+ "uniqueAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "validGuid" : true,
+ "assignedGuid" : true,
+ "unAssignedGuid" : true,
+ "valid" : true
+ },
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ },
+ "firstEntityUpdated" : {
+ "guid" : "...",
+ "status" : "DELETED",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "atlasObjectId" : {
+ "guid" : "...",
+ "typeName" : "...",
+ "uniqueAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "validGuid" : true,
+ "assignedGuid" : true,
+ "unAssignedGuid" : true,
+ "valid" : true
+ },
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ },
+ "firstEntityPartialUpdated" : {
+ "guid" : "...",
+ "status" : "DELETED",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "atlasObjectId" : {
+ "guid" : "...",
+ "typeName" : "...",
+ "uniqueAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "validGuid" : true,
+ "assignedGuid" : true,
+ "unAssignedGuid" : true,
+ "valid" : true
+ },
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ }
+},
+ "description" : ""
+ }
+ ,
+ "json_EntityOperation" : {
+ "type" : "string",
+ "title" : "EntityOperation",
+ "enum" : [
+ "CREATE",
+ "UPDATE",
+ "PARTIAL_UPDATE",
+ "DELETE"
+ ],
+ "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_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" : "ASC",
+ "sortBy" : "..."
+},
+ "description" : "Paginated-list, for returning search results."
+ }
+ ,
+ "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_TypeCategory" : {
+ "type" : "string",
+ "title" : "TypeCategory",
+ "enum" : [
+ "PRIMITIVE",
+ "OBJECT_ID_TYPE",
+ "ENUM",
+ "STRUCT",
+ "CLASSIFICATION",
+ "ENTITY",
+ "ARRAY",
+ "MAP"
+ ],
+ "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."
+ }
+ },
+ "paths": {
+ "\/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" : "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"
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "schema" : {
+"description" : "",
+"$ref" : "#/definitions/json_AtlasSearchResult"
+ },
+ "headers" : {
+ },
+ "examples" : {
+ "application/json" : {
+ "queryText" : "...",
+ "queryType" : "GREMLIN",
+ "entities" : [ {
+ "guid" : "...",
+ "status" : "ACTIVE",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "atlasObjectId" : {
+ "guid" : "...",
+ "typeName" : "...",
+ "uniqueAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "validGuid" : true,
+ "assignedGuid" : true,
+ "unAssignedGuid" : true,
+ "valid" : true
+ },
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ }, {
+ "guid" : "...",
+ "status" : "DELETED",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "atlasObjectId" : {
+ "guid" : "...",
+ "typeName" : "...",
+ "uniqueAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "validGuid" : true,
+ "assignedGuid" : true,
+ "unAssignedGuid" : true,
+ "valid" : true
+ },
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ } ],
+ "attributes" : {
+ "name" : [ "...", "..." ],
+ "values" : [ ]
+ },
+ "fullTextResult" : [ {
+ "entity" : {
+ "guid" : "...",
+ "status" : "ACTIVE",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "atlasObjectId" : { },
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ },
+ "score" : 12345.0
+ }, {
+ "entity" : {
+ "guid" : "...",
+ "status" : "DELETED",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "atlasObjectId" : { },
+ "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" : {
+ "queryText" : "...",
+ "queryType" : "DSL",
+ "entities" : [ {
+ "guid" : "...",
+ "status" : "ACTIVE",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "atlasObjectId" : {
+ "guid" : "...",
+ "typeName" : "...",
+ "uniqueAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "validGuid" : true,
+ "assignedGuid" : true,
+ "unAssignedGuid" : true,
+ "valid" : true
+ },
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ }, {
+ "guid" : "...",
+ "status" : "ACTIVE",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "atlasObjectId" : {
+ "guid" : "...",
+ "typeName" : "...",
+ "uniqueAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "validGuid" : true,
+ "assignedGuid" : true,
+ "unAssignedGuid" : true,
+ "valid" : true
+ },
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ } ],
+ "attributes" : {
+ "name" : [ "...", "..." ],
+ "values" : [ ]
+ },
+ "fullTextResult" : [ {
+ "entity" : {
+ "guid" : "...",
+ "status" : "DELETED",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "atlasObjectId" : { },
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ },
+ "score" : 12345.0
+ }, {
+ "entity" : {
+ "guid" : "...",
+ "status" : "ACTIVE",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "atlasObjectId" : { },
+ "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" : {
+ "queryText" : "...",
+ "queryType" : "GREMLIN",
+ "entities" : [ {
+ "guid" : "...",
+ "status" : "DELETED",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "atlasObjectId" : {
+ "guid" : "...",
+ "typeName" : "...",
+ "uniqueAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "validGuid" : true,
+ "assignedGuid" : true,
+ "unAssignedGuid" : true,
+ "valid" : true
+ },
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ }, {
+ "guid" : "...",
+ "status" : "ACTIVE",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "atlasObjectId" : {
+ "guid" : "...",
+ "typeName" : "...",
+ "uniqueAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "validGuid" : true,
+ "assignedGuid" : true,
+ "unAssignedGuid" : true,
+ "valid" : true
+ },
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ } ],
+ "attributes" : {
+ "name" : [ "...", "..." ],
+ "values" : [ ]
+ },
+ "fullTextResult" : [ {
+ "entity" : {
+ "guid" : "...",
+ "status" : "ACTIVE",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "atlasObjectId" : { },
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ },
+ "score" : 12345.0
+ }, {
+ "entity" : {
+ "guid" : "...",
+ "status" : "DELETED",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "atlasObjectId" : { },
+ "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" : {
+ "queryText" : "...",
+ "queryType" : "DSL",
+ "entities" : [ {
+ "guid" : "...",
+ "status" : "DELETED",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "atlasObjectId" : {
+ "guid" : "...",
+ "typeName" : "...",
+ "uniqueAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "validGuid" : true,
+ "assignedGuid" : true,
+ "unAssignedGuid" : true,
+ "valid" : true
+ },
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ }, {
+ "guid" : "...",
+ "status" : "DELETED",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "atlasObjectId" : {
+ "guid" : "...",
+ "typeName" : "...",
+ "uniqueAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "validGuid" : true,
+ "assignedGuid" : true,
+ "unAssignedGuid" : true,
+ "valid" : true
+ },
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ } ],
+ "attributes" : {
+ "name" : [ "...", "..." ],
+ "values" : [ ]
+ },
+ "fullTextResult" : [ {
+ "entity" : {
+ "guid" : "...",
+ "status" : "ACTIVE",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "atlasObjectId" : { },
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ },
+ "score" : 12345.0
+ }, {
+ "entity" : {
+ "guid" : "...",
+ "status" : "ACTIVE",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "atlasObjectId" : { },
+ "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" : "DELETED",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "atlasObjectId" : {
+ "guid" : "...",
+ "typeName" : "...",
+ "uniqueAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "validGuid" : true,
+ "assignedGuid" : true,
+ "unAssignedGuid" : true,
+ "valid" : true
+ },
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ }, {
+ "guid" : "...",
+ "status" : "ACTIVE",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "atlasObjectId" : {
+ "guid" : "...",
+ "typeName" : "...",
+ "uniqueAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "validGuid" : true,
+ "assignedGuid" : true,
+ "unAssignedGuid" : true,
+ "valid" : true
+ },
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ } ],
+ "property2" : [ {
+ "guid" : "...",
+ "status" : "DELETED",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "atlasObjectId" : {
+ "guid" : "...",
+ "typeName" : "...",
+ "uniqueAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "validGuid" : true,
+ "assignedGuid" : true,
+ "unAssignedGuid" : true,
+ "valid" : true
+ },
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ }, {
+ "guid" : "...",
+ "status" : "DELETED",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "atlasObjectId" : {
+ "guid" : "...",
+ "typeName" : "...",
+ "uniqueAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "validGuid" : true,
+ "assignedGuid" : true,
+ "unAssignedGuid" : true,
+ "valid" : true
+ },
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ } ]
+ },
+ "guidAssignments" : {
+ "property1" : "...",
+ "property2" : "..."
+ },
+ "createdEntities" : [ {
+ "guid" : "...",
+ "status" : "DELETED",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "atlasObjectId" : {
+ "guid" : "...",
+ "typeName" : "...",
+ "uniqueAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "validGuid" : true,
+ "assignedGuid" : true,
+ "unAssignedGuid" : true,
+ "valid" : true
+ },
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ }, {
+ "guid" : "...",
+ "status" : "DELETED",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "atlasObjectId" : {
+ "guid" : "...",
+ "typeName" : "...",
+ "uniqueAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "validGuid" : true,
+ "assignedGuid" : true,
+ "unAssignedGuid" : true,
+ "valid" : true
+ },
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ } ],
+ "updatedEntities" : [ {
+ "guid" : "...",
+ "status" : "DELETED",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "atlasObjectId" : {
+ "guid" : "...",
+ "typeName" : "...",
+ "uniqueAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "validGuid" : true,
+ "assignedGuid" : true,
+ "unAssignedGuid" : true,
+ "valid" : true
+ },
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ }, {
+ "guid" : "...",
+ "status" : "ACTIVE",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "atlasObjectId" : {
+ "guid" : "...",
+ "typeName" : "...",
+ "uniqueAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "validGuid" : true,
+ "assignedGuid" : true,
+ "unAssignedGuid" : true,
+ "valid" : true
+ },
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ } ],
+ "partialUpdatedEntities" : [ {
+ "guid" : "...",
+ "status" : "DELETED",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "atlasObjectId" : {
+ "guid" : "...",
+ "typeName" : "...",
+ "uniqueAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "validGuid" : true,
+ "assignedGuid" : true,
+ "unAssignedGuid" : true,
+ "valid" : true
+ },
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ }, {
+ "guid" : "...",
+ "status" : "DELETED",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "atlasObjectId" : {
+ "guid" : "...",
+ "typeName" : "...",
+ "uniqueAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "validGuid" : true,
+ "assignedGuid" : true,
+ "unAssignedGuid" : true,
+ "valid" : true
+ },
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ } ],
+ "deletedEntities" : [ {
+ "guid" : "...",
+ "status" : "ACTIVE",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "atlasObjectId" : {
+ "guid" : "...",
+ "typeName" : "...",
+ "uniqueAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "validGuid" : true,
+ "assignedGuid" : true,
+ "unAssignedGuid" : true,
+ "valid" : true
+ },
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ }, {
+ "guid" : "...",
+ "status" : "ACTIVE",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "atlasObjectId" : {
+ "guid" : "...",
+ "typeName" : "...",
+ "uniqueAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "validGuid" : true,
+ "assignedGuid" : true,
+ "unAssignedGuid" : true,
+ "valid" : true
+ },
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ } ],
+ "firstEntityCreated" : {
+ "guid" : "...",
+ "status" : "ACTIVE",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "atlasObjectId" : {
+ "guid" : "...",
+ "typeName" : "...",
+ "uniqueAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "validGuid" : true,
+ "assignedGuid" : true,
+ "unAssignedGuid" : true,
+ "valid" : true
+ },
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ },
+ "firstEntityUpdated" : {
+ "guid" : "...",
+ "status" : "ACTIVE",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "atlasObjectId" : {
+ "guid" : "...",
+ "typeName" : "...",
+ "uniqueAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "validGuid" : true,
+ "assignedGuid" : true,
+ "unAssignedGuid" : true,
+ "valid" : true
+ },
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ },
+ "firstEntityPartialUpdated" : {
+ "guid" : "...",
+ "status" : "ACTIVE",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "atlasObjectId" : {
+ "guid" : "...",
+ "typeName" : "...",
+ "uniqueAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "validGuid" : true,
+ "assignedGuid" : true,
+ "unAssignedGuid" : true,
+ "valid" : true
+ },
+ "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" : [ "...", "..." ],
+ "atlasObjectId" : {
+ "guid" : "...",
+ "typeName" : "...",
+ "uniqueAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "validGuid" : true,
+ "assignedGuid" : true,
+ "unAssignedGuid" : true,
+ "valid" : true
+ },
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ }, {
+ "guid" : "...",
+ "status" : "ACTIVE",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "atlasObjectId" : {
+ "guid" : "...",
+ "typeName" : "...",
+ "uniqueAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "validGuid" : true,
+ "assignedGuid" : true,
+ "unAssignedGuid" : true,
+ "valid" : true
+ },
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ } ],
+ "property2" : [ {
+ "guid" : "...",
+ "status" : "ACTIVE",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "atlasObjectId" : {
+ "guid" : "...",
+ "typeName" : "...",
+ "uniqueAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "validGuid" : true,
+ "assignedGuid" : true,
+ "unAssignedGuid" : true,
+ "valid" : true
+ },
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ }, {
+ "guid" : "...",
+ "status" : "ACTIVE",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "atlasObjectId" : {
+ "guid" : "...",
+ "typeName" : "...",
+ "uniqueAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "validGuid" : true,
+ "assignedGuid" : true,
+ "unAssignedGuid" : true,
+ "valid" : true
+ },
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ } ]
+ },
+ "guidAssignments" : {
+ "property1" : "...",
+ "property2" : "..."
+ },
+ "createdEntities" : [ {
+ "guid" : "...",
+ "status" : "ACTIVE",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "atlasObjectId" : {
+ "guid" : "...",
+ "typeName" : "...",
+ "uniqueAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "validGuid" : true,
+ "assignedGuid" : true,
+ "unAssignedGuid" : true,
+ "valid" : true
+ },
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ }, {
+ "guid" : "...",
+ "status" : "ACTIVE",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "atlasObjectId" : {
+ "guid" : "...",
+ "typeName" : "...",
+ "uniqueAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "validGuid" : true,
+ "assignedGuid" : true,
+ "unAssignedGuid" : true,
+ "valid" : true
+ },
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ } ],
+ "updatedEntities" : [ {
+ "guid" : "...",
+ "status" : "DELETED",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "atlasObjectId" : {
+ "guid" : "...",
+ "typeName" : "...",
+ "uniqueAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "validGuid" : true,
+ "assignedGuid" : true,
+ "unAssignedGuid" : true,
+ "valid" : true
+ },
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ }, {
+ "guid" : "...",
+ "status" : "ACTIVE",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "atlasObjectId" : {
+ "guid" : "...",
+ "typeName" : "...",
+ "uniqueAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "validGuid" : true,
+ "assignedGuid" : true,
+ "unAssignedGuid" : true,
+ "valid" : true
+ },
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ } ],
+ "partialUpdatedEntities" : [ {
+ "guid" : "...",
+ "status" : "ACTIVE",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "atlasObjectId" : {
+ "guid" : "...",
+ "typeName" : "...",
+ "uniqueAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "validGuid" : true,
+ "assignedGuid" : true,
+ "unAssignedGuid" : true,
+ "valid" : true
+ },
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ }, {
+ "guid" : "...",
+ "status" : "DELETED",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "atlasObjectId" : {
+ "guid" : "...",
+ "typeName" : "...",
+ "uniqueAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "validGuid" : true,
+ "assignedGuid" : true,
+ "unAssignedGuid" : true,
+ "valid" : true
+ },
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ } ],
+ "deletedEntities" : [ {
+ "guid" : "...",
+ "status" : "ACTIVE",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "atlasObjectId" : {
+ "guid" : "...",
+ "typeName" : "...",
+ "uniqueAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "validGuid" : true,
+ "assignedGuid" : true,
+ "unAssignedGuid" : true,
+ "valid" : true
+ },
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ }, {
+ "guid" : "...",
+ "status" : "ACTIVE",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "atlasObjectId" : {
+ "guid" : "...",
+ "typeName" : "...",
+ "uniqueAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "validGuid" : true,
+ "assignedGuid" : true,
+ "unAssignedGuid" : true,
+ "valid" : true
+ },
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ } ],
+ "firstEntityCreated" : {
+ "guid" : "...",
+ "status" : "ACTIVE",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "atlasObjectId" : {
+ "guid" : "...",
+ "typeName" : "...",
+ "uniqueAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "validGuid" : true,
+ "assignedGuid" : true,
+ "unAssignedGuid" : true,
+ "valid" : true
+ },
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ },
+ "firstEntityUpdated" : {
+ "guid" : "...",
+
<TRUNCATED>