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 2018/05/27 01:57:01 UTC
[08/39] atlas-website git commit: ATLAS-2691: update Apache Atlas
website for 1.0.0 release (rc0)
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/e9346ee2/1.0.0-rc0/api/v2/ui/swagger.json
----------------------------------------------------------------------
diff --git a/1.0.0-rc0/api/v2/ui/swagger.json b/1.0.0-rc0/api/v2/ui/swagger.json
new file mode 100644
index 0000000..ae57ac4
--- /dev/null
+++ b/1.0.0-rc0/api/v2/ui/swagger.json
@@ -0,0 +1,5959 @@
+{
+ "swagger": "2.0",
+ "info" : {
+ "description" : "<h1>Apache Atlas Web Application<\/h1><p>Apache Atlas Web Application<\/p>",
+ "license" : {
+ "url" : "http://www.apache.org/licenses/LICENSE-2.0.txt",
+ "name" : "The Apache Software License, Version 2.0"
+ },
+ "version" : "1.0.0",
+ "title" : "Apache Atlas Web Application"
+ },
+ "schemes" : [],
+ "tags" : [
+ {
+ "name" : "AdminResource"
+ ,
+ "description" : "Jersey Resource for admin operations."
+ }
+ ,
+ {
+ "name" : "DataSetLineageResource"
+ ,
+ "description" : "Jersey Resource for Hive Table Lineage."
+ }
+ ,
+ {
+ "name" : "DiscoveryREST"
+ ,
+ "description" : "REST interface for data discovery using dsl or full text search."
+ }
+ ,
+ {
+ "name" : "EntityREST"
+ ,
+ "description" : "REST for a single entity."
+ }
+ ,
+ {
+ "name" : "EntityResource"
+ ,
+ "description" : "Entity management operations as REST API."
+ }
+ ,
+ {
+ "name" : "GlossaryREST"
+ }
+ ,
+ {
+ "name" : "LineageREST"
+ ,
+ "description" : "REST interface for an entity's lineage information."
+ }
+ ,
+ {
+ "name" : "LineageResource"
+ }
+ ,
+ {
+ "name" : "MetadataDiscoveryResource"
+ ,
+ "description" : "Jersey Resource for metadata operations."
+ }
+ ,
+ {
+ "name" : "RelationshipREST"
+ ,
+ "description" : "REST interface for entity relationships."
+ }
+ ,
+ {
+ "name" : "TypesREST"
+ ,
+ "description" : "REST interface for CRUD operations on type definitions."
+ }
+ ,
+ {
+ "name" : "TypesResource"
+ ,
+ "description" : "This class provides RESTful API for Types."
+ }
+ ],
+ "definitions" : {
+ "json_AtlasClassification" : {
+ "type" : "object",
+ "title" : "AtlasClassification",
+ "allOf" : [
+ {
+ "$ref" : "#/definitions/json_AtlasStruct"
+ },
+ {
+ "properties" : {
+ "entityGuid" : {
+ "readOnly" : false,
+"description" : "",
+"type" : "string"
+ },
+ "propagate" : {
+ "readOnly" : false,
+"description" : "",
+"type" : "boolean"
+ },
+ "validityPeriods" : {
+ "readOnly" : false,
+"description" : "",
+"type" : "array",
+"items" : {
+ "$ref" : "#/definitions/json_TimeBoundary"
+}
+ }
+ }
+ }
+ ],
+ "example" : {
+ "entityGuid" : "...",
+ "propagate" : true,
+ "validityPeriods" : [ {
+ "startTime" : "...",
+ "endTime" : "...",
+ "timeZone" : "..."
+ }, {
+ "startTime" : "...",
+ "endTime" : "...",
+ "timeZone" : "..."
+ } ],
+ "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_AtlasEntity" : {
+ "type" : "object",
+ "title" : "AtlasEntity",
+ "allOf" : [
+ {
+ "$ref" : "#/definitions/json_AtlasStruct"
+ },
+ {
+ "properties" : {
+ "guid" : {
+ "readOnly" : false,
+"description" : "",
+"type" : "string"
+ },
+ "status" : {
+ "readOnly" : false,
+"$ref" : "#/definitions/json_Status"
+ },
+ "createdBy" : {
+ "readOnly" : false,
+"description" : "",
+"type" : "string"
+ },
+ "updatedBy" : {
+ "readOnly" : false,
+"description" : "",
+"type" : "string"
+ },
+ "createTime" : {
+ "readOnly" : false,
+"description" : "",
+"type" : "number"
+ },
+ "updateTime" : {
+ "readOnly" : false,
+"description" : "",
+"type" : "number"
+ },
+ "version" : {
+ "readOnly" : false,
+"description" : "",
+"type" : "number"
+ },
+ "relationshipAttributes" : {
+ "readOnly" : false,
+"description" : "",
+"type" : "object",
+"additionalProperties" : {
+ "type" : "object"
+}
+ },
+ "classifications" : {
+ "readOnly" : false,
+"description" : "",
+"type" : "array",
+"items" : {
+ "$ref" : "#/definitions/json_AtlasClassification"
+}
+ },
+ "meanings" : {
+ "readOnly" : false,
+"description" : "",
+"type" : "array",
+"items" : {
+ "$ref" : "#/definitions/json_AtlasTermAssignmentHeader"
+}
+ }
+ }
+ }
+ ],
+ "example" : {
+ "guid" : "...",
+ "status" : "ACTIVE",
+ "createdBy" : "...",
+ "updatedBy" : "...",
+ "createTime" : 12345,
+ "updateTime" : 12345,
+ "version" : 12345,
+ "relationshipAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "classifications" : [ {
+ "entityGuid" : "...",
+ "propagate" : true,
+ "validityPeriods" : [ {
+ "startTime" : "...",
+ "endTime" : "...",
+ "timeZone" : "..."
+ }, {
+ "startTime" : "...",
+ "endTime" : "...",
+ "timeZone" : "..."
+ } ],
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ }, {
+ "entityGuid" : "...",
+ "propagate" : true,
+ "validityPeriods" : [ {
+ "startTime" : "...",
+ "endTime" : "...",
+ "timeZone" : "..."
+ }, {
+ "startTime" : "...",
+ "endTime" : "...",
+ "timeZone" : "..."
+ } ],
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ } ],
+ "meanings" : [ {
+ "createdBy" : "...",
+ "status" : "OBSOLETE",
+ "description" : "...",
+ "confidence" : 12345,
+ "source" : "...",
+ "relationGuid" : "...",
+ "termGuid" : "...",
+ "expression" : "...",
+ "displayText" : "...",
+ "steward" : "..."
+ }, {
+ "createdBy" : "...",
+ "status" : "VALIDATED",
+ "description" : "...",
+ "confidence" : 12345,
+ "source" : "...",
+ "relationGuid" : "...",
+ "termGuid" : "...",
+ "expression" : "...",
+ "displayText" : "...",
+ "steward" : "..."
+ } ],
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+},
+ "description" : "An instance of an entity - like hive_table, hive_database."
+ }
+ ,
+ "json_AtlasEntityHeader" : {
+ "type" : "object",
+ "title" : "AtlasEntityHeader",
+ "allOf" : [
+ {
+ "$ref" : "#/definitions/json_AtlasStruct"
+ },
+ {
+ "properties" : {
+ "guid" : {
+ "readOnly" : false,
+"description" : "",
+"type" : "string"
+ },
+ "status" : {
+ "readOnly" : false,
+"$ref" : "#/definitions/json_Status"
+ },
+ "displayText" : {
+ "readOnly" : false,
+"description" : "",
+"type" : "string"
+ },
+ "classificationNames" : {
+ "readOnly" : false,
+"description" : "",
+"type" : "array",
+"items" : {
+ "type" : "string"
+}
+ },
+ "classifications" : {
+ "readOnly" : false,
+"description" : "",
+"type" : "array",
+"items" : {
+ "$ref" : "#/definitions/json_AtlasClassification"
+}
+ },
+ "meaningNames" : {
+ "readOnly" : false,
+"description" : "",
+"type" : "array",
+"items" : {
+ "type" : "string"
+}
+ },
+ "meanings" : {
+ "readOnly" : false,
+"description" : "",
+"type" : "array",
+"items" : {
+ "$ref" : "#/definitions/json_AtlasTermAssignmentHeader"
+}
+ }
+ }
+ }
+ ],
+ "example" : {
+ "guid" : "...",
+ "status" : "ACTIVE",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "classifications" : [ {
+ "entityGuid" : "...",
+ "propagate" : true,
+ "validityPeriods" : [ {
+ "startTime" : "...",
+ "endTime" : "...",
+ "timeZone" : "..."
+ }, {
+ "startTime" : "...",
+ "endTime" : "...",
+ "timeZone" : "..."
+ } ],
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ }, {
+ "entityGuid" : "...",
+ "propagate" : true,
+ "validityPeriods" : [ {
+ "startTime" : "...",
+ "endTime" : "...",
+ "timeZone" : "..."
+ }, {
+ "startTime" : "...",
+ "endTime" : "...",
+ "timeZone" : "..."
+ } ],
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ } ],
+ "meaningNames" : [ "...", "..." ],
+ "meanings" : [ {
+ "createdBy" : "...",
+ "status" : "DEPRECATED",
+ "description" : "...",
+ "confidence" : 12345,
+ "source" : "...",
+ "relationGuid" : "...",
+ "termGuid" : "...",
+ "expression" : "...",
+ "displayText" : "...",
+ "steward" : "..."
+ }, {
+ "createdBy" : "...",
+ "status" : "IMPORTED",
+ "description" : "...",
+ "confidence" : 12345,
+ "source" : "...",
+ "relationGuid" : "...",
+ "termGuid" : "...",
+ "expression" : "...",
+ "displayText" : "...",
+ "steward" : "..."
+ } ],
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+},
+ "description" : "An instance of an entity - like hive_table, hive_database."
+ }
+ ,
+ "json_AtlasObjectId" : {
+ "type" : "object",
+ "title" : "AtlasObjectId",
+ "properties" : {
+ "guid" : {
+ "readOnly" : false,
+"description" : "",
+"type" : "string"
+ },
+ "typeName" : {
+ "readOnly" : false,
+"description" : "",
+"type" : "string"
+ },
+ "uniqueAttributes" : {
+ "readOnly" : false,
+"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_AtlasRelatedObjectId" : {
+ "type" : "object",
+ "title" : "AtlasRelatedObjectId",
+ "allOf" : [
+ {
+ "$ref" : "#/definitions/json_AtlasObjectId"
+ },
+ {
+ "properties" : {
+ "displayText" : {
+ "readOnly" : false,
+"description" : "",
+"type" : "string"
+ },
+ "relationshipGuid" : {
+ "readOnly" : false,
+"description" : "",
+"type" : "string"
+ },
+ "relationshipAttributes" : {
+ "readOnly" : false,
+"$ref" : "#/definitions/json_AtlasStruct"
+ },
+ "relationshipStatus" : {
+ "readOnly" : false,
+"$ref" : "#/definitions/json_Status_AtlasRelationship"
+ }
+ }
+ }
+ ],
+ "example" : {
+ "displayText" : "...",
+ "relationshipGuid" : "...",
+ "relationshipAttributes" : {
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ },
+ "relationshipStatus" : "ACTIVE",
+ "guid" : "...",
+ "typeName" : "...",
+ "uniqueAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+},
+ "description" : "Reference to an object-instance of AtlasEntity type used in relationship attribute values"
+ }
+ ,
+ "json_AtlasRelationship" : {
+ "type" : "object",
+ "title" : "AtlasRelationship",
+ "allOf" : [
+ {
+ "$ref" : "#/definitions/json_AtlasStruct"
+ },
+ {
+ "properties" : {
+ "guid" : {
+ "readOnly" : false,
+"description" : "",
+"type" : "string"
+ },
+ "status" : {
+ "readOnly" : false,
+"$ref" : "#/definitions/json_Status_AtlasRelationship"
+ },
+ "createdBy" : {
+ "readOnly" : false,
+"description" : "",
+"type" : "string"
+ },
+ "updatedBy" : {
+ "readOnly" : false,
+"description" : "",
+"type" : "string"
+ },
+ "createTime" : {
+ "readOnly" : false,
+"description" : "",
+"type" : "number"
+ },
+ "updateTime" : {
+ "readOnly" : false,
+"description" : "",
+"type" : "number"
+ },
+ "version" : {
+ "readOnly" : false,
+"description" : "",
+"type" : "number"
+ },
+ "end1" : {
+ "readOnly" : false,
+"$ref" : "#/definitions/json_AtlasObjectId"
+ },
+ "end2" : {
+ "readOnly" : false,
+"$ref" : "#/definitions/json_AtlasObjectId"
+ },
+ "label" : {
+ "readOnly" : false,
+"description" : "",
+"type" : "string"
+ },
+ "propagateTags" : {
+ "readOnly" : false,
+"$ref" : "#/definitions/json_PropagateTags"
+ },
+ "propagatedClassifications" : {
+ "readOnly" : false,
+"description" : "",
+"type" : "array",
+"items" : {
+ "$ref" : "#/definitions/json_AtlasClassification"
+}
+ },
+ "blockedPropagatedClassifications" : {
+ "readOnly" : false,
+"description" : "",
+"type" : "array",
+"items" : {
+ "$ref" : "#/definitions/json_AtlasClassification"
+}
+ }
+ }
+ }
+ ],
+ "example" : {
+ "guid" : "...",
+ "status" : "DELETED",
+ "createdBy" : "...",
+ "updatedBy" : "...",
+ "createTime" : 12345,
+ "updateTime" : 12345,
+ "version" : 12345,
+ "end1" : {
+ "guid" : "...",
+ "typeName" : "...",
+ "uniqueAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ },
+ "end2" : {
+ "guid" : "...",
+ "typeName" : "...",
+ "uniqueAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ },
+ "label" : "...",
+ "propagateTags" : "BOTH",
+ "propagatedClassifications" : [ {
+ "entityGuid" : "...",
+ "propagate" : true,
+ "validityPeriods" : [ {
+ "startTime" : "...",
+ "endTime" : "...",
+ "timeZone" : "..."
+ }, {
+ "startTime" : "...",
+ "endTime" : "...",
+ "timeZone" : "..."
+ } ],
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ }, {
+ "entityGuid" : "...",
+ "propagate" : true,
+ "validityPeriods" : [ {
+ "startTime" : "...",
+ "endTime" : "...",
+ "timeZone" : "..."
+ }, {
+ "startTime" : "...",
+ "endTime" : "...",
+ "timeZone" : "..."
+ } ],
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ } ],
+ "blockedPropagatedClassifications" : [ {
+ "entityGuid" : "...",
+ "propagate" : true,
+ "validityPeriods" : [ {
+ "startTime" : "...",
+ "endTime" : "...",
+ "timeZone" : "..."
+ }, {
+ "startTime" : "...",
+ "endTime" : "...",
+ "timeZone" : "..."
+ } ],
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ }, {
+ "entityGuid" : "...",
+ "propagate" : true,
+ "validityPeriods" : [ {
+ "startTime" : "...",
+ "endTime" : "...",
+ "timeZone" : "..."
+ }, {
+ "startTime" : "...",
+ "endTime" : "...",
+ "timeZone" : "..."
+ } ],
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ } ],
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+},
+ "description" : "Atlas relationship instance."
+ }
+ ,
+ "json_AtlasStruct" : {
+ "type" : "object",
+ "title" : "AtlasStruct",
+ "properties" : {
+ "typeName" : {
+ "readOnly" : false,
+"description" : "",
+"type" : "string"
+ },
+ "attributes" : {
+ "readOnly" : false,
+"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_AtlasTermAssignmentHeader" : {
+ "type" : "object",
+ "title" : "AtlasTermAssignmentHeader",
+ "properties" : {
+ "createdBy" : {
+ "readOnly" : false,
+"description" : "",
+"type" : "string"
+ },
+ "status" : {
+ "readOnly" : false,
+"$ref" : "#/definitions/json_AtlasTermAssignmentStatus"
+ },
+ "description" : {
+ "readOnly" : false,
+"description" : "",
+"type" : "string"
+ },
+ "confidence" : {
+ "readOnly" : false,
+"description" : "",
+"type" : "number"
+ },
+ "source" : {
+ "readOnly" : false,
+"description" : "",
+"type" : "string"
+ },
+ "relationGuid" : {
+ "readOnly" : false,
+"description" : "",
+"type" : "string"
+ },
+ "termGuid" : {
+ "readOnly" : false,
+"description" : "",
+"type" : "string"
+ },
+ "expression" : {
+ "readOnly" : false,
+"description" : "",
+"type" : "string"
+ },
+ "displayText" : {
+ "readOnly" : false,
+"description" : "",
+"type" : "string"
+ },
+ "steward" : {
+ "readOnly" : false,
+"description" : "",
+"type" : "string"
+ }
+ },
+ "example" : {
+ "createdBy" : "...",
+ "status" : "OBSOLETE",
+ "description" : "...",
+ "confidence" : 12345,
+ "source" : "...",
+ "relationGuid" : "...",
+ "termGuid" : "...",
+ "expression" : "...",
+ "displayText" : "...",
+ "steward" : "..."
+},
+ "description" : ""
+ }
+ ,
+ "json_AtlasTermAssignmentStatus" : {
+ "type" : "string",
+ "title" : "AtlasTermAssignmentStatus",
+ "enum" : [
+ "DISCOVERED",
+ "PROPOSED",
+ "IMPORTED",
+ "VALIDATED",
+ "DEPRECATED",
+ "OBSOLETE",
+ "OTHER"
+ ],
+ "description" : ""
+ }
+ ,
+ "json_ClassificationAssociateRequest" : {
+ "type" : "object",
+ "title" : "ClassificationAssociateRequest",
+ "properties" : {
+ "classification" : {
+ "readOnly" : false,
+"$ref" : "#/definitions/json_AtlasClassification"
+ },
+ "entityGuids" : {
+ "readOnly" : false,
+"description" : "",
+"type" : "array",
+"items" : {
+ "type" : "string"
+}
+ }
+ },
+ "example" : {
+ "classification" : {
+ "entityGuid" : "...",
+ "propagate" : true,
+ "validityPeriods" : [ {
+ "startTime" : "...",
+ "endTime" : "...",
+ "timeZone" : "..."
+ }, {
+ "startTime" : "...",
+ "endTime" : "...",
+ "timeZone" : "..."
+ } ],
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ },
+ "entityGuids" : [ "...", "..." ]
+},
+ "description" : ""
+ }
+ ,
+ "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_Status_AtlasRelationship" : {
+ "type" : "string",
+ "title" : "Status",
+ "enum" : [
+ "ACTIVE",
+ "DELETED"
+ ],
+ "description" : ""
+ }
+ ,
+ "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_TimeBoundary" : {
+ "type" : "object",
+ "title" : "TimeBoundary",
+ "properties" : {
+ "startTime" : {
+ "readOnly" : false,
+"description" : "",
+"type" : "string"
+ },
+ "endTime" : {
+ "readOnly" : false,
+"description" : "",
+"type" : "string"
+ },
+ "timeZone" : {
+ "readOnly" : false,
+"description" : "",
+"type" : "string"
+ }
+ },
+ "example" : {
+ "startTime" : "...",
+ "endTime" : "...",
+ "timeZone" : "..."
+},
+ "description" : "Captures time-boundary details"
+ }
+ ,
+ "json_AtlasClassification" : {
+ "type" : "object",
+ "title" : "AtlasClassification",
+ "allOf" : [
+ {
+ "$ref" : "#/definitions/json_AtlasStruct"
+ },
+ {
+ "properties" : {
+ "entityGuid" : {
+ "readOnly" : false,
+"description" : "",
+"type" : "string"
+ },
+ "propagate" : {
+ "readOnly" : false,
+"description" : "",
+"type" : "boolean"
+ },
+ "validityPeriods" : {
+ "readOnly" : false,
+"description" : "",
+"type" : "array",
+"items" : {
+ "$ref" : "#/definitions/json_TimeBoundary"
+}
+ }
+ }
+ }
+ ],
+ "example" : {
+ "entityGuid" : "...",
+ "propagate" : true,
+ "validityPeriods" : [ {
+ "startTime" : "...",
+ "endTime" : "...",
+ "timeZone" : "..."
+ }, {
+ "startTime" : "...",
+ "endTime" : "...",
+ "timeZone" : "..."
+ } ],
+ "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_AtlasEntity" : {
+ "type" : "object",
+ "title" : "AtlasEntity",
+ "allOf" : [
+ {
+ "$ref" : "#/definitions/json_AtlasStruct"
+ },
+ {
+ "properties" : {
+ "guid" : {
+ "readOnly" : false,
+"description" : "",
+"type" : "string"
+ },
+ "status" : {
+ "readOnly" : false,
+"$ref" : "#/definitions/json_Status"
+ },
+ "createdBy" : {
+ "readOnly" : false,
+"description" : "",
+"type" : "string"
+ },
+ "updatedBy" : {
+ "readOnly" : false,
+"description" : "",
+"type" : "string"
+ },
+ "createTime" : {
+ "readOnly" : false,
+"description" : "",
+"type" : "number"
+ },
+ "updateTime" : {
+ "readOnly" : false,
+"description" : "",
+"type" : "number"
+ },
+ "version" : {
+ "readOnly" : false,
+"description" : "",
+"type" : "number"
+ },
+ "relationshipAttributes" : {
+ "readOnly" : false,
+"description" : "",
+"type" : "object",
+"additionalProperties" : {
+ "type" : "object"
+}
+ },
+ "classifications" : {
+ "readOnly" : false,
+"description" : "",
+"type" : "array",
+"items" : {
+ "$ref" : "#/definitions/json_AtlasClassification"
+}
+ },
+ "meanings" : {
+ "readOnly" : false,
+"description" : "",
+"type" : "array",
+"items" : {
+ "$ref" : "#/definitions/json_AtlasTermAssignmentHeader"
+}
+ }
+ }
+ }
+ ],
+ "example" : {
+ "guid" : "...",
+ "status" : "DELETED",
+ "createdBy" : "...",
+ "updatedBy" : "...",
+ "createTime" : 12345,
+ "updateTime" : 12345,
+ "version" : 12345,
+ "relationshipAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "classifications" : [ {
+ "entityGuid" : "...",
+ "propagate" : true,
+ "validityPeriods" : [ {
+ "startTime" : "...",
+ "endTime" : "...",
+ "timeZone" : "..."
+ }, {
+ "startTime" : "...",
+ "endTime" : "...",
+ "timeZone" : "..."
+ } ],
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ }, {
+ "entityGuid" : "...",
+ "propagate" : true,
+ "validityPeriods" : [ {
+ "startTime" : "...",
+ "endTime" : "...",
+ "timeZone" : "..."
+ }, {
+ "startTime" : "...",
+ "endTime" : "...",
+ "timeZone" : "..."
+ } ],
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ } ],
+ "meanings" : [ {
+ "confidence" : 12345,
+ "relationGuid" : "...",
+ "source" : "...",
+ "createdBy" : "...",
+ "status" : "IMPORTED",
+ "displayText" : "...",
+ "termGuid" : "...",
+ "steward" : "...",
+ "expression" : "...",
+ "description" : "..."
+ }, {
+ "confidence" : 12345,
+ "relationGuid" : "...",
+ "source" : "...",
+ "createdBy" : "...",
+ "status" : "VALIDATED",
+ "displayText" : "...",
+ "termGuid" : "...",
+ "steward" : "...",
+ "expression" : "...",
+ "description" : "..."
+ } ],
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+},
+ "description" : "An instance of an entity - like hive_table, hive_database."
+ }
+ ,
+ "json_AtlasEntityHeader" : {
+ "type" : "object",
+ "title" : "AtlasEntityHeader",
+ "allOf" : [
+ {
+ "$ref" : "#/definitions/json_AtlasStruct"
+ },
+ {
+ "properties" : {
+ "guid" : {
+ "readOnly" : false,
+"description" : "",
+"type" : "string"
+ },
+ "status" : {
+ "readOnly" : false,
+"$ref" : "#/definitions/json_Status"
+ },
+ "displayText" : {
+ "readOnly" : false,
+"description" : "",
+"type" : "string"
+ },
+ "classificationNames" : {
+ "readOnly" : false,
+"description" : "",
+"type" : "array",
+"items" : {
+ "type" : "string"
+}
+ },
+ "classifications" : {
+ "readOnly" : false,
+"description" : "",
+"type" : "array",
+"items" : {
+ "$ref" : "#/definitions/json_AtlasClassification"
+}
+ },
+ "meaningNames" : {
+ "readOnly" : false,
+"description" : "",
+"type" : "array",
+"items" : {
+ "type" : "string"
+}
+ },
+ "meanings" : {
+ "readOnly" : false,
+"description" : "",
+"type" : "array",
+"items" : {
+ "$ref" : "#/definitions/json_AtlasTermAssignmentHeader"
+}
+ }
+ }
+ }
+ ],
+ "example" : {
+ "guid" : "...",
+ "status" : "DELETED",
+ "displayText" : "...",
+ "classificationNames" : [ "...", "..." ],
+ "classifications" : [ {
+ "entityGuid" : "...",
+ "propagate" : true,
+ "validityPeriods" : [ {
+ "startTime" : "...",
+ "endTime" : "...",
+ "timeZone" : "..."
+ }, {
+ "startTime" : "...",
+ "endTime" : "...",
+ "timeZone" : "..."
+ } ],
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ }, {
+ "entityGuid" : "...",
+ "propagate" : true,
+ "validityPeriods" : [ {
+ "startTime" : "...",
+ "endTime" : "...",
+ "timeZone" : "..."
+ }, {
+ "startTime" : "...",
+ "endTime" : "...",
+ "timeZone" : "..."
+ } ],
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ } ],
+ "meaningNames" : [ "...", "..." ],
+ "meanings" : [ {
+ "confidence" : 12345,
+ "relationGuid" : "...",
+ "source" : "...",
+ "createdBy" : "...",
+ "status" : "VALIDATED",
+ "displayText" : "...",
+ "termGuid" : "...",
+ "steward" : "...",
+ "expression" : "...",
+ "description" : "..."
+ }, {
+ "confidence" : 12345,
+ "relationGuid" : "...",
+ "source" : "...",
+ "createdBy" : "...",
+ "status" : "OBSOLETE",
+ "displayText" : "...",
+ "termGuid" : "...",
+ "steward" : "...",
+ "expression" : "...",
+ "description" : "..."
+ } ],
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+},
+ "description" : "An instance of an entity - like hive_table, hive_database."
+ }
+ ,
+ "json_AtlasObjectId" : {
+ "type" : "object",
+ "title" : "AtlasObjectId",
+ "properties" : {
+ "guid" : {
+ "readOnly" : false,
+"description" : "",
+"type" : "string"
+ },
+ "typeName" : {
+ "readOnly" : false,
+"description" : "",
+"type" : "string"
+ },
+ "uniqueAttributes" : {
+ "readOnly" : false,
+"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_AtlasRelatedObjectId" : {
+ "type" : "object",
+ "title" : "AtlasRelatedObjectId",
+ "allOf" : [
+ {
+ "$ref" : "#/definitions/json_AtlasObjectId"
+ },
+ {
+ "properties" : {
+ "displayText" : {
+ "readOnly" : false,
+"description" : "",
+"type" : "string"
+ },
+ "relationshipGuid" : {
+ "readOnly" : false,
+"description" : "",
+"type" : "string"
+ },
+ "relationshipAttributes" : {
+ "readOnly" : false,
+"$ref" : "#/definitions/json_AtlasStruct"
+ },
+ "relationshipStatus" : {
+ "readOnly" : false,
+"$ref" : "#/definitions/json_Status_AtlasRelationship"
+ }
+ }
+ }
+ ],
+ "example" : {
+ "displayText" : "...",
+ "relationshipGuid" : "...",
+ "relationshipAttributes" : {
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ },
+ "relationshipStatus" : "DELETED",
+ "guid" : "...",
+ "typeName" : "...",
+ "uniqueAttributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+},
+ "description" : "Reference to an object-instance of AtlasEntity type used in relationship attribute values"
+ }
+ ,
+ "json_AtlasRelationship" : {
+ "type" : "object",
+ "title" : "AtlasRelationship",
+ "allOf" : [
+ {
+ "$ref" : "#/definitions/json_AtlasStruct"
+ },
+ {
+ "properties" : {
+ "guid" : {
+ "readOnly" : false,
+"description" : "",
+"type" : "string"
+ },
+ "status" : {
+ "readOnly" : false,
+"$ref" : "#/definitions/json_Status_AtlasRelationship"
+ },
+ "createdBy" : {
+ "readOnly" : false,
+"description" : "",
+"type" : "string"
+ },
+ "updatedBy" : {
+ "readOnly" : false,
+"description" : "",
+"type" : "string"
+ },
+ "createTime" : {
+ "readOnly" : false,
+"description" : "",
+"type" : "number"
+ },
+ "updateTime" : {
+ "readOnly" : false,
+"description" : "",
+"type" : "number"
+ },
+ "version" : {
+ "readOnly" : false,
+"description" : "",
+"type" : "number"
+ },
+ "end1" : {
+ "readOnly" : false,
+"$ref" : "#/definitions/json_AtlasObjectId"
+ },
+ "end2" : {
+ "readOnly" : false,
+"$ref" : "#/definitions/json_AtlasObjectId"
+ },
+ "label" : {
+ "readOnly" : false,
+"description" : "",
+"type" : "string"
+ },
+ "propagateTags" : {
+ "readOnly" : false,
+"$ref" : "#/definitions/json_PropagateTags"
+ },
+ "propagatedClassifications" : {
+ "readOnly" : false,
+"description" : "",
+"type" : "array",
+"items" : {
+ "$ref" : "#/definitions/json_AtlasClassification"
+}
+ },
+ "blockedPropagatedClassifications" : {
+ "readOnly" : false,
+"description" : "",
+"type" : "array",
+"items" : {
+ "$ref" : "#/definitions/json_AtlasClassification"
+}
+ }
+ }
+ }
+ ],
+ "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" : "...",
+ "propagateTags" : "TWO_TO_ONE",
+ "propagatedClassifications" : [ {
+ "entityGuid" : "...",
+ "propagate" : true,
+ "validityPeriods" : [ {
+ "startTime" : "...",
+ "endTime" : "...",
+ "timeZone" : "..."
+ }, {
+ "startTime" : "...",
+ "endTime" : "...",
+ "timeZone" : "..."
+ } ],
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ }, {
+ "entityGuid" : "...",
+ "propagate" : true,
+ "validityPeriods" : [ {
+ "startTime" : "...",
+ "endTime" : "...",
+ "timeZone" : "..."
+ }, {
+ "startTime" : "...",
+ "endTime" : "...",
+ "timeZone" : "..."
+ } ],
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ } ],
+ "blockedPropagatedClassifications" : [ {
+ "entityGuid" : "...",
+ "propagate" : true,
+ "validityPeriods" : [ {
+ "startTime" : "...",
+ "endTime" : "...",
+ "timeZone" : "..."
+ }, {
+ "startTime" : "...",
+ "endTime" : "...",
+ "timeZone" : "..."
+ } ],
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ }, {
+ "entityGuid" : "...",
+ "propagate" : true,
+ "validityPeriods" : [ {
+ "startTime" : "...",
+ "endTime" : "...",
+ "timeZone" : "..."
+ }, {
+ "startTime" : "...",
+ "endTime" : "...",
+ "timeZone" : "..."
+ } ],
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ } ],
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+},
+ "description" : "Atlas relationship instance."
+ }
+ ,
+ "json_AtlasStruct" : {
+ "type" : "object",
+ "title" : "AtlasStruct",
+ "properties" : {
+ "typeName" : {
+ "readOnly" : false,
+"description" : "",
+"type" : "string"
+ },
+ "attributes" : {
+ "readOnly" : false,
+"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_AtlasTermAssignmentHeader" : {
+ "type" : "object",
+ "title" : "AtlasTermAssignmentHeader",
+ "properties" : {
+ "confidence" : {
+ "readOnly" : false,
+"description" : "",
+"type" : "number"
+ },
+ "relationGuid" : {
+ "readOnly" : false,
+"description" : "",
+"type" : "string"
+ },
+ "source" : {
+ "readOnly" : false,
+"description" : "",
+"type" : "string"
+ },
+ "createdBy" : {
+ "readOnly" : false,
+"description" : "",
+"type" : "string"
+ },
+ "status" : {
+ "readOnly" : false,
+"$ref" : "#/definitions/json_AtlasTermAssignmentStatus"
+ },
+ "displayText" : {
+ "readOnly" : false,
+"description" : "",
+"type" : "string"
+ },
+ "termGuid" : {
+ "readOnly" : false,
+"description" : "",
+"type" : "string"
+ },
+ "steward" : {
+ "readOnly" : false,
+"description" : "",
+"type" : "string"
+ },
+ "expression" : {
+ "readOnly" : false,
+"description" : "",
+"type" : "string"
+ },
+ "description" : {
+ "readOnly" : false,
+"description" : "",
+"type" : "string"
+ }
+ },
+ "example" : {
+ "confidence" : 12345,
+ "relationGuid" : "...",
+ "source" : "...",
+ "createdBy" : "...",
+ "status" : "DEPRECATED",
+ "displayText" : "...",
+ "termGuid" : "...",
+ "steward" : "...",
+ "expression" : "...",
+ "description" : "..."
+},
+ "description" : ""
+ }
+ ,
+ "json_AtlasTermAssignmentStatus" : {
+ "type" : "string",
+ "title" : "AtlasTermAssignmentStatus",
+ "enum" : [
+ "DISCOVERED",
+ "PROPOSED",
+ "IMPORTED",
+ "VALIDATED",
+ "DEPRECATED",
+ "OBSOLETE",
+ "OTHER"
+ ],
+ "description" : ""
+ }
+ ,
+ "json_ClassificationAssociateRequest" : {
+ "type" : "object",
+ "title" : "ClassificationAssociateRequest",
+ "properties" : {
+ "classification" : {
+ "readOnly" : false,
+"$ref" : "#/definitions/json_AtlasClassification"
+ },
+ "entityGuids" : {
+ "readOnly" : false,
+"description" : "",
+"type" : "array",
+"items" : {
+ "type" : "string"
+}
+ }
+ },
+ "example" : {
+ "classification" : {
+ "entityGuid" : "...",
+ "propagate" : true,
+ "validityPeriods" : [ {
+ "startTime" : "...",
+ "endTime" : "...",
+ "timeZone" : "..."
+ }, {
+ "startTime" : "...",
+ "endTime" : "...",
+ "timeZone" : "..."
+ } ],
+ "typeName" : "...",
+ "attributes" : {
+ "property1" : { },
+ "property2" : { }
+ }
+ },
+ "entityGuids" : [ "...", "..." ]
+},
+ "description" : ""
+ }
+ ,
+ "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_Status_AtlasRelationship" : {
+ "type" : "string",
+ "title" : "Status",
+ "enum" : [
+ "ACTIVE",
+ "DELETED"
+ ],
+ "description" : ""
+ }
+ ,
+ "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_TimeBoundary" : {
+ "type" : "object",
+ "title" : "TimeBoundary",
+ "properties" : {
+ "startTime" : {
+ "readOnly" : false,
+"description" : "",
+"type" : "string"
+ },
+ "endTime" : {
+ "readOnly" : false,
+"description" : "",
+"type" : "string"
+ },
+ "timeZone" : {
+ "readOnly" : false,
+"description" : "",
+"type" : "string"
+ }
+ },
+ "example" : {
+ "startTime" : "...",
+ "endTime" : "...",
+ "timeZone" : "..."
+},
+ "description" : "Captures time-boundary details"
+ }
+ ,
+ "xml_ns0_timeBoundary" : {
+ "type" : "object",
+ "xml" : {
+ "name" : "timeBoundary",
+ "namespace" : ""
+ },
+ "title" : "timeBoundary",
+ "allOf" : [
+ {
+ "properties" : {
+ "endTime" : {
+ "xml" : {
+ "namespace" : ""
+ },
+ "readOnly" : false,
+"description" : "",
+"type" : "string"
+ },
+ "startTime" : {
+ "xml" : {
+ "namespace" : ""
+ },
+ "readOnly" : false,
+"description" : "",
+"type" : "string"
+ },
+ "timeZone" : {
+ "xml" : {
+ "namespace" : ""
+ },
+ "readOnly" : false,
+"description" : "",
+"type" : "string"
+ }
+ }
+ }
+ ],
+ "description" : "Captures time-boundary details"
+ }
+ ,
+ "xml_ns0_atlasTermAssignmentStatus" : {
+ "type" : "string",
+ "title" : "atlasTermAssignmentStatus",
+ "enum" : [
+ "DISCOVERED",
+ "PROPOSED",
+ "IMPORTED",
+ "VALIDATED",
+ "DEPRECATED",
+ "OBSOLETE",
+ "OTHER"
+ ],
+ "description" : ""
+ }
+ ,
+ "xml_ns0_atlasTermAssignmentHeader" : {
+ "type" : "object",
+ "title" : "atlasTermAssignmentHeader",
+ "allOf" : [
+ {
+ "properties" : {
+ "confidence" : {
+ "xml" : {
+ "namespace" : ""
+ },
+ "readOnly" : false,
+"description" : "",
+"type" : "integer",
+"format" : "int32"
+ },
+ "createdBy" : {
+ "xml" : {
+ "namespace" : ""
+ },
+ "readOnly" : false,
+"description" : "",
+"type" : "string"
+ },
+ "description" : {
+ "xml" : {
+ "namespace" : ""
+ },
+ "readOnly" : false,
+"description" : "",
+"type" : "string"
+ },
+ "displayText" : {
+ "xml" : {
+ "namespace" : ""
+ },
+ "readOnly" : false,
+"description" : "",
+"type" : "string"
+ },
+ "expression" : {
+ "xml" : {
+ "namespace" : ""
+ },
+ "readOnly" : false,
+"description" : "",
+"type" : "string"
+ },
+ "relationGuid" : {
+ "xml" : {
+ "namespace" : ""
+ },
+ "readOnly" : false,
+"description" : "",
+"type" : "string"
+ },
+ "source" : {
+ "xml" : {
+ "namespace" : ""
+ },
+ "readOnly" : false,
+"description" : "",
+"type" : "string"
+ },
+ "status" : {
+ "xml" : {
+ "namespace" : ""
+ },
+ "readOnly" : false,
+"$ref" : "#/definitions/xml_ns0_atlasTermAssignmentStatus"
+ },
+ "steward" : {
+ "xml" : {
+ "namespace" : ""
+ },
+ "readOnly" : false,
+"description" : "",
+"type" : "string"
+ },
+ "termGuid" : {
+ "xml" : {
+ "namespace" : ""
+ },
+ "readOnly" : false,
+"description" : "",
+"type" : "string"
+ }
+ }
+ }
+ ],
+ "description" : ""
+ }
+ ,
+ "xml_ns0_atlasClassification" : {
+ "type" : "object",
+ "xml" : {
+ "name" : "atlasClassification",
+ "namespace" : ""
+ },
+ "title" : "atlasClassification",
+ "allOf" : [
+ {
+ "$ref" : "#/definitions/xml_ns0_atlasStruct"
+ },
+ {
+ "properties" : {
+ "entityGuid" : {
+ "xml" : {
+ "namespace" : ""
+ },
+ "readOnly" : false,
+"description" : "",
+"type" : "string"
+ },
+ "propagate" : {
+ "xml" : {
+ "namespace" : ""
+ },
+ "readOnly" : false,
+"description" : "",
+"type" : "boolean"
+ },
+ "validityPeriods" : {
+ "xml" : {
+ "namespace" : ""
+ },
+ "readOnly" : false,
+"description" : "",
+"type" : "array",
+"items" : {
+ "$ref" : "#/definitions/xml_ns0_timeBoundary"
+}
+ }
+ }
+ }
+ ],
+ "description" : "An instance of a classification; it doesn't have an identity, this object exists only when associated with an entity."
+ }
+ ,
+ "xml_ns0_atlasEntity" : {
+ "type" : "object",
+ "xml" : {
+ "name" : "atlasEntity",
+ "namespace" : ""
+ },
+ "title" : "atlasEntity",
+ "allOf" : [
+ {
+ "$ref" : "#/definitions/xml_ns0_atlasStruct"
+ },
+ {
+ "properties" : {
+ "classifications" : {
+ "xml" : {
+ "namespace" : ""
+ },
+ "readOnly" : false,
+"description" : "",
+"type" : "array",
+"items" : {
+ "$ref" : "#/definitions/xml_ns0_atlasClassification"
+}
+ },
+ "createTime" : {
+ "xml" : {
+ "namespace" : ""
+ },
+ "readOnly" : false,
+"description" : "",
+"type" : "string"
+ },
+ "createdBy" : {
+ "xml" : {
+ "namespace" : ""
+ },
+ "readOnly" : false,
+"description" : "",
+"type" : "string"
+ },
+ "guid" : {
+ "xml" : {
+ "namespace" : ""
+ },
+ "readOnly" : false,
+"description" : "",
+"type" : "string"
+ },
+ "meanings" : {
+ "xml" : {
+ "namespace" : ""
+ },
+ "readOnly" : false,
+"description" : "",
+"type" : "array",
+"items" : {
+ "$ref" : "#/definitions/xml_ns0_atlasTermAssignmentHeader"
+}
+ },
+ "relationshipAttributes" : {
+ "xml" : {
+ "namespace" : ""
+ },
+ "readOnly" : false,
+"description" : "",
+"type" : "object"
+ },
+ "status" : {
+ "xml" : {
+ "namespace" : ""
+ },
+ "readOnly" : false,
+"$ref" : "#/definitions/xml_ns0_status"
+ },
+ "updateTime" : {
+ "xml" : {
+ "namespace" : ""
+ },
+ "readOnly" : false,
+"description" : "",
+"type" : "string"
+ },
+ "updatedBy" : {
+ "xml" : {
+ "namespace" : ""
+ },
+ "readOnly" : false,
+"description" : "",
+"type" : "string"
+ },
+ "version" : {
+ "xml" : {
+ "namespace" : ""
+ },
+ "readOnly" : false,
+"description" : "",
+"type" : "integer",
+"format" : "int64"
+ }
+ }
+ }
+ ],
+ "description" : "An instance of an entity - like hive_table, hive_database."
+ }
+ ,
+ "xml_ns0_status" : {
+ "type" : "string",
+ "title" : "status",
+ "enum" : [
+ "ACTIVE",
+ "DELETED"
+ ],
+ "description" : "Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store."
+ }
+ ,
+ "xml_ns0_atlasEntityHeader" : {
+ "type" : "object",
+ "xml" : {
+ "name" : "atlasEntityHeader",
+ "namespace" : ""
+ },
+ "title" : "atlasEntityHeader",
+ "allOf" : [
+ {
+ "$ref" : "#/definitions/xml_ns0_atlasStruct"
+ },
+ {
+ "properties" : {
+ "classificationNames" : {
+ "xml" : {
+ "namespace" : ""
+ },
+ "readOnly" : false,
+"description" : "",
+"type" : "array",
+"items" : {
+ "type" : "string"
+}
+ },
+ "classifications" : {
+ "xml" : {
+ "namespace" : ""
+ },
+ "readOnly" : false,
+"description" : "",
+"type" : "array",
+"items" : {
+ "$ref" : "#/definitions/xml_ns0_atlasClassification"
+}
+ },
+ "displayText" : {
+ "xml" : {
+ "namespace" : ""
+ },
+ "readOnly" : false,
+"description" : "",
+"type" : "string"
+ },
+ "guid" : {
+ "xml" : {
+ "namespace" : ""
+ },
+ "readOnly" : false,
+"description" : "",
+"type" : "string"
+ },
+ "meaningNames" : {
+ "xml" : {
+ "namespace" : ""
+ },
+ "readOnly" : false,
+"description" : "",
+"type" : "array",
+"items" : {
+ "type" : "string"
+}
+ },
+ "meanings" : {
+ "xml" : {
+ "namespace" : ""
+ },
+ "readOnly" : false,
+"description" : "",
+"type" : "array",
+"items" : {
+ "$ref" : "#/definitions/xml_ns0_atlasTermAssignmentHeader"
+}
+ },
+ "status" : {
+ "xml" : {
+ "namespace" : ""
+ },
+ "readOnly" : false,
+"$ref" : "#/definitions/xml_ns0_status"
+ }
+ }
+ }
+ ],
+ "description" : "An instance of an entity - like hive_table, hive_database."
+ }
+ ,
+ "xml_ns0_atlasObjectId" : {
+ "type" : "object",
+ "xml" : {
+ "name" : "atlasObjectId",
+ "namespace" : ""
+ },
+ "title" : "atlasObjectId",
+ "allOf" : [
+ {
+ "properties" : {
+ "guid" : {
+ "xml" : {
+ "namespace" : ""
+ },
+ "readOnly" : false,
+"description" : "",
+"type" : "string"
+ },
+ "typeName" : {
+ "xml" : {
+ "namespace" : ""
+ },
+ "readOnly" : false,
+"description" : "",
+"type" : "string"
+ },
+ "uniqueAttributes" : {
+ "xml" : {
+ "namespace" : ""
+ },
+ "readOnly" : false,
+"description" : "",
+"type" : "object"
+ }
+ }
+ }
+ ],
+ "description" : "Reference to an object-instance of an Atlas type - like entity."
+ }
+ ,
+ "xml_ns0_atlasRelatedObjectId" : {
+ "type" : "object",
+ "xml" : {
+ "name" : "atlasRelatedObjectId",
+ "namespace" : ""
+ },
+ "title" : "atlasRelatedObjectId",
+ "allOf" : [
+ {
+ "$ref" : "#/definitions/xml_ns0_atlasObjectId"
+ },
+ {
+ "properties" : {
+ "displayText" : {
+ "xml" : {
+ "namespace" : ""
+ },
+ "readOnly" : false,
+"description" : "",
+"type" : "string"
+ },
+ "relationshipAttributes" : {
+ "xml" : {
+ "namespace" : ""
+ },
+ "readOnly" : false,
+"$ref" : "#/definitions/xml_ns0_atlasStruct"
+ },
+ "relationshipGuid" : {
+ "xml" : {
+ "namespace" : ""
+ },
+ "readOnly" : false,
+"description" : "",
+"type" : "string"
+ },
+ "relationshipStatus" : {
+ "xml" : {
+ "namespace" : ""
+ },
+ "readOnly" : false,
+"description" : "",
+"type" : "object"
+ }
+ }
+ }
+ ],
+ "description" : "Reference to an object-instance of AtlasEntity type used in relationship attribute values"
+ }
+ ,
+ "xml_ns0_atlasRelationship" : {
+ "type" : "object",
+ "xml" : {
+ "name" : "atlasRelationship",
+ "namespace" : ""
+ },
+ "title" : "atlasRelationship",
+ "allOf" : [
+ {
+ "$ref" : "#/definitions/xml_ns0_atlasStruct"
+ },
+ {
+ "properties" : {
+ "blockedPropagatedClassifications" : {
+ "xml" : {
+ "namespace" : ""
+ },
+ "readOnly" : false,
+"description" : "",
+"type" : "array",
+"items" : {
+ "$ref" : "#/definitions/xml_ns0_atlasClassification"
+}
+ },
+ "createTime" : {
+ "xml" : {
+ "namespace" : ""
+ },
+ "readOnly" : false,
+"description" : "",
+"type" : "string"
+ },
+ "createdBy" : {
+ "xml" : {
+ "namespace" : ""
+ },
+ "readOnly" : false,
+"description" : "",
+"type" : "string"
+ },
+ "end1" : {
+ "xml" : {
+ "namespace" : ""
+ },
+ "readOnly" : false,
+"$ref" : "#/definitions/xml_ns0_atlasObjectId"
+ },
+ "end2" : {
+ "xml" : {
+ "namespace" : ""
+ },
+ "readOnly" : false,
+"$ref" : "#/definitions/xml_ns0_atlasObjectId"
+ },
+ "guid" : {
+ "xml" : {
+ "namespace" : ""
+ },
+ "readOnly" : false,
+"description" : "",
+"type" : "string"
+ },
+ "label" : {
+ "xml" : {
+ "namespace" : ""
+ },
+ "readOnly" : false,
+"description" : "",
+"type" : "string"
+ },
+ "propagateTags" : {
+ "xml" : {
+ "namespace" : ""
+ },
+ "readOnly" : false,
+"$ref" : "#/definitions/xml_ns0_propagateTags"
+ },
+ "propagatedClassifications" : {
+ "xml" : {
+ "namespace" : ""
+ },
+ "readOnly" : false,
+"description" : "",
+"type" : "array",
+"items" : {
+ "$ref" : "#/definitions/xml_ns0_atlasClassification"
+}
+ },
+ "status" : {
+ "xml" : {
+ "namespace" : ""
+ },
+ "readOnly" : false,
+"description" : "",
+"type" : "object"
+ },
+ "updateTime" : {
+ "xml" : {
+ "namespace" : ""
+ },
+ "readOnly" : false,
+"description" : "",
+"type" : "string"
+ },
+ "updatedBy" : {
+ "xml" : {
+ "namespace" : ""
+ },
+ "readOnly" : false,
+"description" : "",
+"type" : "string"
+ },
+ "version" : {
+ "xml" : {
+ "namespace" : ""
+ },
+ "readOnly" : false,
+"description" : "",
+"type" : "integer",
+"format" : "int64"
+ }
+ }
+ }
+ ],
+ "description" : "Atlas relationship instance."
+ }
+ ,
+ "xml_ns0_atlasStruct" : {
+ "type" : "object",
+ "xml" : {
+ "name" : "atlasStruct",
+ "namespace" : ""
+ },
+ "title" : "atlasStruct",
+ "allOf" : [
+ {
+ "properties" : {
+ "attributes" : {
+ "xml" : {
+ "namespace" : ""
+ },
+ "readOnly" : false,
+"description" : "",
+"type" : "object"
+ },
+ "typeName" : {
+ "xml" : {
+ "namespace" : ""
+ },
+ "readOnly" : false,
+"description" : "",
+"type" : "string"
+ }
+ }
+ }
+ ],
+ "description" : "Captures details of struct contents. Not instantiated directly, used only via AtlasEntity, AtlasClassification."
+ }
+ ,
+ "xml_ns0_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."
+ }
+ },
+ "paths": {
+ "\/admin/activeSearches" : {
+ "get" : {
+ "tags" : [ "AdminResource" ],
+ "description" : "",
+ "operationId" : "getActiveSearches",
+ "produces" : [ "application/json;charset=UTF-8" ],
+ "parameters" : [
+ ],
+ "responses" : {
+ "200" : {
+ "description" : ""
+ }
+ }
+ }
+ }
+ ,
+ "\/admin/activeSearches/{id}" : {
+ "delete" : {
+ "tags" : [ "AdminResource" ],
+ "description" : "",
+ "operationId" : "terminateActiveSearch",
+ "produces" : [ "application/json;charset=UTF-8" ],
+ "parameters" : [
+ {
+ "name" : "id",
+ "in" : "path",
+ "required" : true,
+ "type" : "string",
+ "description" : ""
+ }
+ ],
+ "responses" : {
+ "204" : {
+ "description" : ""
+ }
+ }
+ }
+ }
+ ,
+ "\/admin/export" : {
+ "post" : {
+ "tags" : [ "AdminResource" ],
+ "description" : "",
+ "operationId" : "export",
+ "consumes" : [ "application/json;charset=UTF-8" ],
+ "produces" : [ "application/xml", "application/json" ],
+ "parameters" : [
+ {
+ "name" : "body",
+ "in" : "body",
+ "type" : "file",
+ "description" : ""
+ }
+ ],
+ "responses" : {
+ "201" : {
+ "schema" : {
+"description" : "",
+"type" : "file"
+ },
+ "description" : ""
+ }
+ }
+ }
+ }
+ ,
+ "\/admin/import" : {
+ "post" : {
+ "tags" : [ "AdminResource" ],
+ "description" : "",
+ "operationId" : "importData",
+ "consumes" : [ "multipart/form-data" ],
+ "produces" : [ "application/json;charset=UTF-8" ],
+ "parameters" : [
+ {
+ "name" : "inputStream",
+ "in" : "formData",
+ "type" : "file",
+ "description" : ""
+ },
+ {
+ "name" : "jsonData",
+ "in" : "formData",
+ "default" : "{}",
+ "type" : "string",
+ "description" : ""
+ },
+ {
+ "name" : "body",
+ "in" : "body",
+ "type" : "file",
+ "description" : ""
+ }
+ ],
+ "responses" : {
+ "201" : {
+ "description" : ""
+ }
+ }
+ }
+ }
+ ,
+ "\/admin/importfile" : {
+ "post" : {
+ "tags" : [ "AdminResource" ],
+ "description" : "",
+ "operationId" : "importFile",
+ "consumes" : [ "application/xml", "application/json" ],
+ "produces" : [ "application/json;charset=UTF-8" ],
+ "parameters" : [
+ {
+ "name" : "body",
+ "in" : "body",
+ "schema" : {
+"description" : "",
+"type" : "string"
+ },
+ "description" : ""
+ }
+ ],
+ "responses" : {
+ "201" : {
+ "description" : ""
+ }
+ }
+ }
+ }
+ ,
+ "\/admin/metrics" : {
+ "get" : {
+ "tags" : [ "AdminResource" ],
+ "description" : "",
+ "operationId" : "getMetrics",
+ "produces" : [ "application/json;charset=UTF-8" ],
+ "parameters" : [
+ {
+ "name" : "ignoreCache",
+ "in" : "query",
+ "type" : "boolean",
+ "description" : ""
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "description" : ""
+ }
+ }
+ }
+ }
+ ,
+ "\/admin/session" : {
+ "get" : {
+ "tags" : [ "AdminResource" ],
+ "description" : "",
+ "operationId" : "getUserProfile",
+ "produces" : [ "application/json;charset=UTF-8" ],
+ "parameters" : [
+ ],
+ "responses" : {
+ "200" : {
+ "description" : ""
+ }
+ }
+ }
+ }
+ ,
+ "\/admin/stack" : {
+ "get" : {
+ "tags" : [ "AdminResource" ],
+ "summary" : "Fetches the thread stack dump for this application.",
+ "description" : "Fetches the thread stack dump for this application.",
+ "operationId" : "getThreadDump",
+ "produces" : [ "text/plain" ],
+ "parameters" : [
+ ],
+ "responses" : {
+ "200" : {
+ "schema" : {
+"description" : "json representing the thread stack dump.",
+"type" : "string"
+ },
+ "description" : "json representing the thread stack dump."
+ }
+ }
+ }
+ }
+ ,
+ "\/admin/status" : {
+ "get" : {
+ "tags" : [ "AdminResource" ],
+ "description" : "",
+ "operationId" : "getStatus",
+ "produces" : [ "application/json;charset=UTF-8" ],
+ "parameters" : [
+ ],
+ "responses" : {
+ "200" : {
+ "description" : ""
+ }
+ }
+ }
+ }
+ ,
+ "\/admin/version" : {
+ "get" : {
+ "tags" : [ "AdminResource" ],
+ "summary" : "Fetches the version for this application.",
+ "description" : "Fetches the version for this application.",
+ "operationId" : "getVersion",
+ "produces" : [ "application/json;charset=UTF-8" ],
+ "parameters" : [
+ ],
+ "responses" : {
+ "200" : {
+ "description" : "json representing the version."
+ }
+ }
+ }
+ }
+ ,
+ "\/discovery/search" : {
+ "get" : {
+ "deprecated":true,
+ "tags" : [ "MetadataDiscoveryResource" ],
+ "summary" : "Search using a given query.",
+ "description" : "Search using a given query.",
+ "operationId" : "search",
+ "produces" : [ "application/json;charset=UTF-8" ],
+ "parameters" : [
+ {
+ "name" : "limit",
+ "in" : "query",
+ "default" : "-1",
+ "type" : "integer",
+ "format" : "int32",
+ "description" : "number of rows to be returned in the result, used for pagination. maxlimit > limit > 0. -1 maps to atlas.search.defaultlimit property value"
+ },
+ {
+ "name" : "offset",
+ "in" : "query",
+ "default" : "-1",
+ "type" : "integer",
+ "format" : "int32",
+ "description" : "offset to the results returned, used for pagination. offset >= 0. -1 maps to offset 0"
+ },
+ {
+ "name" : "query",
+ "in" : "query",
+ "type" : "string",
+ "description" : "search query in DSL format falling back to full text."
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "description" : "JSON representing the type and results."
+ }
+ }
+ }
+ }
+ ,
+ "\/discovery/search/dsl" : {
+ "get" : {
+ "deprecated":true,
+ "tags" : [ "MetadataDiscoveryResource" ],
+ "summary" : "Search using query DSL format.",
+ "description" : "Search using query DSL format.",
+ "operationId" : "searchUsingQueryDSL",
+ "produces" : [ "application/json;charset=UTF-8" ],
+ "parameters" : [
+ {
+ "name" : "limit",
+ "in" : "query",
+ "default" : "-1",
+ "type" : "integer",
+ "format" : "int32",
+ "description" : "number of rows to be returned in the result, used for pagination. maxlimit > limit > 0. -1 maps to atlas.search.defaultlimit property value"
+ },
+ {
+ "name" : "offset",
+ "in" : "query",
+ "default" : "-1",
+ "type" : "integer",
+ "format" : "int32",
+ "description" : "offset to the results returned, used for pagination. offset >= 0. -1 maps to offset 0\nLimit and offset in API are used in conjunction with limit and offset in DSL query\nFinal limit = min(API limit, max(query limit - API offset, 0))\nFinal offset = API offset + query offset"
+ },
+ {
+ "name" : "query",
+ "in" : "query",
+ "type" : "string",
+ "description" : "search query in DSL format."
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "description" : "JSON representing the type and results."
+ }
+ }
+ }
+ }
+ ,
+ "\/discovery/search/fulltext" : {
+ "get" : {
+ "deprecated":true,
+ "tags" : [ "MetadataDiscoveryResource" ],
+ "summary" : "Search using full text search.",
+ "description" : "Search using full text search.",
+ "operationId" : "searchUsingFullText",
+ "produces" : [ "application/json;charset=UTF-8" ],
+ "parameters" : [
+ {
+ "name" : "limit",
+ "in" : "query",
+ "default" : "-1",
+ "type" : "integer",
+ "format" : "int32",
+ "description" : "number of rows to be returned in the result, used for pagination. maxlimit > limit > 0. -1 maps to atlas.search.defaultlimit property value"
+ },
+ {
+ "name" : "offset",
+ "in" : "query",
+ "default" : "-1",
+ "type" : "integer",
+ "format" : "int32",
+ "description" : "offset to the results returned, used for pagination. offset >= 0. -1 maps to offset 0"
+ },
+ {
+ "name" : "query",
+ "in" : "query",
+ "type" : "string",
+ "description" : "search query."
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "description" : "JSON representing the type and results."
+ }
+ }
+ }
+ }
+ ,
+ "\/entities" : {
+ "delete" : {
+ "deprecated":true,
+ "tags" : [ "EntityResource" ],
+ "summary" : "Delete entities from the repository identified by their guids (including their composite references)\nor\nDeletes a single entity identified by its type and unique attribute value from the repository (including their composite references).",
+ "description" : "Delete entities from the repository identified by their guids (including their composite references)\nor\nDeletes a single entity identified by its type and unique attribute value from the repository (including their composite references)",
+ "operationId" : "deleteEntities",
+ "produces" : [ "application/json;charset=UTF-8" ],
+ "parameters" : [
+ {
+ "name" : "guid",
+ "in" : "query",
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ },
+ "collectionFormat" : "multi",
+ "description" : "list of deletion candidate guids\nor"
+ },
+ {
+ "name" : "property",
+ "in" : "query",
+ "type" : "string",
+ "description" : "the unique attribute used to identify the entity"
+ },
+ {
+ "name" : "type",
+ "in" : "query",
+ "type" : "string",
+ "description" : "the entity type"
+ },
+ {
+ "name" : "value",
+ "in" : "query",
+ "type" : "string",
+ "description" : "the unique attribute value used to identify the entity"
+ }
+ ],
+ "responses" : {
+ "204" : {
+ "description" : "response payload as json - including guids of entities(including composite references from that entity) that were deleted"
+ }
+ }
+ }
+ ,
+ "get" : {
+ "deprecated":true,
+ "tags" : [ "EntityResource" ],
+ "description" : "",
+ "operationId" : "getEntity",
+ "produces" : [ "application/json;charset=UTF-8" ],
+ "parameters" : [
+ {
+ "name" : "property",
+ "in" : "query",
+ "type" : "string",
+ "description" : ""
+ },
+ {
+ "name" : "type",
+ "in" : "query",
+ "type" : "string",
+ "description" : ""
+ },
+ {
+ "name" : "value",
+ "in" : "query",
+ "type" : "string",
+ "description" : ""
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "description" : ""
+ }
+ }
+ }
+ ,
+ "post" : {
+ "deprecated":true,
+ "tags" : [ "EntityResource" ],
+ "summary" : "Submits the entity definitions (instances).",
+ "description" : "Submits the entity definitions (instances).\nThe body contains the JSONArray of entity json. The service takes care of de-duping the entities based on any\nunique attribute for the give type.",
+ "operationId" : "submit",
+ "produces" : [ "application/json;charset=UTF-8" ],
+ "parameters" : [
+ ],
+ "responses" : {
+ "201" : {
+ "description" : ""
+ }
+ }
+ }
+ ,
+ "put" : {
+ "deprecated":true,
+ "tags" : [ "EntityResource" ],
+ "summary" : "Complete update of a set of entities - the values not specified will be replaced with null/removed\nAdds/Updates given entities identified by its GUID or unique attribute.",
+ "description" : "Complete update of a set of entities - the values not specified will be replaced with null/removed\nAdds/Updates given entities identified by its GUID or unique attribute",
+ "operationId" : "updateEntities",
+ "produces" : [ "application/json;charset=UTF-8" ],
+ "parameters" : [
+ ],
+ "responses" : {
+ "204" : {
+ "description" : "response payload as json"
+ }
+ }
+ }
+ }
+ ,
+ "\/entities/qualifiedName" : {
+ "post" : {
+ "deprecated":true,
+ "tags" : [ "EntityResource" ],
+ "summary" : "Adds/Updates given entity identified by its unique attribute( entityType, attributeName and value)\nUpdates support only partial update of an entity - Adds/updates any new values specified\nUpdates do not support removal of attribute values.",
+ "description" : "Adds/Updates given entity identified by its unique attribute( entityType, attributeName and value)\nUpdates support only partial update of an entity - Adds/updates any new values specified\nUpdates do not support removal of attribute values",
+ "operationId" : "updateByUniqueAttribute",
+ "produces" : [ "application/json;charset=UTF-8" ],
+ "parameters" : [
+ {
+ "name" : "property",
+ "in" : "query",
+ "type" : "string",
+ "description" : "the unique attribute used to identify the entity"
+ },
+ {
+ "name" : "type",
+ "in" : "query",
+ "type" : "string",
+ "description" : "the entity type"
+ },
+ {
+ "name" : "value",
+ "in" : "query",
+ "type" : "string",
+ "description" : "the unique attributes value"
+ }
+ ],
+ "responses" : {
+ "201" : {
+ "description" : "response payload as json\nThe body contains the JSONArray of entity json. The service takes care of de-duping the entities based on any\nunique attribute for the give type."
+ }
+ }
+ }
+ }
+ ,
+ "\/entities/{guid}" : {
+ "get" : {
+ "deprecated":true,
+ "tags" : [ "EntityResource" ],
+ "summary" : "Fetch the complete definition of an entity given its GUID.",
+ "description" : "Fetch the complete definition of an entity given its GUID.",
+ "operationId" : "getEntityDefinition",
+ "produces" : [ "application/json;charset=UTF-8" ],
+ "parameters" : [
+ {
+ "name" : "guid",
+ "in" : "path",
+ "required" : true,
+ "type" : "string",
+ "description" : "GUID for the entity"
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "description" : ""
+ }
+ }
+ }
+ ,
+ "post" : {
+ "deprecated":true,
+ "tags" : [ "EntityResource" ],
+ "summary" : "Updates entity identified by its GUID\nSupport Partial update of an entity - Adds/updates any new values specified\nDoes not support removal of attribute values.",
+ "description" : "Updates entity identified by its GUID\nSupport Partial update of an entity - Adds/updates any new values specified\nDoes not support removal of attribute values",
+ "operationId" : "updateEntityByGuid",
+ "produces" : [ "application/json;charset=UTF-8" ],
+ "parameters" : [
+ {
+ "name" : "guid",
+ "in" : "path",
+ "required" : true,
+ "type" : "string",
+ "description" : ""
+ },
+ {
+ "name" : "property",
+ "in" : "query",
+ "type" : "string",
+ "description" : ""
+ }
+ ],
+ "responses" : {
+ "201" : {
+ "description" : ""
+ }
+ }
+ }
+ }
+ ,
+ "\/entities/{guid}/audit" : {
+ "get" : {
+ "deprecated":true,
+ "tags" : [ "EntityResource" ],
+ "summary" : "Returns the entity audit events for a given entity id.",
+ "description" : "Returns the entity audit events for a given entity id. The events are returned in the decreasing order of timestamp.",
+ "operationId" : "getAuditEvents",
+ "produces" : [ "application/json;charset=UTF-8" ],
+ "parameters" : [
+ {
+ "name" : "guid",
+ "in" : "path",
+ "required" : true,
+ "type" : "string",
+ "description" : "entity id"
+ },
+ {
+ "name" : "count",
+ "in" : "query",
+ "default" : "100",
+ "type" : "integer",
+ "format" : "int32",
+ "description" : "number of events required"
+ },
+ {
+ "name" : "startKey",
+ "in" : "query",
+ "type" : "string",
+ "description" : "used for pagination. Startkey is inclusive, the returned results contain the event with the given startkey.\nFirst time getAuditEvents() is called for an entity, startKey should be null,\nwith count = (number of events required + 1). Next time getAuditEvents() is called for the same entity,\nstartKey should be equal to the entityKey of the last event returned in the previous call."
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "description" : ""
+ }
+ }
+ }
+ }
+ ,
+ "\/entities/{guid}/traitDefinitions" : {
+ "get" : {
+ "deprecated":true,
+ "tags" : [ "EntityResource" ],
+ "summary" : "Fetches the trait definitions of all the traits associated to the given entity.",
+ "description" : "Fetches the trait definitions of all the traits associated to the given entity",
+ "operationId" : "getTraitDefinitionsForEntity",
+ "produces" : [ "application/json;charset=UTF-8" ],
+ "parameters" : [
+ {
+ "name" : "guid",
+ "in" : "path",
+ "required" : true,
+ "type" : "string",
+ "description" : "globally unique identifier for the entity"
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "description" : ""
+ }
+ }
+ }
+ }
+ ,
+ "\/entities/{guid}/traitDefinitions/{traitName}" : {
+ "get" : {
+ "deprecated":true,
+ "tags" : [ "EntityResource" ],
+ "summary" : "Fetches the trait definition for an entity given its guid and trait name.",
+ "description" : "Fetches the trait definition for an entity given its guid and trait name",
+ "operationId" : "getTraitDefinitionForEntity",
+ "produces" : [ "application/json;charset=UTF-8" ],
+ "parameters" : [
+ {
+ "name" : "guid",
+ "in" : "path",
+ "required" : true,
+ "type" : "string",
+ "description" : "globally unique identifier for the entity"
+ },
+ {
+ "name" : "traitName",
+ "in" : "path",
+ "required" : true,
+ "type" : "string",
+ "description" : "name of the trait"
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "description" : ""
+ }
+ }
+ }
+ }
+ ,
+ "\/entities/{guid}/traits" : {
+ "get" : {
+ "deprecated":true,
+ "tags" : [ "EntityResource" ],
+ "summary" : "Gets the list of trait names for a given entity represented by a guid.",
+ "description" : "Gets the list of trait names for a given entity represented by a guid.",
+ "operationId" : "getTraitNames",
+ "produces" : [ "application/json;charset=UTF-8" ],
+ "parameters" : [
+ {
+ "name" : "guid",
+ "in" : "path",
+ "required" : true,
+ "type" : "string",
+ "description" : "globally unique identifier for the entity"
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "description" : "a list of trait names for the given entity guid"
+ }
+ }
+ }
+ ,
+ "post" : {
+ "deprecated":true,
+ "tags" : [ "EntityResource" ],
+ "summary" : "Adds a new trait to an existing entity represented by a guid.",
+ "description" : "Adds a new trait to an existing entity represented by a guid.",
+ "operationId" : "addTrait",
+ "produces" : [ "application/json;charset=UTF-8" ],
+ "parameters" : [
+ {
+ "name" : "guid",
+ "in" : "path",
+ "required" : true,
+ "type" : "string",
+ "description" : "globally unique identifier for the entity"
+ }
+ ],
+ "responses" : {
+ "201" : {
+ "description" : ""
+ }
+ }
+ }
+ }
+ ,
+ "\/entities/{guid}/traits/{traitName}" : {
+ "delete" : {
+ "deprecated":true,
+ "tags" : [ "EntityResource" ],
+ "summary" : "Deletes a given trait from an existing entity represented by a guid.",
+ "description" : "Deletes a given trait from an existing entity represented by a guid.",
+ "operationId" : "deleteTrait",
+ "produces" : [ "application/json;charset=UTF-8" ],
+ "parameters" : [
+ {
+ "name" : "guid",
+ "in" : "path",
+ "required" : true,
+ "type" : "string",
+ "description" : "globally unique identifier for the entity"
+ },
+ {
+ "name" : "traitName",
+ "in" : "path",
+ "required" : true,
+ "type" : "string",
+ "description" : "name of the trait"
+ }
+ ],
+ "responses" : {
+ "204" : {
+ "description" : ""
+ }
+ }
+ }
+ }
+ ,
+ "\/lineage/hive/table/{tableName}/inputs/graph" : {
+ "get" : {
+ "deprecated":true,
+ "tags" : [ "DataSetLineageResource" ],
+ "summary" : "Returns the inputs graph for a given entity.",
+ "description" : "Returns the inputs graph for a given entity.",
+ "operationId" : "inputsGraph",
+ "produces" : [ "application/json;charset=UTF-8" ],
+ "parameters" : [
+ {
+ "name" : "tableName",
+ "in" : "path",
+ "required" : true,
+ "type" : "string",
+ "description" : "table name"
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "description" : ""
+ }
+ }
+ }
+ }
+ ,
+ "\/lineage/hive/table/{tableName}/outputs/graph" : {
+ "get" : {
+ "deprecated":true,
+ "tags" : [ "DataSetLineageResource" ],
+ "summary" : "Returns the outputs graph for a given entity.",
+ "description" : "Returns the outputs graph for a given entity.",
+ "operationId" : "outputsGraph",
+ "produces" : [ "application/json;charset=UTF-8" ],
+ "parameters" : [
+ {
+ "name" : "tableName",
+ "in" : "path",
+ "required" : true,
+ "type" : "string",
+ "description" : "table name"
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "description" : ""
+ }
+ }
+ }
+ }
+ ,
+ "\/lineage/hive/table/{tableName}/schema" : {
+ "get" : {
+ "deprecated":true,
+ "tags" : [ "DataSetLineageResource" ],
+ "summary" : "Return the schema for the given tableName.",
+ "description" : "Return the schema for the given tableName.",
+ "operationId" : "schema",
+ "produces" : [ "application/json;charset=UTF-8" ],
+ "parameters" : [
+ {
+ "name" : "tableName",
+ "in" : "path",
+ "required" : true,
+ "type" : "string",
+ "description" : "table name"
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "description" : ""
+ }
+ }
+ }
+ }
+ ,
+ "\/lineage/{guid}/inputs/graph" : {
+ "get" : {
+ "deprecated":true,
+ "tags" : [ "LineageResource" ],
+ "summary" : "Returns input lineage graph for the given entity id.",
+ "description" : "Returns input lineage graph for the given entity id.",
+ "operationId" : "inputsGraph2",
+ "produces" : [ "application/json;charset=UTF-8" ],
+ "parameters" : [
+ {
+ "name" : "guid",
+ "in" : "path",
+ "required" : true,
+ "type" : "string",
+ "description" : "dataset entity id"
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "description" : ""
+ }
+ }
+ }
+ }
+ ,
+ "\/lineage/{guid}/outputs/graph" : {
+ "get" : {
+ "deprecated":true,
+ "tags" : [ "LineageResource" ],
+ "summary" : "Returns the outputs graph for a given entity id.",
+ "description" : "Returns the outputs graph for a given entity id.",
+ "operationId" : "outputsGraph2",
+ "produces" : [ "application/json;charset=UTF-8" ],
+ "parameters" : [
+ {
+ "name" : "guid",
+ "in" : "path",
+ "required" : true,
+ "type" : "string",
+ "description" : "dataset entity id"
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "description" : ""
+ }
+ }
+ }
+ }
+ ,
+ "\/lineage/{guid}/schema" : {
+ "get" : {
+ "deprecated":true,
+ "tags" : [ "LineageResource" ],
+ "summary" : "Returns the schema for the given dataset id.",
+ "description" : "Returns the schema for the given dataset id.",
+ "operationId" : "schema2",
+ "produces" : [ "application/json;charset=UTF-8" ],
+ "parameters" : [
+ {
+ "name" : "guid",
+ "in" : "path",
+ "required" : true,
+ "type" : "string",
+ "description" : "dataset entity id"
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "description" : ""
+ }
+ }
+ }
+ }
+ ,
+ "\/types" : {
+ "get" : {
+ "deprecated":true,
+ "tags" : [ "TypesResource" ],
+ "summary" : "Return the list of type names in the type system which match the specified filter.",
+ "description" : "Return the list of type names in the type system which match the specified filter.",
+ "operationId" : "getTypesByFilter",
+ "produces" : [ "application/json;charset=UTF-8" ],
+ "parameters" : [
+ {
+ "name" : "notsupertype",
+ "in" : "query",
+ "type" : "string",
+ "description" : "returns types which do not contain the given supertype\n\nIts possible to specify combination of these filters in one request and the conditions are combined with AND\nFor example, typeCategory = TRAIT && supertype contains 'X' && supertype !contains 'Y'\nIf there is no filter, all the types are returned"
+ },
+ {
+ "name" : "supertype",
+ "in" : "query",
+ "type" : "string",
+ "description" : "returns types which contain the given supertype"
+ },
+ {
+ "name" : "type",
+ "in" : "query",
+ "type" : "string",
+ "description" : "returns types whose relationshipCategory is the given typeCategory"
+ }
+ ],
+ "responses" : {
+ "200" : {
+ "description" : "list of type names"
+ }
+ }
+ }
+ ,
+ "post" : {
+ "deprecated":true,
+ "tags" : [ "TypesResource" ],
+ "summary" : "Submits a type definition corresponding to a given type representing a meta model of a\ndomain.",
+ "description" : "Submits a type definition corresponding to a given type representing a meta model of a\ndomain. Could represent things like Hive Database, Hive Table, etc.",
+ "operationId" : "submit2",
+ "produces" : [ "application/json;charset=UTF-8" ],
+ "parameters" : [
+ ],
+ "responses" : {
+ "201" : {
+ "description" : ""
+ }
+ }
+ }
+ ,
+ "put" : {
+ "deprecated":true,
+ "tags" : [ "TypesResource" ],
+ "summary" : "Update of existing types - if the given type doesn't exist, creates new type\nAllowed updates are:\n1.",
+ "description" : "Update of existing types - if the given type doesn't exist, creates new type\nAllowed updates are:\n1. Add optional attribute\n2. Change required to optional attribute\n3. Add super types - super types shouldn't contain any required attributes",
+ "operationId" : "update",
+ "produces" : [ "application/json;charset=UTF-8" ]
<TRUNCATED>