http://git-wip-us.apache.org/repos/asf/atlas-website/blob/c5b7bdb3/0.8.1/api/v2/ui/swagger.json ---------------------------------------------------------------------- diff --git a/0.8.1/api/v2/ui/swagger.json b/0.8.1/api/v2/ui/swagger.json new file mode 100644 index 0000000..c2ecdeb --- /dev/null +++ b/0.8.1/api/v2/ui/swagger.json @@ -0,0 +1,10833 @@ +{ + "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.1", + "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" : "RelationshipREST" + , + "description" : "REST interface for entity relationships." + } + , + { + "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" + }, + "defaultValue" : { +"description" : "", +"type" : "string" + }, + "constraints" : { +"description" : "", +"type" : "array", +"items" : { + "$ref" : "#/definitions/json_AtlasConstraintDef" +} + } + }, + "example" : { + "name" : "...", + "typeName" : "...", + "isOptional" : true, + "cardinality" : "SET", + "valuesMinCount" : 12345, + "valuesMaxCount" : 12345, + "isUnique" : true, + "isIndexable" : true, + "defaultValue" : "...", + "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" : "RELATIONSHIP", + "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" : "LIST", + "valuesMinCount" : 12345, + "valuesMaxCount" : 12345, + "isUnique" : true, + "isIndexable" : true, + "defaultValue" : "...", + "constraints" : [ { + "type" : "...", + "params" : { + "property1" : { }, + "property2" : { } + } + }, { + "type" : "...", + "params" : { + "property1" : { }, + "property2" : { } + } + } ] + }, { + "name" : "...", + "typeName" : "...", + "isOptional" : true, + "cardinality" : "LIST", + "valuesMinCount" : 12345, + "valuesMaxCount" : 12345, + "isUnique" : true, + "isIndexable" : true, + "defaultValue" : "...", + "constraints" : [ { + "type" : "...", + "params" : { + "property1" : { }, + "property2" : { } + } + }, { + "type" : "...", + "params" : { + "property1" : { }, + "property2" : { } + } + } ] + } ], + "category" : "CLASSIFICATION", + "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, + "relationshipAttributes" : { + "property1" : { }, + "property2" : { } + }, + "classifications" : [ { + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + }, { + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + } ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + }, { + "guid" : "...", + "status" : "ACTIVE", + "createdBy" : "...", + "updatedBy" : "...", + "createTime" : 12345, + "updateTime" : 12345, + "version" : 12345, + "relationshipAttributes" : { + "property1" : { }, + "property2" : { } + }, + "classifications" : [ { + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + }, { + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + } ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + } ], + "referredEntities" : { + "property1" : { + "guid" : "...", + "status" : "DELETED", + "createdBy" : "...", + "updatedBy" : "...", + "createTime" : 12345, + "updateTime" : 12345, + "version" : 12345, + "relationshipAttributes" : { + "property1" : { }, + "property2" : { } + }, + "classifications" : [ { + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + }, { + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + } ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + }, + "property2" : { + "guid" : "...", + "status" : "DELETED", + "createdBy" : "...", + "updatedBy" : "...", + "createTime" : 12345, + "updateTime" : 12345, + "version" : 12345, + "relationshipAttributes" : { + "property1" : { }, + "property2" : { } + }, + "classifications" : [ { + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + }, { + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + } ], + "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" + }, + "relationshipAttributes" : { +"description" : "", +"type" : "object", +"additionalProperties" : { + "type" : "object" +} + }, + "classifications" : { +"description" : "", +"type" : "array", +"items" : { + "$ref" : "#/definitions/json_AtlasClassification" +} + } + } + } + ], + "example" : { + "guid" : "...", + "status" : "DELETED", + "createdBy" : "...", + "updatedBy" : "...", + "createTime" : 12345, + "updateTime" : 12345, + "version" : 12345, + "relationshipAttributes" : { + "property1" : { }, + "property2" : { } + }, + "classifications" : [ { + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + }, { + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + } ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } +}, + "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" : "SET", + "valuesMinCount" : 12345, + "valuesMaxCount" : 12345, + "isUnique" : true, + "isIndexable" : true, + "defaultValue" : "...", + "constraints" : [ { + "type" : "...", + "params" : { + "property1" : { }, + "property2" : { } + } + }, { + "type" : "...", + "params" : { + "property1" : { }, + "property2" : { } + } + } ] + }, { + "name" : "...", + "typeName" : "...", + "isOptional" : true, + "cardinality" : "SET", + "valuesMinCount" : 12345, + "valuesMaxCount" : 12345, + "isUnique" : true, + "isIndexable" : true, + "defaultValue" : "...", + "constraints" : [ { + "type" : "...", + "params" : { + "property1" : { }, + "property2" : { } + } + }, { + "type" : "...", + "params" : { + "property1" : { }, + "property2" : { } + } + } ] + } ], + "category" : "ENTITY", + "guid" : "...", + "createdBy" : "...", + "updatedBy" : "...", + "createTime" : 12345, + "updateTime" : 12345, + "version" : 12345, + "name" : "...", + "description" : "...", + "typeVersion" : "...", + "options" : { + "property1" : "...", + "property2" : "..." + } +}, + "description" : "class that captures details of a entity-type." + } + , + "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, + "relationshipAttributes" : { + "property1" : { }, + "property2" : { } + }, + "classifications" : [ { + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + }, { + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + } ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + }, + "property2" : { + "guid" : "...", + "status" : "DELETED", + "createdBy" : "...", + "updatedBy" : "...", + "createTime" : 12345, + "updateTime" : 12345, + "version" : 12345, + "relationshipAttributes" : { + "property1" : { }, + "property2" : { } + }, + "classifications" : [ { + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + }, { + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + } ], + "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" +} + } + } + } + ], + "example" : { + "guid" : "...", + "status" : "DELETED", + "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, + "relationshipAttributes" : { + "property1" : { }, + "property2" : { } + }, + "classifications" : [ { + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + }, { + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + } ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + }, + "referredEntities" : { + "property1" : { + "guid" : "...", + "status" : "DELETED", + "createdBy" : "...", + "updatedBy" : "...", + "createTime" : 12345, + "updateTime" : 12345, + "version" : 12345, + "relationshipAttributes" : { + "property1" : { }, + "property2" : { } + }, + "classifications" : [ { + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + }, { + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + } ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + }, + "property2" : { + "guid" : "...", + "status" : "ACTIVE", + "createdBy" : "...", + "updatedBy" : "...", + "createTime" : 12345, + "updateTime" : 12345, + "version" : 12345, + "relationshipAttributes" : { + "property1" : { }, + "property2" : { } + }, + "classifications" : [ { + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + }, { + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + } ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + } + } +}, + "description" : "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" : "ARRAY", + "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" : "ACTIVE", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + }, + "score" : 12345.0 +}, + "description" : "" + } + , + "json_AtlasLineageInfo" : { + "type" : "object", + "title" : "AtlasLineageInfo", + "properties" : { + "baseEntityGuid" : { +"description" : "", +"type" : "string" + }, + "guidEntityMap" : { +"description" : "", +"type" : "object", +"additionalProperties" : { + "$ref" : "#/definitions/json_AtlasEntityHeader" +} + }, + "relations" : { +"description" : "", +"type" : "array", +"items" : { + "$ref" : "#/definitions/json_LineageRelation" +} + }, + "lineageDirection" : { +"description" : "", +"$ref" : "#/definitions/json_LineageDirection" + }, + "lineageDepth" : { +"description" : "", +"type" : "number" + } + }, + "example" : { + "baseEntityGuid" : "...", + "guidEntityMap" : { + "property1" : { + "guid" : "...", + "status" : "ACTIVE", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + }, + "property2" : { + "guid" : "...", + "status" : "DELETED", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + } + }, + "relations" : [ { + "fromEntityId" : "...", + "toEntityId" : "..." + }, { + "fromEntityId" : "...", + "toEntityId" : "..." + } ], + "lineageDirection" : "BOTH", + "lineageDepth" : 12345 +}, + "description" : "" + } + , + "json_AtlasObjectId" : { + "type" : "object", + "title" : "AtlasObjectId", + "properties" : { + "guid" : { +"description" : "", +"type" : "string" + }, + "typeName" : { +"description" : "", +"type" : "string" + }, + "uniqueAttributes" : { +"description" : "", +"type" : "object", +"additionalProperties" : { + "type" : "object" +} + } + }, + "example" : { + "guid" : "...", + "typeName" : "...", + "uniqueAttributes" : { + "property1" : { }, + "property2" : { } + } +}, + "description" : "Reference to an object-instance of an Atlas type - like entity." + } + , + "json_AtlasQueryType" : { + "type" : "string", + "title" : "AtlasQueryType", + "enum" : [ + "DSL", + "FULL_TEXT", + "GREMLIN", + "BASIC", + "ATTRIBUTE", + "RELATIONSHIP" + ], + "description" : "" + } + , + "json_AtlasRelationship" : { + "type" : "object", + "title" : "AtlasRelationship", + "allOf" : [ + { + "$ref" : "#/definitions/json_AtlasStruct" + }, + { + "properties" : { + "guid" : { +"description" : "", +"type" : "string" + }, + "status" : { +"description" : "", +"$ref" : "#/definitions/json_Status_AtlasRelationship" + }, + "createdBy" : { +"description" : "", +"type" : "string" + }, + "updatedBy" : { +"description" : "", +"type" : "string" + }, + "createTime" : { +"description" : "", +"type" : "number" + }, + "updateTime" : { +"description" : "", +"type" : "number" + }, + "version" : { +"description" : "", +"type" : "number" + }, + "end1" : { +"description" : "", +"$ref" : "#/definitions/json_AtlasObjectId" + }, + "end2" : { +"description" : "", +"$ref" : "#/definitions/json_AtlasObjectId" + }, + "label" : { +"description" : "", +"type" : "string" + } + } + } + ], + "example" : { + "guid" : "...", + "status" : "ACTIVE", + "createdBy" : "...", + "updatedBy" : "...", + "createTime" : 12345, + "updateTime" : 12345, + "version" : 12345, + "end1" : { + "guid" : "...", + "typeName" : "...", + "uniqueAttributes" : { + "property1" : { }, + "property2" : { } + } + }, + "end2" : { + "guid" : "...", + "typeName" : "...", + "uniqueAttributes" : { + "property1" : { }, + "property2" : { } + } + }, + "label" : "...", + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } +}, + "description" : "Atlas relationship instance." + } + , + "json_AtlasRelationshipDef" : { + "type" : "object", + "title" : "AtlasRelationshipDef", + "allOf" : [ + { + "$ref" : "#/definitions/json_AtlasStructDef" + }, + { + "properties" : { + "relationshipCategory" : { +"description" : "", +"$ref" : "#/definitions/json_RelationshipCategory" + }, + "propagateTags" : { +"description" : "", +"$ref" : "#/definitions/json_PropagateTags" + }, + "endDef1" : { +"description" : "", +"$ref" : "#/definitions/json_AtlasRelationshipEndDef" + }, + "endDef2" : { +"description" : "", +"$ref" : "#/definitions/json_AtlasRelationshipEndDef" + }, + "relationshipLabel" : { +"description" : "", +"type" : "string" + } + } + } + ], + "example" : { + "relationshipCategory" : "COMPOSITION", + "propagateTags" : "TWO_TO_ONE", + "endDef1" : { + "type" : "...", + "name" : "...", + "isContainer" : true, + "cardinality" : "SET", + "isLegacyAttribute" : true + }, + "endDef2" : { + "type" : "...", + "name" : "...", + "isContainer" : true, + "cardinality" : "SET", + "isLegacyAttribute" : true + }, + "relationshipLabel" : "...", + "attributeDefs" : [ { + "name" : "...", + "typeName" : "...", + "isOptional" : true, + "cardinality" : "LIST", + "valuesMinCount" : 12345, + "valuesMaxCount" : 12345, + "isUnique" : true, + "isIndexable" : true, + "defaultValue" : "...", + "constraints" : [ { + "type" : "...", + "params" : { + "property1" : { }, + "property2" : { } + } + }, { + "type" : "...", + "params" : { + "property1" : { }, + "property2" : { } + } + } ] + }, { + "name" : "...", + "typeName" : "...", + "isOptional" : true, + "cardinality" : "SET", + "valuesMinCount" : 12345, + "valuesMaxCount" : 12345, + "isUnique" : true, + "isIndexable" : true, + "defaultValue" : "...", + "constraints" : [ { + "type" : "...", + "params" : { + "property1" : { }, + "property2" : { } + } + }, { + "type" : "...", + "params" : { + "property1" : { }, + "property2" : { } + } + } ] + } ], + "category" : "ENUM", + "guid" : "...", + "createdBy" : "...", + "updatedBy" : "...", + "createTime" : 12345, + "updateTime" : 12345, + "version" : 12345, + "name" : "...", + "description" : "...", + "typeVersion" : "...", + "options" : { + "property1" : "...", + "property2" : "..." + } +}, + "description" : "AtlasRelationshipDef is a TypeDef that defines a relationship.\n<p>\nAs with other typeDefs the AtlasRelationshipDef has a name. Once created the RelationshipDef has a guid.\nThe name and the guid are the 2 ways that the RelationshipDef is identified.\n<p>\nRelationshipDefs have 2 ends, each of which specify cardinality, an EntityDef type name and name and optionally\nwhether the end is a container.\n<p>\nRelationshipDefs can have AttributeDefs - though only primitive types are allowed. <br>\nRelationshipDefs have a relationshipCategory specifying the UML type of relationship required <br>\nRelationshipDefs also have a PropogateTag - indicating which way tags could flow over the relationships.\n<p>\nThe way EntityDefs and RelationshipDefs are intended to be used is that EntityDefs will define AttributeDefs these AttributeDefs\nwill not specify an EntityDef type name as their types.\n<p>\nRelationshipDefs introduce new atributes to the entity instances. For exa mple\n<p>\nEntityDef A might have attributes attr1,attr2,attr3 <br>\nEntityDef B might have attributes attr4,attr5,attr6 <br>\nRelationshipDef AtoB might define 2 ends <br>\n\n<pre>\n end1: type A, name attr7\n end2: type B, name attr8 <\/pre>\n\n<p>\nWhen an instance of EntityDef A is created, it will have attributes attr1,attr2,attr3,attr7 <br>\nWhen an instance of EntityDef B is created, it will have attributes attr4,attr5,attr6,attr8\n<p>\nIn this way relationshipDefs can be authored separately from entityDefs and can inject relationship attributes into\nthe entity instances" + } + , + "json_AtlasRelationshipEndDef" : { + "type" : "object", + "title" : "AtlasRelationshipEndDef", + "properties" : { + "type" : { +"description" : "", +"type" : "string" + }, + "name" : { +"description" : "", +"type" : "string" + }, + "isContainer" : { +"description" : "", +"type" : "boolean" + }, + "cardinality" : { +"description" : "", +"$ref" : "#/definitions/json_Cardinality" + }, + "isLegacyAttribute" : { +"description" : "", +"type" : "boolean" + } + }, + "example" : { + "type" : "...", + "name" : "...", + "isContainer" : true, + "cardinality" : "LIST", + "isLegacyAttribute" : true +}, + "description" : "The relationshipEndDef represents an end of the relationship. The end of the relationship is defined by a type, an\nattribute name, cardinality and whether it is the container end of the relationship." + } + , + "json_AtlasSearchResult" : { + "type" : "object", + "title" : "AtlasSearchResult", + "properties" : { + "queryType" : { +"description" : "", +"$ref" : "#/definitions/json_AtlasQueryType" + }, + "searchParameters" : { +"description" : "", +"$ref" : "#/definitions/json_SearchParameters" + }, + "queryText" : { +"description" : "", +"type" : "string" + }, + "type" : { +"description" : "", +"type" : "string" + }, + "classification" : { +"description" : "", +"type" : "string" + }, + "entities" : { +"description" : "", +"type" : "array", +"items" : { + "$ref" : "#/definitions/json_AtlasEntityHeader" +} + }, + "attributes" : { +"description" : "", +"$ref" : "#/definitions/json_AttributeSearchResult" + }, + "fullTextResult" : { +"description" : "", +"type" : "array", +"items" : { + "$ref" : "#/definitions/json_AtlasFullTextResult" +} + }, + "referredEntities" : { +"description" : "", +"type" : "object", +"additionalProperties" : { + "$ref" : "#/definitions/json_AtlasEntityHeader" +} + } + }, + "example" : { + "queryType" : "FULL_TEXT", + "searchParameters" : { + "query" : "...", + "typeName" : "...", + "classification" : "...", + "excludeDeletedEntities" : true, + "limit" : 12345, + "offset" : 12345, + "entityFilters" : { + "attributeName" : "...", + "operator" : "ENDS_WITH", + "attributeValue" : "...", + "condition" : "OR", + "criterion" : [ { }, { } ] + }, + "tagFilters" : { + "attributeName" : "...", + "operator" : "STARTS_WITH", + "attributeValue" : "...", + "condition" : "OR", + "criterion" : [ { }, { } ] + }, + "attributes" : [ "...", "..." ] + }, + "queryText" : "...", + "type" : "...", + "classification" : "...", + "entities" : [ { + "guid" : "...", + "status" : "DELETED", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + }, { + "guid" : "...", + "status" : "ACTIVE", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + } ], + "attributes" : { + "name" : [ "...", "..." ], + "values" : [ ] + }, + "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 + } ], + "referredEntities" : { + "property1" : { + "guid" : "...", + "status" : "ACTIVE", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + }, + "property2" : { + "guid" : "...", + "status" : "ACTIVE", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + } + } +}, + "description" : "" + } + , + "json_AtlasStruct" : { + "type" : "object", + "title" : "AtlasStruct", + "properties" : { + "typeName" : { +"description" : "", +"type" : "string" + }, + "attributes" : { +"description" : "", +"type" : "object", +"additionalProperties" : { + "type" : "object" +} + } + }, + "example" : { + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } +}, + "description" : "Captures details of struct contents. Not instantiated directly, used only via AtlasEntity, AtlasClassification." + } + , + "json_AtlasStructDef" : { + "type" : "object", + "title" : "AtlasStructDef", + "allOf" : [ + { + "$ref" : "#/definitions/json_AtlasBaseTypeDef" + }, + { + "properties" : { + "attributeDefs" : { +"description" : "", +"type" : "array", +"items" : { + "$ref" : "#/definitions/json_AtlasAttributeDef" +} + } + } + } + ], + "example" : { + "attributeDefs" : [ { + "name" : "...", + "typeName" : "...", + "isOptional" : true, + "cardinality" : "LIST", + "valuesMinCount" : 12345, + "valuesMaxCount" : 12345, + "isUnique" : true, + "isIndexable" : true, + "defaultValue" : "...", + "constraints" : [ { + "type" : "...", + "params" : { + "property1" : { }, + "property2" : { } + } + }, { + "type" : "...", + "params" : { + "property1" : { }, + "property2" : { } + } + } ] + }, { + "name" : "...", + "typeName" : "...", + "isOptional" : true, + "cardinality" : "LIST", + "valuesMinCount" : 12345, + "valuesMaxCount" : 12345, + "isUnique" : true, + "isIndexable" : true, + "defaultValue" : "...", + "constraints" : [ { + "type" : "...", + "params" : { + "property1" : { }, + "property2" : { } + } + }, { + "type" : "...", + "params" : { + "property1" : { }, + "property2" : { } + } + } ] + } ], + "category" : "CLASSIFICATION", + "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" : "PRIMITIVE" +}, + "description" : "" + } + , + "json_AtlasTypesDef" : { + "type" : "object", + "title" : "AtlasTypesDef", + "properties" : { + "enumDefs" : { +"description" : "", +"type" : "array", +"items" : { + "$ref" : "#/definitions/json_AtlasEnumDef" +} + }, + "structDefs" : { +"description" : "", +"type" : "array", +"items" : { + "$ref" : "#/definitions/json_AtlasStructDef" +} + }, + "classificationDefs" : { +"description" : "", +"type" : "array", +"items" : { + "$ref" : "#/definitions/json_AtlasClassificationDef" +} + }, + "entityDefs" : { +"description" : "", +"type" : "array", +"items" : { + "$ref" : "#/definitions/json_AtlasEntityDef" +} + }, + "relationshipDefs" : { +"description" : "", +"type" : "array", +"items" : { + "$ref" : "#/definitions/json_AtlasRelationshipDef" +} + }, + "empty" : { +"description" : "", +"type" : "boolean" + } + }, + "example" : { + "enumDefs" : [ { + "elementDefs" : [ { + "value" : "...", + "description" : "...", + "ordinal" : 12345 + }, { + "value" : "...", + "description" : "...", + "ordinal" : 12345 + } ], + "defaultValue" : "...", + "category" : "OBJECT_ID_TYPE", + "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" : "SET", + "valuesMinCount" : 12345, + "valuesMaxCount" : 12345, + "isUnique" : true, + "isIndexable" : true, + "defaultValue" : "...", + "constraints" : [ { }, { } ] + }, { + "name" : "...", + "typeName" : "...", + "isOptional" : true, + "cardinality" : "SET", + "valuesMinCount" : 12345, + "valuesMaxCount" : 12345, + "isUnique" : true, + "isIndexable" : true, + "defaultValue" : "...", + "constraints" : [ { }, { } ] + } ], + "category" : "STRUCT", + "guid" : "...", + "createdBy" : "...", + "updatedBy" : "...", + "createTime" : 12345, + "updateTime" : 12345, + "version" : 12345, + "name" : "...", + "description" : "...", + "typeVersion" : "...", + "options" : { + "property1" : "...", + "property2" : "..." + } + }, { + "attributeDefs" : [ { + "name" : "...", + "typeName" : "...", + "isOptional" : true, + "cardinality" : "LIST", + "valuesMinCount" : 12345, + "valuesMaxCount" : 12345, + "isUnique" : true, + "isIndexable" : true, + "defaultValue" : "...", + "constraints" : [ { }, { } ] + }, { + "name" : "...", + "typeName" : "...", + "isOptional" : true, + "cardinality" : "SINGLE", + "valuesMinCount" : 12345, + "valuesMaxCount" : 12345, + "isUnique" : true, + "isIndexable" : true, + "defaultValue" : "...", + "constraints" : [ { }, { } ] + } ], + "category" : "ENTITY", + "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, + "defaultValue" : "...", + "constraints" : [ { }, { } ] + }, { + "name" : "...", + "typeName" : "...", + "isOptional" : true, + "cardinality" : "SET", + "valuesMinCount" : 12345, + "valuesMaxCount" : 12345, + "isUnique" : true, + "isIndexable" : true, + "defaultValue" : "...", + "constraints" : [ { }, { } ] + } ], + "category" : "ARRAY", + "guid" : "...", + "createdBy" : "...", + "updatedBy" : "...", + "createTime" : 12345, + "updateTime" : 12345, + "version" : 12345, + "name" : "...", + "description" : "...", + "typeVersion" : "...", + "options" : { + "property1" : "...", + "property2" : "..." + } + }, { + "superTypes" : [ "...", "..." ], + "attributeDefs" : [ { + "name" : "...", + "typeName" : "...", + "isOptional" : true, + "cardinality" : "SET", + "valuesMinCount" : 12345, + "valuesMaxCount" : 12345, + "isUnique" : true, + "isIndexable" : true, + "defaultValue" : "...", + "constraints" : [ { }, { } ] + }, { + "name" : "...", + "typeName" : "...", + "isOptional" : true, + "cardinality" : "SET", + "valuesMinCount" : 12345, + "valuesMaxCount" : 12345, + "isUnique" : true, + "isIndexable" : true, + "defaultValue" : "...", + "constraints" : [ { }, { } ] + } ], + "category" : "STRUCT", + "guid" : "...", + "createdBy" : "...", + "updatedBy" : "...", + "createTime" : 12345, + "updateTime" : 12345, + "version" : 12345, + "name" : "...", + "description" : "...", + "typeVersion" : "...", + "options" : { + "property1" : "...", + "property2" : "..." + } + } ], + "entityDefs" : [ { + "superTypes" : [ "...", "..." ], + "attributeDefs" : [ { + "name" : "...", + "typeName" : "...", + "isOptional" : true, + "cardinality" : "SINGLE", + "valuesMinCount" : 12345, + "valuesMaxCount" : 12345, + "isUnique" : true, + "isIndexable" : true, + "defaultValue" : "...", + "constraints" : [ { }, { } ] + }, { + "name" : "...", + "typeName" : "...", + "isOptional" : true, + "cardinality" : "SET", + "valuesMinCount" : 12345, + "valuesMaxCount" : 12345, + "isUnique" : true, + "isIndexable" : true, + "defaultValue" : "...", + "constraints" : [ { }, { } ] + } ], + "category" : "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, + "defaultValue" : "...", + "constraints" : [ { }, { } ] + }, { + "name" : "...", + "typeName" : "...", + "isOptional" : true, + "cardinality" : "SET", + "valuesMinCount" : 12345, + "valuesMaxCount" : 12345, + "isUnique" : true, + "isIndexable" : true, + "defaultValue" : "...", + "constraints" : [ { }, { } ] + } ], + "category" : "ARRAY", + "guid" : "...", + "createdBy" : "...", + "updatedBy" : "...", + "createTime" : 12345, + "updateTime" : 12345, + "version" : 12345, + "name" : "...", + "description" : "...", + "typeVersion" : "...", + "options" : { + "property1" : "...", + "property2" : "..." + } + } ], + "relationshipDefs" : [ { + "relationshipCategory" : "ASSOCIATION", + "propagateTags" : "BOTH", + "endDef1" : { + "type" : "...", + "name" : "...", + "isContainer" : true, + "cardinality" : "SINGLE", + "isLegacyAttribute" : true + }, + "endDef2" : { + "type" : "...", + "name" : "...", + "isContainer" : true, + "cardinality" : "SINGLE", + "isLegacyAttribute" : true + }, + "relationshipLabel" : "...", + "attributeDefs" : [ { + "name" : "...", + "typeName" : "...", + "isOptional" : true, + "cardinality" : "LIST", + "valuesMinCount" : 12345, + "valuesMaxCount" : 12345, + "isUnique" : true, + "isIndexable" : true, + "defaultValue" : "...", + "constraints" : [ { }, { } ] + }, { + "name" : "...", + "typeName" : "...", + "isOptional" : true, + "cardinality" : "SET", + "valuesMinCount" : 12345, + "valuesMaxCount" : 12345, + "isUnique" : true, + "isIndexable" : true, + "defaultValue" : "...", + "constraints" : [ { }, { } ] + } ], + "category" : "MAP", + "guid" : "...", + "createdBy" : "...", + "updatedBy" : "...", + "createTime" : 12345, + "updateTime" : 12345, + "version" : 12345, + "name" : "...", + "description" : "...", + "typeVersion" : "...", + "options" : { + "property1" : "...", + "property2" : "..." + } + }, { + "relationshipCategory" : "ASSOCIATION", + "propagateTags" : "ONE_TO_TWO", + "endDef1" : { + "type" : "...", + "name" : "...", + "isContainer" : true, + "cardinality" : "SET", + "isLegacyAttribute" : true + }, + "endDef2" : { + "type" : "...", + "name" : "...", + "isContainer" : true, + "cardinality" : "SET", + "isLegacyAttribute" : true + }, + "relationshipLabel" : "...", + "attributeDefs" : [ { + "name" : "...", + "typeName" : "...", + "isOptional" : true, + "cardinality" : "SINGLE", + "valuesMinCount" : 12345, + "valuesMaxCount" : 12345, + "isUnique" : true, + "isIndexable" : true, + "defaultValue" : "...", + "constraints" : [ { }, { } ] + }, { + "name" : "...", + "typeName" : "...", + "isOptional" : true, + "cardinality" : "SET", + "valuesMinCount" : 12345, + "valuesMaxCount" : 12345, + "isUnique" : true, + "isIndexable" : true, + "defaultValue" : "...", + "constraints" : [ { }, { } ] + } ], + "category" : "PRIMITIVE", + "guid" : "...", + "createdBy" : "...", + "updatedBy" : "...", + "createTime" : 12345, + "updateTime" : 12345, + "version" : 12345, + "name" : "...", + "description" : "...", + "typeVersion" : "...", + "options" : { + "property1" : "...", + "property2" : "..." + } + } ], + "empty" : true +}, + "description" : "" + } + , + "json_AttributeSearchResult" : { + "type" : "object", + "title" : "AttributeSearchResult", + "properties" : { + "name" : { +"description" : "", +"type" : "array", +"items" : { + "type" : "string" +} + }, + "values" : { +"description" : "", +"type" : "array", +"items" : { + "type" : "object" +} + } + }, + "example" : { + "name" : [ "...", "..." ], + "values" : [ ] +}, + "description" : "" + } + , + "json_Cardinality" : { + "type" : "string", + "title" : "Cardinality", + "enum" : [ + "SINGLE", + "LIST", + "SET" + ], + "description" : "single-valued attribute or multi-valued attribute." + } + , + "json_ClassificationAssociateRequest" : { + "type" : "object", + "title" : "ClassificationAssociateRequest", + "properties" : { + "classification" : { +"description" : "", +"$ref" : "#/definitions/json_AtlasClassification" + }, + "entityGuids" : { +"description" : "", +"type" : "array", +"items" : { + "type" : "string" +} + } + }, + "example" : { + "classification" : { + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + }, + "entityGuids" : [ "...", "..." ] +}, + "description" : "" + } + , + "json_Condition" : { + "type" : "string", + "title" : "Condition", + "enum" : [ + "AND", + "OR" + ], + "description" : "" + } + , + "json_EntityMutationResponse" : { + "type" : "object", + "title" : "EntityMutationResponse", + "properties" : { + "mutatedEntities" : { +"description" : "", +"type" : "object", +"additionalProperties" : { +"type" : "array", +"items" : { + "$ref" : "#/definitions/json_AtlasEntityHeader" +} +} + }, + "guidAssignments" : { +"description" : "", +"type" : "object", +"additionalProperties" : { + "type" : "string" +} + }, + "createdEntities" : { +"description" : "", +"type" : "array", +"items" : { + "$ref" : "#/definitions/json_AtlasEntityHeader" +} + }, + "updatedEntities" : { +"description" : "", +"type" : "array", +"items" : { + "$ref" : "#/definitions/json_AtlasEntityHeader" +} + }, + "partialUpdatedEntities" : { +"description" : "", +"type" : "array", +"items" : { + "$ref" : "#/definitions/json_AtlasEntityHeader" +} + }, + "deletedEntities" : { +"description" : "", +"type" : "array", +"items" : { + "$ref" : "#/definitions/json_AtlasEntityHeader" +} + }, + "firstEntityCreated" : { +"description" : "", +"$ref" : "#/definitions/json_AtlasEntityHeader" + }, + "firstEntityUpdated" : { +"description" : "", +"$ref" : "#/definitions/json_AtlasEntityHeader" + }, + "firstEntityPartialUpdated" : { +"description" : "", +"$ref" : "#/definitions/json_AtlasEntityHeader" + } + }, + "example" : { + "mutatedEntities" : { + "property1" : [ { + "guid" : "...", + "status" : "DELETED", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + }, { + "guid" : "...", + "status" : "ACTIVE", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + } ], + "property2" : [ { + "guid" : "...", + "status" : "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" : "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" : "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" : "DELETED", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + } +}, + "description" : "" + } + , + "json_EntityOperation" : { + "type" : "string", + "title" : "EntityOperation", + "enum" : [ + "CREATE", + "UPDATE", + "PARTIAL_UPDATE", + "DELETE" + ], + "description" : "" + } + , + "json_FilterCriteria" : { + "type" : "object", + "title" : "FilterCriteria", + "properties" : { + "attributeName" : { +"description" : "", +"type" : "string" + }, + "operator" : { +"description" : "", +"$ref" : "#/definitions/json_Operator" + }, + "attributeValue" : { +"description" : "", +"type" : "string" + }, + "condition" : { +"description" : "", +"$ref" : "#/definitions/json_Condition" + }, + "criterion" : { +"description" : "", +"type" : "array", +"items" : { + "$ref" : "#/definitions/json_FilterCriteria" +} + } + }, + "example" : { + "attributeName" : "...", + "operator" : "EQ", + "attributeValue" : "...", + "condition" : "OR", + "criterion" : [ { + "attributeName" : "...", + "operator" : "GTE", + "attributeValue" : "...", + "condition" : "OR", + "criterion" : [ { }, { } ] + }, { + "attributeName" : "...", + "operator" : "GT", + "attributeValue" : "...", + "condition" : "OR", + "criterion" : [ { }, { } ] + } ] +}, + "description" : "" + } + , + "json_LineageDirection" : { + "type" : "string", + "title" : "LineageDirection", + "enum" : [ + "INPUT", + "OUTPUT", + "BOTH" + ], + "description" : "" + } + , + "json_LineageRelation" : { + "type" : "object", + "title" : "LineageRelation", + "properties" : { + "fromEntityId" : { +"description" : "", +"type" : "string" + }, + "toEntityId" : { +"description" : "", +"type" : "string" + } + }, + "example" : { + "fromEntityId" : "...", + "toEntityId" : "..." +}, + "description" : "" + } + , + "json_Operator" : { + "type" : "string", + "title" : "Operator", + "enum" : [ + "LT", + "GT", + "LTE", + "GTE", + "EQ", + "NEQ", + "IN", + "LIKE", + "STARTS_WITH", + "ENDS_WITH", + "CONTAINS" + ], + "description" : "Supported search operations\nLogical comparision operators can only be used with numbers or dates\nIN, LIKE, startsWith, endsWith, CONTAINS can only be used with strings or text" + } + , + "json_PList" : { + "type" : "object", + "title" : "PList", + "properties" : { + "list" : { +"description" : "", +"type" : "array", +"items" : { + "type" : "object" +} + }, + "startIndex" : { +"description" : "", +"type" : "number" + }, + "pageSize" : { +"description" : "", +"type" : "number" + }, + "totalCount" : { +"description" : "", +"type" : "number" + }, + "sortType" : { +"description" : "", +"$ref" : "#/definitions/json_SortType" + }, + "sortBy" : { +"description" : "", +"type" : "string" + } + }, + "example" : { + "list" : [ { }, { } ], + "startIndex" : 12345, + "pageSize" : 12345, + "totalCount" : 12345, + "sortType" : "DESC", + "sortBy" : "..." +}, + "description" : "Paginated-list, for returning search results." + } + , + "json_PropagateTags" : { + "type" : "string", + "title" : "PropagateTags", + "enum" : [ + "NONE", + "ONE_TO_TWO", + "TWO_TO_ONE", + "BOTH" + ], + "description" : "PropagateTags indicates whether tags should propagate across the relationship instance.\n<p>\nTags can propagate:\n<p>\nNONE - not at all <br>\nONE_TO_TWO - from end 1 to 2 <br>\nTWO_TO_ONE - from end 2 to 1 <br>\nBOTH - both ways\n<p>\nCare needs to be taken when specifying. The use cases we are aware of where this flag is useful:\n<p>\n- propagating confidentiality classifications from a table to columns - ONE_TO_TWO could be used here <br>\n- propagating classifications around Glossary synonyms - BOTH could be used here.\n<p>\nThere is an expectation that further enhancements will allow more granular control of tag propagation and will\naddress how to resolve conflicts." + } + , + "json_RelationshipCategory" : { + "type" : "string", + "title" : "RelationshipCategory", + "enum" : [ + "ASSOCIATION", + "AGGREGATION", + "COMPOSITION" + ], + "description" : "The Relationship category determines the style of relationship around containment and lifecycle.\nUML terminology is used for the values.\n<p>\nASSOCIATION is a relationship with no containment. <br>\nCOMPOSITION and AGGREGATION are containment relationships.\n<p>\nThe difference being in the lifecycles of the container and its children. In the COMPOSITION case,\nthe children cannot exist without the container. For AGGREGATION, the life cycles\nof the container and children are totally independant." + } + , + "json_SearchParameters" : { + "type" : "object", + "title" : "SearchParameters", + "properties" : { + "query" : { +"description" : "", +"type" : "string" + }, + "typeName" : { +"description" : "", +"type" : "string" + }, + "classification" : { +"description" : "", +"type" : "string" + }, + "excludeDeletedEntities" : { +"description" : "", +"type" : "boolean" + }, + "limit" : { +"description" : "", +"type" : "number" + }, + "offset" : { +"description" : "", +"type" : "number" + }, + "entityFilters" : { +"description" : "Entity attribute filters for the type (if type name is specified)", +"$ref" : "#/definitions/json_FilterCriteria" + }, + "tagFilters" : { +"description" : "Tag attribute filters for the classification/tag (if tag name is specified)", +"$ref" : "#/definitions/json_FilterCriteria" + }, + "attributes" : { +"description" : "Attribute values included in the results", +"type" : "array", +"items" : { + "type" : "string" +} + } + }, + "example" : { + "query" : "...", + "typeName" : "...", + "classification" : "...", + "excludeDeletedEntities" : true, + "limit" : 12345, + "offset" : 12345, + "entityFilters" : { + "attributeName" : "...", + "operator" : "GTE", + "attributeValue" : "...", + "condition" : "OR", + "criterion" : [ { }, { } ] + }, + "tagFilters" : { + "attributeName" : "...", + "operator" : "NEQ", + "attributeValue" : "...", + "condition" : "OR", + "criterion" : [ { }, { } ] + }, + "attributes" : [ "...", "..." ] +}, + "description" : "" + } + , + "json_SortType" : { + "type" : "string", + "title" : "SortType", + "enum" : [ + "NONE", + "ASC", + "DESC" + ], + "description" : "to specify whether the result should be sorted? If yes, whether asc or desc." + } + , + "json_Status" : { + "type" : "string", + "title" : "Status", + "enum" : [ + "ACTIVE", + "DELETED" + ], + "description" : "Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store." + } + , + "json_Status_AtlasRelationship" : { + "type" : "string", + "title" : "Status", + "enum" : [ + "ACTIVE", + "DELETED" + ], + "description" : "" + } + , + "json_TypeCategory" : { + "type" : "string", + "title" : "TypeCategory", + "enum" : [ + "PRIMITIVE", + "OBJECT_ID_TYPE", + "ENUM", + "STRUCT", + "CLASSIFICATION", + "ENTITY", + "ARRAY", + "MAP", + "RELATIONSHIP" + ], + "description" : "" + } + , + "xml_ns0_PList" : { + "type" : "object", + "title" : "PList", + "allOf" : [ + { + "properties" : { + "list" : { + "xml" : { + "namespace" : "" + }, +"description" : "", +"type" : "object" + }, + "pageSize" : { + "xml" : { + "namespace" : "" + }, +"description" : "", +"type" : "number" + }, + "sortBy" : { + "xml" : { + "namespace" : "" + }, +"description" : "", +"type" : "string" + }, + "sortType" : { + "xml" : { + "namespace" : "" + }, +"description" : "", +"$ref" : "#/definitions/xml_ns0_sortType" + }, + "startIndex" : { + "xml" : { + "namespace" : "" + }, +"description" : "", +"type" : "number" + }, + "totalCount" : { + "xml" : { + "namespace" : "" + }, +"description" : "", +"type" : "number" + } + } + } + ], + "description" : "Paginated-list, for returning search results." + } + , + "xml_ns0_searchFilter" : { + "type" : "object", + "title" : "searchFilter", + "allOf" : [ + { + "properties" : { + "getCount" : { + "xml" : { + "namespace" : "" + }, +"description" : "", +"type" : "boolean" + }, + "maxRows" : { + "xml" : { + "namespace" : "" + }, +"description" : "", +"type" : "number" + }, + "params" : { + "xml" : { + "namespace" : "" + }, +"description" : "", +"type" : "object" + }, + "sortBy" : { + "xml" : { + "namespace" : "" + }, +"description" : "", +"type" : "string" + }, + "sortType" : { + "xml" : { + "namespace" : "" + }, +"description" : "", +"$ref" : "#/definitions/xml_ns0_sortType" + }, + "startIndex" : { + "xml" : { + "namespace" : "" + }, +"description" : "", +"type" : "number" + } + } + } + ], + "description" : "Generic filter, to specify search criteria using name/value pairs." + } + , + "xml_ns0_sortType" : { + "type" : "string", + "title" : "sortType", + "enum" : [ + "NONE", + "ASC", + "DESC" + ], + "description" : "to specify whether the result should be sorted? If yes, whether asc or desc." + } + , + "xml_ns0_atlasClassification" : { + "type" : "object", + "title" : "atlasClassification", + "allOf" : [ + { + "$ref" : "#/definitions/xml_ns0_atlasStruct" + }, + { + } + ], + "description" : "An instance of a classification; it doesn't have an identity, this object exists only when associated with an entity." + } + , + "xml_ns0_atlasStruct" : { + "type" : "object", + "title" : "atlasStruct", + "allOf" : [ + { + "properties" : { + "attributes" : { + "xml" : { + "namespace" : "" + }, +"description" : "", +"type" : "object" + }, + "typeName" : { + "xml" : { + "namespace" : "" + }, +"description" : "", +"type" : "string" + } + } + } + ], + "description" : "Captures details of struct contents. Not instantiated directly, used only via AtlasEntity, AtlasClassification." + } + }, + "paths": { + "\/v2/search/attribute" : { + "get" : { + "tags" : [ "DiscoveryREST" ], + "summary" : "Retrieve data for the specified attribute search query.", + "description" : "Retrieve data for the specified attribute search query", + "operationId" : "resource_DiscoveryREST_searchUsingAttribute_GET", + "produces" : [ "application/json;charset=UTF-8" ], + "parameters" : [ + { + "name" : "attrName", + "in" : "query", + "type" : "string", + "description" : "Attribute name" + }, + { + "name" : "attrValuePrefix", + "in" : "query", + "type" : "string", + "description" : "Attibute value to search on" + }, + { + "name" : "limit", + "in" : "query", + "type" : "integer", + "description" : "limit the result set to only include the specified number of entries" + }, + { + "name" : "offset", + "in" : "query", + "type" : "integer", + "description" : "start offset of the result set (useful for pagination)" + }, + { + "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" : "FULL_TEXT", + "searchParameters" : { + "query" : "...", + "typeName" : "...", + "classification" : "...", + "excludeDeletedEntities" : true, + "limit" : 12345, + "offset" : 12345, + "entityFilters" : { + "attributeName" : "...", + "operator" : "LIKE", + "attributeValue" : "...", + "condition" : "OR", + "criterion" : [ { }, { } ] + }, + "tagFilters" : { + "attributeName" : "...", + "operator" : "LIKE", + "attributeValue" : "...", + "condition" : "OR", + "criterion" : [ { }, { } ] + }, + "attributes" : [ "...", "..." ] + }, + "queryText" : "...", + "type" : "...", + "classification" : "...", + "entities" : [ { + "guid" : "...", + "status" : "ACTIVE", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + }, { + "guid" : "...", + "status" : "ACTIVE", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + } ], + "attributes" : { + "name" : [ "...", "..." ], + "values" : [ ] + }, + "fullTextResult" : [ { + "entity" : { + "guid" : "...", + "status" : "ACTIVE", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + }, + "score" : 12345.0 + }, { + "entity" : { + "guid" : "...", + "status" : "ACTIVE", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + }, + "score" : 12345.0 + } ], + "referredEntities" : { + "property1" : { + "guid" : "...", + "status" : "ACTIVE", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + }, + "property2" : { + "guid" : "...", + "status" : "DELETED", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + } + } +} + }, + "description" : "On successful FullText lookup with some results, might return an empty list if execution succeeded\nwithout any results" + }, + "400" : { + "headers" : { + }, + "examples" : { + "application/json" : { + "queryType" : "ATTRIBUTE", + "searchParameters" : { + "query" : "...", + "typeName" : "...", + "classification" : "...", + "excludeDeletedEntities" : true, + "limit" : 12345, + "offset" : 12345, + "entityFilters" : { + "attributeName" : "...", + "operator" : "GT", + "attributeValue" : "...", + "condition" : "AND", + "criterion" : [ { }, { } ] + }, + "tagFilters" : { + "attributeName" : "...", + "operator" : "GTE", + "attributeValue" : "...", + "condition" : "OR", + "criterion" : [ { }, { } ] + }, + "attributes" : [ "...", "..." ] + }, + "queryText" : "...", + "type" : "...", + "classification" : "...", + "entities" : [ { + "guid" : "...", + "status" : "ACTIVE", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + }, { + "guid" : "...", + "status" : "ACTIVE", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + } ], + "attributes" : { + "name" : [ "...", "..." ], + "values" : [ ] + }, + "fullTextResult" : [ { + "entity" : { + "guid" : "...", + "status" : "DELETED", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + }, + "score" : 12345.0 + }, { + "entity" : { + "guid" : "...", + "status" : "DELETED", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + }, + "score" : 12345.0 + } ], + "referredEntities" : { + "property1" : { + "guid" : "...", + "status" : "ACTIVE", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + }, + "property2" : { + "guid" : "...", + "status" : "DELETED", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + } + } +} + }, + "description" : "Invalid wildcard or query parameters" + } + } + } + } + , + "\/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" : "excludeDeletedEntities", + "in" : "query", + "type" : "boolean", + "description" : "" + }, + { + "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", + "searchParameters" : { + "query" : "...", + "typeName" : "...", + "classification" : "...", + "excludeDeletedEntities" : true, + "limit" : 12345, + "offset" : 12345, + "entityFilters" : { + "attributeName" : "...", + "operator" : "CONTAINS", + "attributeValue" : "...", + "condition" : "AND", + "criterion" : [ { }, { } ] + }, + "tagFilters" : { + "attributeName" : "...", + "operator" : "ENDS_WITH", + "attributeValue" : "...", + "condition" : "AND", + "criterion" : [ { }, { } ] + }, + "attributes" : [ "...", "..." ] + }, + "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 + } ], + "referredEntities" : { + "property1" : { + "guid" : "...", + "status" : "DELETED", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + }, + "property2" : { + "guid" : "...", + "status" : "ACTIVE", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + } + } +} + }, + "description" : "On successful FullText lookup with some results, might return an empty list if execution succeeded\nwithout any results" + }, + "400" : { + "headers" : { + }, + "examples" : { + "application/json" : { + "queryType" : "FULL_TEXT", + "searchParameters" : { + "query" : "...", + "typeName" : "...", + "classification" : "...", + "excludeDeletedEntities" : true, + "limit" : 12345, + "offset" : 12345, + "entityFilters" : { + "attributeName" : "...", + "operator" : "EQ", + "attributeValue" : "...", + "condition" : "AND", + "criterion" : [ { }, { } ] + }, + "tagFilters" : { + "attributeName" : "...", + "operator" : "GT", + "attributeValue" : "...", + "condition" : "OR", + "criterion" : [ { }, { } ] + }, + "attributes" : [ "...", "..." ] + }, + "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 + } ], + "referredEntities" : { + "property1" : { + "guid" : "...", + "status" : "ACTIVE", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + }, + "property2" : { + "guid" : "...", + "status" : "ACTIVE", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + } + } +} + }, + "description" : "Invalid fulltext or query parameters" + } + } + } + , + "post" : { + "tags" : [ "DiscoveryREST" ], + "summary" : "Attribute based search for entities satisfying the search parameters.", + "description" : "Attribute based search for entities satisfying the search parameters", + "operationId" : "resource_DiscoveryREST_searchWithParameters_POST", + "consumes" : [ "application/json;charset=UTF-8" ], + "produces" : [ "application/json;charset=UTF-8" ], + "parameters" : [ + { + "name" : "body", + "in" : "body", + "schema" : { +"description" : "", +"$ref" : "#/definitions/json_SearchParameters" + }, + "description" : "Search parameters" + } + ], + "responses" : { + "200" : { + "schema" : { +"description" : "", +"$ref" : "#/definitions/json_AtlasSearchResult" + }, + "headers" : { + }, + "examples" : { + "application/json" : { + "queryType" : "DSL", + "searchParameters" : { + "query" : "...", + "typeName" : "...", + "classification" : "...", + "excludeDeletedEntities" : true, + "limit" : 12345, + "offset" : 12345, + "entityFilters" : { + "attributeName" : "...", + "operator" : "IN", + "attributeValue" : "...", + "condition" : "OR", + "criterion" : [ { }, { } ] + }, + "tagFilters" : { + "attributeName" : "...", + "operator" : "IN", + "attributeValue" : "...", + "condition" : "AND", + "criterion" : [ { }, { } ] + }, + "attributes" : [ "...", "..." ] + }, + "queryText" : "...", + "type" : "...", + "classification" : "...", + "entities" : [ { + "guid" : "...", + "status" : "ACTIVE", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + }, { + "guid" : "...", + "status" : "ACTIVE", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + } ], + "attributes" : { + "name" : [ "...", "..." ], + "values" : [ ] + }, + "fullTextResult" : [ { + "entity" : { + "guid" : "...", + "status" : "ACTIVE", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + }, + "score" : 12345.0 + }, { + "entity" : { + "guid" : "...", + "status" : "DELETED", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + }, + "score" : 12345.0 + } ], + "referredEntities" : { + "property1" : { + "guid" : "...", + "status" : "ACTIVE", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + }, + "property2" : { + "guid" : "...", + "status" : "DELETED", + "displayText" : "...", + "classificationNames" : [ "...", "..." ], + "typeName" : "...", + "attributes" : { + "property1" : { }, + "property2" : { } + } + } + } +} + }, + "description" : "On successful search" + }, + "400" : { + "headers" : { + }, + "examples" : { + "application/json" : { + "queryType" : "RELATIONSHIP", + "searchParameters" : { + "query" : "...", + "typeName" : "...", + "classification" : "...", + "excludeDeletedEntities" : true, + "limit" : 12345, + "offset" : 12345, + "entityFilters" : { + "attributeName" : "...", + "operator" : "EQ", + "attributeValue" : "...", + "condition" : "AND", + "criterion" : [ { }, { } ] + }, + "tagFilters" : { + "attributeName" : "...", + "operator" : "CONTAINS", + "attributeValue" : "...", + "condition" : "OR", + "criterion" : [ { }, { } ] + }, + "attributes" : [ "...", "..." ] + }, + "queryText" : "...", + "type" : "...", + "classification" : "...", + "entities" : [ { + "guid" : "...", + "status" : "ACTIVE", + "displayText" : "..
<TRUNCATED>
