| { |
| "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" : "2.3.0", |
| "title" : "Atlas REST API" |
| }, |
| "basePath" : "/api/atlas/", |
| "schemes" : [], |
| "tags" : [ |
| { |
| "name" : "DiscoveryREST" |
| , |
| "description" : "REST interface for data discovery using dsl or full text search." |
| } |
| , |
| { |
| "name" : "EntityREST" |
| , |
| "description" : "REST for a single entity." |
| } |
| , |
| { |
| "name" : "GlossaryREST" |
| } |
| , |
| { |
| "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" : { |
| "AtlasAggregationEntry" : { |
| "type" : "object", |
| "title" : "AtlasAggregationEntry", |
| "required" : ["count"], |
| "properties" : { |
| "count" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "integer", |
| "format" : "int64" |
| }, |
| "name" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| } |
| }, |
| "example" : { |
| "count" : 12345, |
| "name" : "..." |
| }, |
| "description" : "An instance of an entity - like hive_table, hive_database." |
| } |
| , |
| "AtlasAttributeDef" : { |
| "type" : "object", |
| "title" : "AtlasAttributeDef", |
| "required" : ["includeInNotification", "isIndexable", "isOptional", "isUnique", "searchWeight", "valuesMaxCount", "valuesMinCount"], |
| "properties" : { |
| "cardinality" : { |
| "readOnly" : false, |
| "$ref" : "#/definitions/Cardinality", |
| "description" : "" |
| }, |
| "constraints" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "array", |
| "items" : { |
| "$ref" : "#/definitions/AtlasConstraintDef" |
| } |
| }, |
| "defaultValue" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| }, |
| "description" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| }, |
| "displayName" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| }, |
| "includeInNotification" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "boolean" |
| }, |
| "indexType" : { |
| "readOnly" : false, |
| "$ref" : "#/definitions/IndexType", |
| "description" : "" |
| }, |
| "isIndexable" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "boolean" |
| }, |
| "isOptional" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "boolean" |
| }, |
| "isUnique" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "boolean" |
| }, |
| "name" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| }, |
| "options" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "object", |
| "additionalProperties" : { |
| "type" : "string" |
| } |
| }, |
| "searchWeight" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "integer", |
| "format" : "int32" |
| }, |
| "typeName" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| }, |
| "valuesMaxCount" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "integer", |
| "format" : "int32" |
| }, |
| "valuesMinCount" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "integer", |
| "format" : "int32" |
| } |
| }, |
| "example" : { |
| "cardinality" : "LIST", |
| "constraints" : [ { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| }, { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, |
| "description" : "class that captures details of a struct-attribute." |
| } |
| , |
| "AtlasBaseModelObject" : { |
| "type" : "object", |
| "title" : "AtlasBaseModelObject", |
| "properties" : { |
| "guid" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| } |
| }, |
| "example" : { |
| "guid" : "..." |
| }, |
| "description" : "" |
| } |
| , |
| "AtlasBaseTypeDef" : { |
| "type" : "object", |
| "title" : "AtlasBaseTypeDef", |
| "properties" : { |
| "category" : { |
| "readOnly" : false, |
| "$ref" : "#/definitions/TypeCategory", |
| "description" : "" |
| }, |
| "createTime" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "integer", |
| "format" : "int32" |
| }, |
| "createdBy" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| }, |
| "dateFormatter" : { |
| "readOnly" : false, |
| "$ref" : "#/definitions/DateFormat", |
| "description" : "" |
| }, |
| "description" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| }, |
| "guid" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| }, |
| "name" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| }, |
| "options" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "object", |
| "additionalProperties" : { |
| "type" : "string" |
| } |
| }, |
| "serviceType" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| }, |
| "typeVersion" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| }, |
| "updateTime" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "integer", |
| "format" : "int32" |
| }, |
| "updatedBy" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| }, |
| "version" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "integer", |
| "format" : "int64" |
| } |
| }, |
| "example" : { |
| "category" : "CLASSIFICATION", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { |
| "availableLocales" : [ "...", "..." ], |
| "currency" : "...", |
| "currencyInstance" : { }, |
| "groupingUsed" : true, |
| "instance" : { }, |
| "integerInstance" : { }, |
| "maximumFractionDigits" : 12345, |
| "maximumIntegerDigits" : 12345, |
| "minimumFractionDigits" : 12345, |
| "minimumIntegerDigits" : 12345, |
| "numberInstance" : { }, |
| "parseIntegerOnly" : true, |
| "percentInstance" : { }, |
| "roundingMode" : "UP" |
| }, |
| "timeInstance" : { }, |
| "timeZone" : { |
| "DSTSavings" : 12345, |
| "ID" : "...", |
| "availableIDs" : [ "...", "..." ], |
| "default" : { }, |
| "displayName" : "...", |
| "rawOffset" : 12345 |
| } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| }, |
| "description" : "Base class that captures common-attributes for all Atlas types." |
| } |
| , |
| "AtlasBusinessMetadataDef" : { |
| "type" : "object", |
| "title" : "AtlasBusinessMetadataDef", |
| "allOf" : [ |
| { |
| "$ref" : "#/definitions/AtlasStructDef" |
| }, |
| { |
| } |
| ], |
| "example" : { |
| "attributeDefs" : [ { |
| "cardinality" : "LIST", |
| "constraints" : [ { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| }, { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| }, { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "CLASSIFICATION", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { |
| "availableLocales" : [ "...", "..." ], |
| "currency" : "...", |
| "currencyInstance" : { }, |
| "groupingUsed" : true, |
| "instance" : { }, |
| "integerInstance" : { }, |
| "maximumFractionDigits" : 12345, |
| "maximumIntegerDigits" : 12345, |
| "minimumFractionDigits" : 12345, |
| "minimumIntegerDigits" : 12345, |
| "numberInstance" : { }, |
| "parseIntegerOnly" : true, |
| "percentInstance" : { }, |
| "roundingMode" : "FLOOR" |
| }, |
| "timeInstance" : { }, |
| "timeZone" : { |
| "DSTSavings" : 12345, |
| "ID" : "...", |
| "availableIDs" : [ "...", "..." ], |
| "default" : { }, |
| "displayName" : "...", |
| "rawOffset" : 12345 |
| } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| }, |
| "description" : "class that captures details of a struct-type." |
| } |
| , |
| "AtlasClassification" : { |
| "type" : "object", |
| "title" : "AtlasClassification", |
| "allOf" : [ |
| { |
| "$ref" : "#/definitions/AtlasStruct" |
| }, |
| { |
| "properties" : { |
| "entityGuid" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| }, |
| "entityStatus" : { |
| "readOnly" : false, |
| "$ref" : "#/definitions/Status", |
| "description" : "" |
| }, |
| "propagate" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "boolean" |
| }, |
| "removePropagationsOnEntityDelete" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "boolean" |
| }, |
| "validityPeriods" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "array", |
| "items" : { |
| "$ref" : "#/definitions/TimeBoundary" |
| } |
| } |
| } |
| } |
| ], |
| "example" : { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "description" : "An instance of a classification; it doesn't have an identity, this object exists only when associated with an entity." |
| } |
| , |
| "AtlasClassificationDef" : { |
| "type" : "object", |
| "title" : "AtlasClassificationDef", |
| "allOf" : [ |
| { |
| "$ref" : "#/definitions/AtlasStructDef" |
| }, |
| { |
| "properties" : { |
| "entityTypes" : { |
| "readOnly" : false, |
| "description" : "Specifying a list of entityType names in the classificationDef, ensures that classifications can\nonly be applied to those entityTypes.\n<ul>\n<li>Any subtypes of the entity types inherit the restriction<\/li>\n<li>Any classificationDef subtypes inherit the parents entityTypes restrictions<\/li>\n<li>Any classificationDef subtypes can further restrict the parents entityTypes restrictions by specifying a subset of the entityTypes<\/li>\n<li>An empty entityTypes list when there are no parent restrictions means there are no restrictions<\/li>\n<li>An empty entityTypes list when there are parent restrictions means that the subtype picks up the parents restrictions<\/li>\n<li>If a list of entityTypes are supplied, where one inherits from another, this will be rejected. This should encourage cleaner classificationsDefs<\/li>\n<\/ul>", |
| "type" : "array", |
| "items" : { |
| "type" : "string" |
| } |
| }, |
| "subTypes" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "array", |
| "items" : { |
| "type" : "string" |
| } |
| }, |
| "superTypes" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "array", |
| "items" : { |
| "type" : "string" |
| } |
| } |
| } |
| } |
| ], |
| "example" : { |
| "entityTypes" : [ "...", "..." ], |
| "subTypes" : [ "...", "..." ], |
| "superTypes" : [ "...", "..." ], |
| "attributeDefs" : [ { |
| "cardinality" : "LIST", |
| "constraints" : [ { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| }, { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| }, { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "OBJECT_ID_TYPE", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { |
| "availableLocales" : [ "...", "..." ], |
| "currency" : "...", |
| "currencyInstance" : { }, |
| "groupingUsed" : true, |
| "instance" : { }, |
| "integerInstance" : { }, |
| "maximumFractionDigits" : 12345, |
| "maximumIntegerDigits" : 12345, |
| "minimumFractionDigits" : 12345, |
| "minimumIntegerDigits" : 12345, |
| "numberInstance" : { }, |
| "parseIntegerOnly" : true, |
| "percentInstance" : { }, |
| "roundingMode" : "FLOOR" |
| }, |
| "timeInstance" : { }, |
| "timeZone" : { |
| "DSTSavings" : 12345, |
| "ID" : "...", |
| "availableIDs" : [ "...", "..." ], |
| "default" : { }, |
| "displayName" : "...", |
| "rawOffset" : 12345 |
| } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| }, |
| "description" : "class that captures details of a classification-type." |
| } |
| , |
| "AtlasClassifications" : { |
| "type" : "object", |
| "title" : "AtlasClassifications", |
| "allOf" : [ |
| { |
| "$ref" : "#/definitions/PList" |
| }, |
| { |
| } |
| ], |
| "example" : { |
| "list" : [ { }, { } ], |
| "pageSize" : 12345, |
| "sortBy" : "...", |
| "sortType" : "NONE", |
| "startIndex" : 12345, |
| "totalCount" : 12345 |
| }, |
| "description" : "REST serialization friendly list." |
| } |
| , |
| "AtlasConstraintDef" : { |
| "type" : "object", |
| "title" : "AtlasConstraintDef", |
| "properties" : { |
| "params" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "object", |
| "additionalProperties" : { |
| "type" : "object" |
| } |
| }, |
| "type" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| } |
| }, |
| "example" : { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| }, |
| "description" : "class that captures details of a constraint." |
| } |
| , |
| "AtlasEntitiesWithExtInfo" : { |
| "type" : "object", |
| "title" : "AtlasEntitiesWithExtInfo", |
| "allOf" : [ |
| { |
| "$ref" : "#/definitions/AtlasEntityExtInfo" |
| }, |
| { |
| "properties" : { |
| "entities" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "array", |
| "items" : { |
| "$ref" : "#/definitions/AtlasEntity" |
| } |
| } |
| } |
| } |
| ], |
| "example" : { |
| "entities" : [ { |
| "businessAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "customAttributes" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "guid" : "...", |
| "homeId" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "IMPORTED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "VALIDATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "pendingTasks" : [ "...", "..." ], |
| "provenanceType" : 12345, |
| "proxy" : true, |
| "relationshipAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "status" : "DELETED", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "businessAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "customAttributes" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "guid" : "...", |
| "homeId" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "PROPOSED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "PROPOSED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "pendingTasks" : [ "...", "..." ], |
| "provenanceType" : 12345, |
| "proxy" : true, |
| "relationshipAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "status" : "ACTIVE", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "referredEntities" : { |
| "property1" : { |
| "businessAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "customAttributes" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "guid" : "...", |
| "homeId" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "IMPORTED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "pendingTasks" : [ "...", "..." ], |
| "provenanceType" : 12345, |
| "proxy" : true, |
| "relationshipAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "status" : "DELETED", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "property2" : { |
| "businessAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "customAttributes" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "guid" : "...", |
| "homeId" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "VALIDATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "pendingTasks" : [ "...", "..." ], |
| "provenanceType" : 12345, |
| "proxy" : true, |
| "relationshipAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "status" : "ACTIVE", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } |
| } |
| }, |
| "description" : "An instance of an entity along with extended info - like hive_table, hive_database." |
| } |
| , |
| "AtlasEntity" : { |
| "type" : "object", |
| "title" : "AtlasEntity", |
| "allOf" : [ |
| { |
| "$ref" : "#/definitions/AtlasStruct" |
| }, |
| { |
| "properties" : { |
| "businessAttributes" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "object", |
| "additionalProperties" : { |
| "type" : "object" |
| } |
| }, |
| "classifications" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "array", |
| "items" : { |
| "$ref" : "#/definitions/AtlasClassification" |
| } |
| }, |
| "createTime" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "integer", |
| "format" : "int32" |
| }, |
| "createdBy" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| }, |
| "customAttributes" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "object", |
| "additionalProperties" : { |
| "type" : "string" |
| } |
| }, |
| "guid" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| }, |
| "homeId" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| }, |
| "isIncomplete" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "boolean" |
| }, |
| "labels" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "array", |
| "items" : { |
| "type" : "string" |
| } |
| }, |
| "meanings" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "array", |
| "items" : { |
| "$ref" : "#/definitions/AtlasTermAssignmentHeader" |
| } |
| }, |
| "pendingTasks" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "array", |
| "items" : { |
| "type" : "string" |
| } |
| }, |
| "provenanceType" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "integer", |
| "format" : "int32" |
| }, |
| "proxy" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "boolean" |
| }, |
| "relationshipAttributes" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "object", |
| "additionalProperties" : { |
| "type" : "object" |
| } |
| }, |
| "status" : { |
| "readOnly" : false, |
| "$ref" : "#/definitions/Status", |
| "description" : "" |
| }, |
| "updateTime" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "integer", |
| "format" : "int32" |
| }, |
| "updatedBy" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| }, |
| "version" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "integer", |
| "format" : "int64" |
| } |
| } |
| } |
| ], |
| "example" : { |
| "businessAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "customAttributes" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "guid" : "...", |
| "homeId" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "IMPORTED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "PROPOSED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "pendingTasks" : [ "...", "..." ], |
| "provenanceType" : 12345, |
| "proxy" : true, |
| "relationshipAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "status" : "PURGED", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "description" : "An instance of an entity - like hive_table, hive_database." |
| } |
| , |
| "AtlasEntityDef" : { |
| "type" : "object", |
| "title" : "AtlasEntityDef", |
| "allOf" : [ |
| { |
| "$ref" : "#/definitions/AtlasStructDef" |
| }, |
| { |
| "properties" : { |
| "businessAttributeDefs" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "object", |
| "additionalProperties" : { |
| "type" : "array", |
| "items" : { |
| "$ref" : "#/definitions/AtlasAttributeDef" |
| } |
| } |
| }, |
| "relationshipAttributeDefs" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "array", |
| "items" : { |
| "$ref" : "#/definitions/AtlasRelationshipAttributeDef" |
| } |
| }, |
| "subTypes" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "array", |
| "items" : { |
| "type" : "string" |
| } |
| }, |
| "superTypes" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "array", |
| "items" : { |
| "type" : "string" |
| } |
| } |
| } |
| } |
| ], |
| "example" : { |
| "businessAttributeDefs" : { |
| "property1" : [ { |
| "cardinality" : "SET", |
| "constraints" : [ { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| }, { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SET", |
| "constraints" : [ { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| }, { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "property2" : [ { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| }, { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| }, { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ] |
| }, |
| "relationshipAttributeDefs" : [ { |
| "isLegacyAttribute" : true, |
| "relationshipTypeName" : "...", |
| "cardinality" : "SINGLE", |
| "constraints" : [ { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| }, { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "isLegacyAttribute" : true, |
| "relationshipTypeName" : "...", |
| "cardinality" : "SINGLE", |
| "constraints" : [ { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| }, { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "subTypes" : [ "...", "..." ], |
| "superTypes" : [ "...", "..." ], |
| "attributeDefs" : [ { |
| "cardinality" : "SET", |
| "constraints" : [ { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| }, { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SET", |
| "constraints" : [ { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| }, { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "ENTITY", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { |
| "availableLocales" : [ "...", "..." ], |
| "currency" : "...", |
| "currencyInstance" : { }, |
| "groupingUsed" : true, |
| "instance" : { }, |
| "integerInstance" : { }, |
| "maximumFractionDigits" : 12345, |
| "maximumIntegerDigits" : 12345, |
| "minimumFractionDigits" : 12345, |
| "minimumIntegerDigits" : 12345, |
| "numberInstance" : { }, |
| "parseIntegerOnly" : true, |
| "percentInstance" : { }, |
| "roundingMode" : "HALF_UP" |
| }, |
| "timeInstance" : { }, |
| "timeZone" : { |
| "DSTSavings" : 12345, |
| "ID" : "...", |
| "availableIDs" : [ "...", "..." ], |
| "default" : { }, |
| "displayName" : "...", |
| "rawOffset" : 12345 |
| } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| }, |
| "description" : "class that captures details of a entity-type." |
| } |
| , |
| "AtlasEntityExtInfo" : { |
| "type" : "object", |
| "title" : "AtlasEntityExtInfo", |
| "properties" : { |
| "referredEntities" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "object", |
| "additionalProperties" : { |
| "$ref" : "#/definitions/AtlasEntity" |
| } |
| } |
| }, |
| "example" : { |
| "referredEntities" : { |
| "property1" : { |
| "businessAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "customAttributes" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "guid" : "...", |
| "homeId" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "VALIDATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "pendingTasks" : [ "...", "..." ], |
| "provenanceType" : 12345, |
| "proxy" : true, |
| "relationshipAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "status" : "PURGED", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "property2" : { |
| "businessAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "customAttributes" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "guid" : "...", |
| "homeId" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DISCOVERED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "pendingTasks" : [ "...", "..." ], |
| "provenanceType" : 12345, |
| "proxy" : true, |
| "relationshipAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "status" : "DELETED", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } |
| } |
| }, |
| "description" : "An instance of an entity along with extended info - like hive_table, hive_database." |
| } |
| , |
| "AtlasEntityHeader" : { |
| "type" : "object", |
| "title" : "AtlasEntityHeader", |
| "allOf" : [ |
| { |
| "$ref" : "#/definitions/AtlasStruct" |
| }, |
| { |
| "properties" : { |
| "classificationNames" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "array", |
| "items" : { |
| "type" : "string" |
| } |
| }, |
| "classifications" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "array", |
| "items" : { |
| "$ref" : "#/definitions/AtlasClassification" |
| } |
| }, |
| "displayText" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| }, |
| "guid" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| }, |
| "isIncomplete" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "boolean" |
| }, |
| "labels" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "array", |
| "items" : { |
| "type" : "string" |
| } |
| }, |
| "meaningNames" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "array", |
| "items" : { |
| "type" : "string" |
| } |
| }, |
| "meanings" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "array", |
| "items" : { |
| "$ref" : "#/definitions/AtlasTermAssignmentHeader" |
| } |
| }, |
| "status" : { |
| "readOnly" : false, |
| "$ref" : "#/definitions/Status", |
| "description" : "" |
| } |
| } |
| } |
| ], |
| "example" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "VALIDATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "description" : "An instance of an entity - like hive_table, hive_database." |
| } |
| , |
| "AtlasEntityHeaders" : { |
| "type" : "object", |
| "title" : "AtlasEntityHeaders", |
| "properties" : { |
| "guidHeaderMap" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "object", |
| "additionalProperties" : { |
| "$ref" : "#/definitions/AtlasEntityHeader" |
| } |
| } |
| }, |
| "example" : { |
| "guidHeaderMap" : { |
| "property1" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "PROPOSED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "VALIDATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "property2" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "PROPOSED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "VALIDATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } |
| } |
| }, |
| "description" : "" |
| } |
| , |
| "AtlasEntityWithExtInfo" : { |
| "type" : "object", |
| "title" : "AtlasEntityWithExtInfo", |
| "allOf" : [ |
| { |
| "$ref" : "#/definitions/AtlasEntityExtInfo" |
| }, |
| { |
| "properties" : { |
| "entity" : { |
| "readOnly" : false, |
| "$ref" : "#/definitions/AtlasEntity", |
| "description" : "" |
| } |
| } |
| } |
| ], |
| "example" : { |
| "entity" : { |
| "businessAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "customAttributes" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "guid" : "...", |
| "homeId" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "pendingTasks" : [ "...", "..." ], |
| "provenanceType" : 12345, |
| "proxy" : true, |
| "relationshipAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "status" : "PURGED", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "referredEntities" : { |
| "property1" : { |
| "businessAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "customAttributes" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "guid" : "...", |
| "homeId" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "PROPOSED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "pendingTasks" : [ "...", "..." ], |
| "provenanceType" : 12345, |
| "proxy" : true, |
| "relationshipAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "status" : "PURGED", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "property2" : { |
| "businessAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "customAttributes" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "guid" : "...", |
| "homeId" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DISCOVERED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "IMPORTED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "pendingTasks" : [ "...", "..." ], |
| "provenanceType" : 12345, |
| "proxy" : true, |
| "relationshipAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "status" : "DELETED", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } |
| } |
| }, |
| "description" : "An instance of an entity along with extended info - like hive_table, hive_database." |
| } |
| , |
| "AtlasEnumDef" : { |
| "type" : "object", |
| "title" : "AtlasEnumDef", |
| "allOf" : [ |
| { |
| "$ref" : "#/definitions/AtlasBaseTypeDef" |
| }, |
| { |
| "properties" : { |
| "defaultValue" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| }, |
| "elementDefs" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "array", |
| "items" : { |
| "$ref" : "#/definitions/AtlasEnumElementDef" |
| } |
| } |
| } |
| } |
| ], |
| "example" : { |
| "defaultValue" : "...", |
| "elementDefs" : [ { |
| "description" : "...", |
| "ordinal" : 12345, |
| "value" : "..." |
| }, { |
| "description" : "...", |
| "ordinal" : 12345, |
| "value" : "..." |
| } ], |
| "category" : "OBJECT_ID_TYPE", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { |
| "availableLocales" : [ "...", "..." ], |
| "currency" : "...", |
| "currencyInstance" : { }, |
| "groupingUsed" : true, |
| "instance" : { }, |
| "integerInstance" : { }, |
| "maximumFractionDigits" : 12345, |
| "maximumIntegerDigits" : 12345, |
| "minimumFractionDigits" : 12345, |
| "minimumIntegerDigits" : 12345, |
| "numberInstance" : { }, |
| "parseIntegerOnly" : true, |
| "percentInstance" : { }, |
| "roundingMode" : "UP" |
| }, |
| "timeInstance" : { }, |
| "timeZone" : { |
| "DSTSavings" : 12345, |
| "ID" : "...", |
| "availableIDs" : [ "...", "..." ], |
| "default" : { }, |
| "displayName" : "...", |
| "rawOffset" : 12345 |
| } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| }, |
| "description" : "class that captures details of an enum-type." |
| } |
| , |
| "AtlasEnumElementDef" : { |
| "type" : "object", |
| "title" : "AtlasEnumElementDef", |
| "properties" : { |
| "description" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| }, |
| "ordinal" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "integer", |
| "format" : "int32" |
| }, |
| "value" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| } |
| }, |
| "example" : { |
| "description" : "...", |
| "ordinal" : 12345, |
| "value" : "..." |
| }, |
| "description" : "class that captures details of an enum-element." |
| } |
| , |
| "AtlasFullTextResult" : { |
| "type" : "object", |
| "title" : "AtlasFullTextResult", |
| "properties" : { |
| "entity" : { |
| "readOnly" : false, |
| "$ref" : "#/definitions/AtlasEntityHeader", |
| "description" : "" |
| }, |
| "score" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "number" |
| } |
| }, |
| "example" : { |
| "entity" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "IMPORTED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "score" : 12345.0 |
| }, |
| "description" : "" |
| } |
| , |
| "AtlasGlossary" : { |
| "type" : "object", |
| "title" : "AtlasGlossary", |
| "allOf" : [ |
| { |
| "$ref" : "#/definitions/AtlasGlossaryBaseObject" |
| }, |
| { |
| "properties" : { |
| "categories" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "array", |
| "items" : { |
| "$ref" : "#/definitions/AtlasRelatedCategoryHeader" |
| } |
| }, |
| "language" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| }, |
| "terms" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "array", |
| "items" : { |
| "$ref" : "#/definitions/AtlasRelatedTermHeader" |
| } |
| }, |
| "usage" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| } |
| } |
| } |
| ], |
| "example" : { |
| "categories" : [ { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "parentCategoryGuid" : "...", |
| "relationGuid" : "..." |
| }, { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "parentCategoryGuid" : "...", |
| "relationGuid" : "..." |
| } ], |
| "language" : "...", |
| "terms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "usage" : "...", |
| "additionalAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "longDescription" : "...", |
| "name" : "...", |
| "qualifiedName" : "...", |
| "shortDescription" : "...", |
| "guid" : "..." |
| }, |
| "description" : "" |
| } |
| , |
| "AtlasGlossaryBaseObject" : { |
| "type" : "object", |
| "title" : "AtlasGlossaryBaseObject", |
| "allOf" : [ |
| { |
| "$ref" : "#/definitions/AtlasBaseModelObject" |
| }, |
| { |
| "properties" : { |
| "additionalAttributes" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "object", |
| "additionalProperties" : { |
| "type" : "object" |
| } |
| }, |
| "classifications" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "array", |
| "items" : { |
| "$ref" : "#/definitions/AtlasClassification" |
| } |
| }, |
| "longDescription" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| }, |
| "name" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| }, |
| "qualifiedName" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| }, |
| "shortDescription" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| } |
| } |
| } |
| ], |
| "example" : { |
| "additionalAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "longDescription" : "...", |
| "name" : "...", |
| "qualifiedName" : "...", |
| "shortDescription" : "...", |
| "guid" : "..." |
| }, |
| "description" : "" |
| } |
| , |
| "AtlasGlossaryCategory" : { |
| "type" : "object", |
| "title" : "AtlasGlossaryCategory", |
| "allOf" : [ |
| { |
| "$ref" : "#/definitions/AtlasGlossaryBaseObject" |
| }, |
| { |
| "properties" : { |
| "anchor" : { |
| "readOnly" : false, |
| "$ref" : "#/definitions/AtlasGlossaryHeader", |
| "description" : "" |
| }, |
| "childrenCategories" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "array", |
| "items" : { |
| "$ref" : "#/definitions/AtlasRelatedCategoryHeader" |
| } |
| }, |
| "parentCategory" : { |
| "readOnly" : false, |
| "$ref" : "#/definitions/AtlasRelatedCategoryHeader", |
| "description" : "" |
| }, |
| "terms" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "array", |
| "items" : { |
| "$ref" : "#/definitions/AtlasRelatedTermHeader" |
| } |
| } |
| } |
| } |
| ], |
| "example" : { |
| "anchor" : { |
| "displayText" : "...", |
| "glossaryGuid" : "...", |
| "relationGuid" : "..." |
| }, |
| "childrenCategories" : [ { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "parentCategoryGuid" : "...", |
| "relationGuid" : "..." |
| }, { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "parentCategoryGuid" : "...", |
| "relationGuid" : "..." |
| } ], |
| "parentCategory" : { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "parentCategoryGuid" : "...", |
| "relationGuid" : "..." |
| }, |
| "terms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "additionalAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "longDescription" : "...", |
| "name" : "...", |
| "qualifiedName" : "...", |
| "shortDescription" : "...", |
| "guid" : "..." |
| }, |
| "description" : "" |
| } |
| , |
| "AtlasGlossaryExtInfo" : { |
| "type" : "object", |
| "title" : "AtlasGlossaryExtInfo", |
| "allOf" : [ |
| { |
| "$ref" : "#/definitions/AtlasGlossary" |
| }, |
| { |
| "properties" : { |
| "categoryInfo" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "object", |
| "additionalProperties" : { |
| "$ref" : "#/definitions/AtlasGlossaryCategory" |
| } |
| }, |
| "termInfo" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "object", |
| "additionalProperties" : { |
| "$ref" : "#/definitions/AtlasGlossaryTerm" |
| } |
| } |
| } |
| } |
| ], |
| "example" : { |
| "categoryInfo" : { |
| "property1" : { |
| "anchor" : { |
| "displayText" : "...", |
| "glossaryGuid" : "...", |
| "relationGuid" : "..." |
| }, |
| "childrenCategories" : [ { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "parentCategoryGuid" : "...", |
| "relationGuid" : "..." |
| }, { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "parentCategoryGuid" : "...", |
| "relationGuid" : "..." |
| } ], |
| "parentCategory" : { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "parentCategoryGuid" : "...", |
| "relationGuid" : "..." |
| }, |
| "terms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "additionalAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "longDescription" : "...", |
| "name" : "...", |
| "qualifiedName" : "...", |
| "shortDescription" : "...", |
| "guid" : "..." |
| }, |
| "property2" : { |
| "anchor" : { |
| "displayText" : "...", |
| "glossaryGuid" : "...", |
| "relationGuid" : "..." |
| }, |
| "childrenCategories" : [ { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "parentCategoryGuid" : "...", |
| "relationGuid" : "..." |
| }, { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "parentCategoryGuid" : "...", |
| "relationGuid" : "..." |
| } ], |
| "parentCategory" : { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "parentCategoryGuid" : "...", |
| "relationGuid" : "..." |
| }, |
| "terms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "additionalAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "longDescription" : "...", |
| "name" : "...", |
| "qualifiedName" : "...", |
| "shortDescription" : "...", |
| "guid" : "..." |
| } |
| }, |
| "termInfo" : { |
| "property1" : { |
| "abbreviation" : "...", |
| "anchor" : { |
| "displayText" : "...", |
| "glossaryGuid" : "...", |
| "relationGuid" : "..." |
| }, |
| "antonyms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "assignedEntities" : [ { |
| "displayText" : "...", |
| "entityStatus" : "PURGED", |
| "qualifiedName" : "...", |
| "relationshipAttributes" : { }, |
| "relationshipGuid" : "...", |
| "relationshipStatus" : "DELETED", |
| "relationshipType" : "...", |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, { |
| "displayText" : "...", |
| "entityStatus" : "PURGED", |
| "qualifiedName" : "...", |
| "relationshipAttributes" : { }, |
| "relationshipGuid" : "...", |
| "relationshipStatus" : "DELETED", |
| "relationshipType" : "...", |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| } ], |
| "categories" : [ { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "relationGuid" : "...", |
| "status" : "OBSOLETE" |
| }, { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "relationGuid" : "...", |
| "status" : "DEPRECATED" |
| } ], |
| "classifies" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "examples" : [ "...", "..." ], |
| "glossaryTermHeader" : { |
| "qualifiedName" : "...", |
| "termGuid" : "..." |
| }, |
| "isA" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "preferredTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "preferredToTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "replacedBy" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "replacementTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "seeAlso" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "synonyms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "translatedTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "translationTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "usage" : "...", |
| "validValues" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "validValuesFor" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "additionalAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "longDescription" : "...", |
| "name" : "...", |
| "qualifiedName" : "...", |
| "shortDescription" : "...", |
| "guid" : "..." |
| }, |
| "property2" : { |
| "abbreviation" : "...", |
| "anchor" : { |
| "displayText" : "...", |
| "glossaryGuid" : "...", |
| "relationGuid" : "..." |
| }, |
| "antonyms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "assignedEntities" : [ { |
| "displayText" : "...", |
| "entityStatus" : "PURGED", |
| "qualifiedName" : "...", |
| "relationshipAttributes" : { }, |
| "relationshipGuid" : "...", |
| "relationshipStatus" : "ACTIVE", |
| "relationshipType" : "...", |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, { |
| "displayText" : "...", |
| "entityStatus" : "ACTIVE", |
| "qualifiedName" : "...", |
| "relationshipAttributes" : { }, |
| "relationshipGuid" : "...", |
| "relationshipStatus" : "ACTIVE", |
| "relationshipType" : "...", |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| } ], |
| "categories" : [ { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "relationGuid" : "...", |
| "status" : "OBSOLETE" |
| }, { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "relationGuid" : "...", |
| "status" : "ACTIVE" |
| } ], |
| "classifies" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "examples" : [ "...", "..." ], |
| "glossaryTermHeader" : { |
| "qualifiedName" : "...", |
| "termGuid" : "..." |
| }, |
| "isA" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "preferredTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "preferredToTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "replacedBy" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "replacementTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "seeAlso" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "synonyms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "translatedTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "translationTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "usage" : "...", |
| "validValues" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "validValuesFor" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "additionalAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "longDescription" : "...", |
| "name" : "...", |
| "qualifiedName" : "...", |
| "shortDescription" : "...", |
| "guid" : "..." |
| } |
| }, |
| "categories" : [ { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "parentCategoryGuid" : "...", |
| "relationGuid" : "..." |
| }, { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "parentCategoryGuid" : "...", |
| "relationGuid" : "..." |
| } ], |
| "language" : "...", |
| "terms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "usage" : "...", |
| "additionalAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "longDescription" : "...", |
| "name" : "...", |
| "qualifiedName" : "...", |
| "shortDescription" : "...", |
| "guid" : "..." |
| }, |
| "description" : "" |
| } |
| , |
| "AtlasGlossaryHeader" : { |
| "type" : "object", |
| "title" : "AtlasGlossaryHeader", |
| "properties" : { |
| "displayText" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| }, |
| "glossaryGuid" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| }, |
| "relationGuid" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| } |
| }, |
| "example" : { |
| "displayText" : "...", |
| "glossaryGuid" : "...", |
| "relationGuid" : "..." |
| }, |
| "description" : "" |
| } |
| , |
| "AtlasGlossaryTerm" : { |
| "type" : "object", |
| "title" : "AtlasGlossaryTerm", |
| "allOf" : [ |
| { |
| "$ref" : "#/definitions/AtlasGlossaryBaseObject" |
| }, |
| { |
| "properties" : { |
| "abbreviation" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| }, |
| "anchor" : { |
| "readOnly" : false, |
| "$ref" : "#/definitions/AtlasGlossaryHeader", |
| "description" : "" |
| }, |
| "antonyms" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "array", |
| "items" : { |
| "$ref" : "#/definitions/AtlasRelatedTermHeader" |
| } |
| }, |
| "assignedEntities" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "array", |
| "items" : { |
| "$ref" : "#/definitions/AtlasRelatedObjectId" |
| } |
| }, |
| "categories" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "array", |
| "items" : { |
| "$ref" : "#/definitions/AtlasTermCategorizationHeader" |
| } |
| }, |
| "classifies" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "array", |
| "items" : { |
| "$ref" : "#/definitions/AtlasRelatedTermHeader" |
| } |
| }, |
| "examples" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "array", |
| "items" : { |
| "type" : "string" |
| } |
| }, |
| "glossaryTermHeader" : { |
| "readOnly" : false, |
| "$ref" : "#/definitions/AtlasGlossaryTermHeader", |
| "description" : "" |
| }, |
| "isA" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "array", |
| "items" : { |
| "$ref" : "#/definitions/AtlasRelatedTermHeader" |
| } |
| }, |
| "preferredTerms" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "array", |
| "items" : { |
| "$ref" : "#/definitions/AtlasRelatedTermHeader" |
| } |
| }, |
| "preferredToTerms" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "array", |
| "items" : { |
| "$ref" : "#/definitions/AtlasRelatedTermHeader" |
| } |
| }, |
| "replacedBy" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "array", |
| "items" : { |
| "$ref" : "#/definitions/AtlasRelatedTermHeader" |
| } |
| }, |
| "replacementTerms" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "array", |
| "items" : { |
| "$ref" : "#/definitions/AtlasRelatedTermHeader" |
| } |
| }, |
| "seeAlso" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "array", |
| "items" : { |
| "$ref" : "#/definitions/AtlasRelatedTermHeader" |
| } |
| }, |
| "synonyms" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "array", |
| "items" : { |
| "$ref" : "#/definitions/AtlasRelatedTermHeader" |
| } |
| }, |
| "translatedTerms" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "array", |
| "items" : { |
| "$ref" : "#/definitions/AtlasRelatedTermHeader" |
| } |
| }, |
| "translationTerms" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "array", |
| "items" : { |
| "$ref" : "#/definitions/AtlasRelatedTermHeader" |
| } |
| }, |
| "usage" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| }, |
| "validValues" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "array", |
| "items" : { |
| "$ref" : "#/definitions/AtlasRelatedTermHeader" |
| } |
| }, |
| "validValuesFor" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "array", |
| "items" : { |
| "$ref" : "#/definitions/AtlasRelatedTermHeader" |
| } |
| } |
| } |
| } |
| ], |
| "example" : { |
| "abbreviation" : "...", |
| "anchor" : { |
| "displayText" : "...", |
| "glossaryGuid" : "...", |
| "relationGuid" : "..." |
| }, |
| "antonyms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "assignedEntities" : [ { |
| "displayText" : "...", |
| "entityStatus" : "DELETED", |
| "qualifiedName" : "...", |
| "relationshipAttributes" : { |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "relationshipGuid" : "...", |
| "relationshipStatus" : "ACTIVE", |
| "relationshipType" : "...", |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, { |
| "displayText" : "...", |
| "entityStatus" : "PURGED", |
| "qualifiedName" : "...", |
| "relationshipAttributes" : { |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "relationshipGuid" : "...", |
| "relationshipStatus" : "DELETED", |
| "relationshipType" : "...", |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| } ], |
| "categories" : [ { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "relationGuid" : "...", |
| "status" : "OBSOLETE" |
| }, { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "relationGuid" : "...", |
| "status" : "ACTIVE" |
| } ], |
| "classifies" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "examples" : [ "...", "..." ], |
| "glossaryTermHeader" : { |
| "qualifiedName" : "...", |
| "termGuid" : "..." |
| }, |
| "isA" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "preferredTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "preferredToTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "replacedBy" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "replacementTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "seeAlso" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "synonyms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "translatedTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "translationTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "usage" : "...", |
| "validValues" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "validValuesFor" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "additionalAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "longDescription" : "...", |
| "name" : "...", |
| "qualifiedName" : "...", |
| "shortDescription" : "...", |
| "guid" : "..." |
| }, |
| "description" : "" |
| } |
| , |
| "AtlasGlossaryTermHeader" : { |
| "type" : "object", |
| "title" : "AtlasGlossaryTermHeader", |
| "properties" : { |
| "qualifiedName" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| }, |
| "termGuid" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| } |
| }, |
| "example" : { |
| "qualifiedName" : "...", |
| "termGuid" : "..." |
| }, |
| "description" : "" |
| } |
| , |
| "AtlasLineageInfo" : { |
| "type" : "object", |
| "title" : "AtlasLineageInfo", |
| "required" : ["lineageDepth"], |
| "properties" : { |
| "baseEntityGuid" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| }, |
| "guidEntityMap" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "object", |
| "additionalProperties" : { |
| "$ref" : "#/definitions/AtlasEntityHeader" |
| } |
| }, |
| "lineageDepth" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "integer", |
| "format" : "int32" |
| }, |
| "lineageDirection" : { |
| "readOnly" : false, |
| "$ref" : "#/definitions/LineageDirection", |
| "description" : "" |
| }, |
| "lineageOnDemandPayload" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "object", |
| "additionalProperties" : { |
| "$ref" : "#/definitions/LineageOnDemandConstraints" |
| } |
| }, |
| "relations" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "array", |
| "items" : { |
| "$ref" : "#/definitions/LineageRelation" |
| } |
| }, |
| "relationsOnDemand" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "object", |
| "additionalProperties" : { |
| "$ref" : "#/definitions/LineageInfoOnDemand" |
| } |
| } |
| }, |
| "example" : { |
| "baseEntityGuid" : "...", |
| "guidEntityMap" : { |
| "property1" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "VALIDATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "property2" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DISCOVERED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DISCOVERED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } |
| }, |
| "lineageDepth" : 12345, |
| "lineageDirection" : "BOTH", |
| "lineageOnDemandPayload" : { |
| "property1" : { |
| "depth" : 12345, |
| "direction" : "OUTPUT", |
| "inputRelationsLimit" : 12345, |
| "outputRelationsLimit" : 12345 |
| }, |
| "property2" : { |
| "depth" : 12345, |
| "direction" : "INPUT", |
| "inputRelationsLimit" : 12345, |
| "outputRelationsLimit" : 12345 |
| } |
| }, |
| "relations" : [ { |
| "fromEntityId" : "...", |
| "relationshipId" : "...", |
| "toEntityId" : "..." |
| }, { |
| "fromEntityId" : "...", |
| "relationshipId" : "...", |
| "toEntityId" : "..." |
| } ], |
| "relationsOnDemand" : { |
| "property1" : { |
| "hasMoreInputs" : true, |
| "hasMoreOutputs" : true, |
| "inputRelationsCount" : 12345, |
| "outputRelationsCount" : 12345 |
| }, |
| "property2" : { |
| "hasMoreInputs" : true, |
| "hasMoreOutputs" : true, |
| "inputRelationsCount" : 12345, |
| "outputRelationsCount" : 12345 |
| } |
| } |
| }, |
| "description" : "" |
| } |
| , |
| "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." |
| } |
| , |
| "AtlasQueryType" : { |
| "type" : "string", |
| "title" : "AtlasQueryType", |
| "enum" : [ |
| "DSL", |
| "FULL_TEXT", |
| "GREMLIN", |
| "BASIC", |
| "ATTRIBUTE", |
| "RELATIONSHIP" |
| ], |
| "description" : "" |
| } |
| , |
| "AtlasQuickSearchResult" : { |
| "type" : "object", |
| "title" : "AtlasQuickSearchResult", |
| "properties" : { |
| "aggregationMetrics" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "object", |
| "additionalProperties" : { |
| "type" : "array", |
| "items" : { |
| "$ref" : "#/definitions/AtlasAggregationEntry" |
| } |
| } |
| }, |
| "searchResults" : { |
| "readOnly" : false, |
| "$ref" : "#/definitions/AtlasSearchResult", |
| "description" : "" |
| } |
| }, |
| "example" : { |
| "aggregationMetrics" : { |
| "property1" : [ { |
| "count" : 12345, |
| "name" : "..." |
| }, { |
| "count" : 12345, |
| "name" : "..." |
| } ], |
| "property2" : [ { |
| "count" : 12345, |
| "name" : "..." |
| }, { |
| "count" : 12345, |
| "name" : "..." |
| } ] |
| }, |
| "searchResults" : { |
| "approximateCount" : 12345, |
| "attributes" : { |
| "name" : [ "...", "..." ], |
| "values" : [ [ { }, { } ], [ { }, { } ] ] |
| }, |
| "classification" : "...", |
| "entities" : [ { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { }, { } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { }, { } ], |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { }, { } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { }, { } ], |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "fullTextResult" : [ { |
| "entity" : { }, |
| "score" : 12345.0 |
| }, { |
| "entity" : { }, |
| "score" : 12345.0 |
| } ], |
| "nextMarker" : "...", |
| "queryText" : "...", |
| "queryType" : "ATTRIBUTE", |
| "referredEntities" : { |
| "property1" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { }, { } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { }, { } ], |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "property2" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { }, { } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { }, { } ], |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } |
| }, |
| "relations" : [ { |
| "end1" : { }, |
| "end2" : { }, |
| "guid" : "...", |
| "label" : "...", |
| "propagateTags" : "TWO_TO_ONE", |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "end1" : { }, |
| "end2" : { }, |
| "guid" : "...", |
| "label" : "...", |
| "propagateTags" : "NONE", |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "searchParameters" : { |
| "attributes" : [ "...", "..." ], |
| "classification" : "...", |
| "entityFilters" : { }, |
| "excludeDeletedEntities" : true, |
| "excludeHeaderAttributes" : true, |
| "includeClassificationAttributes" : true, |
| "includeSubClassifications" : true, |
| "includeSubTypes" : true, |
| "limit" : 12345, |
| "marker" : "...", |
| "offset" : 12345, |
| "query" : "...", |
| "relationshipFilters" : { }, |
| "relationshipName" : "...", |
| "sortBy" : "...", |
| "sortOrder" : "DESCENDING", |
| "tagFilters" : { }, |
| "termName" : "...", |
| "typeName" : "..." |
| }, |
| "type" : "..." |
| } |
| }, |
| "description" : "" |
| } |
| , |
| "AtlasRelatedCategoryHeader" : { |
| "type" : "object", |
| "title" : "AtlasRelatedCategoryHeader", |
| "properties" : { |
| "categoryGuid" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| }, |
| "description" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| }, |
| "displayText" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| }, |
| "parentCategoryGuid" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| }, |
| "relationGuid" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| } |
| }, |
| "example" : { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "parentCategoryGuid" : "...", |
| "relationGuid" : "..." |
| }, |
| "description" : "" |
| } |
| , |
| "AtlasRelatedObjectId" : { |
| "type" : "object", |
| "title" : "AtlasRelatedObjectId", |
| "allOf" : [ |
| { |
| "$ref" : "#/definitions/AtlasObjectId" |
| }, |
| { |
| "properties" : { |
| "displayText" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| }, |
| "entityStatus" : { |
| "readOnly" : false, |
| "$ref" : "#/definitions/Status", |
| "description" : "" |
| }, |
| "qualifiedName" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| }, |
| "relationshipAttributes" : { |
| "readOnly" : false, |
| "$ref" : "#/definitions/AtlasStruct", |
| "description" : "" |
| }, |
| "relationshipGuid" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| }, |
| "relationshipStatus" : { |
| "readOnly" : false, |
| "$ref" : "#/definitions/Status_AtlasRelationship", |
| "description" : "" |
| }, |
| "relationshipType" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| } |
| } |
| } |
| ], |
| "example" : { |
| "displayText" : "...", |
| "entityStatus" : "ACTIVE", |
| "qualifiedName" : "...", |
| "relationshipAttributes" : { |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "relationshipGuid" : "...", |
| "relationshipStatus" : "DELETED", |
| "relationshipType" : "...", |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "description" : "Reference to an object-instance of AtlasEntity type used in relationship attribute values" |
| } |
| , |
| "AtlasRelatedTermHeader" : { |
| "type" : "object", |
| "title" : "AtlasRelatedTermHeader", |
| "properties" : { |
| "description" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| }, |
| "displayText" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| }, |
| "expression" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| }, |
| "qualifiedName" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| }, |
| "relationGuid" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| }, |
| "source" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| }, |
| "status" : { |
| "readOnly" : false, |
| "$ref" : "#/definitions/AtlasTermRelationshipStatus", |
| "description" : "" |
| }, |
| "steward" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| }, |
| "termGuid" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| } |
| }, |
| "example" : { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, |
| "description" : "" |
| } |
| , |
| "AtlasRelationship" : { |
| "type" : "object", |
| "title" : "AtlasRelationship", |
| "allOf" : [ |
| { |
| "$ref" : "#/definitions/AtlasStruct" |
| }, |
| { |
| "properties" : { |
| "blockedPropagatedClassifications" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "array", |
| "items" : { |
| "$ref" : "#/definitions/AtlasClassification" |
| } |
| }, |
| "createTime" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "integer", |
| "format" : "int32" |
| }, |
| "createdBy" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| }, |
| "end1" : { |
| "readOnly" : false, |
| "$ref" : "#/definitions/AtlasObjectId", |
| "description" : "" |
| }, |
| "end2" : { |
| "readOnly" : false, |
| "$ref" : "#/definitions/AtlasObjectId", |
| "description" : "" |
| }, |
| "guid" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| }, |
| "homeId" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| }, |
| "label" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| }, |
| "propagateTags" : { |
| "readOnly" : false, |
| "$ref" : "#/definitions/PropagateTags", |
| "description" : "" |
| }, |
| "propagatedClassifications" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "array", |
| "items" : { |
| "$ref" : "#/definitions/AtlasClassification" |
| } |
| }, |
| "provenanceType" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "integer", |
| "format" : "int32" |
| }, |
| "status" : { |
| "readOnly" : false, |
| "$ref" : "#/definitions/Status_AtlasRelationship", |
| "description" : "" |
| }, |
| "updateTime" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "integer", |
| "format" : "int32" |
| }, |
| "updatedBy" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| }, |
| "version" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "integer", |
| "format" : "int64" |
| } |
| } |
| } |
| ], |
| "example" : { |
| "blockedPropagatedClassifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "end1" : { |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "end2" : { |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "guid" : "...", |
| "homeId" : "...", |
| "label" : "...", |
| "propagateTags" : "ONE_TO_TWO", |
| "propagatedClassifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "provenanceType" : 12345, |
| "status" : "DELETED", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "description" : "Atlas relationship instance." |
| } |
| , |
| "AtlasRelationshipAttributeDef" : { |
| "type" : "object", |
| "title" : "AtlasRelationshipAttributeDef", |
| "required" : ["isLegacyAttribute"], |
| "allOf" : [ |
| { |
| "$ref" : "#/definitions/AtlasAttributeDef" |
| }, |
| { |
| "properties" : { |
| "isLegacyAttribute" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "boolean" |
| }, |
| "relationshipTypeName" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| } |
| } |
| } |
| ], |
| "example" : { |
| "isLegacyAttribute" : true, |
| "relationshipTypeName" : "...", |
| "cardinality" : "SINGLE", |
| "constraints" : [ { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| }, { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, |
| "description" : "class that captures details of a struct-attribute." |
| } |
| , |
| "AtlasRelationshipDef" : { |
| "type" : "object", |
| "title" : "AtlasRelationshipDef", |
| "allOf" : [ |
| { |
| "$ref" : "#/definitions/AtlasStructDef" |
| }, |
| { |
| "properties" : { |
| "endDef1" : { |
| "readOnly" : false, |
| "$ref" : "#/definitions/AtlasRelationshipEndDef", |
| "description" : "" |
| }, |
| "endDef2" : { |
| "readOnly" : false, |
| "$ref" : "#/definitions/AtlasRelationshipEndDef", |
| "description" : "" |
| }, |
| "propagateTags" : { |
| "readOnly" : false, |
| "$ref" : "#/definitions/PropagateTags", |
| "description" : "" |
| }, |
| "relationshipCategory" : { |
| "readOnly" : false, |
| "$ref" : "#/definitions/RelationshipCategory", |
| "description" : "" |
| }, |
| "relationshipLabel" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| } |
| } |
| } |
| ], |
| "example" : { |
| "endDef1" : { |
| "cardinality" : "SET", |
| "description" : "...", |
| "isContainer" : true, |
| "isLegacyAttribute" : true, |
| "name" : "...", |
| "type" : "..." |
| }, |
| "endDef2" : { |
| "cardinality" : "LIST", |
| "description" : "...", |
| "isContainer" : true, |
| "isLegacyAttribute" : true, |
| "name" : "...", |
| "type" : "..." |
| }, |
| "propagateTags" : "TWO_TO_ONE", |
| "relationshipCategory" : "COMPOSITION", |
| "relationshipLabel" : "...", |
| "attributeDefs" : [ { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| }, { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SET", |
| "constraints" : [ { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| }, { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "ARRAY", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { |
| "availableLocales" : [ "...", "..." ], |
| "currency" : "...", |
| "currencyInstance" : { }, |
| "groupingUsed" : true, |
| "instance" : { }, |
| "integerInstance" : { }, |
| "maximumFractionDigits" : 12345, |
| "maximumIntegerDigits" : 12345, |
| "minimumFractionDigits" : 12345, |
| "minimumIntegerDigits" : 12345, |
| "numberInstance" : { }, |
| "parseIntegerOnly" : true, |
| "percentInstance" : { }, |
| "roundingMode" : "UNNECESSARY" |
| }, |
| "timeInstance" : { }, |
| "timeZone" : { |
| "DSTSavings" : 12345, |
| "ID" : "...", |
| "availableIDs" : [ "...", "..." ], |
| "default" : { }, |
| "displayName" : "...", |
| "rawOffset" : 12345 |
| } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| }, |
| "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 attributes to the entity instances. For example\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" |
| } |
| , |
| "AtlasRelationshipEndDef" : { |
| "type" : "object", |
| "title" : "AtlasRelationshipEndDef", |
| "required" : ["isContainer", "isLegacyAttribute"], |
| "properties" : { |
| "cardinality" : { |
| "readOnly" : false, |
| "$ref" : "#/definitions/Cardinality", |
| "description" : "the cardinality" |
| }, |
| "description" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| }, |
| "isContainer" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "boolean" |
| }, |
| "isLegacyAttribute" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "boolean" |
| }, |
| "name" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| }, |
| "type" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| } |
| }, |
| "example" : { |
| "cardinality" : "SET", |
| "description" : "...", |
| "isContainer" : true, |
| "isLegacyAttribute" : true, |
| "name" : "...", |
| "type" : "..." |
| }, |
| "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." |
| } |
| , |
| "AtlasRelationshipHeader" : { |
| "type" : "object", |
| "title" : "AtlasRelationshipHeader", |
| "allOf" : [ |
| { |
| "$ref" : "#/definitions/AtlasStruct" |
| }, |
| { |
| "properties" : { |
| "end1" : { |
| "readOnly" : false, |
| "$ref" : "#/definitions/AtlasObjectId", |
| "description" : "" |
| }, |
| "end2" : { |
| "readOnly" : false, |
| "$ref" : "#/definitions/AtlasObjectId", |
| "description" : "" |
| }, |
| "guid" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| }, |
| "label" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| }, |
| "propagateTags" : { |
| "readOnly" : false, |
| "$ref" : "#/definitions/PropagateTags", |
| "description" : "" |
| }, |
| "status" : { |
| "readOnly" : false, |
| "$ref" : "#/definitions/Status", |
| "description" : "" |
| } |
| } |
| } |
| ], |
| "example" : { |
| "end1" : { |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "end2" : { |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "guid" : "...", |
| "label" : "...", |
| "propagateTags" : "ONE_TO_TWO", |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "description" : "Captures details of struct contents. Not instantiated directly, used only via AtlasEntity, AtlasClassification." |
| } |
| , |
| "AtlasRelationshipWithExtInfo" : { |
| "type" : "object", |
| "title" : "AtlasRelationshipWithExtInfo", |
| "properties" : { |
| "referredEntities" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "object", |
| "additionalProperties" : { |
| "$ref" : "#/definitions/AtlasEntityHeader" |
| } |
| }, |
| "relationship" : { |
| "readOnly" : false, |
| "$ref" : "#/definitions/AtlasRelationship", |
| "description" : "" |
| } |
| }, |
| "example" : { |
| "referredEntities" : { |
| "property1" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DISCOVERED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "PROPOSED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "property2" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "VALIDATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } |
| }, |
| "relationship" : { |
| "blockedPropagatedClassifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "end1" : { |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "end2" : { |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "guid" : "...", |
| "homeId" : "...", |
| "label" : "...", |
| "propagateTags" : "TWO_TO_ONE", |
| "propagatedClassifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "provenanceType" : 12345, |
| "status" : "ACTIVE", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } |
| }, |
| "description" : "" |
| } |
| , |
| "AtlasSearchResult" : { |
| "type" : "object", |
| "title" : "AtlasSearchResult", |
| "required" : ["approximateCount"], |
| "properties" : { |
| "approximateCount" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "integer", |
| "format" : "int64" |
| }, |
| "attributes" : { |
| "readOnly" : false, |
| "$ref" : "#/definitions/AttributeSearchResult", |
| "description" : "" |
| }, |
| "classification" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| }, |
| "entities" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "array", |
| "items" : { |
| "$ref" : "#/definitions/AtlasEntityHeader" |
| } |
| }, |
| "fullTextResult" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "array", |
| "items" : { |
| "$ref" : "#/definitions/AtlasFullTextResult" |
| } |
| }, |
| "nextMarker" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| }, |
| "queryText" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| }, |
| "queryType" : { |
| "readOnly" : false, |
| "$ref" : "#/definitions/AtlasQueryType", |
| "description" : "" |
| }, |
| "referredEntities" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "object", |
| "additionalProperties" : { |
| "$ref" : "#/definitions/AtlasEntityHeader" |
| } |
| }, |
| "relations" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "array", |
| "items" : { |
| "$ref" : "#/definitions/AtlasRelationshipHeader" |
| } |
| }, |
| "searchParameters" : { |
| "readOnly" : false, |
| "$ref" : "#/definitions/SearchParameters", |
| "description" : "" |
| }, |
| "type" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| } |
| }, |
| "example" : { |
| "approximateCount" : 12345, |
| "attributes" : { |
| "name" : [ "...", "..." ], |
| "values" : [ [ { }, { } ], [ { }, { } ] ] |
| }, |
| "classification" : "...", |
| "entities" : [ { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "PROPOSED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "fullTextResult" : [ { |
| "entity" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { }, { } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { }, { } ], |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "score" : 12345.0 |
| }, { |
| "entity" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { }, { } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { }, { } ], |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "score" : 12345.0 |
| } ], |
| "nextMarker" : "...", |
| "queryText" : "...", |
| "queryType" : "FULL_TEXT", |
| "referredEntities" : { |
| "property1" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "IMPORTED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "property2" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "PROPOSED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "IMPORTED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } |
| }, |
| "relations" : [ { |
| "end1" : { |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "end2" : { |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "guid" : "...", |
| "label" : "...", |
| "propagateTags" : "NONE", |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "end1" : { |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "end2" : { |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "guid" : "...", |
| "label" : "...", |
| "propagateTags" : "TWO_TO_ONE", |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "searchParameters" : { |
| "attributes" : [ "...", "..." ], |
| "classification" : "...", |
| "entityFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "OR", |
| "criterion" : [ { }, { } ], |
| "operator" : "CONTAINS_ANY" |
| }, |
| "excludeDeletedEntities" : true, |
| "excludeHeaderAttributes" : true, |
| "includeClassificationAttributes" : true, |
| "includeSubClassifications" : true, |
| "includeSubTypes" : true, |
| "limit" : 12345, |
| "marker" : "...", |
| "offset" : 12345, |
| "query" : "...", |
| "relationshipFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "OR", |
| "criterion" : [ { }, { } ], |
| "operator" : "GT" |
| }, |
| "relationshipName" : "...", |
| "sortBy" : "...", |
| "sortOrder" : "DESCENDING", |
| "tagFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "OR", |
| "criterion" : [ { }, { } ], |
| "operator" : "CONTAINS" |
| }, |
| "termName" : "...", |
| "typeName" : "..." |
| }, |
| "type" : "..." |
| }, |
| "description" : "" |
| } |
| , |
| "AtlasStruct" : { |
| "type" : "object", |
| "title" : "AtlasStruct", |
| "properties" : { |
| "attributes" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "object", |
| "additionalProperties" : { |
| "type" : "object" |
| } |
| }, |
| "typeName" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| } |
| }, |
| "example" : { |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "description" : "Captures details of struct contents. Not instantiated directly, used only via AtlasEntity, AtlasClassification." |
| } |
| , |
| "AtlasStructDef" : { |
| "type" : "object", |
| "title" : "AtlasStructDef", |
| "allOf" : [ |
| { |
| "$ref" : "#/definitions/AtlasBaseTypeDef" |
| }, |
| { |
| "properties" : { |
| "attributeDefs" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "array", |
| "items" : { |
| "$ref" : "#/definitions/AtlasAttributeDef" |
| } |
| } |
| } |
| } |
| ], |
| "example" : { |
| "attributeDefs" : [ { |
| "cardinality" : "LIST", |
| "constraints" : [ { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| }, { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SET", |
| "constraints" : [ { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| }, { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "PRIMITIVE", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { |
| "availableLocales" : [ "...", "..." ], |
| "currency" : "...", |
| "currencyInstance" : { }, |
| "groupingUsed" : true, |
| "instance" : { }, |
| "integerInstance" : { }, |
| "maximumFractionDigits" : 12345, |
| "maximumIntegerDigits" : 12345, |
| "minimumFractionDigits" : 12345, |
| "minimumIntegerDigits" : 12345, |
| "numberInstance" : { }, |
| "parseIntegerOnly" : true, |
| "percentInstance" : { }, |
| "roundingMode" : "HALF_UP" |
| }, |
| "timeInstance" : { }, |
| "timeZone" : { |
| "DSTSavings" : 12345, |
| "ID" : "...", |
| "availableIDs" : [ "...", "..." ], |
| "default" : { }, |
| "displayName" : "...", |
| "rawOffset" : 12345 |
| } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| }, |
| "description" : "class that captures details of a struct-type." |
| } |
| , |
| "AtlasSuggestionsResult" : { |
| "type" : "object", |
| "title" : "AtlasSuggestionsResult", |
| "properties" : { |
| "fieldName" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| }, |
| "prefixString" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| }, |
| "suggestions" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "array", |
| "items" : { |
| "type" : "string" |
| } |
| } |
| }, |
| "example" : { |
| "fieldName" : "...", |
| "prefixString" : "...", |
| "suggestions" : [ "...", "..." ] |
| }, |
| "description" : "" |
| } |
| , |
| "AtlasTermAssignmentHeader" : { |
| "type" : "object", |
| "title" : "AtlasTermAssignmentHeader", |
| "required" : ["confidence"], |
| "properties" : { |
| "confidence" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "integer", |
| "format" : "int32" |
| }, |
| "createdBy" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| }, |
| "description" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| }, |
| "displayText" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| }, |
| "expression" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| }, |
| "qualifiedName" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| }, |
| "relationGuid" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| }, |
| "source" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| }, |
| "status" : { |
| "readOnly" : false, |
| "$ref" : "#/definitions/AtlasTermAssignmentStatus", |
| "description" : "" |
| }, |
| "steward" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| }, |
| "termGuid" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| } |
| }, |
| "example" : { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, |
| "description" : "" |
| } |
| , |
| "AtlasTermAssignmentStatus" : { |
| "type" : "string", |
| "title" : "AtlasTermAssignmentStatus", |
| "enum" : [ |
| "DISCOVERED", |
| "PROPOSED", |
| "IMPORTED", |
| "VALIDATED", |
| "DEPRECATED", |
| "OBSOLETE", |
| "OTHER" |
| ], |
| "description" : "" |
| } |
| , |
| "AtlasTermCategorizationHeader" : { |
| "type" : "object", |
| "title" : "AtlasTermCategorizationHeader", |
| "properties" : { |
| "categoryGuid" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| }, |
| "description" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| }, |
| "displayText" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| }, |
| "relationGuid" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| }, |
| "status" : { |
| "readOnly" : false, |
| "$ref" : "#/definitions/AtlasTermRelationshipStatus", |
| "description" : "" |
| } |
| }, |
| "example" : { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "relationGuid" : "...", |
| "status" : "ACTIVE" |
| }, |
| "description" : "" |
| } |
| , |
| "AtlasTermRelationshipStatus" : { |
| "type" : "string", |
| "title" : "AtlasTermRelationshipStatus", |
| "enum" : [ |
| "DRAFT", |
| "ACTIVE", |
| "DEPRECATED", |
| "OBSOLETE", |
| "OTHER" |
| ], |
| "description" : "" |
| } |
| , |
| "AtlasTypeDefHeader" : { |
| "type" : "object", |
| "title" : "AtlasTypeDefHeader", |
| "properties" : { |
| "category" : { |
| "readOnly" : false, |
| "$ref" : "#/definitions/TypeCategory", |
| "description" : "" |
| }, |
| "guid" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| }, |
| "name" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| }, |
| "serviceType" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| } |
| }, |
| "example" : { |
| "category" : "BUSINESS_METADATA", |
| "guid" : "...", |
| "name" : "...", |
| "serviceType" : "..." |
| }, |
| "description" : "" |
| } |
| , |
| "AtlasTypesDef" : { |
| "type" : "object", |
| "title" : "AtlasTypesDef", |
| "properties" : { |
| "businessMetadataDefs" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "array", |
| "items" : { |
| "$ref" : "#/definitions/AtlasBusinessMetadataDef" |
| } |
| }, |
| "classificationDefs" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "array", |
| "items" : { |
| "$ref" : "#/definitions/AtlasClassificationDef" |
| } |
| }, |
| "entityDefs" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "array", |
| "items" : { |
| "$ref" : "#/definitions/AtlasEntityDef" |
| } |
| }, |
| "enumDefs" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "array", |
| "items" : { |
| "$ref" : "#/definitions/AtlasEnumDef" |
| } |
| }, |
| "relationshipDefs" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "array", |
| "items" : { |
| "$ref" : "#/definitions/AtlasRelationshipDef" |
| } |
| }, |
| "structDefs" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "array", |
| "items" : { |
| "$ref" : "#/definitions/AtlasStructDef" |
| } |
| } |
| }, |
| "example" : { |
| "businessMetadataDefs" : [ { |
| "attributeDefs" : [ { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "RELATIONSHIP", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| }, { |
| "attributeDefs" : [ { |
| "cardinality" : "LIST", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "LIST", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "PRIMITIVE", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| } ], |
| "classificationDefs" : [ { |
| "entityTypes" : [ "...", "..." ], |
| "subTypes" : [ "...", "..." ], |
| "superTypes" : [ "...", "..." ], |
| "attributeDefs" : [ { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "ARRAY", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| }, { |
| "entityTypes" : [ "...", "..." ], |
| "subTypes" : [ "...", "..." ], |
| "superTypes" : [ "...", "..." ], |
| "attributeDefs" : [ { |
| "cardinality" : "LIST", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "LIST", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "STRUCT", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| } ], |
| "entityDefs" : [ { |
| "businessAttributeDefs" : { |
| "property1" : [ { |
| "cardinality" : "LIST", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "property2" : [ { |
| "cardinality" : "LIST", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ] |
| }, |
| "relationshipAttributeDefs" : [ { |
| "isLegacyAttribute" : true, |
| "relationshipTypeName" : "...", |
| "cardinality" : "SINGLE", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "isLegacyAttribute" : true, |
| "relationshipTypeName" : "...", |
| "cardinality" : "SINGLE", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "subTypes" : [ "...", "..." ], |
| "superTypes" : [ "...", "..." ], |
| "attributeDefs" : [ { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "ENUM", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| }, { |
| "businessAttributeDefs" : { |
| "property1" : [ { |
| "cardinality" : "LIST", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "property2" : [ { |
| "cardinality" : "LIST", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "LIST", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ] |
| }, |
| "relationshipAttributeDefs" : [ { |
| "isLegacyAttribute" : true, |
| "relationshipTypeName" : "...", |
| "cardinality" : "SINGLE", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "isLegacyAttribute" : true, |
| "relationshipTypeName" : "...", |
| "cardinality" : "LIST", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "subTypes" : [ "...", "..." ], |
| "superTypes" : [ "...", "..." ], |
| "attributeDefs" : [ { |
| "cardinality" : "LIST", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "ARRAY", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| } ], |
| "enumDefs" : [ { |
| "defaultValue" : "...", |
| "elementDefs" : [ { |
| "description" : "...", |
| "ordinal" : 12345, |
| "value" : "..." |
| }, { |
| "description" : "...", |
| "ordinal" : 12345, |
| "value" : "..." |
| } ], |
| "category" : "ENTITY", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| }, { |
| "defaultValue" : "...", |
| "elementDefs" : [ { |
| "description" : "...", |
| "ordinal" : 12345, |
| "value" : "..." |
| }, { |
| "description" : "...", |
| "ordinal" : 12345, |
| "value" : "..." |
| } ], |
| "category" : "STRUCT", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| } ], |
| "relationshipDefs" : [ { |
| "endDef1" : { |
| "cardinality" : "LIST", |
| "description" : "...", |
| "isContainer" : true, |
| "isLegacyAttribute" : true, |
| "name" : "...", |
| "type" : "..." |
| }, |
| "endDef2" : { |
| "cardinality" : "SET", |
| "description" : "...", |
| "isContainer" : true, |
| "isLegacyAttribute" : true, |
| "name" : "...", |
| "type" : "..." |
| }, |
| "propagateTags" : "NONE", |
| "relationshipCategory" : "AGGREGATION", |
| "relationshipLabel" : "...", |
| "attributeDefs" : [ { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "CLASSIFICATION", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| }, { |
| "endDef1" : { |
| "cardinality" : "SINGLE", |
| "description" : "...", |
| "isContainer" : true, |
| "isLegacyAttribute" : true, |
| "name" : "...", |
| "type" : "..." |
| }, |
| "endDef2" : { |
| "cardinality" : "SET", |
| "description" : "...", |
| "isContainer" : true, |
| "isLegacyAttribute" : true, |
| "name" : "...", |
| "type" : "..." |
| }, |
| "propagateTags" : "BOTH", |
| "relationshipCategory" : "AGGREGATION", |
| "relationshipLabel" : "...", |
| "attributeDefs" : [ { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "STRUCT", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| } ], |
| "structDefs" : [ { |
| "attributeDefs" : [ { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "ENUM", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| }, { |
| "attributeDefs" : [ { |
| "cardinality" : "LIST", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "ARRAY", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| } ] |
| }, |
| "description" : "" |
| } |
| , |
| "AtlasUserSavedSearch" : { |
| "type" : "object", |
| "title" : "AtlasUserSavedSearch", |
| "allOf" : [ |
| { |
| "$ref" : "#/definitions/AtlasBaseModelObject" |
| }, |
| { |
| "properties" : { |
| "name" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| }, |
| "ownerName" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| }, |
| "searchParameters" : { |
| "readOnly" : false, |
| "$ref" : "#/definitions/SearchParameters", |
| "description" : "" |
| }, |
| "searchType" : { |
| "readOnly" : false, |
| "$ref" : "#/definitions/SavedSearchType", |
| "description" : "" |
| }, |
| "uiParameters" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| } |
| } |
| } |
| ], |
| "example" : { |
| "name" : "...", |
| "ownerName" : "...", |
| "searchParameters" : { |
| "attributes" : [ "...", "..." ], |
| "classification" : "...", |
| "entityFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "AND", |
| "criterion" : [ { }, { } ], |
| "operator" : "IN" |
| }, |
| "excludeDeletedEntities" : true, |
| "excludeHeaderAttributes" : true, |
| "includeClassificationAttributes" : true, |
| "includeSubClassifications" : true, |
| "includeSubTypes" : true, |
| "limit" : 12345, |
| "marker" : "...", |
| "offset" : 12345, |
| "query" : "...", |
| "relationshipFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "OR", |
| "criterion" : [ { }, { } ], |
| "operator" : "CONTAINS" |
| }, |
| "relationshipName" : "...", |
| "sortBy" : "...", |
| "sortOrder" : "DESCENDING", |
| "tagFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "AND", |
| "criterion" : [ { }, { } ], |
| "operator" : "STARTS_WITH" |
| }, |
| "termName" : "...", |
| "typeName" : "..." |
| }, |
| "searchType" : "BASIC_RELATIONSHIP", |
| "uiParameters" : "...", |
| "guid" : "..." |
| }, |
| "description" : "" |
| } |
| , |
| "AttributeSearchResult" : { |
| "type" : "object", |
| "title" : "AttributeSearchResult", |
| "properties" : { |
| "name" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "array", |
| "items" : { |
| "type" : "string" |
| } |
| }, |
| "values" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "array", |
| "items" : { |
| "type" : "array", |
| "items" : { |
| "type" : "object" |
| } |
| } |
| } |
| }, |
| "example" : { |
| "name" : [ "...", "..." ], |
| "values" : [ [ { }, { } ], [ { }, { } ] ] |
| }, |
| "description" : "" |
| } |
| , |
| "BulkImportResponse" : { |
| "type" : "object", |
| "title" : "BulkImportResponse", |
| "properties" : { |
| "failedImportInfoList" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "array", |
| "items" : { |
| "$ref" : "#/definitions/ImportInfo" |
| } |
| }, |
| "successImportInfoList" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "array", |
| "items" : { |
| "$ref" : "#/definitions/ImportInfo" |
| } |
| } |
| }, |
| "example" : { |
| "failedImportInfoList" : [ { |
| "childObjectName" : "...", |
| "importStatus" : "FAILED", |
| "parentObjectName" : "...", |
| "remarks" : "..." |
| }, { |
| "childObjectName" : "...", |
| "importStatus" : "FAILED", |
| "parentObjectName" : "...", |
| "remarks" : "..." |
| } ], |
| "successImportInfoList" : [ { |
| "childObjectName" : "...", |
| "importStatus" : "SUCCESS", |
| "parentObjectName" : "...", |
| "remarks" : "..." |
| }, { |
| "childObjectName" : "...", |
| "importStatus" : "SUCCESS", |
| "parentObjectName" : "...", |
| "remarks" : "..." |
| } ] |
| }, |
| "description" : "" |
| } |
| , |
| "Cardinality" : { |
| "type" : "string", |
| "title" : "Cardinality", |
| "enum" : [ |
| "SINGLE", |
| "LIST", |
| "SET" |
| ], |
| "description" : "single-valued attribute or multi-valued attribute." |
| } |
| , |
| "ClassificationAssociateRequest" : { |
| "type" : "object", |
| "title" : "ClassificationAssociateRequest", |
| "properties" : { |
| "classification" : { |
| "readOnly" : false, |
| "$ref" : "#/definitions/AtlasClassification", |
| "description" : "" |
| }, |
| "entitiesUniqueAttributes" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "array", |
| "items" : { |
| "type" : "object", |
| "additionalProperties" : { |
| "type" : "object" |
| } |
| } |
| }, |
| "entityGuids" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "array", |
| "items" : { |
| "type" : "string" |
| } |
| }, |
| "entityTypeName" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| } |
| }, |
| "example" : { |
| "classification" : { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "entitiesUniqueAttributes" : [ { |
| "property1" : { }, |
| "property2" : { } |
| }, { |
| "property1" : { }, |
| "property2" : { } |
| } ], |
| "entityGuids" : [ "...", "..." ], |
| "entityTypeName" : "..." |
| }, |
| "description" : "" |
| } |
| , |
| "Condition" : { |
| "type" : "string", |
| "title" : "Condition", |
| "enum" : [ |
| "AND", |
| "OR" |
| ], |
| "description" : "" |
| } |
| , |
| "DateFormat" : { |
| "type" : "object", |
| "title" : "DateFormat", |
| "required" : ["lenient"], |
| "allOf" : [ |
| { |
| "$ref" : "#/definitions/Format" |
| }, |
| { |
| "properties" : { |
| "availableLocales" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "array", |
| "items" : { |
| "type" : "string" |
| } |
| }, |
| "calendar" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "integer", |
| "format" : "int32" |
| }, |
| "dateInstance" : { |
| "readOnly" : false, |
| "$ref" : "#/definitions/DateFormat", |
| "description" : "" |
| }, |
| "dateTimeInstance" : { |
| "readOnly" : false, |
| "$ref" : "#/definitions/DateFormat", |
| "description" : "" |
| }, |
| "instance" : { |
| "readOnly" : false, |
| "$ref" : "#/definitions/DateFormat", |
| "description" : "" |
| }, |
| "lenient" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "boolean" |
| }, |
| "numberFormat" : { |
| "readOnly" : false, |
| "$ref" : "#/definitions/NumberFormat", |
| "description" : "" |
| }, |
| "timeInstance" : { |
| "readOnly" : false, |
| "$ref" : "#/definitions/DateFormat", |
| "description" : "" |
| }, |
| "timeZone" : { |
| "readOnly" : false, |
| "$ref" : "#/definitions/TimeZone", |
| "description" : "" |
| } |
| } |
| } |
| ], |
| "example" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { |
| "availableLocales" : [ "...", "..." ], |
| "currency" : "...", |
| "currencyInstance" : { }, |
| "groupingUsed" : true, |
| "instance" : { }, |
| "integerInstance" : { }, |
| "maximumFractionDigits" : 12345, |
| "maximumIntegerDigits" : 12345, |
| "minimumFractionDigits" : 12345, |
| "minimumIntegerDigits" : 12345, |
| "numberInstance" : { }, |
| "parseIntegerOnly" : true, |
| "percentInstance" : { }, |
| "roundingMode" : "CEILING" |
| }, |
| "timeInstance" : { }, |
| "timeZone" : { |
| "DSTSavings" : 12345, |
| "ID" : "...", |
| "availableIDs" : [ "...", "..." ], |
| "default" : { }, |
| "displayName" : "...", |
| "rawOffset" : 12345 |
| } |
| }, |
| "dateTimeInstance" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { |
| "availableLocales" : [ "...", "..." ], |
| "currency" : "...", |
| "currencyInstance" : { }, |
| "groupingUsed" : true, |
| "instance" : { }, |
| "integerInstance" : { }, |
| "maximumFractionDigits" : 12345, |
| "maximumIntegerDigits" : 12345, |
| "minimumFractionDigits" : 12345, |
| "minimumIntegerDigits" : 12345, |
| "numberInstance" : { }, |
| "parseIntegerOnly" : true, |
| "percentInstance" : { }, |
| "roundingMode" : "HALF_DOWN" |
| }, |
| "timeInstance" : { }, |
| "timeZone" : { |
| "DSTSavings" : 12345, |
| "ID" : "...", |
| "availableIDs" : [ "...", "..." ], |
| "default" : { }, |
| "displayName" : "...", |
| "rawOffset" : 12345 |
| } |
| }, |
| "instance" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { |
| "availableLocales" : [ "...", "..." ], |
| "currency" : "...", |
| "currencyInstance" : { }, |
| "groupingUsed" : true, |
| "instance" : { }, |
| "integerInstance" : { }, |
| "maximumFractionDigits" : 12345, |
| "maximumIntegerDigits" : 12345, |
| "minimumFractionDigits" : 12345, |
| "minimumIntegerDigits" : 12345, |
| "numberInstance" : { }, |
| "parseIntegerOnly" : true, |
| "percentInstance" : { }, |
| "roundingMode" : "HALF_EVEN" |
| }, |
| "timeInstance" : { }, |
| "timeZone" : { |
| "DSTSavings" : 12345, |
| "ID" : "...", |
| "availableIDs" : [ "...", "..." ], |
| "default" : { }, |
| "displayName" : "...", |
| "rawOffset" : 12345 |
| } |
| }, |
| "lenient" : true, |
| "numberFormat" : { |
| "availableLocales" : [ "...", "..." ], |
| "currency" : "...", |
| "currencyInstance" : { }, |
| "groupingUsed" : true, |
| "instance" : { }, |
| "integerInstance" : { }, |
| "maximumFractionDigits" : 12345, |
| "maximumIntegerDigits" : 12345, |
| "minimumFractionDigits" : 12345, |
| "minimumIntegerDigits" : 12345, |
| "numberInstance" : { }, |
| "parseIntegerOnly" : true, |
| "percentInstance" : { }, |
| "roundingMode" : "FLOOR" |
| }, |
| "timeInstance" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { |
| "availableLocales" : [ "...", "..." ], |
| "currency" : "...", |
| "currencyInstance" : { }, |
| "groupingUsed" : true, |
| "instance" : { }, |
| "integerInstance" : { }, |
| "maximumFractionDigits" : 12345, |
| "maximumIntegerDigits" : 12345, |
| "minimumFractionDigits" : 12345, |
| "minimumIntegerDigits" : 12345, |
| "numberInstance" : { }, |
| "parseIntegerOnly" : true, |
| "percentInstance" : { }, |
| "roundingMode" : "FLOOR" |
| }, |
| "timeInstance" : { }, |
| "timeZone" : { |
| "DSTSavings" : 12345, |
| "ID" : "...", |
| "availableIDs" : [ "...", "..." ], |
| "default" : { }, |
| "displayName" : "...", |
| "rawOffset" : 12345 |
| } |
| }, |
| "timeZone" : { |
| "DSTSavings" : 12345, |
| "ID" : "...", |
| "availableIDs" : [ "...", "..." ], |
| "default" : { }, |
| "displayName" : "...", |
| "rawOffset" : 12345 |
| } |
| }, |
| "description" : "" |
| } |
| , |
| "EntityAuditActionV2" : { |
| "type" : "string", |
| "title" : "EntityAuditActionV2", |
| "enum" : [ |
| "ENTITY_CREATE", |
| "ENTITY_UPDATE", |
| "ENTITY_DELETE", |
| "ENTITY_IMPORT_CREATE", |
| "ENTITY_IMPORT_UPDATE", |
| "ENTITY_IMPORT_DELETE", |
| "CLASSIFICATION_ADD", |
| "CLASSIFICATION_DELETE", |
| "CLASSIFICATION_UPDATE", |
| "PROPAGATED_CLASSIFICATION_ADD", |
| "PROPAGATED_CLASSIFICATION_DELETE", |
| "PROPAGATED_CLASSIFICATION_UPDATE", |
| "TERM_ADD", |
| "TERM_DELETE", |
| "LABEL_ADD", |
| "LABEL_DELETE", |
| "ENTITY_PURGE", |
| "BUSINESS_ATTRIBUTE_UPDATE", |
| "CUSTOM_ATTRIBUTE_UPDATE" |
| ], |
| "description" : "" |
| } |
| , |
| "EntityAuditEventV2" : { |
| "type" : "object", |
| "title" : "EntityAuditEventV2", |
| "required" : ["timestamp"], |
| "properties" : { |
| "action" : { |
| "readOnly" : false, |
| "$ref" : "#/definitions/EntityAuditActionV2", |
| "description" : "" |
| }, |
| "details" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| }, |
| "entity" : { |
| "readOnly" : false, |
| "$ref" : "#/definitions/AtlasEntity", |
| "description" : "" |
| }, |
| "entityId" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| }, |
| "eventKey" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| }, |
| "timestamp" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "integer", |
| "format" : "int64" |
| }, |
| "type" : { |
| "readOnly" : false, |
| "$ref" : "#/definitions/EntityAuditType", |
| "description" : "" |
| }, |
| "user" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| } |
| }, |
| "example" : { |
| "action" : "BUSINESS_ATTRIBUTE_UPDATE", |
| "details" : "...", |
| "entity" : { |
| "businessAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "customAttributes" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "guid" : "...", |
| "homeId" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "VALIDATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DISCOVERED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "pendingTasks" : [ "...", "..." ], |
| "provenanceType" : 12345, |
| "proxy" : true, |
| "relationshipAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "status" : "DELETED", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "entityId" : "...", |
| "eventKey" : "...", |
| "timestamp" : 12345, |
| "type" : "ENTITY_AUDIT_V1", |
| "user" : "..." |
| }, |
| "description" : "Structure of v2 entity audit event" |
| } |
| , |
| "EntityAuditType" : { |
| "type" : "string", |
| "title" : "EntityAuditType", |
| "enum" : [ |
| "ENTITY_AUDIT_V1", |
| "ENTITY_AUDIT_V2" |
| ], |
| "description" : "" |
| } |
| , |
| "EntityMutationResponse" : { |
| "type" : "object", |
| "title" : "EntityMutationResponse", |
| "properties" : { |
| "guidAssignments" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "object", |
| "additionalProperties" : { |
| "type" : "string" |
| } |
| }, |
| "mutatedEntities" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "object", |
| "additionalProperties" : { |
| "type" : "array", |
| "items" : { |
| "$ref" : "#/definitions/AtlasEntityHeader" |
| } |
| } |
| }, |
| "partialUpdatedEntities" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "array", |
| "items" : { |
| "$ref" : "#/definitions/AtlasEntityHeader" |
| } |
| } |
| }, |
| "example" : { |
| "guidAssignments" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "mutatedEntities" : { |
| "property1" : [ { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "VALIDATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "PROPOSED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "IMPORTED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "VALIDATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "property2" : [ { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "IMPORTED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "IMPORTED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "PROPOSED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ] |
| }, |
| "partialUpdatedEntities" : [ { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ] |
| }, |
| "description" : "" |
| } |
| , |
| "EntityOperation" : { |
| "type" : "string", |
| "title" : "EntityOperation", |
| "enum" : [ |
| "CREATE", |
| "UPDATE", |
| "PARTIAL_UPDATE", |
| "DELETE", |
| "PURGE" |
| ], |
| "description" : "" |
| } |
| , |
| "FilterCriteria" : { |
| "type" : "object", |
| "title" : "FilterCriteria", |
| "properties" : { |
| "attributeName" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| }, |
| "attributeValue" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| }, |
| "condition" : { |
| "readOnly" : false, |
| "$ref" : "#/definitions/Condition", |
| "description" : "" |
| }, |
| "criterion" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "array", |
| "items" : { |
| "$ref" : "#/definitions/FilterCriteria" |
| } |
| }, |
| "operator" : { |
| "readOnly" : false, |
| "$ref" : "#/definitions/Operator", |
| "description" : "" |
| } |
| }, |
| "example" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "AND", |
| "criterion" : [ { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "OR", |
| "criterion" : [ { }, { } ], |
| "operator" : "EQ" |
| }, { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "OR", |
| "criterion" : [ { }, { } ], |
| "operator" : "NOT_EMPTY" |
| } ], |
| "operator" : "TIME_RANGE" |
| }, |
| "description" : "" |
| } |
| , |
| "Format" : { |
| "type" : "object", |
| "title" : "Format", |
| "example" : { }, |
| "description" : "" |
| } |
| , |
| "ImportInfo" : { |
| "type" : "object", |
| "title" : "ImportInfo", |
| "properties" : { |
| "childObjectName" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| }, |
| "importStatus" : { |
| "readOnly" : false, |
| "$ref" : "#/definitions/ImportStatus", |
| "description" : "" |
| }, |
| "parentObjectName" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| }, |
| "remarks" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| } |
| }, |
| "example" : { |
| "childObjectName" : "...", |
| "importStatus" : "SUCCESS", |
| "parentObjectName" : "...", |
| "remarks" : "..." |
| }, |
| "description" : "" |
| } |
| , |
| "ImportStatus" : { |
| "type" : "string", |
| "title" : "ImportStatus", |
| "enum" : [ |
| "SUCCESS", |
| "FAILED" |
| ], |
| "description" : "" |
| } |
| , |
| "IndexType" : { |
| "type" : "string", |
| "title" : "IndexType", |
| "enum" : [ |
| "DEFAULT", |
| "STRING" |
| ], |
| "description" : "" |
| } |
| , |
| "LineageDirection" : { |
| "type" : "string", |
| "title" : "LineageDirection", |
| "enum" : [ |
| "INPUT", |
| "OUTPUT", |
| "BOTH" |
| ], |
| "description" : "" |
| } |
| , |
| "LineageInfoOnDemand" : { |
| "type" : "object", |
| "title" : "LineageInfoOnDemand", |
| "required" : ["hasMoreInputs", "hasMoreOutputs", "inputRelationsCount", "outputRelationsCount"], |
| "properties" : { |
| "hasMoreInputs" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "boolean" |
| }, |
| "hasMoreOutputs" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "boolean" |
| }, |
| "inputRelationsCount" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "integer", |
| "format" : "int32" |
| }, |
| "outputRelationsCount" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "integer", |
| "format" : "int32" |
| } |
| }, |
| "example" : { |
| "hasMoreInputs" : true, |
| "hasMoreOutputs" : true, |
| "inputRelationsCount" : 12345, |
| "outputRelationsCount" : 12345 |
| }, |
| "description" : "" |
| } |
| , |
| "LineageOnDemandConstraints" : { |
| "type" : "object", |
| "title" : "LineageOnDemandConstraints", |
| "required" : ["depth", "inputRelationsLimit", "outputRelationsLimit"], |
| "properties" : { |
| "depth" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "integer", |
| "format" : "int32" |
| }, |
| "direction" : { |
| "readOnly" : false, |
| "$ref" : "#/definitions/LineageDirection", |
| "description" : "" |
| }, |
| "inputRelationsLimit" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "integer", |
| "format" : "int32" |
| }, |
| "outputRelationsLimit" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "integer", |
| "format" : "int32" |
| } |
| }, |
| "example" : { |
| "depth" : 12345, |
| "direction" : "BOTH", |
| "inputRelationsLimit" : 12345, |
| "outputRelationsLimit" : 12345 |
| }, |
| "description" : "" |
| } |
| , |
| "LineageRelation" : { |
| "type" : "object", |
| "title" : "LineageRelation", |
| "properties" : { |
| "fromEntityId" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| }, |
| "relationshipId" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| }, |
| "toEntityId" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| } |
| }, |
| "example" : { |
| "fromEntityId" : "...", |
| "relationshipId" : "...", |
| "toEntityId" : "..." |
| }, |
| "description" : "" |
| } |
| , |
| "NumberFormat" : { |
| "type" : "object", |
| "title" : "NumberFormat", |
| "required" : ["groupingUsed", "maximumFractionDigits", "maximumIntegerDigits", "minimumFractionDigits", "minimumIntegerDigits", "parseIntegerOnly"], |
| "allOf" : [ |
| { |
| "$ref" : "#/definitions/Format" |
| }, |
| { |
| "properties" : { |
| "availableLocales" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "array", |
| "items" : { |
| "type" : "string" |
| } |
| }, |
| "currency" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| }, |
| "currencyInstance" : { |
| "readOnly" : false, |
| "$ref" : "#/definitions/NumberFormat", |
| "description" : "" |
| }, |
| "groupingUsed" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "boolean" |
| }, |
| "instance" : { |
| "readOnly" : false, |
| "$ref" : "#/definitions/NumberFormat", |
| "description" : "" |
| }, |
| "integerInstance" : { |
| "readOnly" : false, |
| "$ref" : "#/definitions/NumberFormat", |
| "description" : "" |
| }, |
| "maximumFractionDigits" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "integer", |
| "format" : "int32" |
| }, |
| "maximumIntegerDigits" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "integer", |
| "format" : "int32" |
| }, |
| "minimumFractionDigits" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "integer", |
| "format" : "int32" |
| }, |
| "minimumIntegerDigits" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "integer", |
| "format" : "int32" |
| }, |
| "numberInstance" : { |
| "readOnly" : false, |
| "$ref" : "#/definitions/NumberFormat", |
| "description" : "" |
| }, |
| "parseIntegerOnly" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "boolean" |
| }, |
| "percentInstance" : { |
| "readOnly" : false, |
| "$ref" : "#/definitions/NumberFormat", |
| "description" : "" |
| }, |
| "roundingMode" : { |
| "readOnly" : false, |
| "$ref" : "#/definitions/RoundingMode", |
| "description" : "" |
| } |
| } |
| } |
| ], |
| "example" : { |
| "availableLocales" : [ "...", "..." ], |
| "currency" : "...", |
| "currencyInstance" : { |
| "availableLocales" : [ "...", "..." ], |
| "currency" : "...", |
| "currencyInstance" : { }, |
| "groupingUsed" : true, |
| "instance" : { }, |
| "integerInstance" : { }, |
| "maximumFractionDigits" : 12345, |
| "maximumIntegerDigits" : 12345, |
| "minimumFractionDigits" : 12345, |
| "minimumIntegerDigits" : 12345, |
| "numberInstance" : { }, |
| "parseIntegerOnly" : true, |
| "percentInstance" : { }, |
| "roundingMode" : "UNNECESSARY" |
| }, |
| "groupingUsed" : true, |
| "instance" : { |
| "availableLocales" : [ "...", "..." ], |
| "currency" : "...", |
| "currencyInstance" : { }, |
| "groupingUsed" : true, |
| "instance" : { }, |
| "integerInstance" : { }, |
| "maximumFractionDigits" : 12345, |
| "maximumIntegerDigits" : 12345, |
| "minimumFractionDigits" : 12345, |
| "minimumIntegerDigits" : 12345, |
| "numberInstance" : { }, |
| "parseIntegerOnly" : true, |
| "percentInstance" : { }, |
| "roundingMode" : "HALF_DOWN" |
| }, |
| "integerInstance" : { |
| "availableLocales" : [ "...", "..." ], |
| "currency" : "...", |
| "currencyInstance" : { }, |
| "groupingUsed" : true, |
| "instance" : { }, |
| "integerInstance" : { }, |
| "maximumFractionDigits" : 12345, |
| "maximumIntegerDigits" : 12345, |
| "minimumFractionDigits" : 12345, |
| "minimumIntegerDigits" : 12345, |
| "numberInstance" : { }, |
| "parseIntegerOnly" : true, |
| "percentInstance" : { }, |
| "roundingMode" : "CEILING" |
| }, |
| "maximumFractionDigits" : 12345, |
| "maximumIntegerDigits" : 12345, |
| "minimumFractionDigits" : 12345, |
| "minimumIntegerDigits" : 12345, |
| "numberInstance" : { |
| "availableLocales" : [ "...", "..." ], |
| "currency" : "...", |
| "currencyInstance" : { }, |
| "groupingUsed" : true, |
| "instance" : { }, |
| "integerInstance" : { }, |
| "maximumFractionDigits" : 12345, |
| "maximumIntegerDigits" : 12345, |
| "minimumFractionDigits" : 12345, |
| "minimumIntegerDigits" : 12345, |
| "numberInstance" : { }, |
| "parseIntegerOnly" : true, |
| "percentInstance" : { }, |
| "roundingMode" : "UNNECESSARY" |
| }, |
| "parseIntegerOnly" : true, |
| "percentInstance" : { |
| "availableLocales" : [ "...", "..." ], |
| "currency" : "...", |
| "currencyInstance" : { }, |
| "groupingUsed" : true, |
| "instance" : { }, |
| "integerInstance" : { }, |
| "maximumFractionDigits" : 12345, |
| "maximumIntegerDigits" : 12345, |
| "minimumFractionDigits" : 12345, |
| "minimumIntegerDigits" : 12345, |
| "numberInstance" : { }, |
| "parseIntegerOnly" : true, |
| "percentInstance" : { }, |
| "roundingMode" : "DOWN" |
| }, |
| "roundingMode" : "UNNECESSARY" |
| }, |
| "description" : "" |
| } |
| , |
| "Operator" : { |
| "type" : "string", |
| "title" : "Operator", |
| "enum" : [ |
| "LT", |
| "GT", |
| "LTE", |
| "GTE", |
| "EQ", |
| "NEQ", |
| "IN", |
| "LIKE", |
| "STARTS_WITH", |
| "ENDS_WITH", |
| "CONTAINS", |
| "NOT_CONTAINS", |
| "CONTAINS_ANY", |
| "CONTAINS_ALL", |
| "IS_NULL", |
| "NOT_NULL", |
| "TIME_RANGE", |
| "NOT_EMPTY" |
| ], |
| "description" : "NOTE : The names added in the String array should always contain first value in lower case" |
| } |
| , |
| "PList" : { |
| "type" : "object", |
| "title" : "PList", |
| "required" : ["pageSize", "startIndex", "totalCount"], |
| "properties" : { |
| "list" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "array", |
| "items" : { |
| "type" : "object" |
| } |
| }, |
| "pageSize" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "integer", |
| "format" : "int32" |
| }, |
| "sortBy" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| }, |
| "sortType" : { |
| "readOnly" : false, |
| "$ref" : "#/definitions/SortType", |
| "description" : "" |
| }, |
| "startIndex" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "integer", |
| "format" : "int64" |
| }, |
| "totalCount" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "integer", |
| "format" : "int64" |
| } |
| }, |
| "example" : { |
| "list" : [ { }, { } ], |
| "pageSize" : 12345, |
| "sortBy" : "...", |
| "sortType" : "ASC", |
| "startIndex" : 12345, |
| "totalCount" : 12345 |
| }, |
| "description" : "Paginated-list, for returning search results." |
| } |
| , |
| "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." |
| } |
| , |
| "QuickSearchParameters" : { |
| "type" : "object", |
| "title" : "QuickSearchParameters", |
| "required" : ["excludeDeletedEntities", "excludeHeaderAttributes", "includeSubTypes", "limit", "offset"], |
| "properties" : { |
| "attributes" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "array", |
| "items" : { |
| "type" : "string" |
| } |
| }, |
| "entityFilters" : { |
| "readOnly" : false, |
| "$ref" : "#/definitions/FilterCriteria", |
| "description" : "" |
| }, |
| "excludeDeletedEntities" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "boolean" |
| }, |
| "excludeHeaderAttributes" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "boolean" |
| }, |
| "includeSubTypes" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "boolean" |
| }, |
| "limit" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "integer", |
| "format" : "int32" |
| }, |
| "offset" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "integer", |
| "format" : "int32" |
| }, |
| "query" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| }, |
| "sortBy" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| }, |
| "sortOrder" : { |
| "readOnly" : false, |
| "$ref" : "#/definitions/SortOrder", |
| "description" : "" |
| }, |
| "typeName" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| } |
| }, |
| "example" : { |
| "attributes" : [ "...", "..." ], |
| "entityFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "OR", |
| "criterion" : [ { }, { } ], |
| "operator" : "NOT_CONTAINS" |
| }, |
| "excludeDeletedEntities" : true, |
| "excludeHeaderAttributes" : true, |
| "includeSubTypes" : true, |
| "limit" : 12345, |
| "offset" : 12345, |
| "query" : "...", |
| "sortBy" : "...", |
| "sortOrder" : "ASCENDING", |
| "typeName" : "..." |
| }, |
| "description" : "" |
| } |
| , |
| "Relation" : { |
| "type" : "string", |
| "title" : "Relation", |
| "enum" : [ |
| "SEE_ALSO", |
| "SYNONYMS", |
| "ANTONYMS", |
| "PREFERRED_TO_TERMS", |
| "PREFERRED_TERMS", |
| "REPLACEMENT_TERMS", |
| "REPLACED_BY", |
| "TRANSLATION_TERMS", |
| "TRANSLATED_TERMS", |
| "ISA", |
| "CLASSIFIES", |
| "VALID_VALUES", |
| "VALID_VALUES_FOR" |
| ], |
| "description" : "" |
| } |
| , |
| "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." |
| } |
| , |
| "RelationshipSearchParameters" : { |
| "type" : "object", |
| "title" : "RelationshipSearchParameters", |
| "required" : ["includeSubTypes", "limit", "offset"], |
| "properties" : { |
| "includeSubTypes" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "boolean" |
| }, |
| "limit" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "integer", |
| "format" : "int32" |
| }, |
| "marker" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| }, |
| "offset" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "integer", |
| "format" : "int32" |
| }, |
| "relationshipFilters" : { |
| "readOnly" : false, |
| "$ref" : "#/definitions/FilterCriteria", |
| "description" : "" |
| }, |
| "relationshipName" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| }, |
| "sortBy" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| }, |
| "sortOrder" : { |
| "readOnly" : false, |
| "$ref" : "#/definitions/SortOrder", |
| "description" : "" |
| } |
| }, |
| "example" : { |
| "includeSubTypes" : true, |
| "limit" : 12345, |
| "marker" : "...", |
| "offset" : 12345, |
| "relationshipFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "OR", |
| "criterion" : [ { }, { } ], |
| "operator" : "TIME_RANGE" |
| }, |
| "relationshipName" : "...", |
| "sortBy" : "...", |
| "sortOrder" : "DESCENDING" |
| }, |
| "description" : "" |
| } |
| , |
| "RoundingMode" : { |
| "type" : "string", |
| "title" : "RoundingMode", |
| "enum" : [ |
| "UP", |
| "DOWN", |
| "CEILING", |
| "FLOOR", |
| "HALF_UP", |
| "HALF_DOWN", |
| "HALF_EVEN", |
| "UNNECESSARY" |
| ], |
| "description" : "" |
| } |
| , |
| "SavedSearchType" : { |
| "type" : "string", |
| "title" : "SavedSearchType", |
| "enum" : [ |
| "BASIC", |
| "ADVANCED", |
| "BASIC_RELATIONSHIP" |
| ], |
| "description" : "" |
| } |
| , |
| "SearchFilter" : { |
| "type" : "object", |
| "title" : "SearchFilter", |
| "required" : ["getCount", "maxRows", "startIndex"], |
| "properties" : { |
| "getCount" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "boolean" |
| }, |
| "maxRows" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "integer", |
| "format" : "int64" |
| }, |
| "params" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "object", |
| "additionalProperties" : { |
| "type" : "array", |
| "items" : { |
| "type" : "string" |
| } |
| } |
| }, |
| "sortBy" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| }, |
| "sortType" : { |
| "readOnly" : false, |
| "$ref" : "#/definitions/SortType", |
| "description" : "" |
| }, |
| "startIndex" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "integer", |
| "format" : "int64" |
| } |
| }, |
| "example" : { |
| "getCount" : true, |
| "maxRows" : 12345, |
| "params" : { |
| "property1" : [ "...", "..." ], |
| "property2" : [ "...", "..." ] |
| }, |
| "sortBy" : "...", |
| "sortType" : "DESC", |
| "startIndex" : 12345 |
| }, |
| "description" : "Generic filter, to specify search criteria using name/value pairs." |
| } |
| , |
| "SearchParameters" : { |
| "type" : "object", |
| "title" : "SearchParameters", |
| "required" : ["excludeDeletedEntities", "excludeHeaderAttributes", "includeClassificationAttributes", "includeSubClassifications", "includeSubTypes", "limit", "offset"], |
| "properties" : { |
| "attributes" : { |
| "readOnly" : false, |
| "description" : "Attribute values included in the results", |
| "type" : "array", |
| "items" : { |
| "type" : "string" |
| } |
| }, |
| "classification" : { |
| "readOnly" : false, |
| "description" : "Classification/tag to search on", |
| "type" : "string" |
| }, |
| "entityFilters" : { |
| "readOnly" : false, |
| "$ref" : "#/definitions/FilterCriteria", |
| "description" : "Entity attribute filters for the type (if type name is specified)" |
| }, |
| "excludeDeletedEntities" : { |
| "readOnly" : false, |
| "description" : "True iff deleted entities are excluded", |
| "type" : "boolean" |
| }, |
| "excludeHeaderAttributes" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "boolean" |
| }, |
| "includeClassificationAttributes" : { |
| "readOnly" : false, |
| "description" : "True if classification attributes are included in search result.", |
| "type" : "boolean" |
| }, |
| "includeSubClassifications" : { |
| "readOnly" : false, |
| "description" : "True iff sub-classifications are to be included", |
| "type" : "boolean" |
| }, |
| "includeSubTypes" : { |
| "readOnly" : false, |
| "description" : "True iff sub-type entities are to be included", |
| "type" : "boolean" |
| }, |
| "limit" : { |
| "readOnly" : false, |
| "description" : "Max number of results to be returned", |
| "type" : "integer", |
| "format" : "int32" |
| }, |
| "marker" : { |
| "readOnly" : false, |
| "description" : "marker (offset of the next page)", |
| "type" : "string" |
| }, |
| "offset" : { |
| "readOnly" : false, |
| "description" : "Offset(pagination) of the results", |
| "type" : "integer", |
| "format" : "int32" |
| }, |
| "query" : { |
| "readOnly" : false, |
| "description" : "The type of query", |
| "type" : "string" |
| }, |
| "relationshipFilters" : { |
| "readOnly" : false, |
| "$ref" : "#/definitions/FilterCriteria", |
| "description" : "Relationship attribute filters for the relationship" |
| }, |
| "relationshipName" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| }, |
| "sortBy" : { |
| "readOnly" : false, |
| "description" : "Attribute on which to sort the results", |
| "type" : "string" |
| }, |
| "sortOrder" : { |
| "readOnly" : false, |
| "$ref" : "#/definitions/SortOrder", |
| "description" : "Sorting order of the results" |
| }, |
| "tagFilters" : { |
| "readOnly" : false, |
| "$ref" : "#/definitions/FilterCriteria", |
| "description" : "Tag attribute filters for the classification/tag (if tag name is specified)" |
| }, |
| "termName" : { |
| "readOnly" : false, |
| "description" : "termName to search on", |
| "type" : "string" |
| }, |
| "typeName" : { |
| "readOnly" : false, |
| "description" : "Type name to search on", |
| "type" : "string" |
| } |
| }, |
| "example" : { |
| "attributes" : [ "...", "..." ], |
| "classification" : "...", |
| "entityFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "OR", |
| "criterion" : [ { }, { } ], |
| "operator" : "NOT_EMPTY" |
| }, |
| "excludeDeletedEntities" : true, |
| "excludeHeaderAttributes" : true, |
| "includeClassificationAttributes" : true, |
| "includeSubClassifications" : true, |
| "includeSubTypes" : true, |
| "limit" : 12345, |
| "marker" : "...", |
| "offset" : 12345, |
| "query" : "...", |
| "relationshipFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "AND", |
| "criterion" : [ { }, { } ], |
| "operator" : "IS_NULL" |
| }, |
| "relationshipName" : "...", |
| "sortBy" : "...", |
| "sortOrder" : "ASCENDING", |
| "tagFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "OR", |
| "criterion" : [ { }, { } ], |
| "operator" : "IS_NULL" |
| }, |
| "termName" : "...", |
| "typeName" : "..." |
| }, |
| "description" : "" |
| } |
| , |
| "SortOrder" : { |
| "type" : "string", |
| "title" : "SortOrder", |
| "enum" : [ |
| "ASCENDING", |
| "DESCENDING" |
| ], |
| "description" : "" |
| } |
| , |
| "SortType" : { |
| "type" : "string", |
| "title" : "SortType", |
| "enum" : [ |
| "NONE", |
| "ASC", |
| "DESC" |
| ], |
| "description" : "to specify whether the result should be sorted? If yes, whether asc or desc." |
| } |
| , |
| "Status" : { |
| "type" : "string", |
| "title" : "Status", |
| "enum" : [ |
| "ACTIVE", |
| "DELETED", |
| "PURGED" |
| ], |
| "description" : "Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store." |
| } |
| , |
| "Status_AtlasRelationship" : { |
| "type" : "string", |
| "title" : "Status", |
| "enum" : [ |
| "ACTIVE", |
| "DELETED" |
| ], |
| "description" : "" |
| } |
| , |
| "TimeBoundary" : { |
| "type" : "object", |
| "title" : "TimeBoundary", |
| "properties" : { |
| "endTime" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| }, |
| "startTime" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| }, |
| "timeZone" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| } |
| }, |
| "example" : { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, |
| "description" : "Captures time-boundary details" |
| } |
| , |
| "TimeZone" : { |
| "type" : "object", |
| "title" : "TimeZone", |
| "required" : ["DSTSavings", "rawOffset"], |
| "properties" : { |
| "DSTSavings" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "integer", |
| "format" : "int32" |
| }, |
| "ID" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| }, |
| "availableIDs" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "array", |
| "items" : { |
| "type" : "string" |
| } |
| }, |
| "default" : { |
| "readOnly" : false, |
| "$ref" : "#/definitions/TimeZone", |
| "description" : "" |
| }, |
| "displayName" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| }, |
| "rawOffset" : { |
| "readOnly" : false, |
| "description" : "", |
| "type" : "integer", |
| "format" : "int32" |
| } |
| }, |
| "example" : { |
| "DSTSavings" : 12345, |
| "ID" : "...", |
| "availableIDs" : [ "...", "..." ], |
| "default" : { |
| "DSTSavings" : 12345, |
| "ID" : "...", |
| "availableIDs" : [ "...", "..." ], |
| "default" : { }, |
| "displayName" : "...", |
| "rawOffset" : 12345 |
| }, |
| "displayName" : "...", |
| "rawOffset" : 12345 |
| }, |
| "description" : "" |
| } |
| , |
| "TypeCategory" : { |
| "type" : "string", |
| "title" : "TypeCategory", |
| "enum" : [ |
| "PRIMITIVE", |
| "OBJECT_ID_TYPE", |
| "ENUM", |
| "STRUCT", |
| "CLASSIFICATION", |
| "ENTITY", |
| "ARRAY", |
| "MAP", |
| "RELATIONSHIP", |
| "BUSINESS_METADATA" |
| ], |
| "description" : "" |
| } |
| , |
| "xml_ns0_PList" : { |
| "type" : "object", |
| "xml" : { |
| "name" : "PList", |
| "namespace" : "" |
| }, |
| "title" : "PList", |
| "required" : ["pageSize", "startIndex", "totalCount"], |
| "allOf" : [ |
| { |
| "properties" : { |
| "list" : { |
| "xml" : { |
| "namespace" : "" |
| }, |
| "readOnly" : false, |
| "description" : "", |
| "type" : "array", |
| "items" : { |
| "type" : "object" |
| } |
| }, |
| "pageSize" : { |
| "xml" : { |
| "namespace" : "" |
| }, |
| "readOnly" : false, |
| "description" : "", |
| "type" : "integer", |
| "format" : "int32" |
| }, |
| "sortBy" : { |
| "xml" : { |
| "namespace" : "" |
| }, |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| }, |
| "sortType" : { |
| "xml" : { |
| "namespace" : "" |
| }, |
| "readOnly" : false, |
| "$ref" : "#/definitions/xml_ns0_sortType", |
| "description" : "" |
| }, |
| "startIndex" : { |
| "xml" : { |
| "namespace" : "" |
| }, |
| "readOnly" : false, |
| "description" : "", |
| "type" : "integer", |
| "format" : "int64" |
| }, |
| "totalCount" : { |
| "xml" : { |
| "namespace" : "" |
| }, |
| "readOnly" : false, |
| "description" : "", |
| "type" : "integer", |
| "format" : "int64" |
| } |
| } |
| } |
| ], |
| "description" : "Paginated-list, for returning search results." |
| } |
| , |
| "xml_ns0_searchFilter" : { |
| "type" : "object", |
| "xml" : { |
| "name" : "searchFilter", |
| "namespace" : "" |
| }, |
| "title" : "searchFilter", |
| "required" : ["getCount", "maxRows", "startIndex"], |
| "allOf" : [ |
| { |
| "properties" : { |
| "getCount" : { |
| "xml" : { |
| "namespace" : "" |
| }, |
| "readOnly" : false, |
| "description" : "", |
| "type" : "boolean" |
| }, |
| "maxRows" : { |
| "xml" : { |
| "namespace" : "" |
| }, |
| "readOnly" : false, |
| "description" : "", |
| "type" : "integer", |
| "format" : "int64" |
| }, |
| "params" : { |
| "xml" : { |
| "namespace" : "" |
| }, |
| "readOnly" : false, |
| "description" : "", |
| "type" : "object" |
| }, |
| "sortBy" : { |
| "xml" : { |
| "namespace" : "" |
| }, |
| "readOnly" : false, |
| "description" : "", |
| "type" : "string" |
| }, |
| "sortType" : { |
| "xml" : { |
| "namespace" : "" |
| }, |
| "readOnly" : false, |
| "$ref" : "#/definitions/xml_ns0_sortType", |
| "description" : "" |
| }, |
| "startIndex" : { |
| "xml" : { |
| "namespace" : "" |
| }, |
| "readOnly" : false, |
| "description" : "", |
| "type" : "integer", |
| "format" : "int64" |
| } |
| } |
| } |
| ], |
| "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_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" |
| } |
| }, |
| "paths": { |
| "\/v2/entity" : { |
| "post" : { |
| "tags" : [ "EntityREST" ], |
| "description" : "Create new entity or update existing entity in Atlas.\nExisting entity is matched using its unique guid if supplied or by its unique attributes eg: qualifiedName", |
| "operationId" : "createOrUpdate", |
| "consumes" : [ "application/json" ], |
| "produces" : [ "application/json" ], |
| "parameters" : [ |
| { |
| "name" : "body", |
| "required" : false, |
| "in" : "body", |
| "schema" : { |
| "$ref" : "#/definitions/AtlasEntityWithExtInfo", |
| "description" : "" |
| }, |
| "description" : "" |
| } |
| ], |
| "responses" : { |
| "201" : { |
| "schema" : { |
| "$ref" : "#/definitions/EntityMutationResponse", |
| "description" : "EntityMutationResponse" |
| }, |
| "examples" : { |
| "application/json" : { |
| "guidAssignments" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "mutatedEntities" : { |
| "property1" : [ { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "VALIDATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "IMPORTED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "property2" : [ { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "PROPOSED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DISCOVERED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ] |
| }, |
| "partialUpdatedEntities" : [ { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "PROPOSED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "IMPORTED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ] |
| } |
| }, |
| "description" : "EntityMutationResponse" |
| } |
| } |
| } |
| }, |
| "\/v2/entity/bulk" : { |
| "delete" : { |
| "tags" : [ "EntityREST" ], |
| "description" : "Bulk API to delete list of entities identified by its GUIDs", |
| "operationId" : "deleteByGuids", |
| "produces" : [ "application/json" ], |
| "parameters" : [ |
| { |
| "name" : "guid", |
| "in" : "query", |
| "type" : "array", |
| "items" : { |
| "type" : "string" |
| }, |
| "collectionFormat" : "multi", |
| "description" : "" |
| } |
| ], |
| "responses" : { |
| "204" : { |
| "schema" : { |
| "$ref" : "#/definitions/EntityMutationResponse", |
| "description" : "" |
| }, |
| "examples" : { |
| "application/json" : { |
| "guidAssignments" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "mutatedEntities" : { |
| "property1" : [ { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DISCOVERED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "IMPORTED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "property2" : [ { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "IMPORTED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "VALIDATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "PROPOSED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ] |
| }, |
| "partialUpdatedEntities" : [ { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "PROPOSED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "VALIDATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ] |
| } |
| }, |
| "description" : "" |
| } |
| } |
| }, |
| "get" : { |
| "tags" : [ "EntityREST" ], |
| "description" : "Bulk API to retrieve list of entities identified by its GUIDs.", |
| "operationId" : "getByGuids", |
| "produces" : [ "application/json" ], |
| "parameters" : [ |
| { |
| "name" : "guid", |
| "in" : "query", |
| "type" : "array", |
| "items" : { |
| "type" : "string" |
| }, |
| "collectionFormat" : "multi", |
| "description" : "" |
| }, |
| { |
| "name" : "ignoreRelationships", |
| "in" : "query", |
| "default" : "false", |
| "type" : "boolean", |
| "description" : "" |
| }, |
| { |
| "name" : "minExtInfo", |
| "in" : "query", |
| "default" : "false", |
| "type" : "boolean", |
| "description" : "" |
| } |
| ], |
| "responses" : { |
| "200" : { |
| "schema" : { |
| "$ref" : "#/definitions/AtlasEntitiesWithExtInfo", |
| "description" : "" |
| }, |
| "examples" : { |
| "application/json" : { |
| "entities" : [ { |
| "businessAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "customAttributes" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "guid" : "...", |
| "homeId" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DISCOVERED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "pendingTasks" : [ "...", "..." ], |
| "provenanceType" : 12345, |
| "proxy" : true, |
| "relationshipAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "status" : "DELETED", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "businessAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "customAttributes" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "guid" : "...", |
| "homeId" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "pendingTasks" : [ "...", "..." ], |
| "provenanceType" : 12345, |
| "proxy" : true, |
| "relationshipAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "status" : "PURGED", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "referredEntities" : { |
| "property1" : { |
| "businessAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "customAttributes" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "guid" : "...", |
| "homeId" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "IMPORTED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "pendingTasks" : [ "...", "..." ], |
| "provenanceType" : 12345, |
| "proxy" : true, |
| "relationshipAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "status" : "PURGED", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "property2" : { |
| "businessAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "customAttributes" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "guid" : "...", |
| "homeId" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "PROPOSED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "pendingTasks" : [ "...", "..." ], |
| "provenanceType" : 12345, |
| "proxy" : true, |
| "relationshipAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "status" : "ACTIVE", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } |
| } |
| } |
| }, |
| "description" : "" |
| } |
| } |
| }, |
| "post" : { |
| "tags" : [ "EntityREST" ], |
| "description" : "Bulk API to create new entities or updates existing entities in Atlas.\nExisting entity is matched using its unique guid if supplied or by its unique attributes eg: qualifiedName", |
| "operationId" : "createOrUpdate", |
| "consumes" : [ "application/json" ], |
| "produces" : [ "application/json" ], |
| "parameters" : [ |
| { |
| "name" : "body", |
| "required" : false, |
| "in" : "body", |
| "schema" : { |
| "$ref" : "#/definitions/AtlasEntitiesWithExtInfo", |
| "description" : "" |
| }, |
| "description" : "" |
| } |
| ], |
| "responses" : { |
| "201" : { |
| "schema" : { |
| "$ref" : "#/definitions/EntityMutationResponse", |
| "description" : "" |
| }, |
| "examples" : { |
| "application/json" : { |
| "guidAssignments" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "mutatedEntities" : { |
| "property1" : [ { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "VALIDATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "PROPOSED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "PROPOSED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "property2" : [ { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "IMPORTED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "IMPORTED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "PROPOSED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "IMPORTED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ] |
| }, |
| "partialUpdatedEntities" : [ { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "PROPOSED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ] |
| } |
| }, |
| "description" : "" |
| } |
| } |
| } |
| }, |
| "\/v2/entity/bulk/classification" : { |
| "post" : { |
| "tags" : [ "EntityREST" ], |
| "description" : "Bulk API to associate a tag to multiple entities.\nOption 1: List of GUIDs to associate a tag\nOption 2: Typename and list of uniq attributes for entities to associate a tag\nOption 3: List of GUIDs and Typename with list of uniq attributes for entities to associate a tag", |
| "operationId" : "addClassification", |
| "consumes" : [ "application/json" ], |
| "parameters" : [ |
| { |
| "name" : "body", |
| "required" : false, |
| "in" : "body", |
| "schema" : { |
| "$ref" : "#/definitions/ClassificationAssociateRequest", |
| "description" : "" |
| }, |
| "description" : "" |
| } |
| ], |
| "responses" : { |
| "201" : { |
| "description" : "Success" |
| } |
| } |
| } |
| }, |
| "\/v2/entity/bulk/headers" : { |
| "get" : { |
| "tags" : [ "EntityREST" ], |
| "operationId" : "getEntityHeaders", |
| "produces" : [ "application/json" ], |
| "parameters" : [ |
| { |
| "name" : "tagUpdateStartTime", |
| "in" : "query", |
| "required" : true, |
| "type" : "integer", |
| "format" : "int64", |
| "description" : "" |
| } |
| ], |
| "responses" : { |
| "200" : { |
| "schema" : { |
| "$ref" : "#/definitions/AtlasEntityHeaders", |
| "description" : "" |
| }, |
| "examples" : { |
| "application/json" : { |
| "guidHeaderMap" : { |
| "property1" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DISCOVERED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "property2" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "IMPORTED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } |
| } |
| } |
| }, |
| "description" : "" |
| } |
| } |
| } |
| }, |
| "\/v2/entity/bulk/setClassifications" : { |
| "post" : { |
| "tags" : [ "EntityREST" ], |
| "operationId" : "setClassifications", |
| "consumes" : [ "application/json" ], |
| "produces" : [ "application/json" ], |
| "parameters" : [ |
| { |
| "name" : "body", |
| "required" : false, |
| "in" : "body", |
| "schema" : { |
| "$ref" : "#/definitions/AtlasEntityHeaders", |
| "description" : "" |
| }, |
| "description" : "" |
| } |
| ], |
| "responses" : { |
| "201" : { |
| "schema" : { |
| "description" : "", |
| "type" : "string" |
| }, |
| "description" : "" |
| } |
| } |
| } |
| }, |
| "\/v2/entity/bulk/uniqueAttribute/type/{typeName}" : { |
| "get" : { |
| "tags" : [ "EntityREST" ], |
| "description" : "Bulk API to retrieve list of entities identified by its unique attributes.\n\nIn addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format\n\ntypeName=<typeName>&attr_1:<attrName>=<attrValue>&attr_2:<attrName>=<attrValue>&attr_3:<attrName>=<attrValue>\n\nNOTE: The attrName should be an unique attribute for the given entity-type\n\nThe REST request would look something like this\n\nGET /v2/entity/bulk/uniqueAttribute/type/hive_db?attr_0:qualifiedName=db1@cl1&attr_2:qualifiedName=db2@cl1", |
| "operationId" : "getEntitiesByUniqueAttributes", |
| "produces" : [ "application/json" ], |
| "parameters" : [ |
| { |
| "name" : "typeName", |
| "in" : "path", |
| "type" : "string", |
| "description" : "" |
| }, |
| { |
| "name" : "ignoreRelationships", |
| "in" : "query", |
| "default" : "false", |
| "type" : "boolean", |
| "description" : "" |
| }, |
| { |
| "name" : "minExtInfo", |
| "in" : "query", |
| "default" : "false", |
| "type" : "boolean", |
| "description" : "" |
| } |
| ], |
| "responses" : { |
| "200" : { |
| "schema" : { |
| "$ref" : "#/definitions/AtlasEntitiesWithExtInfo", |
| "description" : "AtlasEntitiesWithExtInfo" |
| }, |
| "examples" : { |
| "application/json" : { |
| "entities" : [ { |
| "businessAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "customAttributes" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "guid" : "...", |
| "homeId" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "PROPOSED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "pendingTasks" : [ "...", "..." ], |
| "provenanceType" : 12345, |
| "proxy" : true, |
| "relationshipAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "status" : "PURGED", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "businessAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "customAttributes" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "guid" : "...", |
| "homeId" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "VALIDATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "VALIDATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "pendingTasks" : [ "...", "..." ], |
| "provenanceType" : 12345, |
| "proxy" : true, |
| "relationshipAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "status" : "DELETED", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "referredEntities" : { |
| "property1" : { |
| "businessAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "customAttributes" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "guid" : "...", |
| "homeId" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "PROPOSED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DISCOVERED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "pendingTasks" : [ "...", "..." ], |
| "provenanceType" : 12345, |
| "proxy" : true, |
| "relationshipAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "status" : "DELETED", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "property2" : { |
| "businessAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "customAttributes" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "guid" : "...", |
| "homeId" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DISCOVERED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DISCOVERED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "pendingTasks" : [ "...", "..." ], |
| "provenanceType" : 12345, |
| "proxy" : true, |
| "relationshipAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "status" : "DELETED", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } |
| } |
| } |
| }, |
| "description" : "AtlasEntitiesWithExtInfo" |
| } |
| } |
| } |
| }, |
| "\/v2/entity/businessmetadata/import" : { |
| "post" : { |
| "tags" : [ "EntityREST" ], |
| "description" : "Upload the file for creating Business Metadata in BULK", |
| "operationId" : "importBMAttributes", |
| "consumes" : [ "multipart/form-data" ], |
| "produces" : [ "application/json" ], |
| "parameters" : [ |
| { |
| "name" : "fileDetail", |
| "in" : "formData", |
| "type" : "file", |
| "description" : "FormDataContentDisposition metadata of file" |
| }, |
| { |
| "name" : "uploadedInputStream", |
| "in" : "formData", |
| "type" : "file", |
| "description" : "InputStream of file" |
| }, |
| { |
| "name" : "body", |
| "required" : false, |
| "in" : "body", |
| "type" : "file", |
| "description" : "" |
| } |
| ], |
| "responses" : { |
| "200" : { |
| "schema" : { |
| "$ref" : "#/definitions/BulkImportResponse", |
| "description" : "If Business Metadata creation was successful" |
| }, |
| "examples" : { |
| "application/json" : { |
| "failedImportInfoList" : [ { |
| "childObjectName" : "...", |
| "importStatus" : "FAILED", |
| "parentObjectName" : "...", |
| "remarks" : "..." |
| }, { |
| "childObjectName" : "...", |
| "importStatus" : "SUCCESS", |
| "parentObjectName" : "...", |
| "remarks" : "..." |
| } ], |
| "successImportInfoList" : [ { |
| "childObjectName" : "...", |
| "importStatus" : "SUCCESS", |
| "parentObjectName" : "...", |
| "remarks" : "..." |
| }, { |
| "childObjectName" : "...", |
| "importStatus" : "FAILED", |
| "parentObjectName" : "...", |
| "remarks" : "..." |
| } ] |
| } |
| }, |
| "description" : "If Business Metadata creation was successful" |
| }, |
| "400" : { |
| "examples" : { |
| "application/json" : { |
| "failedImportInfoList" : [ { |
| "childObjectName" : "...", |
| "importStatus" : "SUCCESS", |
| "parentObjectName" : "...", |
| "remarks" : "..." |
| }, { |
| "childObjectName" : "...", |
| "importStatus" : "FAILED", |
| "parentObjectName" : "...", |
| "remarks" : "..." |
| } ], |
| "successImportInfoList" : [ { |
| "childObjectName" : "...", |
| "importStatus" : "FAILED", |
| "parentObjectName" : "...", |
| "remarks" : "..." |
| }, { |
| "childObjectName" : "...", |
| "importStatus" : "SUCCESS", |
| "parentObjectName" : "...", |
| "remarks" : "..." |
| } ] |
| } |
| }, |
| "description" : "If Business Metadata definition has invalid or missing information" |
| }, |
| "409" : { |
| "examples" : { |
| "application/json" : { |
| "failedImportInfoList" : [ { |
| "childObjectName" : "...", |
| "importStatus" : "SUCCESS", |
| "parentObjectName" : "...", |
| "remarks" : "..." |
| }, { |
| "childObjectName" : "...", |
| "importStatus" : "FAILED", |
| "parentObjectName" : "...", |
| "remarks" : "..." |
| } ], |
| "successImportInfoList" : [ { |
| "childObjectName" : "...", |
| "importStatus" : "FAILED", |
| "parentObjectName" : "...", |
| "remarks" : "..." |
| }, { |
| "childObjectName" : "...", |
| "importStatus" : "FAILED", |
| "parentObjectName" : "...", |
| "remarks" : "..." |
| } ] |
| } |
| }, |
| "description" : "If Business Metadata already exists (duplicate qualifiedName)" |
| } |
| } |
| } |
| }, |
| "\/v2/entity/businessmetadata/import/template" : { |
| "get" : { |
| "tags" : [ "EntityREST" ], |
| "description" : "Get the sample Template for uploading/creating bulk BusinessMetaData", |
| "operationId" : "produceTemplate", |
| "produces" : [ "application/octet-stream" ], |
| "parameters" : [ |
| ], |
| "responses" : { |
| "200" : { |
| "schema" : { |
| "description" : "Template File", |
| "type" : "file" |
| }, |
| "description" : "Template File" |
| }, |
| "400" : { |
| "description" : "If the provided fileType is not supported" |
| } |
| } |
| } |
| }, |
| "\/v2/entity/guid/{guid}" : { |
| "delete" : { |
| "tags" : [ "EntityREST" ], |
| "description" : "Delete an entity identified by its GUID.", |
| "operationId" : "deleteByGuid", |
| "produces" : [ "application/json" ], |
| "parameters" : [ |
| { |
| "name" : "guid", |
| "in" : "path", |
| "type" : "string", |
| "description" : "GUID for the entity" |
| } |
| ], |
| "responses" : { |
| "204" : { |
| "schema" : { |
| "$ref" : "#/definitions/EntityMutationResponse", |
| "description" : "EntityMutationResponse" |
| }, |
| "examples" : { |
| "application/json" : { |
| "guidAssignments" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "mutatedEntities" : { |
| "property1" : [ { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "IMPORTED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "PROPOSED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "IMPORTED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "VALIDATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "property2" : [ { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "VALIDATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ] |
| }, |
| "partialUpdatedEntities" : [ { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "PROPOSED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "PROPOSED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ] |
| } |
| }, |
| "description" : "EntityMutationResponse" |
| } |
| } |
| }, |
| "get" : { |
| "tags" : [ "EntityREST" ], |
| "description" : "Fetch complete definition of an entity given its GUID.", |
| "operationId" : "getById", |
| "produces" : [ "application/json" ], |
| "parameters" : [ |
| { |
| "name" : "guid", |
| "in" : "path", |
| "type" : "string", |
| "description" : "GUID for the entity" |
| }, |
| { |
| "name" : "ignoreRelationships", |
| "in" : "query", |
| "default" : "false", |
| "type" : "boolean", |
| "description" : "" |
| }, |
| { |
| "name" : "minExtInfo", |
| "in" : "query", |
| "default" : "false", |
| "type" : "boolean", |
| "description" : "" |
| } |
| ], |
| "responses" : { |
| "200" : { |
| "schema" : { |
| "$ref" : "#/definitions/AtlasEntityWithExtInfo", |
| "description" : "AtlasEntity" |
| }, |
| "examples" : { |
| "application/json" : { |
| "entity" : { |
| "businessAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "customAttributes" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "guid" : "...", |
| "homeId" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "IMPORTED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "pendingTasks" : [ "...", "..." ], |
| "provenanceType" : 12345, |
| "proxy" : true, |
| "relationshipAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "status" : "DELETED", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "referredEntities" : { |
| "property1" : { |
| "businessAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "customAttributes" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "guid" : "...", |
| "homeId" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "pendingTasks" : [ "...", "..." ], |
| "provenanceType" : 12345, |
| "proxy" : true, |
| "relationshipAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "status" : "ACTIVE", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "property2" : { |
| "businessAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "customAttributes" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "guid" : "...", |
| "homeId" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "VALIDATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "pendingTasks" : [ "...", "..." ], |
| "provenanceType" : 12345, |
| "proxy" : true, |
| "relationshipAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "status" : "PURGED", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } |
| } |
| } |
| }, |
| "description" : "AtlasEntity" |
| } |
| } |
| }, |
| "put" : { |
| "tags" : [ "EntityREST" ], |
| "description" : "Entity Partial Update - Add/Update entity attribute identified by its GUID.\nSupports only uprimitive attribute type and entity references.\ndoes not support updation of complex types like arrays, maps\nNull updates are not possible", |
| "operationId" : "partialUpdateEntityAttrByGuid", |
| "consumes" : [ "application/json" ], |
| "produces" : [ "application/json" ], |
| "parameters" : [ |
| { |
| "name" : "guid", |
| "in" : "path", |
| "type" : "string", |
| "description" : "" |
| }, |
| { |
| "name" : "name", |
| "in" : "query", |
| "type" : "string", |
| "description" : "" |
| }, |
| { |
| "name" : "body", |
| "required" : false, |
| "in" : "body", |
| "schema" : { |
| "description" : "", |
| "type" : "file" |
| }, |
| "description" : "" |
| } |
| ], |
| "responses" : { |
| "204" : { |
| "schema" : { |
| "$ref" : "#/definitions/EntityMutationResponse", |
| "description" : "" |
| }, |
| "examples" : { |
| "application/json" : { |
| "guidAssignments" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "mutatedEntities" : { |
| "property1" : [ { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "IMPORTED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DISCOVERED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "IMPORTED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "property2" : [ { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "VALIDATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DISCOVERED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ] |
| }, |
| "partialUpdatedEntities" : [ { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DISCOVERED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "PROPOSED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "VALIDATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ] |
| } |
| }, |
| "description" : "" |
| } |
| } |
| } |
| }, |
| "\/v2/entity/guid/{guid}/businessmetadata" : { |
| "delete" : { |
| "tags" : [ "EntityREST" ], |
| "operationId" : "removeBusinessAttributes", |
| "consumes" : [ "application/json" ], |
| "parameters" : [ |
| { |
| "name" : "guid", |
| "in" : "path", |
| "type" : "string", |
| "description" : "" |
| }, |
| { |
| "name" : "body", |
| "required" : false, |
| "in" : "body", |
| "schema" : { |
| "description" : "", |
| "type" : "object", |
| "additionalProperties" : { |
| "type" : "object" |
| } |
| }, |
| "description" : "" |
| } |
| ], |
| "responses" : { |
| "204" : { |
| "description" : "Success" |
| } |
| } |
| }, |
| "post" : { |
| "tags" : [ "EntityREST" ], |
| "operationId" : "addOrUpdateBusinessAttributes", |
| "consumes" : [ "application/json" ], |
| "parameters" : [ |
| { |
| "name" : "guid", |
| "in" : "path", |
| "type" : "string", |
| "description" : "" |
| }, |
| { |
| "name" : "isOverwrite", |
| "in" : "query", |
| "default" : "false", |
| "type" : "boolean", |
| "description" : "" |
| }, |
| { |
| "name" : "body", |
| "required" : false, |
| "in" : "body", |
| "schema" : { |
| "description" : "", |
| "type" : "object", |
| "additionalProperties" : { |
| "type" : "object" |
| } |
| }, |
| "description" : "" |
| } |
| ], |
| "responses" : { |
| "201" : { |
| "description" : "Success" |
| } |
| } |
| } |
| }, |
| "\/v2/entity/guid/{guid}/businessmetadata/{bmName}" : { |
| "delete" : { |
| "tags" : [ "EntityREST" ], |
| "operationId" : "removeBusinessAttributes", |
| "consumes" : [ "application/json" ], |
| "parameters" : [ |
| { |
| "name" : "bmName", |
| "in" : "path", |
| "type" : "string", |
| "description" : "" |
| }, |
| { |
| "name" : "guid", |
| "in" : "path", |
| "type" : "string", |
| "description" : "" |
| }, |
| { |
| "name" : "body", |
| "required" : false, |
| "in" : "body", |
| "schema" : { |
| "description" : "", |
| "type" : "object", |
| "additionalProperties" : { |
| "type" : "object" |
| } |
| }, |
| "description" : "" |
| } |
| ], |
| "responses" : { |
| "204" : { |
| "description" : "Success" |
| } |
| } |
| }, |
| "post" : { |
| "tags" : [ "EntityREST" ], |
| "operationId" : "addOrUpdateBusinessAttributes", |
| "consumes" : [ "application/json" ], |
| "parameters" : [ |
| { |
| "name" : "bmName", |
| "in" : "path", |
| "type" : "string", |
| "description" : "" |
| }, |
| { |
| "name" : "guid", |
| "in" : "path", |
| "type" : "string", |
| "description" : "" |
| }, |
| { |
| "name" : "body", |
| "required" : false, |
| "in" : "body", |
| "schema" : { |
| "description" : "", |
| "type" : "object", |
| "additionalProperties" : { |
| "type" : "object" |
| } |
| }, |
| "description" : "" |
| } |
| ], |
| "responses" : { |
| "201" : { |
| "description" : "Success" |
| } |
| } |
| } |
| }, |
| "\/v2/entity/guid/{guid}/classification/{classificationName}" : { |
| "delete" : { |
| "tags" : [ "EntityREST" ], |
| "description" : "Deletes a given classification from an existing entity represented by a guid.", |
| "operationId" : "deleteClassification", |
| "parameters" : [ |
| { |
| "name" : "classificationName", |
| "in" : "path", |
| "type" : "string", |
| "description" : "name of the classifcation" |
| }, |
| { |
| "name" : "guid", |
| "in" : "path", |
| "type" : "string", |
| "description" : "globally unique identifier for the entity" |
| }, |
| { |
| "name" : "associatedEntityGuid", |
| "in" : "query", |
| "type" : "string", |
| "description" : "" |
| } |
| ], |
| "responses" : { |
| "204" : { |
| "description" : "Success" |
| } |
| } |
| }, |
| "get" : { |
| "tags" : [ "EntityREST" ], |
| "description" : "Gets the list of classifications for a given entity represented by a guid.", |
| "operationId" : "getClassification", |
| "produces" : [ "application/json" ], |
| "parameters" : [ |
| { |
| "name" : "classificationName", |
| "in" : "path", |
| "type" : "string", |
| "description" : "" |
| }, |
| { |
| "name" : "guid", |
| "in" : "path", |
| "type" : "string", |
| "description" : "globally unique identifier for the entity" |
| } |
| ], |
| "responses" : { |
| "200" : { |
| "schema" : { |
| "$ref" : "#/definitions/AtlasClassification", |
| "description" : "classification for the given entity guid" |
| }, |
| "examples" : { |
| "application/json" : { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } |
| }, |
| "description" : "classification for the given entity guid" |
| } |
| } |
| } |
| }, |
| "\/v2/entity/guid/{guid}/classifications" : { |
| "get" : { |
| "tags" : [ "EntityREST" ], |
| "description" : "Gets the list of classifications for a given entity represented by a guid.", |
| "operationId" : "getClassifications", |
| "produces" : [ "application/json" ], |
| "parameters" : [ |
| { |
| "name" : "guid", |
| "in" : "path", |
| "type" : "string", |
| "description" : "globally unique identifier for the entity" |
| } |
| ], |
| "responses" : { |
| "200" : { |
| "schema" : { |
| "$ref" : "#/definitions/AtlasClassifications", |
| "description" : "a list of classifications for the given entity guid" |
| }, |
| "examples" : { |
| "application/json" : { |
| "list" : [ { }, { } ], |
| "pageSize" : 12345, |
| "sortBy" : "...", |
| "sortType" : "ASC", |
| "startIndex" : 12345, |
| "totalCount" : 12345 |
| } |
| }, |
| "description" : "a list of classifications for the given entity guid" |
| } |
| } |
| }, |
| "post" : { |
| "tags" : [ "EntityREST" ], |
| "description" : "Adds classifications to an existing entity represented by a guid.", |
| "operationId" : "addClassifications", |
| "consumes" : [ "application/json" ], |
| "parameters" : [ |
| { |
| "name" : "guid", |
| "in" : "path", |
| "type" : "string", |
| "description" : "globally unique identifier for the entity" |
| }, |
| { |
| "name" : "body", |
| "required" : false, |
| "in" : "body", |
| "schema" : { |
| "description" : "", |
| "type" : "array", |
| "items" : { |
| "$ref" : "#/definitions/AtlasClassification" |
| } |
| }, |
| "description" : "" |
| } |
| ], |
| "responses" : { |
| "201" : { |
| "description" : "Success" |
| } |
| } |
| }, |
| "put" : { |
| "tags" : [ "EntityREST" ], |
| "description" : "Updates classifications to an existing entity represented by a guid.", |
| "operationId" : "updateClassifications", |
| "consumes" : [ "application/json" ], |
| "parameters" : [ |
| { |
| "name" : "guid", |
| "in" : "path", |
| "type" : "string", |
| "description" : "globally unique identifier for the entity" |
| }, |
| { |
| "name" : "body", |
| "required" : false, |
| "in" : "body", |
| "schema" : { |
| "description" : "", |
| "type" : "array", |
| "items" : { |
| "$ref" : "#/definitions/AtlasClassification" |
| } |
| }, |
| "description" : "" |
| } |
| ], |
| "responses" : { |
| "204" : { |
| "description" : "Success" |
| } |
| } |
| } |
| }, |
| "\/v2/entity/guid/{guid}/header" : { |
| "get" : { |
| "tags" : [ "EntityREST" ], |
| "description" : "Get entity header given its GUID.", |
| "operationId" : "getHeaderById", |
| "produces" : [ "application/json" ], |
| "parameters" : [ |
| { |
| "name" : "guid", |
| "in" : "path", |
| "type" : "string", |
| "description" : "GUID for the entity" |
| } |
| ], |
| "responses" : { |
| "200" : { |
| "schema" : { |
| "$ref" : "#/definitions/AtlasEntityHeader", |
| "description" : "AtlasEntity" |
| }, |
| "examples" : { |
| "application/json" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "IMPORTED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } |
| }, |
| "description" : "AtlasEntity" |
| } |
| } |
| } |
| }, |
| "\/v2/entity/guid/{guid}/labels" : { |
| "delete" : { |
| "tags" : [ "EntityREST" ], |
| "description" : "delete given labels to a given entity", |
| "operationId" : "removeLabels", |
| "consumes" : [ "application/json" ], |
| "parameters" : [ |
| { |
| "name" : "guid", |
| "in" : "path", |
| "type" : "string", |
| "description" : "- Unique entity identifier" |
| }, |
| { |
| "name" : "body", |
| "required" : false, |
| "in" : "body", |
| "schema" : { |
| "description" : "", |
| "type" : "array", |
| "items" : { |
| "type" : "string" |
| } |
| }, |
| "description" : "" |
| } |
| ], |
| "responses" : { |
| "204" : { |
| "description" : "Success" |
| } |
| } |
| }, |
| "post" : { |
| "tags" : [ "EntityREST" ], |
| "description" : "Set labels to a given entity", |
| "operationId" : "setLabels", |
| "consumes" : [ "application/json" ], |
| "parameters" : [ |
| { |
| "name" : "guid", |
| "in" : "path", |
| "type" : "string", |
| "description" : "- Unique entity identifier" |
| }, |
| { |
| "name" : "body", |
| "required" : false, |
| "in" : "body", |
| "schema" : { |
| "description" : "- set of labels to be set to the entity", |
| "type" : "array", |
| "items" : { |
| "type" : "string" |
| } |
| }, |
| "description" : "- set of labels to be set to the entity" |
| } |
| ], |
| "responses" : { |
| "201" : { |
| "description" : "Success" |
| } |
| } |
| }, |
| "put" : { |
| "tags" : [ "EntityREST" ], |
| "description" : "add given labels to a given entity", |
| "operationId" : "addLabels", |
| "consumes" : [ "application/json" ], |
| "parameters" : [ |
| { |
| "name" : "guid", |
| "in" : "path", |
| "type" : "string", |
| "description" : "- Unique entity identifier" |
| }, |
| { |
| "name" : "body", |
| "required" : false, |
| "in" : "body", |
| "schema" : { |
| "description" : "", |
| "type" : "array", |
| "items" : { |
| "type" : "string" |
| } |
| }, |
| "description" : "" |
| } |
| ], |
| "responses" : { |
| "204" : { |
| "description" : "Success" |
| } |
| } |
| } |
| }, |
| "\/v2/entity/uniqueAttribute/type/{typeName}" : { |
| "delete" : { |
| "tags" : [ "EntityREST" ], |
| "description" : "Delete an entity identified by its type and unique attributes.\n\nIn addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format\n\nattr:<attrName>=<attrValue>\n\nNOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName\n\nThe REST request would look something like this\n\nDELETE /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue", |
| "operationId" : "deleteByUniqueAttribute", |
| "produces" : [ "application/json" ], |
| "parameters" : [ |
| { |
| "name" : "typeName", |
| "in" : "path", |
| "type" : "string", |
| "description" : "- entity type to be deleted" |
| } |
| ], |
| "responses" : { |
| "204" : { |
| "schema" : { |
| "$ref" : "#/definitions/EntityMutationResponse", |
| "description" : "EntityMutationResponse" |
| }, |
| "examples" : { |
| "application/json" : { |
| "guidAssignments" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "mutatedEntities" : { |
| "property1" : [ { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "PROPOSED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "VALIDATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "PROPOSED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "property2" : [ { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "PROPOSED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ] |
| }, |
| "partialUpdatedEntities" : [ { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "PROPOSED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "PROPOSED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "VALIDATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ] |
| } |
| }, |
| "description" : "EntityMutationResponse" |
| } |
| } |
| }, |
| "get" : { |
| "tags" : [ "EntityREST" ], |
| "description" : "Fetch complete definition of an entity given its type and unique attribute.\n\nIn addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format\n\nattr:<attrName>=<attrValue>\n\nNOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName\n\nThe REST request would look something like this\n\nGET /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue", |
| "operationId" : "getByUniqueAttributes", |
| "produces" : [ "application/json" ], |
| "parameters" : [ |
| { |
| "name" : "typeName", |
| "in" : "path", |
| "type" : "string", |
| "description" : "" |
| }, |
| { |
| "name" : "ignoreRelationships", |
| "in" : "query", |
| "default" : "false", |
| "type" : "boolean", |
| "description" : "" |
| }, |
| { |
| "name" : "minExtInfo", |
| "in" : "query", |
| "default" : "false", |
| "type" : "boolean", |
| "description" : "" |
| } |
| ], |
| "responses" : { |
| "200" : { |
| "schema" : { |
| "$ref" : "#/definitions/AtlasEntityWithExtInfo", |
| "description" : "AtlasEntityWithExtInfo" |
| }, |
| "examples" : { |
| "application/json" : { |
| "entity" : { |
| "businessAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "customAttributes" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "guid" : "...", |
| "homeId" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "VALIDATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "PROPOSED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "pendingTasks" : [ "...", "..." ], |
| "provenanceType" : 12345, |
| "proxy" : true, |
| "relationshipAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "status" : "ACTIVE", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "referredEntities" : { |
| "property1" : { |
| "businessAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "customAttributes" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "guid" : "...", |
| "homeId" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "VALIDATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "pendingTasks" : [ "...", "..." ], |
| "provenanceType" : 12345, |
| "proxy" : true, |
| "relationshipAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "status" : "PURGED", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "property2" : { |
| "businessAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "customAttributes" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "guid" : "...", |
| "homeId" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DISCOVERED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "pendingTasks" : [ "...", "..." ], |
| "provenanceType" : 12345, |
| "proxy" : true, |
| "relationshipAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "status" : "PURGED", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } |
| } |
| } |
| }, |
| "description" : "AtlasEntityWithExtInfo" |
| } |
| } |
| }, |
| "put" : { |
| "tags" : [ "EntityREST" ], |
| "description" : "Entity Partial Update - Allows a subset of attributes to be updated on\nan entity which is identified by its type and unique attribute eg: Referenceable.qualifiedName.\nNull updates are not possible\n\nIn addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format\n\nattr:<attrName>=<attrValue>\n\nNOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName\n\nThe REST request would look something like this\n\nPUT /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue", |
| "operationId" : "partialUpdateEntityByUniqueAttrs", |
| "consumes" : [ "application/json" ], |
| "produces" : [ "application/json" ], |
| "parameters" : [ |
| { |
| "name" : "typeName", |
| "in" : "path", |
| "type" : "string", |
| "description" : "" |
| }, |
| { |
| "name" : "body", |
| "required" : false, |
| "in" : "body", |
| "schema" : { |
| "$ref" : "#/definitions/AtlasEntityWithExtInfo", |
| "description" : "" |
| }, |
| "description" : "" |
| } |
| ], |
| "responses" : { |
| "204" : { |
| "schema" : { |
| "$ref" : "#/definitions/EntityMutationResponse", |
| "description" : "" |
| }, |
| "examples" : { |
| "application/json" : { |
| "guidAssignments" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "mutatedEntities" : { |
| "property1" : [ { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "PROPOSED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "property2" : [ { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "PROPOSED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "VALIDATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ] |
| }, |
| "partialUpdatedEntities" : [ { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "IMPORTED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "IMPORTED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "IMPORTED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ] |
| } |
| }, |
| "description" : "" |
| } |
| } |
| } |
| }, |
| "\/v2/entity/uniqueAttribute/type/{typeName}/classification/{classificationName}" : { |
| "delete" : { |
| "tags" : [ "EntityREST" ], |
| "description" : "Deletes a given classification from an entity identified by its type and unique attributes.", |
| "operationId" : "deleteClassificationByUniqueAttribute", |
| "parameters" : [ |
| { |
| "name" : "classificationName", |
| "in" : "path", |
| "type" : "string", |
| "description" : "name of the classification" |
| }, |
| { |
| "name" : "typeName", |
| "in" : "path", |
| "type" : "string", |
| "description" : "" |
| } |
| ], |
| "responses" : { |
| "204" : { |
| "description" : "Success" |
| } |
| } |
| } |
| }, |
| "\/v2/entity/uniqueAttribute/type/{typeName}/classifications" : { |
| "post" : { |
| "tags" : [ "EntityREST" ], |
| "description" : "Adds classification to the entity identified by its type and unique attributes.", |
| "operationId" : "addClassificationsByUniqueAttribute", |
| "consumes" : [ "application/json" ], |
| "parameters" : [ |
| { |
| "name" : "typeName", |
| "in" : "path", |
| "type" : "string", |
| "description" : "" |
| }, |
| { |
| "name" : "body", |
| "required" : false, |
| "in" : "body", |
| "schema" : { |
| "description" : "", |
| "type" : "array", |
| "items" : { |
| "$ref" : "#/definitions/AtlasClassification" |
| } |
| }, |
| "description" : "" |
| } |
| ], |
| "responses" : { |
| "201" : { |
| "description" : "Success" |
| } |
| } |
| }, |
| "put" : { |
| "tags" : [ "EntityREST" ], |
| "description" : "Updates classification on an entity identified by its type and unique attributes.", |
| "operationId" : "updateClassificationsByUniqueAttribute", |
| "consumes" : [ "application/json" ], |
| "parameters" : [ |
| { |
| "name" : "typeName", |
| "in" : "path", |
| "type" : "string", |
| "description" : "" |
| }, |
| { |
| "name" : "body", |
| "required" : false, |
| "in" : "body", |
| "schema" : { |
| "description" : "", |
| "type" : "array", |
| "items" : { |
| "$ref" : "#/definitions/AtlasClassification" |
| } |
| }, |
| "description" : "" |
| } |
| ], |
| "responses" : { |
| "204" : { |
| "description" : "Success" |
| } |
| } |
| } |
| }, |
| "\/v2/entity/uniqueAttribute/type/{typeName}/header" : { |
| "get" : { |
| "tags" : [ "EntityREST" ], |
| "description" : "Fetch AtlasEntityHeader given its type and unique attribute.\n\nIn addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format\n\nattr:<attrName>=<attrValue>\n\nNOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName\n\nThe REST request would look something like this\n\nGET /v2/entity/uniqueAttribute/type/aType/header?attr:aTypeAttribute=someValue", |
| "operationId" : "getEntityHeaderByUniqueAttributes", |
| "produces" : [ "application/json" ], |
| "parameters" : [ |
| { |
| "name" : "typeName", |
| "in" : "path", |
| "type" : "string", |
| "description" : "" |
| } |
| ], |
| "responses" : { |
| "200" : { |
| "schema" : { |
| "$ref" : "#/definitions/AtlasEntityHeader", |
| "description" : "AtlasEntityHeader" |
| }, |
| "examples" : { |
| "application/json" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "PROPOSED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } |
| }, |
| "description" : "AtlasEntityHeader" |
| } |
| } |
| } |
| }, |
| "\/v2/entity/uniqueAttribute/type/{typeName}/labels" : { |
| "delete" : { |
| "tags" : [ "EntityREST" ], |
| "operationId" : "removeLabels", |
| "consumes" : [ "application/json" ], |
| "parameters" : [ |
| { |
| "name" : "typeName", |
| "in" : "path", |
| "type" : "string", |
| "description" : "" |
| }, |
| { |
| "name" : "body", |
| "required" : false, |
| "in" : "body", |
| "schema" : { |
| "description" : "", |
| "type" : "array", |
| "items" : { |
| "type" : "string" |
| } |
| }, |
| "description" : "" |
| } |
| ], |
| "responses" : { |
| "204" : { |
| "description" : "Success" |
| } |
| } |
| }, |
| "post" : { |
| "tags" : [ "EntityREST" ], |
| "operationId" : "setLabels", |
| "consumes" : [ "application/json" ], |
| "parameters" : [ |
| { |
| "name" : "typeName", |
| "in" : "path", |
| "type" : "string", |
| "description" : "" |
| }, |
| { |
| "name" : "body", |
| "required" : false, |
| "in" : "body", |
| "schema" : { |
| "description" : "", |
| "type" : "array", |
| "items" : { |
| "type" : "string" |
| } |
| }, |
| "description" : "" |
| } |
| ], |
| "responses" : { |
| "201" : { |
| "description" : "Success" |
| } |
| } |
| }, |
| "put" : { |
| "tags" : [ "EntityREST" ], |
| "operationId" : "addLabels", |
| "consumes" : [ "application/json" ], |
| "parameters" : [ |
| { |
| "name" : "typeName", |
| "in" : "path", |
| "type" : "string", |
| "description" : "" |
| }, |
| { |
| "name" : "body", |
| "required" : false, |
| "in" : "body", |
| "schema" : { |
| "description" : "", |
| "type" : "array", |
| "items" : { |
| "type" : "string" |
| } |
| }, |
| "description" : "" |
| } |
| ], |
| "responses" : { |
| "204" : { |
| "description" : "Success" |
| } |
| } |
| } |
| }, |
| "\/v2/entity/{guid}/audit" : { |
| "get" : { |
| "tags" : [ "EntityREST" ], |
| "operationId" : "getAuditEvents", |
| "produces" : [ "application/json" ], |
| "parameters" : [ |
| { |
| "name" : "guid", |
| "in" : "path", |
| "type" : "string", |
| "description" : "" |
| }, |
| { |
| "name" : "auditAction", |
| "in" : "query", |
| "type" : "string", |
| "enum" : ["BUSINESS_ATTRIBUTE_UPDATE", "CLASSIFICATION_ADD", "CLASSIFICATION_DELETE", "CLASSIFICATION_UPDATE", "CUSTOM_ATTRIBUTE_UPDATE", "ENTITY_CREATE", "ENTITY_DELETE", "ENTITY_IMPORT_CREATE", "ENTITY_IMPORT_DELETE", "ENTITY_IMPORT_UPDATE", "ENTITY_PURGE", "ENTITY_UPDATE", "LABEL_ADD", "LABEL_DELETE", "PROPAGATED_CLASSIFICATION_ADD", "PROPAGATED_CLASSIFICATION_DELETE", "PROPAGATED_CLASSIFICATION_UPDATE", "TERM_ADD", "TERM_DELETE"], |
| "description" : "" |
| }, |
| { |
| "name" : "count", |
| "in" : "query", |
| "default" : "100", |
| "type" : "integer", |
| "format" : "int32", |
| "description" : "" |
| }, |
| { |
| "name" : "offset", |
| "in" : "query", |
| "default" : "-1", |
| "type" : "integer", |
| "format" : "int32", |
| "description" : "" |
| }, |
| { |
| "name" : "sortBy", |
| "in" : "query", |
| "type" : "string", |
| "description" : "" |
| }, |
| { |
| "name" : "sortOrder", |
| "in" : "query", |
| "type" : "string", |
| "description" : "" |
| }, |
| { |
| "name" : "startKey", |
| "in" : "query", |
| "type" : "string", |
| "description" : "" |
| } |
| ], |
| "responses" : { |
| "200" : { |
| "schema" : { |
| "description" : "", |
| "type" : "array", |
| "items" : { |
| "$ref" : "#/definitions/EntityAuditEventV2" |
| } |
| }, |
| "examples" : { |
| "application/json" : [ { |
| "action" : "CLASSIFICATION_DELETE", |
| "details" : "...", |
| "entity" : { |
| "businessAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "customAttributes" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "guid" : "...", |
| "homeId" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "PROPOSED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "pendingTasks" : [ "...", "..." ], |
| "provenanceType" : 12345, |
| "proxy" : true, |
| "relationshipAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "status" : "DELETED", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "entityId" : "...", |
| "eventKey" : "...", |
| "timestamp" : 12345, |
| "type" : "ENTITY_AUDIT_V2", |
| "user" : "..." |
| } ] |
| }, |
| "description" : "" |
| } |
| } |
| } |
| }, |
| "\/v2/glossary" : { |
| "get" : { |
| "tags" : [ "GlossaryREST" ], |
| "description" : "Retrieve all glossaries registered with Atlas", |
| "operationId" : "getGlossaries", |
| "produces" : [ "application/json" ], |
| "parameters" : [ |
| { |
| "name" : "limit", |
| "in" : "query", |
| "default" : "-1", |
| "type" : "string", |
| "description" : "page size - by default there is no paging" |
| }, |
| { |
| "name" : "offset", |
| "in" : "query", |
| "default" : "0", |
| "type" : "string", |
| "description" : "offset for pagination purpose" |
| }, |
| { |
| "name" : "sort", |
| "in" : "query", |
| "default" : "ASC", |
| "type" : "string", |
| "description" : "Sort order, ASC (default) or DESC" |
| } |
| ], |
| "responses" : { |
| "200" : { |
| "schema" : { |
| "description" : "List of existing glossaries fitting the search criteria or empty list if nothing matches", |
| "type" : "array", |
| "items" : { |
| "$ref" : "#/definitions/AtlasGlossary" |
| } |
| }, |
| "examples" : { |
| "application/json" : [ { |
| "categories" : [ { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "parentCategoryGuid" : "...", |
| "relationGuid" : "..." |
| }, { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "parentCategoryGuid" : "...", |
| "relationGuid" : "..." |
| } ], |
| "language" : "...", |
| "terms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "usage" : "...", |
| "additionalAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "longDescription" : "...", |
| "name" : "...", |
| "qualifiedName" : "...", |
| "shortDescription" : "...", |
| "guid" : "..." |
| } ] |
| }, |
| "description" : "List of existing glossaries fitting the search criteria or empty list if nothing matches" |
| } |
| } |
| }, |
| "post" : { |
| "tags" : [ "GlossaryREST" ], |
| "description" : "Create a glossary", |
| "operationId" : "createGlossary", |
| "consumes" : [ "application/json" ], |
| "produces" : [ "application/json" ], |
| "parameters" : [ |
| { |
| "name" : "body", |
| "required" : false, |
| "in" : "body", |
| "schema" : { |
| "$ref" : "#/definitions/AtlasGlossary", |
| "description" : "Glossary definition, terms & categories can be anchored to a glossary\nusing the anchor attribute when creating the Term/Category" |
| }, |
| "description" : "Glossary definition, terms & categories can be anchored to a glossary\nusing the anchor attribute when creating the Term/Category" |
| } |
| ], |
| "responses" : { |
| "200" : { |
| "schema" : { |
| "$ref" : "#/definitions/AtlasGlossary", |
| "description" : "If glossary creation was successful" |
| }, |
| "examples" : { |
| "application/json" : { |
| "categories" : [ { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "parentCategoryGuid" : "...", |
| "relationGuid" : "..." |
| }, { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "parentCategoryGuid" : "...", |
| "relationGuid" : "..." |
| } ], |
| "language" : "...", |
| "terms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "usage" : "...", |
| "additionalAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "longDescription" : "...", |
| "name" : "...", |
| "qualifiedName" : "...", |
| "shortDescription" : "...", |
| "guid" : "..." |
| } |
| }, |
| "description" : "If glossary creation was successful" |
| }, |
| "400" : { |
| "examples" : { |
| "application/json" : { |
| "categories" : [ { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "parentCategoryGuid" : "...", |
| "relationGuid" : "..." |
| }, { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "parentCategoryGuid" : "...", |
| "relationGuid" : "..." |
| } ], |
| "language" : "...", |
| "terms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "usage" : "...", |
| "additionalAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "longDescription" : "...", |
| "name" : "...", |
| "qualifiedName" : "...", |
| "shortDescription" : "...", |
| "guid" : "..." |
| } |
| }, |
| "description" : "If Glossary definition has invalid or missing information" |
| }, |
| "409" : { |
| "examples" : { |
| "application/json" : { |
| "categories" : [ { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "parentCategoryGuid" : "...", |
| "relationGuid" : "..." |
| }, { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "parentCategoryGuid" : "...", |
| "relationGuid" : "..." |
| } ], |
| "language" : "...", |
| "terms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "usage" : "...", |
| "additionalAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "longDescription" : "...", |
| "name" : "...", |
| "qualifiedName" : "...", |
| "shortDescription" : "...", |
| "guid" : "..." |
| } |
| }, |
| "description" : "If Glossary definition already exists (duplicate qualifiedName)" |
| } |
| } |
| } |
| }, |
| "\/v2/glossary/categories" : { |
| "post" : { |
| "tags" : [ "GlossaryREST" ], |
| "description" : "Create glossary category in bulk", |
| "operationId" : "createGlossaryCategories", |
| "consumes" : [ "application/json" ], |
| "produces" : [ "application/json" ], |
| "parameters" : [ |
| { |
| "name" : "body", |
| "required" : false, |
| "in" : "body", |
| "schema" : { |
| "description" : "glossary category definitions", |
| "type" : "array", |
| "items" : { |
| "$ref" : "#/definitions/AtlasGlossaryCategory" |
| } |
| }, |
| "description" : "glossary category definitions" |
| } |
| ], |
| "responses" : { |
| "200" : { |
| "schema" : { |
| "description" : "If BULK glossary category creation was successful", |
| "type" : "array", |
| "items" : { |
| "$ref" : "#/definitions/AtlasGlossaryCategory" |
| } |
| }, |
| "examples" : { |
| "application/json" : [ { |
| "anchor" : { |
| "displayText" : "...", |
| "glossaryGuid" : "...", |
| "relationGuid" : "..." |
| }, |
| "childrenCategories" : [ { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "parentCategoryGuid" : "...", |
| "relationGuid" : "..." |
| }, { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "parentCategoryGuid" : "...", |
| "relationGuid" : "..." |
| } ], |
| "parentCategory" : { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "parentCategoryGuid" : "...", |
| "relationGuid" : "..." |
| }, |
| "terms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "additionalAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "longDescription" : "...", |
| "name" : "...", |
| "qualifiedName" : "...", |
| "shortDescription" : "...", |
| "guid" : "..." |
| } ] |
| }, |
| "description" : "If BULK glossary category creation was successful" |
| }, |
| "400" : { |
| "examples" : { |
| "application/json" : [ { |
| "anchor" : { |
| "displayText" : "...", |
| "glossaryGuid" : "...", |
| "relationGuid" : "..." |
| }, |
| "childrenCategories" : [ { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "parentCategoryGuid" : "...", |
| "relationGuid" : "..." |
| }, { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "parentCategoryGuid" : "...", |
| "relationGuid" : "..." |
| } ], |
| "parentCategory" : { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "parentCategoryGuid" : "...", |
| "relationGuid" : "..." |
| }, |
| "terms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "additionalAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "longDescription" : "...", |
| "name" : "...", |
| "qualifiedName" : "...", |
| "shortDescription" : "...", |
| "guid" : "..." |
| } ] |
| }, |
| "description" : "If ANY Glossary category definition has invalid or missing information" |
| } |
| } |
| } |
| }, |
| "\/v2/glossary/category" : { |
| "post" : { |
| "tags" : [ "GlossaryREST" ], |
| "description" : "Create glossary category", |
| "operationId" : "createGlossaryCategory", |
| "consumes" : [ "application/json" ], |
| "produces" : [ "application/json" ], |
| "parameters" : [ |
| { |
| "name" : "body", |
| "required" : false, |
| "in" : "body", |
| "schema" : { |
| "$ref" : "#/definitions/AtlasGlossaryCategory", |
| "description" : "glossary category definition, a category must be anchored to a Glossary when creating\nOptionally, terms belonging to the category and the hierarchy can also be defined during creation" |
| }, |
| "description" : "glossary category definition, a category must be anchored to a Glossary when creating\nOptionally, terms belonging to the category and the hierarchy can also be defined during creation" |
| } |
| ], |
| "responses" : { |
| "200" : { |
| "schema" : { |
| "$ref" : "#/definitions/AtlasGlossaryCategory", |
| "description" : "If glossary category creation was successful" |
| }, |
| "examples" : { |
| "application/json" : { |
| "anchor" : { |
| "displayText" : "...", |
| "glossaryGuid" : "...", |
| "relationGuid" : "..." |
| }, |
| "childrenCategories" : [ { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "parentCategoryGuid" : "...", |
| "relationGuid" : "..." |
| }, { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "parentCategoryGuid" : "...", |
| "relationGuid" : "..." |
| } ], |
| "parentCategory" : { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "parentCategoryGuid" : "...", |
| "relationGuid" : "..." |
| }, |
| "terms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "additionalAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "longDescription" : "...", |
| "name" : "...", |
| "qualifiedName" : "...", |
| "shortDescription" : "...", |
| "guid" : "..." |
| } |
| }, |
| "description" : "If glossary category creation was successful" |
| }, |
| "400" : { |
| "examples" : { |
| "application/json" : { |
| "anchor" : { |
| "displayText" : "...", |
| "glossaryGuid" : "...", |
| "relationGuid" : "..." |
| }, |
| "childrenCategories" : [ { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "parentCategoryGuid" : "...", |
| "relationGuid" : "..." |
| }, { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "parentCategoryGuid" : "...", |
| "relationGuid" : "..." |
| } ], |
| "parentCategory" : { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "parentCategoryGuid" : "...", |
| "relationGuid" : "..." |
| }, |
| "terms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "additionalAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "longDescription" : "...", |
| "name" : "...", |
| "qualifiedName" : "...", |
| "shortDescription" : "...", |
| "guid" : "..." |
| } |
| }, |
| "description" : "If Glossary category definition has invalid or missing information" |
| }, |
| "409" : { |
| "examples" : { |
| "application/json" : { |
| "anchor" : { |
| "displayText" : "...", |
| "glossaryGuid" : "...", |
| "relationGuid" : "..." |
| }, |
| "childrenCategories" : [ { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "parentCategoryGuid" : "...", |
| "relationGuid" : "..." |
| }, { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "parentCategoryGuid" : "...", |
| "relationGuid" : "..." |
| } ], |
| "parentCategory" : { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "parentCategoryGuid" : "...", |
| "relationGuid" : "..." |
| }, |
| "terms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "additionalAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "longDescription" : "...", |
| "name" : "...", |
| "qualifiedName" : "...", |
| "shortDescription" : "...", |
| "guid" : "..." |
| } |
| }, |
| "description" : "If Glossary category already exists (duplicate qualifiedName)" |
| } |
| } |
| } |
| }, |
| "\/v2/glossary/category/{categoryGuid}" : { |
| "delete" : { |
| "tags" : [ "GlossaryREST" ], |
| "description" : "Delete a glossary category", |
| "operationId" : "deleteGlossaryCategory", |
| "parameters" : [ |
| { |
| "name" : "categoryGuid", |
| "in" : "path", |
| "type" : "string", |
| "description" : "unique identifier for glossary category" |
| } |
| ], |
| "responses" : { |
| "204" : { |
| "description" : "If glossary category delete was successful" |
| }, |
| "404" : { |
| "description" : "If glossary category guid in invalid" |
| } |
| } |
| }, |
| "get" : { |
| "tags" : [ "GlossaryREST" ], |
| "description" : "Get specific glossary category", |
| "operationId" : "getGlossaryCategory", |
| "produces" : [ "application/json" ], |
| "parameters" : [ |
| { |
| "name" : "categoryGuid", |
| "in" : "path", |
| "type" : "string", |
| "description" : "unique identifier for glossary category" |
| } |
| ], |
| "responses" : { |
| "200" : { |
| "schema" : { |
| "$ref" : "#/definitions/AtlasGlossaryCategory", |
| "description" : "If glossary category exists for given GUID" |
| }, |
| "examples" : { |
| "application/json" : { |
| "anchor" : { |
| "displayText" : "...", |
| "glossaryGuid" : "...", |
| "relationGuid" : "..." |
| }, |
| "childrenCategories" : [ { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "parentCategoryGuid" : "...", |
| "relationGuid" : "..." |
| }, { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "parentCategoryGuid" : "...", |
| "relationGuid" : "..." |
| } ], |
| "parentCategory" : { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "parentCategoryGuid" : "...", |
| "relationGuid" : "..." |
| }, |
| "terms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "additionalAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "longDescription" : "...", |
| "name" : "...", |
| "qualifiedName" : "...", |
| "shortDescription" : "...", |
| "guid" : "..." |
| } |
| }, |
| "description" : "If glossary category exists for given GUID" |
| }, |
| "404" : { |
| "examples" : { |
| "application/json" : { |
| "anchor" : { |
| "displayText" : "...", |
| "glossaryGuid" : "...", |
| "relationGuid" : "..." |
| }, |
| "childrenCategories" : [ { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "parentCategoryGuid" : "...", |
| "relationGuid" : "..." |
| }, { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "parentCategoryGuid" : "...", |
| "relationGuid" : "..." |
| } ], |
| "parentCategory" : { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "parentCategoryGuid" : "...", |
| "relationGuid" : "..." |
| }, |
| "terms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "additionalAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "longDescription" : "...", |
| "name" : "...", |
| "qualifiedName" : "...", |
| "shortDescription" : "...", |
| "guid" : "..." |
| } |
| }, |
| "description" : "If glossary category GUID is invalid" |
| } |
| } |
| }, |
| "put" : { |
| "tags" : [ "GlossaryREST" ], |
| "description" : "Update the given glossary category", |
| "operationId" : "updateGlossaryCategory", |
| "consumes" : [ "application/json" ], |
| "produces" : [ "application/json" ], |
| "parameters" : [ |
| { |
| "name" : "categoryGuid", |
| "in" : "path", |
| "type" : "string", |
| "description" : "unique identifier for glossary category" |
| }, |
| { |
| "name" : "body", |
| "required" : false, |
| "in" : "body", |
| "schema" : { |
| "$ref" : "#/definitions/AtlasGlossaryCategory", |
| "description" : "updated glossary category" |
| }, |
| "description" : "updated glossary category" |
| } |
| ], |
| "responses" : { |
| "200" : { |
| "schema" : { |
| "$ref" : "#/definitions/AtlasGlossaryCategory", |
| "description" : "If glossary category partial update was successful" |
| }, |
| "examples" : { |
| "application/json" : { |
| "anchor" : { |
| "displayText" : "...", |
| "glossaryGuid" : "...", |
| "relationGuid" : "..." |
| }, |
| "childrenCategories" : [ { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "parentCategoryGuid" : "...", |
| "relationGuid" : "..." |
| }, { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "parentCategoryGuid" : "...", |
| "relationGuid" : "..." |
| } ], |
| "parentCategory" : { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "parentCategoryGuid" : "...", |
| "relationGuid" : "..." |
| }, |
| "terms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "additionalAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "longDescription" : "...", |
| "name" : "...", |
| "qualifiedName" : "...", |
| "shortDescription" : "...", |
| "guid" : "..." |
| } |
| }, |
| "description" : "If glossary category partial update was successful" |
| }, |
| "400" : { |
| "examples" : { |
| "application/json" : { |
| "anchor" : { |
| "displayText" : "...", |
| "glossaryGuid" : "...", |
| "relationGuid" : "..." |
| }, |
| "childrenCategories" : [ { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "parentCategoryGuid" : "...", |
| "relationGuid" : "..." |
| }, { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "parentCategoryGuid" : "...", |
| "relationGuid" : "..." |
| } ], |
| "parentCategory" : { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "parentCategoryGuid" : "...", |
| "relationGuid" : "..." |
| }, |
| "terms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "additionalAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "longDescription" : "...", |
| "name" : "...", |
| "qualifiedName" : "...", |
| "shortDescription" : "...", |
| "guid" : "..." |
| } |
| }, |
| "description" : "If Glossary category definition has invalid or missing information" |
| }, |
| "404" : { |
| "examples" : { |
| "application/json" : { |
| "anchor" : { |
| "displayText" : "...", |
| "glossaryGuid" : "...", |
| "relationGuid" : "..." |
| }, |
| "childrenCategories" : [ { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "parentCategoryGuid" : "...", |
| "relationGuid" : "..." |
| }, { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "parentCategoryGuid" : "...", |
| "relationGuid" : "..." |
| } ], |
| "parentCategory" : { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "parentCategoryGuid" : "...", |
| "relationGuid" : "..." |
| }, |
| "terms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "additionalAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "longDescription" : "...", |
| "name" : "...", |
| "qualifiedName" : "...", |
| "shortDescription" : "...", |
| "guid" : "..." |
| } |
| }, |
| "description" : "If glossary category guid in invalid" |
| } |
| } |
| } |
| }, |
| "\/v2/glossary/category/{categoryGuid}/partial" : { |
| "put" : { |
| "tags" : [ "GlossaryREST" ], |
| "description" : "Partially update the glossary category", |
| "operationId" : "partialUpdateGlossaryCategory", |
| "consumes" : [ "application/json" ], |
| "produces" : [ "application/json" ], |
| "parameters" : [ |
| { |
| "name" : "categoryGuid", |
| "in" : "path", |
| "type" : "string", |
| "description" : "unique identifier for glossary term" |
| }, |
| { |
| "name" : "body", |
| "required" : false, |
| "in" : "body", |
| "schema" : { |
| "description" : "Map containing keys as attribute names and values as corresponding attribute values", |
| "type" : "object", |
| "additionalProperties" : { |
| "type" : "string" |
| } |
| }, |
| "description" : "Map containing keys as attribute names and values as corresponding attribute values" |
| } |
| ], |
| "responses" : { |
| "200" : { |
| "schema" : { |
| "$ref" : "#/definitions/AtlasGlossaryCategory", |
| "description" : "If glossary category partial update was successful" |
| }, |
| "examples" : { |
| "application/json" : { |
| "anchor" : { |
| "displayText" : "...", |
| "glossaryGuid" : "...", |
| "relationGuid" : "..." |
| }, |
| "childrenCategories" : [ { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "parentCategoryGuid" : "...", |
| "relationGuid" : "..." |
| }, { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "parentCategoryGuid" : "...", |
| "relationGuid" : "..." |
| } ], |
| "parentCategory" : { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "parentCategoryGuid" : "...", |
| "relationGuid" : "..." |
| }, |
| "terms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "additionalAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "longDescription" : "...", |
| "name" : "...", |
| "qualifiedName" : "...", |
| "shortDescription" : "...", |
| "guid" : "..." |
| } |
| }, |
| "description" : "If glossary category partial update was successful" |
| }, |
| "400" : { |
| "examples" : { |
| "application/json" : { |
| "anchor" : { |
| "displayText" : "...", |
| "glossaryGuid" : "...", |
| "relationGuid" : "..." |
| }, |
| "childrenCategories" : [ { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "parentCategoryGuid" : "...", |
| "relationGuid" : "..." |
| }, { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "parentCategoryGuid" : "...", |
| "relationGuid" : "..." |
| } ], |
| "parentCategory" : { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "parentCategoryGuid" : "...", |
| "relationGuid" : "..." |
| }, |
| "terms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "additionalAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "longDescription" : "...", |
| "name" : "...", |
| "qualifiedName" : "...", |
| "shortDescription" : "...", |
| "guid" : "..." |
| } |
| }, |
| "description" : "If category attributes are invalid" |
| }, |
| "404" : { |
| "examples" : { |
| "application/json" : { |
| "anchor" : { |
| "displayText" : "...", |
| "glossaryGuid" : "...", |
| "relationGuid" : "..." |
| }, |
| "childrenCategories" : [ { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "parentCategoryGuid" : "...", |
| "relationGuid" : "..." |
| }, { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "parentCategoryGuid" : "...", |
| "relationGuid" : "..." |
| } ], |
| "parentCategory" : { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "parentCategoryGuid" : "...", |
| "relationGuid" : "..." |
| }, |
| "terms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "additionalAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "longDescription" : "...", |
| "name" : "...", |
| "qualifiedName" : "...", |
| "shortDescription" : "...", |
| "guid" : "..." |
| } |
| }, |
| "description" : "If glossary category guid in invalid" |
| } |
| } |
| } |
| }, |
| "\/v2/glossary/category/{categoryGuid}/related" : { |
| "get" : { |
| "tags" : [ "GlossaryREST" ], |
| "description" : "Get all related categories (parent and children)", |
| "operationId" : "getRelatedCategories", |
| "produces" : [ "application/json" ], |
| "parameters" : [ |
| { |
| "name" : "categoryGuid", |
| "in" : "path", |
| "type" : "string", |
| "description" : "unique identifier for glossary category" |
| }, |
| { |
| "name" : "limit", |
| "in" : "query", |
| "default" : "-1", |
| "type" : "string", |
| "description" : "page size - by default there is no paging" |
| }, |
| { |
| "name" : "offset", |
| "in" : "query", |
| "default" : "0", |
| "type" : "string", |
| "description" : "offset for pagination purpose" |
| }, |
| { |
| "name" : "sort", |
| "in" : "query", |
| "default" : "ASC", |
| "type" : "string", |
| "description" : "ASC (default) or DESC" |
| } |
| ], |
| "responses" : { |
| "200" : { |
| "schema" : { |
| "description" : "List of related categories", |
| "type" : "object", |
| "additionalProperties" : { |
| "type" : "array", |
| "items" : { |
| "$ref" : "#/definitions/AtlasRelatedCategoryHeader" |
| } |
| } |
| }, |
| "examples" : { |
| "application/json" : [ { |
| "..." : { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "parentCategoryGuid" : "...", |
| "relationGuid" : "..." |
| } |
| } ] |
| }, |
| "description" : "List of related categories" |
| } |
| } |
| } |
| }, |
| "\/v2/glossary/category/{categoryGuid}/terms" : { |
| "get" : { |
| "tags" : [ "GlossaryREST" ], |
| "description" : "Get all terms associated with the specific category", |
| "operationId" : "getCategoryTerms", |
| "produces" : [ "application/json" ], |
| "parameters" : [ |
| { |
| "name" : "categoryGuid", |
| "in" : "path", |
| "type" : "string", |
| "description" : "unique identifier for glossary category" |
| }, |
| { |
| "name" : "limit", |
| "in" : "query", |
| "default" : "-1", |
| "type" : "string", |
| "description" : "page size - by default there is no paging" |
| }, |
| { |
| "name" : "offset", |
| "in" : "query", |
| "default" : "0", |
| "type" : "string", |
| "description" : "offset for pagination purpose" |
| }, |
| { |
| "name" : "sort", |
| "in" : "query", |
| "default" : "ASC", |
| "type" : "string", |
| "description" : "ASC (default) or DESC" |
| } |
| ], |
| "responses" : { |
| "200" : { |
| "schema" : { |
| "description" : "List of terms for the given category or an empty list", |
| "type" : "array", |
| "items" : { |
| "$ref" : "#/definitions/AtlasRelatedTermHeader" |
| } |
| }, |
| "examples" : { |
| "application/json" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ] |
| }, |
| "description" : "List of terms for the given category or an empty list" |
| }, |
| "404" : { |
| "examples" : { |
| "application/json" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ] |
| }, |
| "description" : "If glossary category guid in invalid" |
| } |
| } |
| } |
| }, |
| "\/v2/glossary/import" : { |
| "post" : { |
| "tags" : [ "GlossaryREST" ], |
| "description" : "Upload glossary file for creating AtlasGlossaryTerms in bulk", |
| "operationId" : "importGlossaryData", |
| "consumes" : [ "multipart/form-data" ], |
| "produces" : [ "application/json" ], |
| "parameters" : [ |
| { |
| "name" : "fileDetail", |
| "in" : "formData", |
| "type" : "file", |
| "description" : "FormDataContentDisposition metadata of file" |
| }, |
| { |
| "name" : "inputStream", |
| "in" : "formData", |
| "type" : "file", |
| "description" : "InputStream of file" |
| }, |
| { |
| "name" : "body", |
| "required" : false, |
| "in" : "body", |
| "type" : "file", |
| "description" : "" |
| } |
| ], |
| "responses" : { |
| "200" : { |
| "schema" : { |
| "$ref" : "#/definitions/BulkImportResponse", |
| "description" : "If glossary term creation was successful" |
| }, |
| "examples" : { |
| "application/json" : { |
| "failedImportInfoList" : [ { |
| "childObjectName" : "...", |
| "importStatus" : "SUCCESS", |
| "parentObjectName" : "...", |
| "remarks" : "..." |
| }, { |
| "childObjectName" : "...", |
| "importStatus" : "SUCCESS", |
| "parentObjectName" : "...", |
| "remarks" : "..." |
| } ], |
| "successImportInfoList" : [ { |
| "childObjectName" : "...", |
| "importStatus" : "SUCCESS", |
| "parentObjectName" : "...", |
| "remarks" : "..." |
| }, { |
| "childObjectName" : "...", |
| "importStatus" : "SUCCESS", |
| "parentObjectName" : "...", |
| "remarks" : "..." |
| } ] |
| } |
| }, |
| "description" : "If glossary term creation was successful" |
| }, |
| "400" : { |
| "examples" : { |
| "application/json" : { |
| "failedImportInfoList" : [ { |
| "childObjectName" : "...", |
| "importStatus" : "FAILED", |
| "parentObjectName" : "...", |
| "remarks" : "..." |
| }, { |
| "childObjectName" : "...", |
| "importStatus" : "SUCCESS", |
| "parentObjectName" : "...", |
| "remarks" : "..." |
| } ], |
| "successImportInfoList" : [ { |
| "childObjectName" : "...", |
| "importStatus" : "SUCCESS", |
| "parentObjectName" : "...", |
| "remarks" : "..." |
| }, { |
| "childObjectName" : "...", |
| "importStatus" : "SUCCESS", |
| "parentObjectName" : "...", |
| "remarks" : "..." |
| } ] |
| } |
| }, |
| "description" : "If Glossary term definition has invalid or missing information" |
| }, |
| "409" : { |
| "examples" : { |
| "application/json" : { |
| "failedImportInfoList" : [ { |
| "childObjectName" : "...", |
| "importStatus" : "SUCCESS", |
| "parentObjectName" : "...", |
| "remarks" : "..." |
| }, { |
| "childObjectName" : "...", |
| "importStatus" : "SUCCESS", |
| "parentObjectName" : "...", |
| "remarks" : "..." |
| } ], |
| "successImportInfoList" : [ { |
| "childObjectName" : "...", |
| "importStatus" : "FAILED", |
| "parentObjectName" : "...", |
| "remarks" : "..." |
| }, { |
| "childObjectName" : "...", |
| "importStatus" : "SUCCESS", |
| "parentObjectName" : "...", |
| "remarks" : "..." |
| } ] |
| } |
| }, |
| "description" : "If Glossary term already exists (duplicate qualifiedName)" |
| } |
| } |
| } |
| }, |
| "\/v2/glossary/import/template" : { |
| "get" : { |
| "tags" : [ "GlossaryREST" ], |
| "description" : "Get sample template for uploading/creating bulk AtlasGlossaryTerm", |
| "operationId" : "produceTemplate2", |
| "produces" : [ "application/octet-stream" ], |
| "parameters" : [ |
| ], |
| "responses" : { |
| "200" : { |
| "schema" : { |
| "description" : "Template File", |
| "type" : "file" |
| }, |
| "description" : "Template File" |
| }, |
| "400" : { |
| "description" : "If the provided fileType is not supported" |
| } |
| } |
| } |
| }, |
| "\/v2/glossary/term" : { |
| "post" : { |
| "tags" : [ "GlossaryREST" ], |
| "description" : "Create a glossary term", |
| "operationId" : "createGlossaryTerm", |
| "consumes" : [ "application/json" ], |
| "produces" : [ "application/json" ], |
| "parameters" : [ |
| { |
| "name" : "body", |
| "required" : false, |
| "in" : "body", |
| "schema" : { |
| "$ref" : "#/definitions/AtlasGlossaryTerm", |
| "description" : "Glossary term definition, a term must be anchored to a Glossary at the time of creation\noptionally it can be categorized as well" |
| }, |
| "description" : "Glossary term definition, a term must be anchored to a Glossary at the time of creation\noptionally it can be categorized as well" |
| } |
| ], |
| "responses" : { |
| "200" : { |
| "schema" : { |
| "$ref" : "#/definitions/AtlasGlossaryTerm", |
| "description" : "If glossary term creation was successful" |
| }, |
| "examples" : { |
| "application/json" : { |
| "abbreviation" : "...", |
| "anchor" : { |
| "displayText" : "...", |
| "glossaryGuid" : "...", |
| "relationGuid" : "..." |
| }, |
| "antonyms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "assignedEntities" : [ { |
| "displayText" : "...", |
| "entityStatus" : "DELETED", |
| "qualifiedName" : "...", |
| "relationshipAttributes" : { |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "relationshipGuid" : "...", |
| "relationshipStatus" : "DELETED", |
| "relationshipType" : "...", |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, { |
| "displayText" : "...", |
| "entityStatus" : "PURGED", |
| "qualifiedName" : "...", |
| "relationshipAttributes" : { |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "relationshipGuid" : "...", |
| "relationshipStatus" : "ACTIVE", |
| "relationshipType" : "...", |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| } ], |
| "categories" : [ { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "relationGuid" : "...", |
| "status" : "ACTIVE" |
| }, { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "relationGuid" : "...", |
| "status" : "DRAFT" |
| } ], |
| "classifies" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "examples" : [ "...", "..." ], |
| "glossaryTermHeader" : { |
| "qualifiedName" : "...", |
| "termGuid" : "..." |
| }, |
| "isA" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "preferredTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "preferredToTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "replacedBy" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "replacementTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "seeAlso" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "synonyms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "translatedTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "translationTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "usage" : "...", |
| "validValues" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "validValuesFor" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "additionalAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "longDescription" : "...", |
| "name" : "...", |
| "qualifiedName" : "...", |
| "shortDescription" : "...", |
| "guid" : "..." |
| } |
| }, |
| "description" : "If glossary term creation was successful" |
| }, |
| "400" : { |
| "examples" : { |
| "application/json" : { |
| "abbreviation" : "...", |
| "anchor" : { |
| "displayText" : "...", |
| "glossaryGuid" : "...", |
| "relationGuid" : "..." |
| }, |
| "antonyms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "assignedEntities" : [ { |
| "displayText" : "...", |
| "entityStatus" : "PURGED", |
| "qualifiedName" : "...", |
| "relationshipAttributes" : { |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "relationshipGuid" : "...", |
| "relationshipStatus" : "DELETED", |
| "relationshipType" : "...", |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, { |
| "displayText" : "...", |
| "entityStatus" : "PURGED", |
| "qualifiedName" : "...", |
| "relationshipAttributes" : { |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "relationshipGuid" : "...", |
| "relationshipStatus" : "DELETED", |
| "relationshipType" : "...", |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| } ], |
| "categories" : [ { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "relationGuid" : "...", |
| "status" : "ACTIVE" |
| }, { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "relationGuid" : "...", |
| "status" : "OBSOLETE" |
| } ], |
| "classifies" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "examples" : [ "...", "..." ], |
| "glossaryTermHeader" : { |
| "qualifiedName" : "...", |
| "termGuid" : "..." |
| }, |
| "isA" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "preferredTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "preferredToTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "replacedBy" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "replacementTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "seeAlso" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "synonyms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "translatedTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "translationTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "usage" : "...", |
| "validValues" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "validValuesFor" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "additionalAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "longDescription" : "...", |
| "name" : "...", |
| "qualifiedName" : "...", |
| "shortDescription" : "...", |
| "guid" : "..." |
| } |
| }, |
| "description" : "If Glossary term definition has invalid or missing information" |
| }, |
| "409" : { |
| "examples" : { |
| "application/json" : { |
| "abbreviation" : "...", |
| "anchor" : { |
| "displayText" : "...", |
| "glossaryGuid" : "...", |
| "relationGuid" : "..." |
| }, |
| "antonyms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "assignedEntities" : [ { |
| "displayText" : "...", |
| "entityStatus" : "DELETED", |
| "qualifiedName" : "...", |
| "relationshipAttributes" : { |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "relationshipGuid" : "...", |
| "relationshipStatus" : "DELETED", |
| "relationshipType" : "...", |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, { |
| "displayText" : "...", |
| "entityStatus" : "DELETED", |
| "qualifiedName" : "...", |
| "relationshipAttributes" : { |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "relationshipGuid" : "...", |
| "relationshipStatus" : "DELETED", |
| "relationshipType" : "...", |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| } ], |
| "categories" : [ { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "relationGuid" : "...", |
| "status" : "DRAFT" |
| }, { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "relationGuid" : "...", |
| "status" : "DRAFT" |
| } ], |
| "classifies" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "examples" : [ "...", "..." ], |
| "glossaryTermHeader" : { |
| "qualifiedName" : "...", |
| "termGuid" : "..." |
| }, |
| "isA" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "preferredTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "preferredToTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "replacedBy" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "replacementTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "seeAlso" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "synonyms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "translatedTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "translationTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "usage" : "...", |
| "validValues" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "validValuesFor" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "additionalAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "longDescription" : "...", |
| "name" : "...", |
| "qualifiedName" : "...", |
| "shortDescription" : "...", |
| "guid" : "..." |
| } |
| }, |
| "description" : "If Glossary term already exists (duplicate qualifiedName)" |
| } |
| } |
| } |
| }, |
| "\/v2/glossary/term/{termGuid}" : { |
| "delete" : { |
| "tags" : [ "GlossaryREST" ], |
| "description" : "Delete a glossary term", |
| "operationId" : "deleteGlossaryTerm", |
| "parameters" : [ |
| { |
| "name" : "termGuid", |
| "in" : "path", |
| "type" : "string", |
| "description" : "unique identifier for glossary term" |
| } |
| ], |
| "responses" : { |
| "204" : { |
| "description" : "If glossary term delete was successful" |
| }, |
| "404" : { |
| "description" : "If glossary term guid in invalid" |
| } |
| } |
| }, |
| "get" : { |
| "tags" : [ "GlossaryREST" ], |
| "description" : "Get specific glossary term", |
| "operationId" : "getGlossaryTerm", |
| "produces" : [ "application/json" ], |
| "parameters" : [ |
| { |
| "name" : "termGuid", |
| "in" : "path", |
| "type" : "string", |
| "description" : "unique identifier for glossary term" |
| } |
| ], |
| "responses" : { |
| "200" : { |
| "schema" : { |
| "$ref" : "#/definitions/AtlasGlossaryTerm", |
| "description" : "If glossary term exists for given GUID" |
| }, |
| "examples" : { |
| "application/json" : { |
| "abbreviation" : "...", |
| "anchor" : { |
| "displayText" : "...", |
| "glossaryGuid" : "...", |
| "relationGuid" : "..." |
| }, |
| "antonyms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "assignedEntities" : [ { |
| "displayText" : "...", |
| "entityStatus" : "ACTIVE", |
| "qualifiedName" : "...", |
| "relationshipAttributes" : { |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "relationshipGuid" : "...", |
| "relationshipStatus" : "ACTIVE", |
| "relationshipType" : "...", |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, { |
| "displayText" : "...", |
| "entityStatus" : "ACTIVE", |
| "qualifiedName" : "...", |
| "relationshipAttributes" : { |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "relationshipGuid" : "...", |
| "relationshipStatus" : "DELETED", |
| "relationshipType" : "...", |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| } ], |
| "categories" : [ { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "relationGuid" : "...", |
| "status" : "ACTIVE" |
| }, { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "relationGuid" : "...", |
| "status" : "OBSOLETE" |
| } ], |
| "classifies" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "examples" : [ "...", "..." ], |
| "glossaryTermHeader" : { |
| "qualifiedName" : "...", |
| "termGuid" : "..." |
| }, |
| "isA" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "preferredTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "preferredToTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "replacedBy" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "replacementTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "seeAlso" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "synonyms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "translatedTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "translationTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "usage" : "...", |
| "validValues" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "validValuesFor" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "additionalAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "longDescription" : "...", |
| "name" : "...", |
| "qualifiedName" : "...", |
| "shortDescription" : "...", |
| "guid" : "..." |
| } |
| }, |
| "description" : "If glossary term exists for given GUID" |
| }, |
| "404" : { |
| "examples" : { |
| "application/json" : { |
| "abbreviation" : "...", |
| "anchor" : { |
| "displayText" : "...", |
| "glossaryGuid" : "...", |
| "relationGuid" : "..." |
| }, |
| "antonyms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "assignedEntities" : [ { |
| "displayText" : "...", |
| "entityStatus" : "ACTIVE", |
| "qualifiedName" : "...", |
| "relationshipAttributes" : { |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "relationshipGuid" : "...", |
| "relationshipStatus" : "DELETED", |
| "relationshipType" : "...", |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, { |
| "displayText" : "...", |
| "entityStatus" : "PURGED", |
| "qualifiedName" : "...", |
| "relationshipAttributes" : { |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "relationshipGuid" : "...", |
| "relationshipStatus" : "DELETED", |
| "relationshipType" : "...", |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| } ], |
| "categories" : [ { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "relationGuid" : "...", |
| "status" : "ACTIVE" |
| }, { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "relationGuid" : "...", |
| "status" : "OTHER" |
| } ], |
| "classifies" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "examples" : [ "...", "..." ], |
| "glossaryTermHeader" : { |
| "qualifiedName" : "...", |
| "termGuid" : "..." |
| }, |
| "isA" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "preferredTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "preferredToTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "replacedBy" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "replacementTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "seeAlso" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "synonyms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "translatedTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "translationTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "usage" : "...", |
| "validValues" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "validValuesFor" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "additionalAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "longDescription" : "...", |
| "name" : "...", |
| "qualifiedName" : "...", |
| "shortDescription" : "...", |
| "guid" : "..." |
| } |
| }, |
| "description" : "If glossary term GUID is invalid" |
| } |
| } |
| }, |
| "put" : { |
| "tags" : [ "GlossaryREST" ], |
| "description" : "Update the given glossary term", |
| "operationId" : "updateGlossaryTerm", |
| "consumes" : [ "application/json" ], |
| "produces" : [ "application/json" ], |
| "parameters" : [ |
| { |
| "name" : "termGuid", |
| "in" : "path", |
| "type" : "string", |
| "description" : "unique identifier for glossary term" |
| }, |
| { |
| "name" : "body", |
| "required" : false, |
| "in" : "body", |
| "schema" : { |
| "$ref" : "#/definitions/AtlasGlossaryTerm", |
| "description" : "updated glossary term" |
| }, |
| "description" : "updated glossary term" |
| } |
| ], |
| "responses" : { |
| "200" : { |
| "schema" : { |
| "$ref" : "#/definitions/AtlasGlossaryTerm", |
| "description" : "If glossary term update was successful" |
| }, |
| "examples" : { |
| "application/json" : { |
| "abbreviation" : "...", |
| "anchor" : { |
| "displayText" : "...", |
| "glossaryGuid" : "...", |
| "relationGuid" : "..." |
| }, |
| "antonyms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "assignedEntities" : [ { |
| "displayText" : "...", |
| "entityStatus" : "ACTIVE", |
| "qualifiedName" : "...", |
| "relationshipAttributes" : { |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "relationshipGuid" : "...", |
| "relationshipStatus" : "ACTIVE", |
| "relationshipType" : "...", |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, { |
| "displayText" : "...", |
| "entityStatus" : "DELETED", |
| "qualifiedName" : "...", |
| "relationshipAttributes" : { |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "relationshipGuid" : "...", |
| "relationshipStatus" : "DELETED", |
| "relationshipType" : "...", |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| } ], |
| "categories" : [ { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "relationGuid" : "...", |
| "status" : "OBSOLETE" |
| }, { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "relationGuid" : "...", |
| "status" : "OTHER" |
| } ], |
| "classifies" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "examples" : [ "...", "..." ], |
| "glossaryTermHeader" : { |
| "qualifiedName" : "...", |
| "termGuid" : "..." |
| }, |
| "isA" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "preferredTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "preferredToTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "replacedBy" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "replacementTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "seeAlso" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "synonyms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "translatedTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "translationTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "usage" : "...", |
| "validValues" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "validValuesFor" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "additionalAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "longDescription" : "...", |
| "name" : "...", |
| "qualifiedName" : "...", |
| "shortDescription" : "...", |
| "guid" : "..." |
| } |
| }, |
| "description" : "If glossary term update was successful" |
| }, |
| "400" : { |
| "examples" : { |
| "application/json" : { |
| "abbreviation" : "...", |
| "anchor" : { |
| "displayText" : "...", |
| "glossaryGuid" : "...", |
| "relationGuid" : "..." |
| }, |
| "antonyms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "assignedEntities" : [ { |
| "displayText" : "...", |
| "entityStatus" : "ACTIVE", |
| "qualifiedName" : "...", |
| "relationshipAttributes" : { |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "relationshipGuid" : "...", |
| "relationshipStatus" : "ACTIVE", |
| "relationshipType" : "...", |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, { |
| "displayText" : "...", |
| "entityStatus" : "ACTIVE", |
| "qualifiedName" : "...", |
| "relationshipAttributes" : { |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "relationshipGuid" : "...", |
| "relationshipStatus" : "ACTIVE", |
| "relationshipType" : "...", |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| } ], |
| "categories" : [ { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "relationGuid" : "...", |
| "status" : "ACTIVE" |
| }, { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "relationGuid" : "...", |
| "status" : "DRAFT" |
| } ], |
| "classifies" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "examples" : [ "...", "..." ], |
| "glossaryTermHeader" : { |
| "qualifiedName" : "...", |
| "termGuid" : "..." |
| }, |
| "isA" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "preferredTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "preferredToTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "replacedBy" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "replacementTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "seeAlso" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "synonyms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "translatedTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "translationTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "usage" : "...", |
| "validValues" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "validValuesFor" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "additionalAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "longDescription" : "...", |
| "name" : "...", |
| "qualifiedName" : "...", |
| "shortDescription" : "...", |
| "guid" : "..." |
| } |
| }, |
| "description" : "If Glossary temr definition has invalid or missing information" |
| }, |
| "404" : { |
| "examples" : { |
| "application/json" : { |
| "abbreviation" : "...", |
| "anchor" : { |
| "displayText" : "...", |
| "glossaryGuid" : "...", |
| "relationGuid" : "..." |
| }, |
| "antonyms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "assignedEntities" : [ { |
| "displayText" : "...", |
| "entityStatus" : "PURGED", |
| "qualifiedName" : "...", |
| "relationshipAttributes" : { |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "relationshipGuid" : "...", |
| "relationshipStatus" : "ACTIVE", |
| "relationshipType" : "...", |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, { |
| "displayText" : "...", |
| "entityStatus" : "DELETED", |
| "qualifiedName" : "...", |
| "relationshipAttributes" : { |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "relationshipGuid" : "...", |
| "relationshipStatus" : "ACTIVE", |
| "relationshipType" : "...", |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| } ], |
| "categories" : [ { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "relationGuid" : "...", |
| "status" : "ACTIVE" |
| }, { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "relationGuid" : "...", |
| "status" : "OTHER" |
| } ], |
| "classifies" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "examples" : [ "...", "..." ], |
| "glossaryTermHeader" : { |
| "qualifiedName" : "...", |
| "termGuid" : "..." |
| }, |
| "isA" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "preferredTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "preferredToTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "replacedBy" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "replacementTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "seeAlso" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "synonyms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "translatedTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "translationTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "usage" : "...", |
| "validValues" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "validValuesFor" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "additionalAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "longDescription" : "...", |
| "name" : "...", |
| "qualifiedName" : "...", |
| "shortDescription" : "...", |
| "guid" : "..." |
| } |
| }, |
| "description" : "If glossary term guid in invalid" |
| } |
| } |
| } |
| }, |
| "\/v2/glossary/term/{termGuid}/partial" : { |
| "put" : { |
| "tags" : [ "GlossaryREST" ], |
| "description" : "Partially update the glossary term", |
| "operationId" : "partialUpdateGlossaryTerm", |
| "consumes" : [ "application/json" ], |
| "produces" : [ "application/json" ], |
| "parameters" : [ |
| { |
| "name" : "termGuid", |
| "in" : "path", |
| "type" : "string", |
| "description" : "unique identifier for glossary term" |
| }, |
| { |
| "name" : "body", |
| "required" : false, |
| "in" : "body", |
| "schema" : { |
| "description" : "Map containing keys as attribute names and values as corresponding attribute values", |
| "type" : "object", |
| "additionalProperties" : { |
| "type" : "string" |
| } |
| }, |
| "description" : "Map containing keys as attribute names and values as corresponding attribute values" |
| } |
| ], |
| "responses" : { |
| "200" : { |
| "schema" : { |
| "$ref" : "#/definitions/AtlasGlossaryTerm", |
| "description" : "If glossary partial update was successful" |
| }, |
| "examples" : { |
| "application/json" : { |
| "abbreviation" : "...", |
| "anchor" : { |
| "displayText" : "...", |
| "glossaryGuid" : "...", |
| "relationGuid" : "..." |
| }, |
| "antonyms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "assignedEntities" : [ { |
| "displayText" : "...", |
| "entityStatus" : "ACTIVE", |
| "qualifiedName" : "...", |
| "relationshipAttributes" : { |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "relationshipGuid" : "...", |
| "relationshipStatus" : "ACTIVE", |
| "relationshipType" : "...", |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, { |
| "displayText" : "...", |
| "entityStatus" : "PURGED", |
| "qualifiedName" : "...", |
| "relationshipAttributes" : { |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "relationshipGuid" : "...", |
| "relationshipStatus" : "ACTIVE", |
| "relationshipType" : "...", |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| } ], |
| "categories" : [ { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "relationGuid" : "...", |
| "status" : "OTHER" |
| }, { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "relationGuid" : "...", |
| "status" : "DEPRECATED" |
| } ], |
| "classifies" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "examples" : [ "...", "..." ], |
| "glossaryTermHeader" : { |
| "qualifiedName" : "...", |
| "termGuid" : "..." |
| }, |
| "isA" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "preferredTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "preferredToTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "replacedBy" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "replacementTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "seeAlso" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "synonyms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "translatedTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "translationTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "usage" : "...", |
| "validValues" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "validValuesFor" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "additionalAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "longDescription" : "...", |
| "name" : "...", |
| "qualifiedName" : "...", |
| "shortDescription" : "...", |
| "guid" : "..." |
| } |
| }, |
| "description" : "If glossary partial update was successful" |
| }, |
| "400" : { |
| "examples" : { |
| "application/json" : { |
| "abbreviation" : "...", |
| "anchor" : { |
| "displayText" : "...", |
| "glossaryGuid" : "...", |
| "relationGuid" : "..." |
| }, |
| "antonyms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "assignedEntities" : [ { |
| "displayText" : "...", |
| "entityStatus" : "ACTIVE", |
| "qualifiedName" : "...", |
| "relationshipAttributes" : { |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "relationshipGuid" : "...", |
| "relationshipStatus" : "ACTIVE", |
| "relationshipType" : "...", |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, { |
| "displayText" : "...", |
| "entityStatus" : "ACTIVE", |
| "qualifiedName" : "...", |
| "relationshipAttributes" : { |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "relationshipGuid" : "...", |
| "relationshipStatus" : "ACTIVE", |
| "relationshipType" : "...", |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| } ], |
| "categories" : [ { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "relationGuid" : "...", |
| "status" : "DEPRECATED" |
| }, { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "relationGuid" : "...", |
| "status" : "OTHER" |
| } ], |
| "classifies" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "examples" : [ "...", "..." ], |
| "glossaryTermHeader" : { |
| "qualifiedName" : "...", |
| "termGuid" : "..." |
| }, |
| "isA" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "preferredTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "preferredToTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "replacedBy" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "replacementTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "seeAlso" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "synonyms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "translatedTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "translationTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "usage" : "...", |
| "validValues" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "validValuesFor" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "additionalAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "longDescription" : "...", |
| "name" : "...", |
| "qualifiedName" : "...", |
| "shortDescription" : "...", |
| "guid" : "..." |
| } |
| }, |
| "description" : "If partial attributes are invalid" |
| }, |
| "404" : { |
| "examples" : { |
| "application/json" : { |
| "abbreviation" : "...", |
| "anchor" : { |
| "displayText" : "...", |
| "glossaryGuid" : "...", |
| "relationGuid" : "..." |
| }, |
| "antonyms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "assignedEntities" : [ { |
| "displayText" : "...", |
| "entityStatus" : "PURGED", |
| "qualifiedName" : "...", |
| "relationshipAttributes" : { |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "relationshipGuid" : "...", |
| "relationshipStatus" : "ACTIVE", |
| "relationshipType" : "...", |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, { |
| "displayText" : "...", |
| "entityStatus" : "PURGED", |
| "qualifiedName" : "...", |
| "relationshipAttributes" : { |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "relationshipGuid" : "...", |
| "relationshipStatus" : "DELETED", |
| "relationshipType" : "...", |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| } ], |
| "categories" : [ { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "relationGuid" : "...", |
| "status" : "DRAFT" |
| }, { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "relationGuid" : "...", |
| "status" : "DRAFT" |
| } ], |
| "classifies" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "examples" : [ "...", "..." ], |
| "glossaryTermHeader" : { |
| "qualifiedName" : "...", |
| "termGuid" : "..." |
| }, |
| "isA" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "preferredTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "preferredToTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "replacedBy" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "replacementTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "seeAlso" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "synonyms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "translatedTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "translationTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "usage" : "...", |
| "validValues" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "validValuesFor" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "additionalAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "longDescription" : "...", |
| "name" : "...", |
| "qualifiedName" : "...", |
| "shortDescription" : "...", |
| "guid" : "..." |
| } |
| }, |
| "description" : "If glossary term guid in invalid" |
| } |
| } |
| } |
| }, |
| "\/v2/glossary/terms" : { |
| "post" : { |
| "tags" : [ "GlossaryREST" ], |
| "description" : "Create glossary terms in bulk", |
| "operationId" : "createGlossaryTerms", |
| "consumes" : [ "application/json" ], |
| "produces" : [ "application/json" ], |
| "parameters" : [ |
| { |
| "name" : "body", |
| "required" : false, |
| "in" : "body", |
| "schema" : { |
| "description" : "glossary term definitions", |
| "type" : "array", |
| "items" : { |
| "$ref" : "#/definitions/AtlasGlossaryTerm" |
| } |
| }, |
| "description" : "glossary term definitions" |
| } |
| ], |
| "responses" : { |
| "200" : { |
| "schema" : { |
| "description" : "If Bulk glossary terms creation was successful", |
| "type" : "array", |
| "items" : { |
| "$ref" : "#/definitions/AtlasGlossaryTerm" |
| } |
| }, |
| "examples" : { |
| "application/json" : [ { |
| "abbreviation" : "...", |
| "anchor" : { |
| "displayText" : "...", |
| "glossaryGuid" : "...", |
| "relationGuid" : "..." |
| }, |
| "antonyms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "assignedEntities" : [ { |
| "displayText" : "...", |
| "entityStatus" : "ACTIVE", |
| "qualifiedName" : "...", |
| "relationshipAttributes" : { |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "relationshipGuid" : "...", |
| "relationshipStatus" : "DELETED", |
| "relationshipType" : "...", |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, { |
| "displayText" : "...", |
| "entityStatus" : "ACTIVE", |
| "qualifiedName" : "...", |
| "relationshipAttributes" : { |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "relationshipGuid" : "...", |
| "relationshipStatus" : "ACTIVE", |
| "relationshipType" : "...", |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| } ], |
| "categories" : [ { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "relationGuid" : "...", |
| "status" : "DEPRECATED" |
| }, { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "relationGuid" : "...", |
| "status" : "OBSOLETE" |
| } ], |
| "classifies" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "examples" : [ "...", "..." ], |
| "glossaryTermHeader" : { |
| "qualifiedName" : "...", |
| "termGuid" : "..." |
| }, |
| "isA" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "preferredTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "preferredToTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "replacedBy" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "replacementTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "seeAlso" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "synonyms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "translatedTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "translationTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "usage" : "...", |
| "validValues" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "validValuesFor" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "additionalAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "longDescription" : "...", |
| "name" : "...", |
| "qualifiedName" : "...", |
| "shortDescription" : "...", |
| "guid" : "..." |
| } ] |
| }, |
| "description" : "If Bulk glossary terms creation was successful" |
| }, |
| "400" : { |
| "examples" : { |
| "application/json" : [ { |
| "abbreviation" : "...", |
| "anchor" : { |
| "displayText" : "...", |
| "glossaryGuid" : "...", |
| "relationGuid" : "..." |
| }, |
| "antonyms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "assignedEntities" : [ { |
| "displayText" : "...", |
| "entityStatus" : "ACTIVE", |
| "qualifiedName" : "...", |
| "relationshipAttributes" : { |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "relationshipGuid" : "...", |
| "relationshipStatus" : "ACTIVE", |
| "relationshipType" : "...", |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, { |
| "displayText" : "...", |
| "entityStatus" : "PURGED", |
| "qualifiedName" : "...", |
| "relationshipAttributes" : { |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "relationshipGuid" : "...", |
| "relationshipStatus" : "DELETED", |
| "relationshipType" : "...", |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| } ], |
| "categories" : [ { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "relationGuid" : "...", |
| "status" : "DEPRECATED" |
| }, { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "relationGuid" : "...", |
| "status" : "ACTIVE" |
| } ], |
| "classifies" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "examples" : [ "...", "..." ], |
| "glossaryTermHeader" : { |
| "qualifiedName" : "...", |
| "termGuid" : "..." |
| }, |
| "isA" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "preferredTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "preferredToTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "replacedBy" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "replacementTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "seeAlso" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "synonyms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "translatedTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "translationTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "usage" : "...", |
| "validValues" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "validValuesFor" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "additionalAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "longDescription" : "...", |
| "name" : "...", |
| "qualifiedName" : "...", |
| "shortDescription" : "...", |
| "guid" : "..." |
| } ] |
| }, |
| "description" : "If any glossary term definition has invalid or missing information" |
| } |
| } |
| } |
| }, |
| "\/v2/glossary/terms/{termGuid}/assignedEntities" : { |
| "delete" : { |
| "tags" : [ "GlossaryREST" ], |
| "description" : "Remove the term assignment for the given list of entity headers", |
| "operationId" : "removeTermAssignmentFromEntities", |
| "consumes" : [ "application/json" ], |
| "parameters" : [ |
| { |
| "name" : "termGuid", |
| "in" : "path", |
| "type" : "string", |
| "description" : "Glossary term GUID" |
| }, |
| { |
| "name" : "body", |
| "required" : false, |
| "in" : "body", |
| "schema" : { |
| "description" : "List of related entity IDs from which the term has to be dissociated", |
| "type" : "array", |
| "items" : { |
| "$ref" : "#/definitions/AtlasRelatedObjectId" |
| } |
| }, |
| "description" : "List of related entity IDs from which the term has to be dissociated" |
| } |
| ], |
| "responses" : { |
| "204" : { |
| "description" : "If glossary term dissociation was successful" |
| }, |
| "400" : { |
| "description" : "If ANY of the entity header is invalid" |
| }, |
| "404" : { |
| "description" : "If glossary term guid in invalid" |
| } |
| } |
| }, |
| "get" : { |
| "tags" : [ "GlossaryREST" ], |
| "description" : "Get all entity headers assigned with the specified term", |
| "operationId" : "getEntitiesAssignedWithTerm", |
| "produces" : [ "application/json" ], |
| "parameters" : [ |
| { |
| "name" : "termGuid", |
| "in" : "path", |
| "type" : "string", |
| "description" : "GUID of the term" |
| }, |
| { |
| "name" : "limit", |
| "in" : "query", |
| "default" : "-1", |
| "type" : "string", |
| "description" : "page size - by default there is no paging" |
| }, |
| { |
| "name" : "offset", |
| "in" : "query", |
| "default" : "0", |
| "type" : "string", |
| "description" : "offset for pagination purpose" |
| }, |
| { |
| "name" : "sort", |
| "in" : "query", |
| "default" : "ASC", |
| "type" : "string", |
| "description" : "ASC (default) or DESC" |
| } |
| ], |
| "responses" : { |
| "200" : { |
| "schema" : { |
| "description" : "List of entity headers (if any) for the given glossary or an empty list", |
| "type" : "array", |
| "items" : { |
| "$ref" : "#/definitions/AtlasRelatedObjectId" |
| } |
| }, |
| "examples" : { |
| "application/json" : [ { |
| "displayText" : "...", |
| "entityStatus" : "PURGED", |
| "qualifiedName" : "...", |
| "relationshipAttributes" : { |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "relationshipGuid" : "...", |
| "relationshipStatus" : "ACTIVE", |
| "relationshipType" : "...", |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| } ] |
| }, |
| "description" : "List of entity headers (if any) for the given glossary or an empty list" |
| }, |
| "404" : { |
| "examples" : { |
| "application/json" : [ { |
| "displayText" : "...", |
| "entityStatus" : "ACTIVE", |
| "qualifiedName" : "...", |
| "relationshipAttributes" : { |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "relationshipGuid" : "...", |
| "relationshipStatus" : "DELETED", |
| "relationshipType" : "...", |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| } ] |
| }, |
| "description" : "If glossary term guid in invalid" |
| } |
| } |
| }, |
| "post" : { |
| "tags" : [ "GlossaryREST" ], |
| "description" : "Assign the given term to the provided list of entity headers", |
| "operationId" : "assignTermToEntities", |
| "consumes" : [ "application/json" ], |
| "parameters" : [ |
| { |
| "name" : "termGuid", |
| "in" : "path", |
| "type" : "string", |
| "description" : "Glossary term GUID" |
| }, |
| { |
| "name" : "body", |
| "required" : false, |
| "in" : "body", |
| "schema" : { |
| "description" : "Related Entity IDs to which the term has to be associated", |
| "type" : "array", |
| "items" : { |
| "$ref" : "#/definitions/AtlasRelatedObjectId" |
| } |
| }, |
| "description" : "Related Entity IDs to which the term has to be associated" |
| } |
| ], |
| "responses" : { |
| "204" : { |
| "description" : "If the term assignment was successful" |
| }, |
| "400" : { |
| "description" : "If ANY of the entity header is invalid" |
| }, |
| "404" : { |
| "description" : "If glossary guid in invalid" |
| } |
| } |
| }, |
| "put" : { |
| "tags" : [ "GlossaryREST" ], |
| "description" : "Remove the term assignment for the given list of entity headers", |
| "operationId" : "disassociateTermAssignmentFromEntities", |
| "consumes" : [ "application/json" ], |
| "parameters" : [ |
| { |
| "name" : "termGuid", |
| "in" : "path", |
| "type" : "string", |
| "description" : "Glossary term GUID" |
| }, |
| { |
| "name" : "body", |
| "required" : false, |
| "in" : "body", |
| "schema" : { |
| "description" : "List of related entity IDs from which the term has to be dissociated", |
| "type" : "array", |
| "items" : { |
| "$ref" : "#/definitions/AtlasRelatedObjectId" |
| } |
| }, |
| "description" : "List of related entity IDs from which the term has to be dissociated" |
| } |
| ], |
| "responses" : { |
| "204" : { |
| "description" : "If glossary term dissociation was successful" |
| }, |
| "400" : { |
| "description" : "If ANY of the entity header is invalid" |
| }, |
| "404" : { |
| "description" : "If glossary term guid in invalid" |
| } |
| } |
| } |
| }, |
| "\/v2/glossary/terms/{termGuid}/related" : { |
| "get" : { |
| "tags" : [ "GlossaryREST" ], |
| "description" : "Get all related terms for a specific term", |
| "operationId" : "getRelatedTerms", |
| "produces" : [ "application/json" ], |
| "parameters" : [ |
| { |
| "name" : "termGuid", |
| "in" : "path", |
| "type" : "string", |
| "description" : "unique identifier for glossary term" |
| }, |
| { |
| "name" : "limit", |
| "in" : "query", |
| "default" : "-1", |
| "type" : "string", |
| "description" : "page size - by default there is no paging" |
| }, |
| { |
| "name" : "offset", |
| "in" : "query", |
| "default" : "0", |
| "type" : "string", |
| "description" : "offset for pagination purpose" |
| }, |
| { |
| "name" : "sort", |
| "in" : "query", |
| "default" : "ASC", |
| "type" : "string", |
| "description" : "ASC (default) or DESC" |
| } |
| ], |
| "responses" : { |
| "200" : { |
| "schema" : { |
| "description" : "List of related glossary terms for the given glossary or an empty list", |
| "type" : "object", |
| "additionalProperties" : { |
| "type" : "array", |
| "items" : { |
| "$ref" : "#/definitions/AtlasRelatedTermHeader" |
| } |
| } |
| }, |
| "examples" : { |
| "application/json" : [ { |
| "..." : { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| } |
| } ] |
| }, |
| "description" : "List of related glossary terms for the given glossary or an empty list" |
| }, |
| "404" : { |
| "examples" : { |
| "application/json" : [ { |
| "..." : { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } |
| } ] |
| }, |
| "description" : "If glossary term guid in invalid" |
| } |
| } |
| } |
| }, |
| "\/v2/glossary/{glossaryGuid}" : { |
| "delete" : { |
| "tags" : [ "GlossaryREST" ], |
| "description" : "Delete a glossary", |
| "operationId" : "deleteGlossary", |
| "parameters" : [ |
| { |
| "name" : "glossaryGuid", |
| "in" : "path", |
| "type" : "string", |
| "description" : "unique identifier for glossary" |
| } |
| ], |
| "responses" : { |
| "204" : { |
| "description" : "If glossary delete was successful" |
| }, |
| "404" : { |
| "description" : "If glossary guid in invalid" |
| } |
| } |
| }, |
| "get" : { |
| "tags" : [ "GlossaryREST" ], |
| "description" : "Get a specific Glossary", |
| "operationId" : "getGlossary", |
| "produces" : [ "application/json" ], |
| "parameters" : [ |
| { |
| "name" : "glossaryGuid", |
| "in" : "path", |
| "type" : "string", |
| "description" : "unique glossary identifier" |
| } |
| ], |
| "responses" : { |
| "200" : { |
| "schema" : { |
| "$ref" : "#/definitions/AtlasGlossary", |
| "description" : "If glossary with given guid exists" |
| }, |
| "examples" : { |
| "application/json" : { |
| "categories" : [ { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "parentCategoryGuid" : "...", |
| "relationGuid" : "..." |
| }, { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "parentCategoryGuid" : "...", |
| "relationGuid" : "..." |
| } ], |
| "language" : "...", |
| "terms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "usage" : "...", |
| "additionalAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "longDescription" : "...", |
| "name" : "...", |
| "qualifiedName" : "...", |
| "shortDescription" : "...", |
| "guid" : "..." |
| } |
| }, |
| "description" : "If glossary with given guid exists" |
| }, |
| "404" : { |
| "examples" : { |
| "application/json" : { |
| "categories" : [ { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "parentCategoryGuid" : "...", |
| "relationGuid" : "..." |
| }, { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "parentCategoryGuid" : "...", |
| "relationGuid" : "..." |
| } ], |
| "language" : "...", |
| "terms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "usage" : "...", |
| "additionalAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "longDescription" : "...", |
| "name" : "...", |
| "qualifiedName" : "...", |
| "shortDescription" : "...", |
| "guid" : "..." |
| } |
| }, |
| "description" : "If glossary GUID is invalid" |
| } |
| } |
| }, |
| "put" : { |
| "tags" : [ "GlossaryREST" ], |
| "description" : "Update the given glossary", |
| "operationId" : "updateGlossary", |
| "consumes" : [ "application/json" ], |
| "produces" : [ "application/json" ], |
| "parameters" : [ |
| { |
| "name" : "glossaryGuid", |
| "in" : "path", |
| "type" : "string", |
| "description" : "unique identifier for glossary" |
| }, |
| { |
| "name" : "body", |
| "required" : false, |
| "in" : "body", |
| "schema" : { |
| "$ref" : "#/definitions/AtlasGlossary", |
| "description" : "Updated glossary definition" |
| }, |
| "description" : "Updated glossary definition" |
| } |
| ], |
| "responses" : { |
| "200" : { |
| "schema" : { |
| "$ref" : "#/definitions/AtlasGlossary", |
| "description" : "If glossary update was successful" |
| }, |
| "examples" : { |
| "application/json" : { |
| "categories" : [ { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "parentCategoryGuid" : "...", |
| "relationGuid" : "..." |
| }, { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "parentCategoryGuid" : "...", |
| "relationGuid" : "..." |
| } ], |
| "language" : "...", |
| "terms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "usage" : "...", |
| "additionalAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "longDescription" : "...", |
| "name" : "...", |
| "qualifiedName" : "...", |
| "shortDescription" : "...", |
| "guid" : "..." |
| } |
| }, |
| "description" : "If glossary update was successful" |
| }, |
| "400" : { |
| "examples" : { |
| "application/json" : { |
| "categories" : [ { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "parentCategoryGuid" : "...", |
| "relationGuid" : "..." |
| }, { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "parentCategoryGuid" : "...", |
| "relationGuid" : "..." |
| } ], |
| "language" : "...", |
| "terms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "usage" : "...", |
| "additionalAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "longDescription" : "...", |
| "name" : "...", |
| "qualifiedName" : "...", |
| "shortDescription" : "...", |
| "guid" : "..." |
| } |
| }, |
| "description" : "If Glossary definition has invalid or missing information" |
| }, |
| "404" : { |
| "examples" : { |
| "application/json" : { |
| "categories" : [ { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "parentCategoryGuid" : "...", |
| "relationGuid" : "..." |
| }, { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "parentCategoryGuid" : "...", |
| "relationGuid" : "..." |
| } ], |
| "language" : "...", |
| "terms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "usage" : "...", |
| "additionalAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "longDescription" : "...", |
| "name" : "...", |
| "qualifiedName" : "...", |
| "shortDescription" : "...", |
| "guid" : "..." |
| } |
| }, |
| "description" : "If glossary guid in invalid" |
| } |
| } |
| } |
| }, |
| "\/v2/glossary/{glossaryGuid}/categories" : { |
| "get" : { |
| "tags" : [ "GlossaryREST" ], |
| "description" : "Get the categories belonging to a specific glossary", |
| "operationId" : "getGlossaryCategories", |
| "produces" : [ "application/json" ], |
| "parameters" : [ |
| { |
| "name" : "glossaryGuid", |
| "in" : "path", |
| "type" : "string", |
| "description" : "unique identifier for glossary term" |
| }, |
| { |
| "name" : "limit", |
| "in" : "query", |
| "default" : "-1", |
| "type" : "string", |
| "description" : "page size - by default there is no paging" |
| }, |
| { |
| "name" : "offset", |
| "in" : "query", |
| "default" : "0", |
| "type" : "string", |
| "description" : "offset for pagination purpose" |
| }, |
| { |
| "name" : "sort", |
| "in" : "query", |
| "default" : "ASC", |
| "type" : "string", |
| "description" : "ASC (default) or DESC" |
| } |
| ], |
| "responses" : { |
| "200" : { |
| "schema" : { |
| "description" : "List of glossary categories for the given glossary or an empty list", |
| "type" : "array", |
| "items" : { |
| "$ref" : "#/definitions/AtlasGlossaryCategory" |
| } |
| }, |
| "examples" : { |
| "application/json" : [ { |
| "anchor" : { |
| "displayText" : "...", |
| "glossaryGuid" : "...", |
| "relationGuid" : "..." |
| }, |
| "childrenCategories" : [ { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "parentCategoryGuid" : "...", |
| "relationGuid" : "..." |
| }, { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "parentCategoryGuid" : "...", |
| "relationGuid" : "..." |
| } ], |
| "parentCategory" : { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "parentCategoryGuid" : "...", |
| "relationGuid" : "..." |
| }, |
| "terms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "additionalAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "longDescription" : "...", |
| "name" : "...", |
| "qualifiedName" : "...", |
| "shortDescription" : "...", |
| "guid" : "..." |
| } ] |
| }, |
| "description" : "List of glossary categories for the given glossary or an empty list" |
| }, |
| "404" : { |
| "examples" : { |
| "application/json" : [ { |
| "anchor" : { |
| "displayText" : "...", |
| "glossaryGuid" : "...", |
| "relationGuid" : "..." |
| }, |
| "childrenCategories" : [ { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "parentCategoryGuid" : "...", |
| "relationGuid" : "..." |
| }, { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "parentCategoryGuid" : "...", |
| "relationGuid" : "..." |
| } ], |
| "parentCategory" : { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "parentCategoryGuid" : "...", |
| "relationGuid" : "..." |
| }, |
| "terms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "additionalAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "longDescription" : "...", |
| "name" : "...", |
| "qualifiedName" : "...", |
| "shortDescription" : "...", |
| "guid" : "..." |
| } ] |
| }, |
| "description" : "If glossary guid in invalid" |
| } |
| } |
| } |
| }, |
| "\/v2/glossary/{glossaryGuid}/categories/headers" : { |
| "get" : { |
| "tags" : [ "GlossaryREST" ], |
| "description" : "Get the categories belonging to a specific glossary", |
| "operationId" : "getGlossaryCategoriesHeaders", |
| "produces" : [ "application/json" ], |
| "parameters" : [ |
| { |
| "name" : "glossaryGuid", |
| "in" : "path", |
| "type" : "string", |
| "description" : "unique identifier for glossary term" |
| }, |
| { |
| "name" : "limit", |
| "in" : "query", |
| "default" : "-1", |
| "type" : "string", |
| "description" : "page size - by default there is no paging" |
| }, |
| { |
| "name" : "offset", |
| "in" : "query", |
| "default" : "0", |
| "type" : "string", |
| "description" : "offset for pagination purpose" |
| }, |
| { |
| "name" : "sort", |
| "in" : "query", |
| "default" : "ASC", |
| "type" : "string", |
| "description" : "ASC (default) or DESC" |
| } |
| ], |
| "responses" : { |
| "200" : { |
| "schema" : { |
| "description" : "List of glossary categories for the given glossary or an empty list", |
| "type" : "array", |
| "items" : { |
| "$ref" : "#/definitions/AtlasRelatedCategoryHeader" |
| } |
| }, |
| "examples" : { |
| "application/json" : [ { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "parentCategoryGuid" : "...", |
| "relationGuid" : "..." |
| } ] |
| }, |
| "description" : "List of glossary categories for the given glossary or an empty list" |
| }, |
| "404" : { |
| "examples" : { |
| "application/json" : [ { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "parentCategoryGuid" : "...", |
| "relationGuid" : "..." |
| } ] |
| }, |
| "description" : "If glossary guid in invalid" |
| } |
| } |
| } |
| }, |
| "\/v2/glossary/{glossaryGuid}/detailed" : { |
| "get" : { |
| "tags" : [ "GlossaryREST" ], |
| "description" : "Get a specific Glossary", |
| "operationId" : "getDetailedGlossary", |
| "produces" : [ "application/json" ], |
| "parameters" : [ |
| { |
| "name" : "glossaryGuid", |
| "in" : "path", |
| "type" : "string", |
| "description" : "unique glossary identifier" |
| } |
| ], |
| "responses" : { |
| "200" : { |
| "schema" : { |
| "$ref" : "#/definitions/AtlasGlossaryExtInfo", |
| "description" : "If glossary exists for given GUID" |
| }, |
| "examples" : { |
| "application/json" : { |
| "categoryInfo" : { |
| "property1" : { |
| "anchor" : { |
| "displayText" : "...", |
| "glossaryGuid" : "...", |
| "relationGuid" : "..." |
| }, |
| "childrenCategories" : [ { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "parentCategoryGuid" : "...", |
| "relationGuid" : "..." |
| }, { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "parentCategoryGuid" : "...", |
| "relationGuid" : "..." |
| } ], |
| "parentCategory" : { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "parentCategoryGuid" : "...", |
| "relationGuid" : "..." |
| }, |
| "terms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "additionalAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "longDescription" : "...", |
| "name" : "...", |
| "qualifiedName" : "...", |
| "shortDescription" : "...", |
| "guid" : "..." |
| }, |
| "property2" : { |
| "anchor" : { |
| "displayText" : "...", |
| "glossaryGuid" : "...", |
| "relationGuid" : "..." |
| }, |
| "childrenCategories" : [ { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "parentCategoryGuid" : "...", |
| "relationGuid" : "..." |
| }, { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "parentCategoryGuid" : "...", |
| "relationGuid" : "..." |
| } ], |
| "parentCategory" : { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "parentCategoryGuid" : "...", |
| "relationGuid" : "..." |
| }, |
| "terms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "additionalAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "longDescription" : "...", |
| "name" : "...", |
| "qualifiedName" : "...", |
| "shortDescription" : "...", |
| "guid" : "..." |
| } |
| }, |
| "termInfo" : { |
| "property1" : { |
| "abbreviation" : "...", |
| "anchor" : { |
| "displayText" : "...", |
| "glossaryGuid" : "...", |
| "relationGuid" : "..." |
| }, |
| "antonyms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "assignedEntities" : [ { |
| "displayText" : "...", |
| "entityStatus" : "DELETED", |
| "qualifiedName" : "...", |
| "relationshipAttributes" : { }, |
| "relationshipGuid" : "...", |
| "relationshipStatus" : "DELETED", |
| "relationshipType" : "...", |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, { |
| "displayText" : "...", |
| "entityStatus" : "PURGED", |
| "qualifiedName" : "...", |
| "relationshipAttributes" : { }, |
| "relationshipGuid" : "...", |
| "relationshipStatus" : "DELETED", |
| "relationshipType" : "...", |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| } ], |
| "categories" : [ { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "relationGuid" : "...", |
| "status" : "OBSOLETE" |
| }, { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "relationGuid" : "...", |
| "status" : "OBSOLETE" |
| } ], |
| "classifies" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "examples" : [ "...", "..." ], |
| "glossaryTermHeader" : { |
| "qualifiedName" : "...", |
| "termGuid" : "..." |
| }, |
| "isA" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "preferredTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "preferredToTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "replacedBy" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "replacementTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "seeAlso" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "synonyms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "translatedTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "translationTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "usage" : "...", |
| "validValues" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "validValuesFor" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "additionalAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "longDescription" : "...", |
| "name" : "...", |
| "qualifiedName" : "...", |
| "shortDescription" : "...", |
| "guid" : "..." |
| }, |
| "property2" : { |
| "abbreviation" : "...", |
| "anchor" : { |
| "displayText" : "...", |
| "glossaryGuid" : "...", |
| "relationGuid" : "..." |
| }, |
| "antonyms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "assignedEntities" : [ { |
| "displayText" : "...", |
| "entityStatus" : "ACTIVE", |
| "qualifiedName" : "...", |
| "relationshipAttributes" : { }, |
| "relationshipGuid" : "...", |
| "relationshipStatus" : "ACTIVE", |
| "relationshipType" : "...", |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, { |
| "displayText" : "...", |
| "entityStatus" : "DELETED", |
| "qualifiedName" : "...", |
| "relationshipAttributes" : { }, |
| "relationshipGuid" : "...", |
| "relationshipStatus" : "ACTIVE", |
| "relationshipType" : "...", |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| } ], |
| "categories" : [ { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "relationGuid" : "...", |
| "status" : "ACTIVE" |
| }, { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "relationGuid" : "...", |
| "status" : "DRAFT" |
| } ], |
| "classifies" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "examples" : [ "...", "..." ], |
| "glossaryTermHeader" : { |
| "qualifiedName" : "...", |
| "termGuid" : "..." |
| }, |
| "isA" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "preferredTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "preferredToTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "replacedBy" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "replacementTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "seeAlso" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "synonyms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "translatedTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "translationTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "usage" : "...", |
| "validValues" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "validValuesFor" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "additionalAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "longDescription" : "...", |
| "name" : "...", |
| "qualifiedName" : "...", |
| "shortDescription" : "...", |
| "guid" : "..." |
| } |
| }, |
| "categories" : [ { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "parentCategoryGuid" : "...", |
| "relationGuid" : "..." |
| }, { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "parentCategoryGuid" : "...", |
| "relationGuid" : "..." |
| } ], |
| "language" : "...", |
| "terms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "usage" : "...", |
| "additionalAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "longDescription" : "...", |
| "name" : "...", |
| "qualifiedName" : "...", |
| "shortDescription" : "...", |
| "guid" : "..." |
| } |
| }, |
| "description" : "If glossary exists for given GUID" |
| }, |
| "404" : { |
| "examples" : { |
| "application/json" : { |
| "categoryInfo" : { |
| "property1" : { |
| "anchor" : { |
| "displayText" : "...", |
| "glossaryGuid" : "...", |
| "relationGuid" : "..." |
| }, |
| "childrenCategories" : [ { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "parentCategoryGuid" : "...", |
| "relationGuid" : "..." |
| }, { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "parentCategoryGuid" : "...", |
| "relationGuid" : "..." |
| } ], |
| "parentCategory" : { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "parentCategoryGuid" : "...", |
| "relationGuid" : "..." |
| }, |
| "terms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "additionalAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "longDescription" : "...", |
| "name" : "...", |
| "qualifiedName" : "...", |
| "shortDescription" : "...", |
| "guid" : "..." |
| }, |
| "property2" : { |
| "anchor" : { |
| "displayText" : "...", |
| "glossaryGuid" : "...", |
| "relationGuid" : "..." |
| }, |
| "childrenCategories" : [ { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "parentCategoryGuid" : "...", |
| "relationGuid" : "..." |
| }, { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "parentCategoryGuid" : "...", |
| "relationGuid" : "..." |
| } ], |
| "parentCategory" : { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "parentCategoryGuid" : "...", |
| "relationGuid" : "..." |
| }, |
| "terms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "additionalAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "longDescription" : "...", |
| "name" : "...", |
| "qualifiedName" : "...", |
| "shortDescription" : "...", |
| "guid" : "..." |
| } |
| }, |
| "termInfo" : { |
| "property1" : { |
| "abbreviation" : "...", |
| "anchor" : { |
| "displayText" : "...", |
| "glossaryGuid" : "...", |
| "relationGuid" : "..." |
| }, |
| "antonyms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "assignedEntities" : [ { |
| "displayText" : "...", |
| "entityStatus" : "DELETED", |
| "qualifiedName" : "...", |
| "relationshipAttributes" : { }, |
| "relationshipGuid" : "...", |
| "relationshipStatus" : "ACTIVE", |
| "relationshipType" : "...", |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, { |
| "displayText" : "...", |
| "entityStatus" : "ACTIVE", |
| "qualifiedName" : "...", |
| "relationshipAttributes" : { }, |
| "relationshipGuid" : "...", |
| "relationshipStatus" : "ACTIVE", |
| "relationshipType" : "...", |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| } ], |
| "categories" : [ { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "relationGuid" : "...", |
| "status" : "DEPRECATED" |
| }, { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "relationGuid" : "...", |
| "status" : "DEPRECATED" |
| } ], |
| "classifies" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "examples" : [ "...", "..." ], |
| "glossaryTermHeader" : { |
| "qualifiedName" : "...", |
| "termGuid" : "..." |
| }, |
| "isA" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "preferredTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "preferredToTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "replacedBy" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "replacementTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "seeAlso" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "synonyms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "translatedTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "translationTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "usage" : "...", |
| "validValues" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "validValuesFor" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "additionalAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "longDescription" : "...", |
| "name" : "...", |
| "qualifiedName" : "...", |
| "shortDescription" : "...", |
| "guid" : "..." |
| }, |
| "property2" : { |
| "abbreviation" : "...", |
| "anchor" : { |
| "displayText" : "...", |
| "glossaryGuid" : "...", |
| "relationGuid" : "..." |
| }, |
| "antonyms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "assignedEntities" : [ { |
| "displayText" : "...", |
| "entityStatus" : "PURGED", |
| "qualifiedName" : "...", |
| "relationshipAttributes" : { }, |
| "relationshipGuid" : "...", |
| "relationshipStatus" : "ACTIVE", |
| "relationshipType" : "...", |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, { |
| "displayText" : "...", |
| "entityStatus" : "PURGED", |
| "qualifiedName" : "...", |
| "relationshipAttributes" : { }, |
| "relationshipGuid" : "...", |
| "relationshipStatus" : "ACTIVE", |
| "relationshipType" : "...", |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| } ], |
| "categories" : [ { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "relationGuid" : "...", |
| "status" : "DEPRECATED" |
| }, { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "relationGuid" : "...", |
| "status" : "ACTIVE" |
| } ], |
| "classifies" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "examples" : [ "...", "..." ], |
| "glossaryTermHeader" : { |
| "qualifiedName" : "...", |
| "termGuid" : "..." |
| }, |
| "isA" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "preferredTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "preferredToTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "replacedBy" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "replacementTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "seeAlso" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "synonyms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "translatedTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "translationTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "usage" : "...", |
| "validValues" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "validValuesFor" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "additionalAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "longDescription" : "...", |
| "name" : "...", |
| "qualifiedName" : "...", |
| "shortDescription" : "...", |
| "guid" : "..." |
| } |
| }, |
| "categories" : [ { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "parentCategoryGuid" : "...", |
| "relationGuid" : "..." |
| }, { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "parentCategoryGuid" : "...", |
| "relationGuid" : "..." |
| } ], |
| "language" : "...", |
| "terms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "usage" : "...", |
| "additionalAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "longDescription" : "...", |
| "name" : "...", |
| "qualifiedName" : "...", |
| "shortDescription" : "...", |
| "guid" : "..." |
| } |
| }, |
| "description" : "If glossary GUID is invalid" |
| } |
| } |
| } |
| }, |
| "\/v2/glossary/{glossaryGuid}/partial" : { |
| "put" : { |
| "tags" : [ "GlossaryREST" ], |
| "description" : "Partially update the glossary", |
| "operationId" : "partialUpdateGlossary", |
| "consumes" : [ "application/json" ], |
| "produces" : [ "application/json" ], |
| "parameters" : [ |
| { |
| "name" : "glossaryGuid", |
| "in" : "path", |
| "type" : "string", |
| "description" : "unique identifier for glossary term" |
| }, |
| { |
| "name" : "body", |
| "required" : false, |
| "in" : "body", |
| "schema" : { |
| "description" : "Map containing keys as attribute names and values as corresponding attribute values", |
| "type" : "object", |
| "additionalProperties" : { |
| "type" : "string" |
| } |
| }, |
| "description" : "Map containing keys as attribute names and values as corresponding attribute values" |
| } |
| ], |
| "responses" : { |
| "200" : { |
| "schema" : { |
| "$ref" : "#/definitions/AtlasGlossary", |
| "description" : "If glossary partial update was successful" |
| }, |
| "examples" : { |
| "application/json" : { |
| "categories" : [ { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "parentCategoryGuid" : "...", |
| "relationGuid" : "..." |
| }, { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "parentCategoryGuid" : "...", |
| "relationGuid" : "..." |
| } ], |
| "language" : "...", |
| "terms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "usage" : "...", |
| "additionalAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "longDescription" : "...", |
| "name" : "...", |
| "qualifiedName" : "...", |
| "shortDescription" : "...", |
| "guid" : "..." |
| } |
| }, |
| "description" : "If glossary partial update was successful" |
| }, |
| "400" : { |
| "examples" : { |
| "application/json" : { |
| "categories" : [ { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "parentCategoryGuid" : "...", |
| "relationGuid" : "..." |
| }, { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "parentCategoryGuid" : "...", |
| "relationGuid" : "..." |
| } ], |
| "language" : "...", |
| "terms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "usage" : "...", |
| "additionalAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "longDescription" : "...", |
| "name" : "...", |
| "qualifiedName" : "...", |
| "shortDescription" : "...", |
| "guid" : "..." |
| } |
| }, |
| "description" : "If partial update parameters are invalid" |
| }, |
| "404" : { |
| "examples" : { |
| "application/json" : { |
| "categories" : [ { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "parentCategoryGuid" : "...", |
| "relationGuid" : "..." |
| }, { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "parentCategoryGuid" : "...", |
| "relationGuid" : "..." |
| } ], |
| "language" : "...", |
| "terms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "usage" : "...", |
| "additionalAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "longDescription" : "...", |
| "name" : "...", |
| "qualifiedName" : "...", |
| "shortDescription" : "...", |
| "guid" : "..." |
| } |
| }, |
| "description" : "If glossary guid in invalid" |
| } |
| } |
| } |
| }, |
| "\/v2/glossary/{glossaryGuid}/terms" : { |
| "get" : { |
| "tags" : [ "GlossaryREST" ], |
| "description" : "Get terms belonging to a specific glossary", |
| "operationId" : "getGlossaryTerms", |
| "produces" : [ "application/json" ], |
| "parameters" : [ |
| { |
| "name" : "glossaryGuid", |
| "in" : "path", |
| "type" : "string", |
| "description" : "unique identifier for glossary" |
| }, |
| { |
| "name" : "limit", |
| "in" : "query", |
| "default" : "-1", |
| "type" : "string", |
| "description" : "page size - by default there is no paging" |
| }, |
| { |
| "name" : "offset", |
| "in" : "query", |
| "default" : "0", |
| "type" : "string", |
| "description" : "starting offset for loading terms" |
| }, |
| { |
| "name" : "sort", |
| "in" : "query", |
| "default" : "ASC", |
| "type" : "string", |
| "description" : "ASC(default) or DESC" |
| } |
| ], |
| "responses" : { |
| "200" : { |
| "schema" : { |
| "description" : "List of glossary terms for the given glossary or an empty list", |
| "type" : "array", |
| "items" : { |
| "$ref" : "#/definitions/AtlasGlossaryTerm" |
| } |
| }, |
| "examples" : { |
| "application/json" : [ { |
| "abbreviation" : "...", |
| "anchor" : { |
| "displayText" : "...", |
| "glossaryGuid" : "...", |
| "relationGuid" : "..." |
| }, |
| "antonyms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "assignedEntities" : [ { |
| "displayText" : "...", |
| "entityStatus" : "ACTIVE", |
| "qualifiedName" : "...", |
| "relationshipAttributes" : { |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "relationshipGuid" : "...", |
| "relationshipStatus" : "DELETED", |
| "relationshipType" : "...", |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, { |
| "displayText" : "...", |
| "entityStatus" : "PURGED", |
| "qualifiedName" : "...", |
| "relationshipAttributes" : { |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "relationshipGuid" : "...", |
| "relationshipStatus" : "DELETED", |
| "relationshipType" : "...", |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| } ], |
| "categories" : [ { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "relationGuid" : "...", |
| "status" : "OBSOLETE" |
| }, { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "relationGuid" : "...", |
| "status" : "DEPRECATED" |
| } ], |
| "classifies" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "examples" : [ "...", "..." ], |
| "glossaryTermHeader" : { |
| "qualifiedName" : "...", |
| "termGuid" : "..." |
| }, |
| "isA" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "preferredTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "preferredToTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "replacedBy" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "replacementTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "seeAlso" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "synonyms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "translatedTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "translationTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "usage" : "...", |
| "validValues" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "validValuesFor" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "additionalAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "longDescription" : "...", |
| "name" : "...", |
| "qualifiedName" : "...", |
| "shortDescription" : "...", |
| "guid" : "..." |
| } ] |
| }, |
| "description" : "List of glossary terms for the given glossary or an empty list" |
| }, |
| "404" : { |
| "examples" : { |
| "application/json" : [ { |
| "abbreviation" : "...", |
| "anchor" : { |
| "displayText" : "...", |
| "glossaryGuid" : "...", |
| "relationGuid" : "..." |
| }, |
| "antonyms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "assignedEntities" : [ { |
| "displayText" : "...", |
| "entityStatus" : "DELETED", |
| "qualifiedName" : "...", |
| "relationshipAttributes" : { |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "relationshipGuid" : "...", |
| "relationshipStatus" : "ACTIVE", |
| "relationshipType" : "...", |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, { |
| "displayText" : "...", |
| "entityStatus" : "ACTIVE", |
| "qualifiedName" : "...", |
| "relationshipAttributes" : { |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "relationshipGuid" : "...", |
| "relationshipStatus" : "ACTIVE", |
| "relationshipType" : "...", |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| } ], |
| "categories" : [ { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "relationGuid" : "...", |
| "status" : "ACTIVE" |
| }, { |
| "categoryGuid" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "relationGuid" : "...", |
| "status" : "OBSOLETE" |
| } ], |
| "classifies" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "examples" : [ "...", "..." ], |
| "glossaryTermHeader" : { |
| "qualifiedName" : "...", |
| "termGuid" : "..." |
| }, |
| "isA" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "preferredTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "preferredToTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "replacedBy" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "replacementTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "seeAlso" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "synonyms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "translatedTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DRAFT", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "translationTerms" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "usage" : "...", |
| "validValues" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "ACTIVE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "validValuesFor" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "additionalAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "longDescription" : "...", |
| "name" : "...", |
| "qualifiedName" : "...", |
| "shortDescription" : "...", |
| "guid" : "..." |
| } ] |
| }, |
| "description" : "If glossary guid in invalid" |
| } |
| } |
| } |
| }, |
| "\/v2/glossary/{glossaryGuid}/terms/headers" : { |
| "get" : { |
| "tags" : [ "GlossaryREST" ], |
| "description" : "Get term headers belonging to a specific glossary", |
| "operationId" : "getGlossaryTermHeaders", |
| "produces" : [ "application/json" ], |
| "parameters" : [ |
| { |
| "name" : "glossaryGuid", |
| "in" : "path", |
| "type" : "string", |
| "description" : "unique identifier for glossary" |
| }, |
| { |
| "name" : "limit", |
| "in" : "query", |
| "default" : "-1", |
| "type" : "string", |
| "description" : "page size - by default there is no paging" |
| }, |
| { |
| "name" : "offset", |
| "in" : "query", |
| "default" : "0", |
| "type" : "string", |
| "description" : "starting offset for loading terms" |
| }, |
| { |
| "name" : "sort", |
| "in" : "query", |
| "default" : "ASC", |
| "type" : "string", |
| "description" : "ASC(default) or DESC" |
| } |
| ], |
| "responses" : { |
| "200" : { |
| "schema" : { |
| "description" : "List of glossary terms for the given glossary or an empty list", |
| "type" : "array", |
| "items" : { |
| "$ref" : "#/definitions/AtlasRelatedTermHeader" |
| } |
| }, |
| "examples" : { |
| "application/json" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ] |
| }, |
| "description" : "List of glossary terms for the given glossary or an empty list" |
| }, |
| "404" : { |
| "examples" : { |
| "application/json" : [ { |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ] |
| }, |
| "description" : "If glossary guid in invalid" |
| } |
| } |
| } |
| }, |
| "\/v2/lineage/uniqueAttribute/type/{typeName}" : { |
| "get" : { |
| "tags" : [ "LineageREST" ], |
| "description" : "Returns lineage info about entity.\n\nIn addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format\n\nattr:<attrName>=<attrValue>\n\nNOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName", |
| "operationId" : "getLineageByUniqueAttribute", |
| "produces" : [ "application/json" ], |
| "parameters" : [ |
| { |
| "name" : "typeName", |
| "in" : "path", |
| "type" : "string", |
| "description" : "- typeName of entity" |
| }, |
| { |
| "name" : "depth", |
| "in" : "query", |
| "default" : "3", |
| "type" : "integer", |
| "format" : "int32", |
| "description" : "- number of hops for lineage" |
| }, |
| { |
| "name" : "direction", |
| "in" : "query", |
| "default" : "BOTH", |
| "type" : "string", |
| "enum" : ["BOTH", "INPUT", "OUTPUT"], |
| "description" : "- input, output or both" |
| } |
| ], |
| "responses" : { |
| "200" : { |
| "schema" : { |
| "$ref" : "#/definitions/AtlasLineageInfo", |
| "description" : "If Lineage exists for the given entity" |
| }, |
| "examples" : { |
| "application/json" : { |
| "baseEntityGuid" : "...", |
| "guidEntityMap" : { |
| "property1" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "PROPOSED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "property2" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "PROPOSED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "VALIDATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } |
| }, |
| "lineageDepth" : 12345, |
| "lineageDirection" : "OUTPUT", |
| "lineageOnDemandPayload" : { |
| "property1" : { |
| "depth" : 12345, |
| "direction" : "BOTH", |
| "inputRelationsLimit" : 12345, |
| "outputRelationsLimit" : 12345 |
| }, |
| "property2" : { |
| "depth" : 12345, |
| "direction" : "BOTH", |
| "inputRelationsLimit" : 12345, |
| "outputRelationsLimit" : 12345 |
| } |
| }, |
| "relations" : [ { |
| "fromEntityId" : "...", |
| "relationshipId" : "...", |
| "toEntityId" : "..." |
| }, { |
| "fromEntityId" : "...", |
| "relationshipId" : "...", |
| "toEntityId" : "..." |
| } ], |
| "relationsOnDemand" : { |
| "property1" : { |
| "hasMoreInputs" : true, |
| "hasMoreOutputs" : true, |
| "inputRelationsCount" : 12345, |
| "outputRelationsCount" : 12345 |
| }, |
| "property2" : { |
| "hasMoreInputs" : true, |
| "hasMoreOutputs" : true, |
| "inputRelationsCount" : 12345, |
| "outputRelationsCount" : 12345 |
| } |
| } |
| } |
| }, |
| "description" : "If Lineage exists for the given entity" |
| }, |
| "400" : { |
| "examples" : { |
| "application/json" : { |
| "baseEntityGuid" : "...", |
| "guidEntityMap" : { |
| "property1" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DISCOVERED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DISCOVERED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "property2" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DISCOVERED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "PROPOSED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } |
| }, |
| "lineageDepth" : 12345, |
| "lineageDirection" : "BOTH", |
| "lineageOnDemandPayload" : { |
| "property1" : { |
| "depth" : 12345, |
| "direction" : "OUTPUT", |
| "inputRelationsLimit" : 12345, |
| "outputRelationsLimit" : 12345 |
| }, |
| "property2" : { |
| "depth" : 12345, |
| "direction" : "INPUT", |
| "inputRelationsLimit" : 12345, |
| "outputRelationsLimit" : 12345 |
| } |
| }, |
| "relations" : [ { |
| "fromEntityId" : "...", |
| "relationshipId" : "...", |
| "toEntityId" : "..." |
| }, { |
| "fromEntityId" : "...", |
| "relationshipId" : "...", |
| "toEntityId" : "..." |
| } ], |
| "relationsOnDemand" : { |
| "property1" : { |
| "hasMoreInputs" : true, |
| "hasMoreOutputs" : true, |
| "inputRelationsCount" : 12345, |
| "outputRelationsCount" : 12345 |
| }, |
| "property2" : { |
| "hasMoreInputs" : true, |
| "hasMoreOutputs" : true, |
| "inputRelationsCount" : 12345, |
| "outputRelationsCount" : 12345 |
| } |
| } |
| } |
| }, |
| "description" : "Bad query parameters" |
| }, |
| "404" : { |
| "examples" : { |
| "application/json" : { |
| "baseEntityGuid" : "...", |
| "guidEntityMap" : { |
| "property1" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "PROPOSED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "property2" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "PROPOSED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } |
| }, |
| "lineageDepth" : 12345, |
| "lineageDirection" : "OUTPUT", |
| "lineageOnDemandPayload" : { |
| "property1" : { |
| "depth" : 12345, |
| "direction" : "INPUT", |
| "inputRelationsLimit" : 12345, |
| "outputRelationsLimit" : 12345 |
| }, |
| "property2" : { |
| "depth" : 12345, |
| "direction" : "INPUT", |
| "inputRelationsLimit" : 12345, |
| "outputRelationsLimit" : 12345 |
| } |
| }, |
| "relations" : [ { |
| "fromEntityId" : "...", |
| "relationshipId" : "...", |
| "toEntityId" : "..." |
| }, { |
| "fromEntityId" : "...", |
| "relationshipId" : "...", |
| "toEntityId" : "..." |
| } ], |
| "relationsOnDemand" : { |
| "property1" : { |
| "hasMoreInputs" : true, |
| "hasMoreOutputs" : true, |
| "inputRelationsCount" : 12345, |
| "outputRelationsCount" : 12345 |
| }, |
| "property2" : { |
| "hasMoreInputs" : true, |
| "hasMoreOutputs" : true, |
| "inputRelationsCount" : 12345, |
| "outputRelationsCount" : 12345 |
| } |
| } |
| } |
| }, |
| "description" : "If no lineage is found for the given entity" |
| } |
| } |
| } |
| }, |
| "\/v2/lineage/{guid}" : { |
| "get" : { |
| "tags" : [ "LineageREST" ], |
| "description" : "Returns lineage info about entity.", |
| "operationId" : "getLineageGraph", |
| "produces" : [ "application/json" ], |
| "parameters" : [ |
| { |
| "name" : "guid", |
| "in" : "path", |
| "type" : "string", |
| "description" : "- unique entity id" |
| }, |
| { |
| "name" : "depth", |
| "in" : "query", |
| "default" : "3", |
| "type" : "integer", |
| "format" : "int32", |
| "description" : "- number of hops for lineage" |
| }, |
| { |
| "name" : "direction", |
| "in" : "query", |
| "default" : "BOTH", |
| "type" : "string", |
| "enum" : ["BOTH", "INPUT", "OUTPUT"], |
| "description" : "- input, output or both" |
| } |
| ], |
| "responses" : { |
| "200" : { |
| "schema" : { |
| "$ref" : "#/definitions/AtlasLineageInfo", |
| "description" : "If Lineage exists for the given entity" |
| }, |
| "examples" : { |
| "application/json" : { |
| "baseEntityGuid" : "...", |
| "guidEntityMap" : { |
| "property1" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "VALIDATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "IMPORTED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "property2" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } |
| }, |
| "lineageDepth" : 12345, |
| "lineageDirection" : "OUTPUT", |
| "lineageOnDemandPayload" : { |
| "property1" : { |
| "depth" : 12345, |
| "direction" : "OUTPUT", |
| "inputRelationsLimit" : 12345, |
| "outputRelationsLimit" : 12345 |
| }, |
| "property2" : { |
| "depth" : 12345, |
| "direction" : "BOTH", |
| "inputRelationsLimit" : 12345, |
| "outputRelationsLimit" : 12345 |
| } |
| }, |
| "relations" : [ { |
| "fromEntityId" : "...", |
| "relationshipId" : "...", |
| "toEntityId" : "..." |
| }, { |
| "fromEntityId" : "...", |
| "relationshipId" : "...", |
| "toEntityId" : "..." |
| } ], |
| "relationsOnDemand" : { |
| "property1" : { |
| "hasMoreInputs" : true, |
| "hasMoreOutputs" : true, |
| "inputRelationsCount" : 12345, |
| "outputRelationsCount" : 12345 |
| }, |
| "property2" : { |
| "hasMoreInputs" : true, |
| "hasMoreOutputs" : true, |
| "inputRelationsCount" : 12345, |
| "outputRelationsCount" : 12345 |
| } |
| } |
| } |
| }, |
| "description" : "If Lineage exists for the given entity" |
| }, |
| "400" : { |
| "examples" : { |
| "application/json" : { |
| "baseEntityGuid" : "...", |
| "guidEntityMap" : { |
| "property1" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "PROPOSED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "IMPORTED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "property2" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "VALIDATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } |
| }, |
| "lineageDepth" : 12345, |
| "lineageDirection" : "BOTH", |
| "lineageOnDemandPayload" : { |
| "property1" : { |
| "depth" : 12345, |
| "direction" : "BOTH", |
| "inputRelationsLimit" : 12345, |
| "outputRelationsLimit" : 12345 |
| }, |
| "property2" : { |
| "depth" : 12345, |
| "direction" : "BOTH", |
| "inputRelationsLimit" : 12345, |
| "outputRelationsLimit" : 12345 |
| } |
| }, |
| "relations" : [ { |
| "fromEntityId" : "...", |
| "relationshipId" : "...", |
| "toEntityId" : "..." |
| }, { |
| "fromEntityId" : "...", |
| "relationshipId" : "...", |
| "toEntityId" : "..." |
| } ], |
| "relationsOnDemand" : { |
| "property1" : { |
| "hasMoreInputs" : true, |
| "hasMoreOutputs" : true, |
| "inputRelationsCount" : 12345, |
| "outputRelationsCount" : 12345 |
| }, |
| "property2" : { |
| "hasMoreInputs" : true, |
| "hasMoreOutputs" : true, |
| "inputRelationsCount" : 12345, |
| "outputRelationsCount" : 12345 |
| } |
| } |
| } |
| }, |
| "description" : "Bad query parameters" |
| }, |
| "404" : { |
| "examples" : { |
| "application/json" : { |
| "baseEntityGuid" : "...", |
| "guidEntityMap" : { |
| "property1" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "property2" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DISCOVERED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } |
| }, |
| "lineageDepth" : 12345, |
| "lineageDirection" : "OUTPUT", |
| "lineageOnDemandPayload" : { |
| "property1" : { |
| "depth" : 12345, |
| "direction" : "BOTH", |
| "inputRelationsLimit" : 12345, |
| "outputRelationsLimit" : 12345 |
| }, |
| "property2" : { |
| "depth" : 12345, |
| "direction" : "INPUT", |
| "inputRelationsLimit" : 12345, |
| "outputRelationsLimit" : 12345 |
| } |
| }, |
| "relations" : [ { |
| "fromEntityId" : "...", |
| "relationshipId" : "...", |
| "toEntityId" : "..." |
| }, { |
| "fromEntityId" : "...", |
| "relationshipId" : "...", |
| "toEntityId" : "..." |
| } ], |
| "relationsOnDemand" : { |
| "property1" : { |
| "hasMoreInputs" : true, |
| "hasMoreOutputs" : true, |
| "inputRelationsCount" : 12345, |
| "outputRelationsCount" : 12345 |
| }, |
| "property2" : { |
| "hasMoreInputs" : true, |
| "hasMoreOutputs" : true, |
| "inputRelationsCount" : 12345, |
| "outputRelationsCount" : 12345 |
| } |
| } |
| } |
| }, |
| "description" : "If no lineage is found for the given entity" |
| } |
| } |
| }, |
| "post" : { |
| "tags" : [ "LineageREST" ], |
| "description" : "Returns lineage info about entity.", |
| "operationId" : "getLineageGraph2", |
| "consumes" : [ "application/json" ], |
| "produces" : [ "application/json" ], |
| "parameters" : [ |
| { |
| "name" : "guid", |
| "in" : "path", |
| "type" : "string", |
| "description" : "" |
| }, |
| { |
| "name" : "body", |
| "required" : false, |
| "in" : "body", |
| "schema" : { |
| "description" : "", |
| "type" : "object", |
| "additionalProperties" : { |
| "$ref" : "#/definitions/LineageOnDemandConstraints" |
| } |
| }, |
| "description" : "" |
| } |
| ], |
| "responses" : { |
| "200" : { |
| "schema" : { |
| "$ref" : "#/definitions/AtlasLineageInfo", |
| "description" : "If Lineage exists for the given entity" |
| }, |
| "examples" : { |
| "application/json" : { |
| "baseEntityGuid" : "...", |
| "guidEntityMap" : { |
| "property1" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "IMPORTED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "property2" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "IMPORTED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "VALIDATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } |
| }, |
| "lineageDepth" : 12345, |
| "lineageDirection" : "OUTPUT", |
| "lineageOnDemandPayload" : { |
| "property1" : { |
| "depth" : 12345, |
| "direction" : "OUTPUT", |
| "inputRelationsLimit" : 12345, |
| "outputRelationsLimit" : 12345 |
| }, |
| "property2" : { |
| "depth" : 12345, |
| "direction" : "OUTPUT", |
| "inputRelationsLimit" : 12345, |
| "outputRelationsLimit" : 12345 |
| } |
| }, |
| "relations" : [ { |
| "fromEntityId" : "...", |
| "relationshipId" : "...", |
| "toEntityId" : "..." |
| }, { |
| "fromEntityId" : "...", |
| "relationshipId" : "...", |
| "toEntityId" : "..." |
| } ], |
| "relationsOnDemand" : { |
| "property1" : { |
| "hasMoreInputs" : true, |
| "hasMoreOutputs" : true, |
| "inputRelationsCount" : 12345, |
| "outputRelationsCount" : 12345 |
| }, |
| "property2" : { |
| "hasMoreInputs" : true, |
| "hasMoreOutputs" : true, |
| "inputRelationsCount" : 12345, |
| "outputRelationsCount" : 12345 |
| } |
| } |
| } |
| }, |
| "description" : "If Lineage exists for the given entity" |
| }, |
| "400" : { |
| "examples" : { |
| "application/json" : { |
| "baseEntityGuid" : "...", |
| "guidEntityMap" : { |
| "property1" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "property2" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "VALIDATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "IMPORTED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } |
| }, |
| "lineageDepth" : 12345, |
| "lineageDirection" : "INPUT", |
| "lineageOnDemandPayload" : { |
| "property1" : { |
| "depth" : 12345, |
| "direction" : "INPUT", |
| "inputRelationsLimit" : 12345, |
| "outputRelationsLimit" : 12345 |
| }, |
| "property2" : { |
| "depth" : 12345, |
| "direction" : "INPUT", |
| "inputRelationsLimit" : 12345, |
| "outputRelationsLimit" : 12345 |
| } |
| }, |
| "relations" : [ { |
| "fromEntityId" : "...", |
| "relationshipId" : "...", |
| "toEntityId" : "..." |
| }, { |
| "fromEntityId" : "...", |
| "relationshipId" : "...", |
| "toEntityId" : "..." |
| } ], |
| "relationsOnDemand" : { |
| "property1" : { |
| "hasMoreInputs" : true, |
| "hasMoreOutputs" : true, |
| "inputRelationsCount" : 12345, |
| "outputRelationsCount" : 12345 |
| }, |
| "property2" : { |
| "hasMoreInputs" : true, |
| "hasMoreOutputs" : true, |
| "inputRelationsCount" : 12345, |
| "outputRelationsCount" : 12345 |
| } |
| } |
| } |
| }, |
| "description" : "Bad query parameters" |
| }, |
| "404" : { |
| "examples" : { |
| "application/json" : { |
| "baseEntityGuid" : "...", |
| "guidEntityMap" : { |
| "property1" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "VALIDATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "IMPORTED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "property2" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "VALIDATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } |
| }, |
| "lineageDepth" : 12345, |
| "lineageDirection" : "INPUT", |
| "lineageOnDemandPayload" : { |
| "property1" : { |
| "depth" : 12345, |
| "direction" : "OUTPUT", |
| "inputRelationsLimit" : 12345, |
| "outputRelationsLimit" : 12345 |
| }, |
| "property2" : { |
| "depth" : 12345, |
| "direction" : "INPUT", |
| "inputRelationsLimit" : 12345, |
| "outputRelationsLimit" : 12345 |
| } |
| }, |
| "relations" : [ { |
| "fromEntityId" : "...", |
| "relationshipId" : "...", |
| "toEntityId" : "..." |
| }, { |
| "fromEntityId" : "...", |
| "relationshipId" : "...", |
| "toEntityId" : "..." |
| } ], |
| "relationsOnDemand" : { |
| "property1" : { |
| "hasMoreInputs" : true, |
| "hasMoreOutputs" : true, |
| "inputRelationsCount" : 12345, |
| "outputRelationsCount" : 12345 |
| }, |
| "property2" : { |
| "hasMoreInputs" : true, |
| "hasMoreOutputs" : true, |
| "inputRelationsCount" : 12345, |
| "outputRelationsCount" : 12345 |
| } |
| } |
| } |
| }, |
| "description" : "If no lineage is found for the given entity" |
| } |
| } |
| } |
| }, |
| "\/v2/relationship" : { |
| "post" : { |
| "tags" : [ "RelationshipREST" ], |
| "description" : "Create a new relationship between entities.", |
| "operationId" : "create", |
| "consumes" : [ "application/json" ], |
| "produces" : [ "application/json" ], |
| "parameters" : [ |
| { |
| "name" : "body", |
| "required" : false, |
| "in" : "body", |
| "schema" : { |
| "$ref" : "#/definitions/AtlasRelationship", |
| "description" : "" |
| }, |
| "description" : "" |
| } |
| ], |
| "responses" : { |
| "201" : { |
| "schema" : { |
| "$ref" : "#/definitions/AtlasRelationship", |
| "description" : "" |
| }, |
| "examples" : { |
| "application/json" : { |
| "blockedPropagatedClassifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "end1" : { |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "end2" : { |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "guid" : "...", |
| "homeId" : "...", |
| "label" : "...", |
| "propagateTags" : "ONE_TO_TWO", |
| "propagatedClassifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "provenanceType" : 12345, |
| "status" : "ACTIVE", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } |
| }, |
| "description" : "" |
| } |
| } |
| }, |
| "put" : { |
| "tags" : [ "RelationshipREST" ], |
| "description" : "Update an existing relationship between entities.", |
| "operationId" : "update", |
| "consumes" : [ "application/json" ], |
| "produces" : [ "application/json" ], |
| "parameters" : [ |
| { |
| "name" : "body", |
| "required" : false, |
| "in" : "body", |
| "schema" : { |
| "$ref" : "#/definitions/AtlasRelationship", |
| "description" : "" |
| }, |
| "description" : "" |
| } |
| ], |
| "responses" : { |
| "204" : { |
| "schema" : { |
| "$ref" : "#/definitions/AtlasRelationship", |
| "description" : "" |
| }, |
| "examples" : { |
| "application/json" : { |
| "blockedPropagatedClassifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "end1" : { |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "end2" : { |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "guid" : "...", |
| "homeId" : "...", |
| "label" : "...", |
| "propagateTags" : "NONE", |
| "propagatedClassifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| }, { |
| "endTime" : "...", |
| "startTime" : "...", |
| "timeZone" : "..." |
| } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "provenanceType" : 12345, |
| "status" : "ACTIVE", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } |
| }, |
| "description" : "" |
| } |
| } |
| } |
| }, |
| "\/v2/relationship/guid/{guid}" : { |
| "delete" : { |
| "tags" : [ "RelationshipREST" ], |
| "description" : "Delete a relationship between entities using guid.", |
| "operationId" : "deleteById", |
| "parameters" : [ |
| { |
| "name" : "guid", |
| "in" : "path", |
| "type" : "string", |
| "description" : "" |
| } |
| ], |
| "responses" : { |
| "204" : { |
| "description" : "Success" |
| } |
| } |
| }, |
| "get" : { |
| "tags" : [ "RelationshipREST" ], |
| "description" : "Get relationship information between entities using guid.", |
| "operationId" : "getById2", |
| "produces" : [ "application/json" ], |
| "parameters" : [ |
| { |
| "name" : "guid", |
| "in" : "path", |
| "type" : "string", |
| "description" : "" |
| }, |
| { |
| "name" : "extendedInfo", |
| "in" : "query", |
| "default" : "false", |
| "type" : "boolean", |
| "description" : "" |
| } |
| ], |
| "responses" : { |
| "200" : { |
| "schema" : { |
| "$ref" : "#/definitions/AtlasRelationshipWithExtInfo", |
| "description" : "" |
| }, |
| "examples" : { |
| "application/json" : { |
| "referredEntities" : { |
| "property1" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "property2" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "IMPORTED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } |
| }, |
| "relationship" : { |
| "blockedPropagatedClassifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "end1" : { |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "end2" : { |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "guid" : "...", |
| "homeId" : "...", |
| "label" : "...", |
| "propagateTags" : "BOTH", |
| "propagatedClassifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "provenanceType" : 12345, |
| "status" : "ACTIVE", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } |
| } |
| }, |
| "description" : "" |
| } |
| } |
| } |
| }, |
| "\/v2/search/attribute" : { |
| "get" : { |
| "tags" : [ "DiscoveryREST" ], |
| "description" : "Retrieve data for the specified attribute search query", |
| "operationId" : "searchUsingAttribute", |
| "produces" : [ "application/json" ], |
| "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", |
| "required" : true, |
| "type" : "integer", |
| "format" : "int32", |
| "description" : "limit the result set to only include the specified number of entries" |
| }, |
| { |
| "name" : "offset", |
| "in" : "query", |
| "required" : true, |
| "type" : "integer", |
| "format" : "int32", |
| "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" : { |
| "$ref" : "#/definitions/AtlasSearchResult", |
| "description" : "On successful FullText lookup with some results, might return an empty list if execution succeeded\nwithout any results" |
| }, |
| "examples" : { |
| "application/json" : { |
| "approximateCount" : 12345, |
| "attributes" : { |
| "name" : [ "...", "..." ], |
| "values" : [ [ { }, { } ], [ { }, { } ] ] |
| }, |
| "classification" : "...", |
| "entities" : [ { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "VALIDATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DISCOVERED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "fullTextResult" : [ { |
| "entity" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { }, { } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { }, { } ], |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "score" : 12345.0 |
| }, { |
| "entity" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { }, { } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { }, { } ], |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "score" : 12345.0 |
| } ], |
| "nextMarker" : "...", |
| "queryText" : "...", |
| "queryType" : "DSL", |
| "referredEntities" : { |
| "property1" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DISCOVERED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "IMPORTED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "property2" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "PROPOSED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } |
| }, |
| "relations" : [ { |
| "end1" : { |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "end2" : { |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "guid" : "...", |
| "label" : "...", |
| "propagateTags" : "NONE", |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "end1" : { |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "end2" : { |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "guid" : "...", |
| "label" : "...", |
| "propagateTags" : "BOTH", |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "searchParameters" : { |
| "attributes" : [ "...", "..." ], |
| "classification" : "...", |
| "entityFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "AND", |
| "criterion" : [ { }, { } ], |
| "operator" : "NOT_NULL" |
| }, |
| "excludeDeletedEntities" : true, |
| "excludeHeaderAttributes" : true, |
| "includeClassificationAttributes" : true, |
| "includeSubClassifications" : true, |
| "includeSubTypes" : true, |
| "limit" : 12345, |
| "marker" : "...", |
| "offset" : 12345, |
| "query" : "...", |
| "relationshipFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "OR", |
| "criterion" : [ { }, { } ], |
| "operator" : "ENDS_WITH" |
| }, |
| "relationshipName" : "...", |
| "sortBy" : "...", |
| "sortOrder" : "ASCENDING", |
| "tagFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "AND", |
| "criterion" : [ { }, { } ], |
| "operator" : "LIKE" |
| }, |
| "termName" : "...", |
| "typeName" : "..." |
| }, |
| "type" : "..." |
| } |
| }, |
| "description" : "On successful FullText lookup with some results, might return an empty list if execution succeeded\nwithout any results" |
| }, |
| "400" : { |
| "examples" : { |
| "application/json" : { |
| "approximateCount" : 12345, |
| "attributes" : { |
| "name" : [ "...", "..." ], |
| "values" : [ [ { }, { } ], [ { }, { } ] ] |
| }, |
| "classification" : "...", |
| "entities" : [ { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "VALIDATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "VALIDATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "fullTextResult" : [ { |
| "entity" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { }, { } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { }, { } ], |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "score" : 12345.0 |
| }, { |
| "entity" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { }, { } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { }, { } ], |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "score" : 12345.0 |
| } ], |
| "nextMarker" : "...", |
| "queryText" : "...", |
| "queryType" : "FULL_TEXT", |
| "referredEntities" : { |
| "property1" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "VALIDATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "PROPOSED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "property2" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } |
| }, |
| "relations" : [ { |
| "end1" : { |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "end2" : { |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "guid" : "...", |
| "label" : "...", |
| "propagateTags" : "TWO_TO_ONE", |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "end1" : { |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "end2" : { |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "guid" : "...", |
| "label" : "...", |
| "propagateTags" : "TWO_TO_ONE", |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "searchParameters" : { |
| "attributes" : [ "...", "..." ], |
| "classification" : "...", |
| "entityFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "OR", |
| "criterion" : [ { }, { } ], |
| "operator" : "IS_NULL" |
| }, |
| "excludeDeletedEntities" : true, |
| "excludeHeaderAttributes" : true, |
| "includeClassificationAttributes" : true, |
| "includeSubClassifications" : true, |
| "includeSubTypes" : true, |
| "limit" : 12345, |
| "marker" : "...", |
| "offset" : 12345, |
| "query" : "...", |
| "relationshipFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "AND", |
| "criterion" : [ { }, { } ], |
| "operator" : "CONTAINS" |
| }, |
| "relationshipName" : "...", |
| "sortBy" : "...", |
| "sortOrder" : "ASCENDING", |
| "tagFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "AND", |
| "criterion" : [ { }, { } ], |
| "operator" : "TIME_RANGE" |
| }, |
| "termName" : "...", |
| "typeName" : "..." |
| }, |
| "type" : "..." |
| } |
| }, |
| "description" : "Invalid wildcard or query parameters" |
| } |
| } |
| } |
| }, |
| "\/v2/search/basic" : { |
| "get" : { |
| "tags" : [ "DiscoveryREST" ], |
| "description" : "Retrieve data for the specified fulltext query", |
| "operationId" : "searchUsingBasic", |
| "produces" : [ "application/json" ], |
| "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", |
| "required" : true, |
| "type" : "boolean", |
| "description" : "" |
| }, |
| { |
| "name" : "limit", |
| "in" : "query", |
| "required" : true, |
| "type" : "integer", |
| "format" : "int32", |
| "description" : "limit the result set to only include the specified number of entries" |
| }, |
| { |
| "name" : "marker", |
| "in" : "query", |
| "type" : "string", |
| "description" : "" |
| }, |
| { |
| "name" : "offset", |
| "in" : "query", |
| "required" : true, |
| "type" : "integer", |
| "format" : "int32", |
| "description" : "start offset of the result set (useful for pagination)" |
| }, |
| { |
| "name" : "query", |
| "in" : "query", |
| "type" : "string", |
| "description" : "Fulltext query" |
| }, |
| { |
| "name" : "sortBy", |
| "in" : "query", |
| "type" : "string", |
| "description" : "" |
| }, |
| { |
| "name" : "sortOrder", |
| "in" : "query", |
| "type" : "string", |
| "enum" : ["ASCENDING", "DESCENDING"], |
| "description" : "" |
| }, |
| { |
| "name" : "typeName", |
| "in" : "query", |
| "type" : "string", |
| "description" : "limit the result to only entities of specified type or its sub-types" |
| } |
| ], |
| "responses" : { |
| "200" : { |
| "schema" : { |
| "$ref" : "#/definitions/AtlasSearchResult", |
| "description" : "On successful FullText lookup with some results, might return an empty list if execution succeeded\nwithout any results" |
| }, |
| "examples" : { |
| "application/json" : { |
| "approximateCount" : 12345, |
| "attributes" : { |
| "name" : [ "...", "..." ], |
| "values" : [ [ { }, { } ], [ { }, { } ] ] |
| }, |
| "classification" : "...", |
| "entities" : [ { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "VALIDATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "PROPOSED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "PROPOSED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "fullTextResult" : [ { |
| "entity" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { }, { } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { }, { } ], |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "score" : 12345.0 |
| }, { |
| "entity" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { }, { } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { }, { } ], |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "score" : 12345.0 |
| } ], |
| "nextMarker" : "...", |
| "queryText" : "...", |
| "queryType" : "FULL_TEXT", |
| "referredEntities" : { |
| "property1" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "IMPORTED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "PROPOSED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "property2" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "VALIDATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "IMPORTED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } |
| }, |
| "relations" : [ { |
| "end1" : { |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "end2" : { |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "guid" : "...", |
| "label" : "...", |
| "propagateTags" : "ONE_TO_TWO", |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "end1" : { |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "end2" : { |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "guid" : "...", |
| "label" : "...", |
| "propagateTags" : "ONE_TO_TWO", |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "searchParameters" : { |
| "attributes" : [ "...", "..." ], |
| "classification" : "...", |
| "entityFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "AND", |
| "criterion" : [ { }, { } ], |
| "operator" : "ENDS_WITH" |
| }, |
| "excludeDeletedEntities" : true, |
| "excludeHeaderAttributes" : true, |
| "includeClassificationAttributes" : true, |
| "includeSubClassifications" : true, |
| "includeSubTypes" : true, |
| "limit" : 12345, |
| "marker" : "...", |
| "offset" : 12345, |
| "query" : "...", |
| "relationshipFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "AND", |
| "criterion" : [ { }, { } ], |
| "operator" : "NOT_EMPTY" |
| }, |
| "relationshipName" : "...", |
| "sortBy" : "...", |
| "sortOrder" : "ASCENDING", |
| "tagFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "AND", |
| "criterion" : [ { }, { } ], |
| "operator" : "GTE" |
| }, |
| "termName" : "...", |
| "typeName" : "..." |
| }, |
| "type" : "..." |
| } |
| }, |
| "description" : "On successful FullText lookup with some results, might return an empty list if execution succeeded\nwithout any results" |
| }, |
| "400" : { |
| "examples" : { |
| "application/json" : { |
| "approximateCount" : 12345, |
| "attributes" : { |
| "name" : [ "...", "..." ], |
| "values" : [ [ { }, { } ], [ { }, { } ] ] |
| }, |
| "classification" : "...", |
| "entities" : [ { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "PROPOSED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "PROPOSED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "fullTextResult" : [ { |
| "entity" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { }, { } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { }, { } ], |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "score" : 12345.0 |
| }, { |
| "entity" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { }, { } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { }, { } ], |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "score" : 12345.0 |
| } ], |
| "nextMarker" : "...", |
| "queryText" : "...", |
| "queryType" : "GREMLIN", |
| "referredEntities" : { |
| "property1" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "IMPORTED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "property2" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "VALIDATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } |
| }, |
| "relations" : [ { |
| "end1" : { |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "end2" : { |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "guid" : "...", |
| "label" : "...", |
| "propagateTags" : "ONE_TO_TWO", |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "end1" : { |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "end2" : { |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "guid" : "...", |
| "label" : "...", |
| "propagateTags" : "ONE_TO_TWO", |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "searchParameters" : { |
| "attributes" : [ "...", "..." ], |
| "classification" : "...", |
| "entityFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "AND", |
| "criterion" : [ { }, { } ], |
| "operator" : "STARTS_WITH" |
| }, |
| "excludeDeletedEntities" : true, |
| "excludeHeaderAttributes" : true, |
| "includeClassificationAttributes" : true, |
| "includeSubClassifications" : true, |
| "includeSubTypes" : true, |
| "limit" : 12345, |
| "marker" : "...", |
| "offset" : 12345, |
| "query" : "...", |
| "relationshipFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "OR", |
| "criterion" : [ { }, { } ], |
| "operator" : "NOT_CONTAINS" |
| }, |
| "relationshipName" : "...", |
| "sortBy" : "...", |
| "sortOrder" : "ASCENDING", |
| "tagFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "OR", |
| "criterion" : [ { }, { } ], |
| "operator" : "NOT_NULL" |
| }, |
| "termName" : "...", |
| "typeName" : "..." |
| }, |
| "type" : "..." |
| } |
| }, |
| "description" : "Invalid fulltext or query parameters" |
| } |
| } |
| }, |
| "post" : { |
| "tags" : [ "DiscoveryREST" ], |
| "description" : "Attribute based search for entities satisfying the search parameters", |
| "operationId" : "searchWithParameters", |
| "consumes" : [ "application/json" ], |
| "produces" : [ "application/json" ], |
| "parameters" : [ |
| { |
| "name" : "body", |
| "required" : false, |
| "in" : "body", |
| "schema" : { |
| "$ref" : "#/definitions/SearchParameters", |
| "description" : "Search parameters" |
| }, |
| "description" : "Search parameters" |
| } |
| ], |
| "responses" : { |
| "200" : { |
| "schema" : { |
| "$ref" : "#/definitions/AtlasSearchResult", |
| "description" : "On successful search" |
| }, |
| "examples" : { |
| "application/json" : { |
| "approximateCount" : 12345, |
| "attributes" : { |
| "name" : [ "...", "..." ], |
| "values" : [ [ { }, { } ], [ { }, { } ] ] |
| }, |
| "classification" : "...", |
| "entities" : [ { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DISCOVERED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "fullTextResult" : [ { |
| "entity" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { }, { } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { }, { } ], |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "score" : 12345.0 |
| }, { |
| "entity" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { }, { } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { }, { } ], |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "score" : 12345.0 |
| } ], |
| "nextMarker" : "...", |
| "queryText" : "...", |
| "queryType" : "GREMLIN", |
| "referredEntities" : { |
| "property1" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "PROPOSED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DISCOVERED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "property2" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } |
| }, |
| "relations" : [ { |
| "end1" : { |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "end2" : { |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "guid" : "...", |
| "label" : "...", |
| "propagateTags" : "NONE", |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "end1" : { |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "end2" : { |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "guid" : "...", |
| "label" : "...", |
| "propagateTags" : "TWO_TO_ONE", |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "searchParameters" : { |
| "attributes" : [ "...", "..." ], |
| "classification" : "...", |
| "entityFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "AND", |
| "criterion" : [ { }, { } ], |
| "operator" : "NOT_NULL" |
| }, |
| "excludeDeletedEntities" : true, |
| "excludeHeaderAttributes" : true, |
| "includeClassificationAttributes" : true, |
| "includeSubClassifications" : true, |
| "includeSubTypes" : true, |
| "limit" : 12345, |
| "marker" : "...", |
| "offset" : 12345, |
| "query" : "...", |
| "relationshipFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "AND", |
| "criterion" : [ { }, { } ], |
| "operator" : "NOT_EMPTY" |
| }, |
| "relationshipName" : "...", |
| "sortBy" : "...", |
| "sortOrder" : "ASCENDING", |
| "tagFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "OR", |
| "criterion" : [ { }, { } ], |
| "operator" : "CONTAINS_ANY" |
| }, |
| "termName" : "...", |
| "typeName" : "..." |
| }, |
| "type" : "..." |
| } |
| }, |
| "description" : "On successful search" |
| }, |
| "400" : { |
| "examples" : { |
| "application/json" : { |
| "approximateCount" : 12345, |
| "attributes" : { |
| "name" : [ "...", "..." ], |
| "values" : [ [ { }, { } ], [ { }, { } ] ] |
| }, |
| "classification" : "...", |
| "entities" : [ { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "IMPORTED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "IMPORTED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "IMPORTED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "PROPOSED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "fullTextResult" : [ { |
| "entity" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { }, { } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { }, { } ], |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "score" : 12345.0 |
| }, { |
| "entity" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { }, { } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { }, { } ], |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "score" : 12345.0 |
| } ], |
| "nextMarker" : "...", |
| "queryText" : "...", |
| "queryType" : "DSL", |
| "referredEntities" : { |
| "property1" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "IMPORTED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DISCOVERED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "property2" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DISCOVERED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DISCOVERED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } |
| }, |
| "relations" : [ { |
| "end1" : { |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "end2" : { |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "guid" : "...", |
| "label" : "...", |
| "propagateTags" : "BOTH", |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "end1" : { |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "end2" : { |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "guid" : "...", |
| "label" : "...", |
| "propagateTags" : "NONE", |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "searchParameters" : { |
| "attributes" : [ "...", "..." ], |
| "classification" : "...", |
| "entityFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "OR", |
| "criterion" : [ { }, { } ], |
| "operator" : "GT" |
| }, |
| "excludeDeletedEntities" : true, |
| "excludeHeaderAttributes" : true, |
| "includeClassificationAttributes" : true, |
| "includeSubClassifications" : true, |
| "includeSubTypes" : true, |
| "limit" : 12345, |
| "marker" : "...", |
| "offset" : 12345, |
| "query" : "...", |
| "relationshipFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "AND", |
| "criterion" : [ { }, { } ], |
| "operator" : "LT" |
| }, |
| "relationshipName" : "...", |
| "sortBy" : "...", |
| "sortOrder" : "ASCENDING", |
| "tagFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "OR", |
| "criterion" : [ { }, { } ], |
| "operator" : "EQ" |
| }, |
| "termName" : "...", |
| "typeName" : "..." |
| }, |
| "type" : "..." |
| } |
| }, |
| "description" : "Tag/Entity doesn't exist or Tag/entity filter is present without tag/type name" |
| } |
| } |
| } |
| }, |
| "\/v2/search/dsl" : { |
| "get" : { |
| "tags" : [ "DiscoveryREST" ], |
| "description" : "Retrieve data for the specified DSL", |
| "operationId" : "searchUsingDSL", |
| "produces" : [ "application/json" ], |
| "parameters" : [ |
| { |
| "name" : "classification", |
| "in" : "query", |
| "type" : "string", |
| "description" : "limit the result to only entities tagged with the given classification or or its sub-types" |
| }, |
| { |
| "name" : "limit", |
| "in" : "query", |
| "required" : true, |
| "type" : "integer", |
| "format" : "int32", |
| "description" : "limit the result set to only include the specified number of entries" |
| }, |
| { |
| "name" : "offset", |
| "in" : "query", |
| "required" : true, |
| "type" : "integer", |
| "format" : "int32", |
| "description" : "start offset of the result set (useful for pagination)" |
| }, |
| { |
| "name" : "query", |
| "in" : "query", |
| "type" : "string", |
| "description" : "DSL query" |
| }, |
| { |
| "name" : "typeName", |
| "in" : "query", |
| "type" : "string", |
| "description" : "limit the result to only entities of specified type or its sub-types" |
| } |
| ], |
| "responses" : { |
| "200" : { |
| "schema" : { |
| "$ref" : "#/definitions/AtlasSearchResult", |
| "description" : "On successful DSL execution with some results, might return an empty list if execution succeeded\nwithout any results" |
| }, |
| "examples" : { |
| "application/json" : { |
| "approximateCount" : 12345, |
| "attributes" : { |
| "name" : [ "...", "..." ], |
| "values" : [ [ { }, { } ], [ { }, { } ] ] |
| }, |
| "classification" : "...", |
| "entities" : [ { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DISCOVERED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "VALIDATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DISCOVERED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "fullTextResult" : [ { |
| "entity" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { }, { } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { }, { } ], |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "score" : 12345.0 |
| }, { |
| "entity" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { }, { } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { }, { } ], |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "score" : 12345.0 |
| } ], |
| "nextMarker" : "...", |
| "queryText" : "...", |
| "queryType" : "GREMLIN", |
| "referredEntities" : { |
| "property1" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "PROPOSED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "IMPORTED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "property2" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "IMPORTED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } |
| }, |
| "relations" : [ { |
| "end1" : { |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "end2" : { |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "guid" : "...", |
| "label" : "...", |
| "propagateTags" : "ONE_TO_TWO", |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "end1" : { |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "end2" : { |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "guid" : "...", |
| "label" : "...", |
| "propagateTags" : "BOTH", |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "searchParameters" : { |
| "attributes" : [ "...", "..." ], |
| "classification" : "...", |
| "entityFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "AND", |
| "criterion" : [ { }, { } ], |
| "operator" : "NOT_NULL" |
| }, |
| "excludeDeletedEntities" : true, |
| "excludeHeaderAttributes" : true, |
| "includeClassificationAttributes" : true, |
| "includeSubClassifications" : true, |
| "includeSubTypes" : true, |
| "limit" : 12345, |
| "marker" : "...", |
| "offset" : 12345, |
| "query" : "...", |
| "relationshipFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "AND", |
| "criterion" : [ { }, { } ], |
| "operator" : "TIME_RANGE" |
| }, |
| "relationshipName" : "...", |
| "sortBy" : "...", |
| "sortOrder" : "DESCENDING", |
| "tagFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "OR", |
| "criterion" : [ { }, { } ], |
| "operator" : "GT" |
| }, |
| "termName" : "...", |
| "typeName" : "..." |
| }, |
| "type" : "..." |
| } |
| }, |
| "description" : "On successful DSL execution with some results, might return an empty list if execution succeeded\nwithout any results" |
| }, |
| "400" : { |
| "examples" : { |
| "application/json" : { |
| "approximateCount" : 12345, |
| "attributes" : { |
| "name" : [ "...", "..." ], |
| "values" : [ [ { }, { } ], [ { }, { } ] ] |
| }, |
| "classification" : "...", |
| "entities" : [ { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "VALIDATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DISCOVERED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "fullTextResult" : [ { |
| "entity" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { }, { } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { }, { } ], |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "score" : 12345.0 |
| }, { |
| "entity" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { }, { } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { }, { } ], |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "score" : 12345.0 |
| } ], |
| "nextMarker" : "...", |
| "queryText" : "...", |
| "queryType" : "DSL", |
| "referredEntities" : { |
| "property1" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "PROPOSED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "PROPOSED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "property2" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } |
| }, |
| "relations" : [ { |
| "end1" : { |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "end2" : { |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "guid" : "...", |
| "label" : "...", |
| "propagateTags" : "NONE", |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "end1" : { |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "end2" : { |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "guid" : "...", |
| "label" : "...", |
| "propagateTags" : "NONE", |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "searchParameters" : { |
| "attributes" : [ "...", "..." ], |
| "classification" : "...", |
| "entityFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "AND", |
| "criterion" : [ { }, { } ], |
| "operator" : "CONTAINS_ALL" |
| }, |
| "excludeDeletedEntities" : true, |
| "excludeHeaderAttributes" : true, |
| "includeClassificationAttributes" : true, |
| "includeSubClassifications" : true, |
| "includeSubTypes" : true, |
| "limit" : 12345, |
| "marker" : "...", |
| "offset" : 12345, |
| "query" : "...", |
| "relationshipFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "OR", |
| "criterion" : [ { }, { } ], |
| "operator" : "CONTAINS" |
| }, |
| "relationshipName" : "...", |
| "sortBy" : "...", |
| "sortOrder" : "DESCENDING", |
| "tagFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "AND", |
| "criterion" : [ { }, { } ], |
| "operator" : "NEQ" |
| }, |
| "termName" : "...", |
| "typeName" : "..." |
| }, |
| "type" : "..." |
| } |
| }, |
| "description" : "Invalid DSL or query parameters" |
| } |
| } |
| } |
| }, |
| "\/v2/search/fulltext" : { |
| "get" : { |
| "tags" : [ "DiscoveryREST" ], |
| "description" : "Retrieve data for the specified fulltext query", |
| "operationId" : "searchUsingFullText", |
| "produces" : [ "application/json" ], |
| "parameters" : [ |
| { |
| "name" : "excludeDeletedEntities", |
| "in" : "query", |
| "required" : true, |
| "type" : "boolean", |
| "description" : "" |
| }, |
| { |
| "name" : "limit", |
| "in" : "query", |
| "required" : true, |
| "type" : "integer", |
| "format" : "int32", |
| "description" : "limit the result set to only include the specified number of entries" |
| }, |
| { |
| "name" : "offset", |
| "in" : "query", |
| "required" : true, |
| "type" : "integer", |
| "format" : "int32", |
| "description" : "start offset of the result set (useful for pagination)" |
| }, |
| { |
| "name" : "query", |
| "in" : "query", |
| "type" : "string", |
| "description" : "Fulltext query" |
| } |
| ], |
| "responses" : { |
| "200" : { |
| "schema" : { |
| "$ref" : "#/definitions/AtlasSearchResult", |
| "description" : "On successful FullText lookup with some results, might return an empty list if execution succeeded\nwithout any results" |
| }, |
| "examples" : { |
| "application/json" : { |
| "approximateCount" : 12345, |
| "attributes" : { |
| "name" : [ "...", "..." ], |
| "values" : [ [ { }, { } ], [ { }, { } ] ] |
| }, |
| "classification" : "...", |
| "entities" : [ { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DISCOVERED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "IMPORTED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "PROPOSED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DISCOVERED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "fullTextResult" : [ { |
| "entity" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { }, { } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { }, { } ], |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "score" : 12345.0 |
| }, { |
| "entity" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { }, { } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { }, { } ], |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "score" : 12345.0 |
| } ], |
| "nextMarker" : "...", |
| "queryText" : "...", |
| "queryType" : "BASIC", |
| "referredEntities" : { |
| "property1" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "property2" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "IMPORTED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } |
| }, |
| "relations" : [ { |
| "end1" : { |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "end2" : { |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "guid" : "...", |
| "label" : "...", |
| "propagateTags" : "NONE", |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "end1" : { |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "end2" : { |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "guid" : "...", |
| "label" : "...", |
| "propagateTags" : "BOTH", |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "searchParameters" : { |
| "attributes" : [ "...", "..." ], |
| "classification" : "...", |
| "entityFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "OR", |
| "criterion" : [ { }, { } ], |
| "operator" : "CONTAINS" |
| }, |
| "excludeDeletedEntities" : true, |
| "excludeHeaderAttributes" : true, |
| "includeClassificationAttributes" : true, |
| "includeSubClassifications" : true, |
| "includeSubTypes" : true, |
| "limit" : 12345, |
| "marker" : "...", |
| "offset" : 12345, |
| "query" : "...", |
| "relationshipFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "OR", |
| "criterion" : [ { }, { } ], |
| "operator" : "LTE" |
| }, |
| "relationshipName" : "...", |
| "sortBy" : "...", |
| "sortOrder" : "DESCENDING", |
| "tagFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "AND", |
| "criterion" : [ { }, { } ], |
| "operator" : "STARTS_WITH" |
| }, |
| "termName" : "...", |
| "typeName" : "..." |
| }, |
| "type" : "..." |
| } |
| }, |
| "description" : "On successful FullText lookup with some results, might return an empty list if execution succeeded\nwithout any results" |
| }, |
| "400" : { |
| "examples" : { |
| "application/json" : { |
| "approximateCount" : 12345, |
| "attributes" : { |
| "name" : [ "...", "..." ], |
| "values" : [ [ { }, { } ], [ { }, { } ] ] |
| }, |
| "classification" : "...", |
| "entities" : [ { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "VALIDATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DISCOVERED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "IMPORTED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "fullTextResult" : [ { |
| "entity" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { }, { } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { }, { } ], |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "score" : 12345.0 |
| }, { |
| "entity" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { }, { } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { }, { } ], |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "score" : 12345.0 |
| } ], |
| "nextMarker" : "...", |
| "queryText" : "...", |
| "queryType" : "BASIC", |
| "referredEntities" : { |
| "property1" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "IMPORTED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "property2" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "PROPOSED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } |
| }, |
| "relations" : [ { |
| "end1" : { |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "end2" : { |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "guid" : "...", |
| "label" : "...", |
| "propagateTags" : "NONE", |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "end1" : { |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "end2" : { |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "guid" : "...", |
| "label" : "...", |
| "propagateTags" : "TWO_TO_ONE", |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "searchParameters" : { |
| "attributes" : [ "...", "..." ], |
| "classification" : "...", |
| "entityFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "AND", |
| "criterion" : [ { }, { } ], |
| "operator" : "CONTAINS" |
| }, |
| "excludeDeletedEntities" : true, |
| "excludeHeaderAttributes" : true, |
| "includeClassificationAttributes" : true, |
| "includeSubClassifications" : true, |
| "includeSubTypes" : true, |
| "limit" : 12345, |
| "marker" : "...", |
| "offset" : 12345, |
| "query" : "...", |
| "relationshipFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "AND", |
| "criterion" : [ { }, { } ], |
| "operator" : "EQ" |
| }, |
| "relationshipName" : "...", |
| "sortBy" : "...", |
| "sortOrder" : "ASCENDING", |
| "tagFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "OR", |
| "criterion" : [ { }, { } ], |
| "operator" : "NEQ" |
| }, |
| "termName" : "...", |
| "typeName" : "..." |
| }, |
| "type" : "..." |
| } |
| }, |
| "description" : "Invalid fulltext or query parameters" |
| } |
| } |
| } |
| }, |
| "\/v2/search/quick" : { |
| "get" : { |
| "tags" : [ "DiscoveryREST" ], |
| "description" : "Attribute based search for entities satisfying the search parameters", |
| "operationId" : "quickSearch", |
| "produces" : [ "application/json" ], |
| "parameters" : [ |
| { |
| "name" : "excludeDeletedEntities", |
| "in" : "query", |
| "required" : true, |
| "type" : "boolean", |
| "description" : "" |
| }, |
| { |
| "name" : "limit", |
| "in" : "query", |
| "required" : true, |
| "type" : "integer", |
| "format" : "int32", |
| "description" : "" |
| }, |
| { |
| "name" : "offset", |
| "in" : "query", |
| "required" : true, |
| "type" : "integer", |
| "format" : "int32", |
| "description" : "" |
| }, |
| { |
| "name" : "query", |
| "in" : "query", |
| "type" : "string", |
| "description" : "" |
| }, |
| { |
| "name" : "sortBy", |
| "in" : "query", |
| "type" : "string", |
| "description" : "" |
| }, |
| { |
| "name" : "sortOrder", |
| "in" : "query", |
| "type" : "string", |
| "enum" : ["ASCENDING", "DESCENDING"], |
| "description" : "" |
| }, |
| { |
| "name" : "typeName", |
| "in" : "query", |
| "type" : "string", |
| "description" : "" |
| } |
| ], |
| "responses" : { |
| "200" : { |
| "schema" : { |
| "$ref" : "#/definitions/AtlasQuickSearchResult", |
| "description" : "On successful search" |
| }, |
| "examples" : { |
| "application/json" : { |
| "aggregationMetrics" : { |
| "property1" : [ { |
| "count" : 12345, |
| "name" : "..." |
| }, { |
| "count" : 12345, |
| "name" : "..." |
| } ], |
| "property2" : [ { |
| "count" : 12345, |
| "name" : "..." |
| }, { |
| "count" : 12345, |
| "name" : "..." |
| } ] |
| }, |
| "searchResults" : { |
| "approximateCount" : 12345, |
| "attributes" : { |
| "name" : [ "...", "..." ], |
| "values" : [ [ { }, { } ], [ { }, { } ] ] |
| }, |
| "classification" : "...", |
| "entities" : [ { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { }, { } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { }, { } ], |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { }, { } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { }, { } ], |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "fullTextResult" : [ { |
| "entity" : { }, |
| "score" : 12345.0 |
| }, { |
| "entity" : { }, |
| "score" : 12345.0 |
| } ], |
| "nextMarker" : "...", |
| "queryText" : "...", |
| "queryType" : "BASIC", |
| "referredEntities" : { |
| "property1" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { }, { } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { }, { } ], |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "property2" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { }, { } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { }, { } ], |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } |
| }, |
| "relations" : [ { |
| "end1" : { }, |
| "end2" : { }, |
| "guid" : "...", |
| "label" : "...", |
| "propagateTags" : "ONE_TO_TWO", |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "end1" : { }, |
| "end2" : { }, |
| "guid" : "...", |
| "label" : "...", |
| "propagateTags" : "BOTH", |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "searchParameters" : { |
| "attributes" : [ "...", "..." ], |
| "classification" : "...", |
| "entityFilters" : { }, |
| "excludeDeletedEntities" : true, |
| "excludeHeaderAttributes" : true, |
| "includeClassificationAttributes" : true, |
| "includeSubClassifications" : true, |
| "includeSubTypes" : true, |
| "limit" : 12345, |
| "marker" : "...", |
| "offset" : 12345, |
| "query" : "...", |
| "relationshipFilters" : { }, |
| "relationshipName" : "...", |
| "sortBy" : "...", |
| "sortOrder" : "ASCENDING", |
| "tagFilters" : { }, |
| "termName" : "...", |
| "typeName" : "..." |
| }, |
| "type" : "..." |
| } |
| } |
| }, |
| "description" : "On successful search" |
| }, |
| "400" : { |
| "examples" : { |
| "application/json" : { |
| "aggregationMetrics" : { |
| "property1" : [ { |
| "count" : 12345, |
| "name" : "..." |
| }, { |
| "count" : 12345, |
| "name" : "..." |
| } ], |
| "property2" : [ { |
| "count" : 12345, |
| "name" : "..." |
| }, { |
| "count" : 12345, |
| "name" : "..." |
| } ] |
| }, |
| "searchResults" : { |
| "approximateCount" : 12345, |
| "attributes" : { |
| "name" : [ "...", "..." ], |
| "values" : [ [ { }, { } ], [ { }, { } ] ] |
| }, |
| "classification" : "...", |
| "entities" : [ { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { }, { } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { }, { } ], |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { }, { } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { }, { } ], |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "fullTextResult" : [ { |
| "entity" : { }, |
| "score" : 12345.0 |
| }, { |
| "entity" : { }, |
| "score" : 12345.0 |
| } ], |
| "nextMarker" : "...", |
| "queryText" : "...", |
| "queryType" : "ATTRIBUTE", |
| "referredEntities" : { |
| "property1" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { }, { } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { }, { } ], |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "property2" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { }, { } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { }, { } ], |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } |
| }, |
| "relations" : [ { |
| "end1" : { }, |
| "end2" : { }, |
| "guid" : "...", |
| "label" : "...", |
| "propagateTags" : "TWO_TO_ONE", |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "end1" : { }, |
| "end2" : { }, |
| "guid" : "...", |
| "label" : "...", |
| "propagateTags" : "TWO_TO_ONE", |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "searchParameters" : { |
| "attributes" : [ "...", "..." ], |
| "classification" : "...", |
| "entityFilters" : { }, |
| "excludeDeletedEntities" : true, |
| "excludeHeaderAttributes" : true, |
| "includeClassificationAttributes" : true, |
| "includeSubClassifications" : true, |
| "includeSubTypes" : true, |
| "limit" : 12345, |
| "marker" : "...", |
| "offset" : 12345, |
| "query" : "...", |
| "relationshipFilters" : { }, |
| "relationshipName" : "...", |
| "sortBy" : "...", |
| "sortOrder" : "ASCENDING", |
| "tagFilters" : { }, |
| "termName" : "...", |
| "typeName" : "..." |
| }, |
| "type" : "..." |
| } |
| } |
| }, |
| "description" : "Tag/Entity doesn't exist or Tag/entity filter is present without tag/type name" |
| } |
| } |
| }, |
| "post" : { |
| "tags" : [ "DiscoveryREST" ], |
| "description" : "Attribute based search for entities satisfying the search parameters", |
| "operationId" : "quickSearch2", |
| "consumes" : [ "application/json" ], |
| "produces" : [ "application/json" ], |
| "parameters" : [ |
| { |
| "name" : "body", |
| "required" : false, |
| "in" : "body", |
| "schema" : { |
| "$ref" : "#/definitions/QuickSearchParameters", |
| "description" : "" |
| }, |
| "description" : "" |
| } |
| ], |
| "responses" : { |
| "200" : { |
| "schema" : { |
| "$ref" : "#/definitions/AtlasQuickSearchResult", |
| "description" : "On successful search" |
| }, |
| "examples" : { |
| "application/json" : { |
| "aggregationMetrics" : { |
| "property1" : [ { |
| "count" : 12345, |
| "name" : "..." |
| }, { |
| "count" : 12345, |
| "name" : "..." |
| } ], |
| "property2" : [ { |
| "count" : 12345, |
| "name" : "..." |
| }, { |
| "count" : 12345, |
| "name" : "..." |
| } ] |
| }, |
| "searchResults" : { |
| "approximateCount" : 12345, |
| "attributes" : { |
| "name" : [ "...", "..." ], |
| "values" : [ [ { }, { } ], [ { }, { } ] ] |
| }, |
| "classification" : "...", |
| "entities" : [ { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { }, { } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { }, { } ], |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { }, { } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { }, { } ], |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "fullTextResult" : [ { |
| "entity" : { }, |
| "score" : 12345.0 |
| }, { |
| "entity" : { }, |
| "score" : 12345.0 |
| } ], |
| "nextMarker" : "...", |
| "queryText" : "...", |
| "queryType" : "FULL_TEXT", |
| "referredEntities" : { |
| "property1" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { }, { } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { }, { } ], |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "property2" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { }, { } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { }, { } ], |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } |
| }, |
| "relations" : [ { |
| "end1" : { }, |
| "end2" : { }, |
| "guid" : "...", |
| "label" : "...", |
| "propagateTags" : "BOTH", |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "end1" : { }, |
| "end2" : { }, |
| "guid" : "...", |
| "label" : "...", |
| "propagateTags" : "NONE", |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "searchParameters" : { |
| "attributes" : [ "...", "..." ], |
| "classification" : "...", |
| "entityFilters" : { }, |
| "excludeDeletedEntities" : true, |
| "excludeHeaderAttributes" : true, |
| "includeClassificationAttributes" : true, |
| "includeSubClassifications" : true, |
| "includeSubTypes" : true, |
| "limit" : 12345, |
| "marker" : "...", |
| "offset" : 12345, |
| "query" : "...", |
| "relationshipFilters" : { }, |
| "relationshipName" : "...", |
| "sortBy" : "...", |
| "sortOrder" : "DESCENDING", |
| "tagFilters" : { }, |
| "termName" : "...", |
| "typeName" : "..." |
| }, |
| "type" : "..." |
| } |
| } |
| }, |
| "description" : "On successful search" |
| }, |
| "400" : { |
| "examples" : { |
| "application/json" : { |
| "aggregationMetrics" : { |
| "property1" : [ { |
| "count" : 12345, |
| "name" : "..." |
| }, { |
| "count" : 12345, |
| "name" : "..." |
| } ], |
| "property2" : [ { |
| "count" : 12345, |
| "name" : "..." |
| }, { |
| "count" : 12345, |
| "name" : "..." |
| } ] |
| }, |
| "searchResults" : { |
| "approximateCount" : 12345, |
| "attributes" : { |
| "name" : [ "...", "..." ], |
| "values" : [ [ { }, { } ], [ { }, { } ] ] |
| }, |
| "classification" : "...", |
| "entities" : [ { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { }, { } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { }, { } ], |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { }, { } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { }, { } ], |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "fullTextResult" : [ { |
| "entity" : { }, |
| "score" : 12345.0 |
| }, { |
| "entity" : { }, |
| "score" : 12345.0 |
| } ], |
| "nextMarker" : "...", |
| "queryText" : "...", |
| "queryType" : "GREMLIN", |
| "referredEntities" : { |
| "property1" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { }, { } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { }, { } ], |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "property2" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { }, { } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { }, { } ], |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } |
| }, |
| "relations" : [ { |
| "end1" : { }, |
| "end2" : { }, |
| "guid" : "...", |
| "label" : "...", |
| "propagateTags" : "TWO_TO_ONE", |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "end1" : { }, |
| "end2" : { }, |
| "guid" : "...", |
| "label" : "...", |
| "propagateTags" : "BOTH", |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "searchParameters" : { |
| "attributes" : [ "...", "..." ], |
| "classification" : "...", |
| "entityFilters" : { }, |
| "excludeDeletedEntities" : true, |
| "excludeHeaderAttributes" : true, |
| "includeClassificationAttributes" : true, |
| "includeSubClassifications" : true, |
| "includeSubTypes" : true, |
| "limit" : 12345, |
| "marker" : "...", |
| "offset" : 12345, |
| "query" : "...", |
| "relationshipFilters" : { }, |
| "relationshipName" : "...", |
| "sortBy" : "...", |
| "sortOrder" : "ASCENDING", |
| "tagFilters" : { }, |
| "termName" : "...", |
| "typeName" : "..." |
| }, |
| "type" : "..." |
| } |
| } |
| }, |
| "description" : "Entity/attribute doesn't exist or entity filter is present without type name" |
| } |
| } |
| } |
| }, |
| "\/v2/search/relations" : { |
| "get" : { |
| "tags" : [ "DiscoveryREST" ], |
| "description" : "Relationship search to search for relations(edges)", |
| "operationId" : "relationSearch", |
| "produces" : [ "application/json" ], |
| "parameters" : [ |
| { |
| "name" : "limit", |
| "in" : "query", |
| "required" : true, |
| "type" : "integer", |
| "format" : "int32", |
| "description" : "limit the result set to only include the specified number of entries" |
| }, |
| { |
| "name" : "marker", |
| "in" : "query", |
| "type" : "string", |
| "description" : "" |
| }, |
| { |
| "name" : "offset", |
| "in" : "query", |
| "required" : true, |
| "type" : "integer", |
| "format" : "int32", |
| "description" : "start offset of the result set (useful for pagination)" |
| }, |
| { |
| "name" : "relationshipName", |
| "in" : "query", |
| "type" : "string", |
| "description" : "AtlasRelationshipType name" |
| }, |
| { |
| "name" : "sortBy", |
| "in" : "query", |
| "type" : "string", |
| "description" : "sort the result using this attribute name, default value is 'name'" |
| }, |
| { |
| "name" : "sortOrder", |
| "in" : "query", |
| "type" : "string", |
| "enum" : ["ASCENDING", "DESCENDING"], |
| "description" : "sorting order" |
| } |
| ], |
| "responses" : { |
| "200" : { |
| "schema" : { |
| "$ref" : "#/definitions/AtlasSearchResult", |
| "description" : "On successful search" |
| }, |
| "examples" : { |
| "application/json" : { |
| "approximateCount" : 12345, |
| "attributes" : { |
| "name" : [ "...", "..." ], |
| "values" : [ [ { }, { } ], [ { }, { } ] ] |
| }, |
| "classification" : "...", |
| "entities" : [ { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "IMPORTED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DISCOVERED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "VALIDATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "fullTextResult" : [ { |
| "entity" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { }, { } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { }, { } ], |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "score" : 12345.0 |
| }, { |
| "entity" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { }, { } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { }, { } ], |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "score" : 12345.0 |
| } ], |
| "nextMarker" : "...", |
| "queryText" : "...", |
| "queryType" : "RELATIONSHIP", |
| "referredEntities" : { |
| "property1" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "property2" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DISCOVERED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } |
| }, |
| "relations" : [ { |
| "end1" : { |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "end2" : { |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "guid" : "...", |
| "label" : "...", |
| "propagateTags" : "TWO_TO_ONE", |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "end1" : { |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "end2" : { |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "guid" : "...", |
| "label" : "...", |
| "propagateTags" : "TWO_TO_ONE", |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "searchParameters" : { |
| "attributes" : [ "...", "..." ], |
| "classification" : "...", |
| "entityFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "OR", |
| "criterion" : [ { }, { } ], |
| "operator" : "NOT_EMPTY" |
| }, |
| "excludeDeletedEntities" : true, |
| "excludeHeaderAttributes" : true, |
| "includeClassificationAttributes" : true, |
| "includeSubClassifications" : true, |
| "includeSubTypes" : true, |
| "limit" : 12345, |
| "marker" : "...", |
| "offset" : 12345, |
| "query" : "...", |
| "relationshipFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "AND", |
| "criterion" : [ { }, { } ], |
| "operator" : "LIKE" |
| }, |
| "relationshipName" : "...", |
| "sortBy" : "...", |
| "sortOrder" : "DESCENDING", |
| "tagFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "AND", |
| "criterion" : [ { }, { } ], |
| "operator" : "LIKE" |
| }, |
| "termName" : "...", |
| "typeName" : "..." |
| }, |
| "type" : "..." |
| } |
| }, |
| "description" : "On successful search" |
| } |
| } |
| }, |
| "post" : { |
| "tags" : [ "DiscoveryREST" ], |
| "description" : "Relationship search to search for relations(edges)", |
| "operationId" : "relationSearch2", |
| "consumes" : [ "application/json" ], |
| "produces" : [ "application/json" ], |
| "parameters" : [ |
| { |
| "name" : "body", |
| "required" : false, |
| "in" : "body", |
| "schema" : { |
| "$ref" : "#/definitions/RelationshipSearchParameters", |
| "description" : "RelationshipSearchParameters" |
| }, |
| "description" : "RelationshipSearchParameters" |
| } |
| ], |
| "responses" : { |
| "200" : { |
| "schema" : { |
| "$ref" : "#/definitions/AtlasSearchResult", |
| "description" : "On successful search" |
| }, |
| "examples" : { |
| "application/json" : { |
| "approximateCount" : 12345, |
| "attributes" : { |
| "name" : [ "...", "..." ], |
| "values" : [ [ { }, { } ], [ { }, { } ] ] |
| }, |
| "classification" : "...", |
| "entities" : [ { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "IMPORTED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "PROPOSED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DISCOVERED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "fullTextResult" : [ { |
| "entity" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { }, { } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { }, { } ], |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "score" : 12345.0 |
| }, { |
| "entity" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { }, { } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { }, { } ], |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "score" : 12345.0 |
| } ], |
| "nextMarker" : "...", |
| "queryText" : "...", |
| "queryType" : "FULL_TEXT", |
| "referredEntities" : { |
| "property1" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "VALIDATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "property2" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "PROPOSED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } |
| }, |
| "relations" : [ { |
| "end1" : { |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "end2" : { |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "guid" : "...", |
| "label" : "...", |
| "propagateTags" : "TWO_TO_ONE", |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "end1" : { |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "end2" : { |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "guid" : "...", |
| "label" : "...", |
| "propagateTags" : "TWO_TO_ONE", |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "searchParameters" : { |
| "attributes" : [ "...", "..." ], |
| "classification" : "...", |
| "entityFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "AND", |
| "criterion" : [ { }, { } ], |
| "operator" : "CONTAINS_ANY" |
| }, |
| "excludeDeletedEntities" : true, |
| "excludeHeaderAttributes" : true, |
| "includeClassificationAttributes" : true, |
| "includeSubClassifications" : true, |
| "includeSubTypes" : true, |
| "limit" : 12345, |
| "marker" : "...", |
| "offset" : 12345, |
| "query" : "...", |
| "relationshipFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "AND", |
| "criterion" : [ { }, { } ], |
| "operator" : "CONTAINS" |
| }, |
| "relationshipName" : "...", |
| "sortBy" : "...", |
| "sortOrder" : "DESCENDING", |
| "tagFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "AND", |
| "criterion" : [ { }, { } ], |
| "operator" : "IS_NULL" |
| }, |
| "termName" : "...", |
| "typeName" : "..." |
| }, |
| "type" : "..." |
| } |
| }, |
| "description" : "On successful search" |
| } |
| } |
| } |
| }, |
| "\/v2/search/relationship" : { |
| "get" : { |
| "tags" : [ "DiscoveryREST" ], |
| "description" : "Relationship search to search for related entities satisfying the search parameters", |
| "operationId" : "searchRelatedEntities", |
| "produces" : [ "application/json" ], |
| "parameters" : [ |
| { |
| "name" : "attributes", |
| "in" : "query", |
| "type" : "array", |
| "items" : { |
| "type" : "string" |
| }, |
| "collectionFormat" : "multi", |
| "description" : "set of attributes in search result." |
| }, |
| { |
| "name" : "excludeDeletedEntities", |
| "in" : "query", |
| "required" : true, |
| "type" : "boolean", |
| "description" : "" |
| }, |
| { |
| "name" : "getApproximateCount", |
| "in" : "query", |
| "required" : true, |
| "type" : "boolean", |
| "description" : "" |
| }, |
| { |
| "name" : "guid", |
| "in" : "query", |
| "type" : "string", |
| "description" : "Attribute name" |
| }, |
| { |
| "name" : "includeClassificationAttributes", |
| "in" : "query", |
| "required" : true, |
| "type" : "boolean", |
| "description" : "" |
| }, |
| { |
| "name" : "limit", |
| "in" : "query", |
| "required" : true, |
| "type" : "integer", |
| "format" : "int32", |
| "description" : "limit the result set to only include the specified number of entries" |
| }, |
| { |
| "name" : "offset", |
| "in" : "query", |
| "required" : true, |
| "type" : "integer", |
| "format" : "int32", |
| "description" : "start offset of the result set (useful for pagination)" |
| }, |
| { |
| "name" : "relation", |
| "in" : "query", |
| "type" : "string", |
| "description" : "relationName" |
| }, |
| { |
| "name" : "sortBy", |
| "in" : "query", |
| "type" : "string", |
| "description" : "sort the result using this attribute name, default value is 'name'" |
| }, |
| { |
| "name" : "sortOrder", |
| "in" : "query", |
| "type" : "string", |
| "enum" : ["ASCENDING", "DESCENDING"], |
| "description" : "sorting order" |
| } |
| ], |
| "responses" : { |
| "200" : { |
| "schema" : { |
| "$ref" : "#/definitions/AtlasSearchResult", |
| "description" : "On successful search" |
| }, |
| "examples" : { |
| "application/json" : { |
| "approximateCount" : 12345, |
| "attributes" : { |
| "name" : [ "...", "..." ], |
| "values" : [ [ { }, { } ], [ { }, { } ] ] |
| }, |
| "classification" : "...", |
| "entities" : [ { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "VALIDATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DISCOVERED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "fullTextResult" : [ { |
| "entity" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { }, { } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { }, { } ], |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "score" : 12345.0 |
| }, { |
| "entity" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { }, { } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { }, { } ], |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "score" : 12345.0 |
| } ], |
| "nextMarker" : "...", |
| "queryText" : "...", |
| "queryType" : "GREMLIN", |
| "referredEntities" : { |
| "property1" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "property2" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "PROPOSED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } |
| }, |
| "relations" : [ { |
| "end1" : { |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "end2" : { |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "guid" : "...", |
| "label" : "...", |
| "propagateTags" : "TWO_TO_ONE", |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "end1" : { |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "end2" : { |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "guid" : "...", |
| "label" : "...", |
| "propagateTags" : "NONE", |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "searchParameters" : { |
| "attributes" : [ "...", "..." ], |
| "classification" : "...", |
| "entityFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "OR", |
| "criterion" : [ { }, { } ], |
| "operator" : "LTE" |
| }, |
| "excludeDeletedEntities" : true, |
| "excludeHeaderAttributes" : true, |
| "includeClassificationAttributes" : true, |
| "includeSubClassifications" : true, |
| "includeSubTypes" : true, |
| "limit" : 12345, |
| "marker" : "...", |
| "offset" : 12345, |
| "query" : "...", |
| "relationshipFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "OR", |
| "criterion" : [ { }, { } ], |
| "operator" : "LT" |
| }, |
| "relationshipName" : "...", |
| "sortBy" : "...", |
| "sortOrder" : "DESCENDING", |
| "tagFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "OR", |
| "criterion" : [ { }, { } ], |
| "operator" : "ENDS_WITH" |
| }, |
| "termName" : "...", |
| "typeName" : "..." |
| }, |
| "type" : "..." |
| } |
| }, |
| "description" : "On successful search" |
| }, |
| "400" : { |
| "examples" : { |
| "application/json" : { |
| "approximateCount" : 12345, |
| "attributes" : { |
| "name" : [ "...", "..." ], |
| "values" : [ [ { }, { } ], [ { }, { } ] ] |
| }, |
| "classification" : "...", |
| "entities" : [ { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "IMPORTED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DISCOVERED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "fullTextResult" : [ { |
| "entity" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { }, { } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { }, { } ], |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "score" : 12345.0 |
| }, { |
| "entity" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { }, { } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { }, { } ], |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "score" : 12345.0 |
| } ], |
| "nextMarker" : "...", |
| "queryText" : "...", |
| "queryType" : "RELATIONSHIP", |
| "referredEntities" : { |
| "property1" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "PROPOSED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "property2" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } |
| }, |
| "relations" : [ { |
| "end1" : { |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "end2" : { |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "guid" : "...", |
| "label" : "...", |
| "propagateTags" : "NONE", |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "end1" : { |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "end2" : { |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "guid" : "...", |
| "label" : "...", |
| "propagateTags" : "TWO_TO_ONE", |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "searchParameters" : { |
| "attributes" : [ "...", "..." ], |
| "classification" : "...", |
| "entityFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "OR", |
| "criterion" : [ { }, { } ], |
| "operator" : "CONTAINS_ALL" |
| }, |
| "excludeDeletedEntities" : true, |
| "excludeHeaderAttributes" : true, |
| "includeClassificationAttributes" : true, |
| "includeSubClassifications" : true, |
| "includeSubTypes" : true, |
| "limit" : 12345, |
| "marker" : "...", |
| "offset" : 12345, |
| "query" : "...", |
| "relationshipFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "OR", |
| "criterion" : [ { }, { } ], |
| "operator" : "IN" |
| }, |
| "relationshipName" : "...", |
| "sortBy" : "...", |
| "sortOrder" : "ASCENDING", |
| "tagFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "AND", |
| "criterion" : [ { }, { } ], |
| "operator" : "TIME_RANGE" |
| }, |
| "termName" : "...", |
| "typeName" : "..." |
| }, |
| "type" : "..." |
| } |
| }, |
| "description" : "guid is not a valid entity type or attributeName is not a valid relationship attribute" |
| } |
| } |
| } |
| }, |
| "\/v2/search/saved" : { |
| "get" : { |
| "tags" : [ "DiscoveryREST" ], |
| "operationId" : "getSavedSearches", |
| "produces" : [ "application/json" ], |
| "parameters" : [ |
| { |
| "name" : "user", |
| "in" : "query", |
| "type" : "string", |
| "description" : "User for whom the search is retrieved" |
| } |
| ], |
| "responses" : { |
| "200" : { |
| "schema" : { |
| "description" : "list of all saved searches for given user", |
| "type" : "array", |
| "items" : { |
| "$ref" : "#/definitions/AtlasUserSavedSearch" |
| } |
| }, |
| "examples" : { |
| "application/json" : [ { |
| "name" : "...", |
| "ownerName" : "...", |
| "searchParameters" : { |
| "attributes" : [ "...", "..." ], |
| "classification" : "...", |
| "entityFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "OR", |
| "criterion" : [ { }, { } ], |
| "operator" : "CONTAINS" |
| }, |
| "excludeDeletedEntities" : true, |
| "excludeHeaderAttributes" : true, |
| "includeClassificationAttributes" : true, |
| "includeSubClassifications" : true, |
| "includeSubTypes" : true, |
| "limit" : 12345, |
| "marker" : "...", |
| "offset" : 12345, |
| "query" : "...", |
| "relationshipFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "AND", |
| "criterion" : [ { }, { } ], |
| "operator" : "IS_NULL" |
| }, |
| "relationshipName" : "...", |
| "sortBy" : "...", |
| "sortOrder" : "ASCENDING", |
| "tagFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "OR", |
| "criterion" : [ { }, { } ], |
| "operator" : "NOT_NULL" |
| }, |
| "termName" : "...", |
| "typeName" : "..." |
| }, |
| "searchType" : "BASIC", |
| "uiParameters" : "...", |
| "guid" : "..." |
| } ] |
| }, |
| "description" : "list of all saved searches for given user" |
| } |
| } |
| }, |
| "post" : { |
| "tags" : [ "DiscoveryREST" ], |
| "operationId" : "addSavedSearch", |
| "consumes" : [ "application/json" ], |
| "produces" : [ "application/json" ], |
| "parameters" : [ |
| { |
| "name" : "body", |
| "required" : false, |
| "in" : "body", |
| "schema" : { |
| "$ref" : "#/definitions/AtlasUserSavedSearch", |
| "description" : "" |
| }, |
| "description" : "" |
| } |
| ], |
| "responses" : { |
| "201" : { |
| "schema" : { |
| "$ref" : "#/definitions/AtlasUserSavedSearch", |
| "description" : "the saved search-object" |
| }, |
| "examples" : { |
| "application/json" : { |
| "name" : "...", |
| "ownerName" : "...", |
| "searchParameters" : { |
| "attributes" : [ "...", "..." ], |
| "classification" : "...", |
| "entityFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "AND", |
| "criterion" : [ { }, { } ], |
| "operator" : "ENDS_WITH" |
| }, |
| "excludeDeletedEntities" : true, |
| "excludeHeaderAttributes" : true, |
| "includeClassificationAttributes" : true, |
| "includeSubClassifications" : true, |
| "includeSubTypes" : true, |
| "limit" : 12345, |
| "marker" : "...", |
| "offset" : 12345, |
| "query" : "...", |
| "relationshipFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "OR", |
| "criterion" : [ { }, { } ], |
| "operator" : "GTE" |
| }, |
| "relationshipName" : "...", |
| "sortBy" : "...", |
| "sortOrder" : "ASCENDING", |
| "tagFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "OR", |
| "criterion" : [ { }, { } ], |
| "operator" : "GT" |
| }, |
| "termName" : "...", |
| "typeName" : "..." |
| }, |
| "searchType" : "ADVANCED", |
| "uiParameters" : "...", |
| "guid" : "..." |
| } |
| }, |
| "description" : "the saved search-object" |
| } |
| } |
| }, |
| "put" : { |
| "tags" : [ "DiscoveryREST" ], |
| "operationId" : "updateSavedSearch", |
| "consumes" : [ "application/json" ], |
| "produces" : [ "application/json" ], |
| "parameters" : [ |
| { |
| "name" : "body", |
| "required" : false, |
| "in" : "body", |
| "schema" : { |
| "$ref" : "#/definitions/AtlasUserSavedSearch", |
| "description" : "" |
| }, |
| "description" : "" |
| } |
| ], |
| "responses" : { |
| "204" : { |
| "schema" : { |
| "$ref" : "#/definitions/AtlasUserSavedSearch", |
| "description" : "the updated search-object" |
| }, |
| "examples" : { |
| "application/json" : { |
| "name" : "...", |
| "ownerName" : "...", |
| "searchParameters" : { |
| "attributes" : [ "...", "..." ], |
| "classification" : "...", |
| "entityFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "AND", |
| "criterion" : [ { }, { } ], |
| "operator" : "GT" |
| }, |
| "excludeDeletedEntities" : true, |
| "excludeHeaderAttributes" : true, |
| "includeClassificationAttributes" : true, |
| "includeSubClassifications" : true, |
| "includeSubTypes" : true, |
| "limit" : 12345, |
| "marker" : "...", |
| "offset" : 12345, |
| "query" : "...", |
| "relationshipFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "OR", |
| "criterion" : [ { }, { } ], |
| "operator" : "NEQ" |
| }, |
| "relationshipName" : "...", |
| "sortBy" : "...", |
| "sortOrder" : "ASCENDING", |
| "tagFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "OR", |
| "criterion" : [ { }, { } ], |
| "operator" : "LTE" |
| }, |
| "termName" : "...", |
| "typeName" : "..." |
| }, |
| "searchType" : "BASIC_RELATIONSHIP", |
| "uiParameters" : "...", |
| "guid" : "..." |
| } |
| }, |
| "description" : "the updated search-object" |
| } |
| } |
| } |
| }, |
| "\/v2/search/saved/execute/guid/{guid}" : { |
| "get" : { |
| "tags" : [ "DiscoveryREST" ], |
| "description" : "Attribute based search for entities satisfying the search parameters", |
| "operationId" : "executeSavedSearchByGuid", |
| "produces" : [ "application/json" ], |
| "parameters" : [ |
| { |
| "name" : "guid", |
| "in" : "path", |
| "type" : "string", |
| "description" : "Guid identifying saved search" |
| } |
| ], |
| "responses" : { |
| "200" : { |
| "schema" : { |
| "$ref" : "#/definitions/AtlasSearchResult", |
| "description" : "Atlas search result" |
| }, |
| "examples" : { |
| "application/json" : { |
| "approximateCount" : 12345, |
| "attributes" : { |
| "name" : [ "...", "..." ], |
| "values" : [ [ { }, { } ], [ { }, { } ] ] |
| }, |
| "classification" : "...", |
| "entities" : [ { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "IMPORTED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "VALIDATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "IMPORTED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "IMPORTED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "fullTextResult" : [ { |
| "entity" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { }, { } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { }, { } ], |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "score" : 12345.0 |
| }, { |
| "entity" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { }, { } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { }, { } ], |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "score" : 12345.0 |
| } ], |
| "nextMarker" : "...", |
| "queryText" : "...", |
| "queryType" : "GREMLIN", |
| "referredEntities" : { |
| "property1" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DISCOVERED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "property2" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OBSOLETE", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "PROPOSED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } |
| }, |
| "relations" : [ { |
| "end1" : { |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "end2" : { |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "guid" : "...", |
| "label" : "...", |
| "propagateTags" : "ONE_TO_TWO", |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "end1" : { |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "end2" : { |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "guid" : "...", |
| "label" : "...", |
| "propagateTags" : "ONE_TO_TWO", |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "searchParameters" : { |
| "attributes" : [ "...", "..." ], |
| "classification" : "...", |
| "entityFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "OR", |
| "criterion" : [ { }, { } ], |
| "operator" : "LTE" |
| }, |
| "excludeDeletedEntities" : true, |
| "excludeHeaderAttributes" : true, |
| "includeClassificationAttributes" : true, |
| "includeSubClassifications" : true, |
| "includeSubTypes" : true, |
| "limit" : 12345, |
| "marker" : "...", |
| "offset" : 12345, |
| "query" : "...", |
| "relationshipFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "OR", |
| "criterion" : [ { }, { } ], |
| "operator" : "CONTAINS_ALL" |
| }, |
| "relationshipName" : "...", |
| "sortBy" : "...", |
| "sortOrder" : "ASCENDING", |
| "tagFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "OR", |
| "criterion" : [ { }, { } ], |
| "operator" : "NEQ" |
| }, |
| "termName" : "...", |
| "typeName" : "..." |
| }, |
| "type" : "..." |
| } |
| }, |
| "description" : "Atlas search result" |
| } |
| } |
| } |
| }, |
| "\/v2/search/saved/execute/{name}" : { |
| "get" : { |
| "tags" : [ "DiscoveryREST" ], |
| "description" : "Attribute based search for entities satisfying the search parameters", |
| "operationId" : "executeSavedSearchByName", |
| "produces" : [ "application/json" ], |
| "parameters" : [ |
| { |
| "name" : "name", |
| "in" : "path", |
| "type" : "string", |
| "description" : "name of saved-search" |
| }, |
| { |
| "name" : "user", |
| "in" : "query", |
| "type" : "string", |
| "description" : "saved-search owner" |
| } |
| ], |
| "responses" : { |
| "200" : { |
| "schema" : { |
| "$ref" : "#/definitions/AtlasSearchResult", |
| "description" : "Atlas search result" |
| }, |
| "examples" : { |
| "application/json" : { |
| "approximateCount" : 12345, |
| "attributes" : { |
| "name" : [ "...", "..." ], |
| "values" : [ [ { }, { } ], [ { }, { } ] ] |
| }, |
| "classification" : "...", |
| "entities" : [ { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DISCOVERED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "IMPORTED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "PROPOSED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "fullTextResult" : [ { |
| "entity" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { }, { } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { }, { } ], |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "score" : 12345.0 |
| }, { |
| "entity" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { }, { } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { }, { } ], |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "score" : 12345.0 |
| } ], |
| "nextMarker" : "...", |
| "queryText" : "...", |
| "queryType" : "FULL_TEXT", |
| "referredEntities" : { |
| "property1" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "PURGED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DISCOVERED", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "VALIDATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "ACTIVE", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, |
| "property2" : { |
| "classificationNames" : [ "...", "..." ], |
| "classifications" : [ { |
| "entityGuid" : "...", |
| "entityStatus" : "ACTIVE", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "entityGuid" : "...", |
| "entityStatus" : "DELETED", |
| "propagate" : true, |
| "removePropagationsOnEntityDelete" : true, |
| "validityPeriods" : [ { }, { } ], |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "displayText" : "...", |
| "guid" : "...", |
| "isIncomplete" : true, |
| "labels" : [ "...", "..." ], |
| "meaningNames" : [ "...", "..." ], |
| "meanings" : [ { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "OTHER", |
| "steward" : "...", |
| "termGuid" : "..." |
| }, { |
| "confidence" : 12345, |
| "createdBy" : "...", |
| "description" : "...", |
| "displayText" : "...", |
| "expression" : "...", |
| "qualifiedName" : "...", |
| "relationGuid" : "...", |
| "source" : "...", |
| "status" : "DEPRECATED", |
| "steward" : "...", |
| "termGuid" : "..." |
| } ], |
| "status" : "PURGED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } |
| }, |
| "relations" : [ { |
| "end1" : { |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "end2" : { |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "guid" : "...", |
| "label" : "...", |
| "propagateTags" : "NONE", |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| }, { |
| "end1" : { |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "end2" : { |
| "guid" : "...", |
| "typeName" : "...", |
| "uniqueAttributes" : { |
| "property1" : { }, |
| "property2" : { } |
| } |
| }, |
| "guid" : "...", |
| "label" : "...", |
| "propagateTags" : "ONE_TO_TWO", |
| "status" : "DELETED", |
| "attributes" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "typeName" : "..." |
| } ], |
| "searchParameters" : { |
| "attributes" : [ "...", "..." ], |
| "classification" : "...", |
| "entityFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "OR", |
| "criterion" : [ { }, { } ], |
| "operator" : "GTE" |
| }, |
| "excludeDeletedEntities" : true, |
| "excludeHeaderAttributes" : true, |
| "includeClassificationAttributes" : true, |
| "includeSubClassifications" : true, |
| "includeSubTypes" : true, |
| "limit" : 12345, |
| "marker" : "...", |
| "offset" : 12345, |
| "query" : "...", |
| "relationshipFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "AND", |
| "criterion" : [ { }, { } ], |
| "operator" : "GT" |
| }, |
| "relationshipName" : "...", |
| "sortBy" : "...", |
| "sortOrder" : "ASCENDING", |
| "tagFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "AND", |
| "criterion" : [ { }, { } ], |
| "operator" : "GTE" |
| }, |
| "termName" : "...", |
| "typeName" : "..." |
| }, |
| "type" : "..." |
| } |
| }, |
| "description" : "Atlas search result" |
| } |
| } |
| } |
| }, |
| "\/v2/search/saved/{guid}" : { |
| "delete" : { |
| "tags" : [ "DiscoveryREST" ], |
| "operationId" : "deleteSavedSearch", |
| "parameters" : [ |
| { |
| "name" : "guid", |
| "in" : "path", |
| "type" : "string", |
| "description" : "Name of the saved search" |
| } |
| ], |
| "responses" : { |
| "204" : { |
| "description" : "Success" |
| } |
| } |
| } |
| }, |
| "\/v2/search/saved/{name}" : { |
| "get" : { |
| "tags" : [ "DiscoveryREST" ], |
| "operationId" : "getSavedSearch", |
| "produces" : [ "application/json" ], |
| "parameters" : [ |
| { |
| "name" : "name", |
| "in" : "path", |
| "type" : "string", |
| "description" : "Name of the saved search" |
| }, |
| { |
| "name" : "user", |
| "in" : "query", |
| "type" : "string", |
| "description" : "User for whom the search is retrieved" |
| } |
| ], |
| "responses" : { |
| "200" : { |
| "schema" : { |
| "$ref" : "#/definitions/AtlasUserSavedSearch", |
| "description" : "" |
| }, |
| "examples" : { |
| "application/json" : { |
| "name" : "...", |
| "ownerName" : "...", |
| "searchParameters" : { |
| "attributes" : [ "...", "..." ], |
| "classification" : "...", |
| "entityFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "OR", |
| "criterion" : [ { }, { } ], |
| "operator" : "CONTAINS_ALL" |
| }, |
| "excludeDeletedEntities" : true, |
| "excludeHeaderAttributes" : true, |
| "includeClassificationAttributes" : true, |
| "includeSubClassifications" : true, |
| "includeSubTypes" : true, |
| "limit" : 12345, |
| "marker" : "...", |
| "offset" : 12345, |
| "query" : "...", |
| "relationshipFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "OR", |
| "criterion" : [ { }, { } ], |
| "operator" : "LIKE" |
| }, |
| "relationshipName" : "...", |
| "sortBy" : "...", |
| "sortOrder" : "DESCENDING", |
| "tagFilters" : { |
| "attributeName" : "...", |
| "attributeValue" : "...", |
| "condition" : "AND", |
| "criterion" : [ { }, { } ], |
| "operator" : "CONTAINS_ALL" |
| }, |
| "termName" : "...", |
| "typeName" : "..." |
| }, |
| "searchType" : "BASIC", |
| "uiParameters" : "...", |
| "guid" : "..." |
| } |
| }, |
| "description" : "" |
| } |
| } |
| } |
| }, |
| "\/v2/search/suggestions" : { |
| "get" : { |
| "tags" : [ "DiscoveryREST" ], |
| "operationId" : "getSuggestions", |
| "produces" : [ "application/json" ], |
| "parameters" : [ |
| { |
| "name" : "fieldName", |
| "in" : "query", |
| "type" : "string", |
| "description" : "" |
| }, |
| { |
| "name" : "prefixString", |
| "in" : "query", |
| "type" : "string", |
| "description" : "" |
| } |
| ], |
| "responses" : { |
| "200" : { |
| "schema" : { |
| "$ref" : "#/definitions/AtlasSuggestionsResult", |
| "description" : "" |
| }, |
| "examples" : { |
| "application/json" : { |
| "fieldName" : "...", |
| "prefixString" : "...", |
| "suggestions" : [ "...", "..." ] |
| } |
| }, |
| "description" : "" |
| } |
| } |
| } |
| }, |
| "\/v2/types/businessmetadatadef/guid/{guid}" : { |
| "get" : { |
| "tags" : [ "TypesREST" ], |
| "description" : "Get the businessMetadata definition for the given guid", |
| "operationId" : "getBusinessMetadataDefByGuid", |
| "produces" : [ "application/json" ], |
| "parameters" : [ |
| { |
| "name" : "guid", |
| "in" : "path", |
| "type" : "string", |
| "description" : "businessMetadata guid" |
| } |
| ], |
| "responses" : { |
| "200" : { |
| "schema" : { |
| "$ref" : "#/definitions/AtlasBusinessMetadataDef", |
| "description" : "On successful lookup of the the businessMetadata definition by it's guid" |
| }, |
| "examples" : { |
| "application/json" : { |
| "attributeDefs" : [ { |
| "cardinality" : "SET", |
| "constraints" : [ { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| }, { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SET", |
| "constraints" : [ { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| }, { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "RELATIONSHIP", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { |
| "availableLocales" : [ "...", "..." ], |
| "currency" : "...", |
| "currencyInstance" : { }, |
| "groupingUsed" : true, |
| "instance" : { }, |
| "integerInstance" : { }, |
| "maximumFractionDigits" : 12345, |
| "maximumIntegerDigits" : 12345, |
| "minimumFractionDigits" : 12345, |
| "minimumIntegerDigits" : 12345, |
| "numberInstance" : { }, |
| "parseIntegerOnly" : true, |
| "percentInstance" : { }, |
| "roundingMode" : "HALF_EVEN" |
| }, |
| "timeInstance" : { }, |
| "timeZone" : { |
| "DSTSavings" : 12345, |
| "ID" : "...", |
| "availableIDs" : [ "...", "..." ], |
| "default" : { }, |
| "displayName" : "...", |
| "rawOffset" : 12345 |
| } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| } |
| }, |
| "description" : "On successful lookup of the the businessMetadata definition by it's guid" |
| }, |
| "404" : { |
| "examples" : { |
| "application/json" : { |
| "attributeDefs" : [ { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| }, { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "LIST", |
| "constraints" : [ { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| }, { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "CLASSIFICATION", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { |
| "availableLocales" : [ "...", "..." ], |
| "currency" : "...", |
| "currencyInstance" : { }, |
| "groupingUsed" : true, |
| "instance" : { }, |
| "integerInstance" : { }, |
| "maximumFractionDigits" : 12345, |
| "maximumIntegerDigits" : 12345, |
| "minimumFractionDigits" : 12345, |
| "minimumIntegerDigits" : 12345, |
| "numberInstance" : { }, |
| "parseIntegerOnly" : true, |
| "percentInstance" : { }, |
| "roundingMode" : "UNNECESSARY" |
| }, |
| "timeInstance" : { }, |
| "timeZone" : { |
| "DSTSavings" : 12345, |
| "ID" : "...", |
| "availableIDs" : [ "...", "..." ], |
| "default" : { }, |
| "displayName" : "...", |
| "rawOffset" : 12345 |
| } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| } |
| }, |
| "description" : "On Failed lookup for the given guid" |
| } |
| } |
| } |
| }, |
| "\/v2/types/businessmetadatadef/name/{name}" : { |
| "get" : { |
| "tags" : [ "TypesREST" ], |
| "description" : "Get the businessMetadata definition by it's name (unique)", |
| "operationId" : "getBusinessMetadataDefByName", |
| "produces" : [ "application/json" ], |
| "parameters" : [ |
| { |
| "name" : "name", |
| "in" : "path", |
| "type" : "string", |
| "description" : "businessMetadata name" |
| } |
| ], |
| "responses" : { |
| "200" : { |
| "schema" : { |
| "$ref" : "#/definitions/AtlasBusinessMetadataDef", |
| "description" : "On successful lookup of the the businessMetadata definition by it's name" |
| }, |
| "examples" : { |
| "application/json" : { |
| "attributeDefs" : [ { |
| "cardinality" : "LIST", |
| "constraints" : [ { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| }, { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "LIST", |
| "constraints" : [ { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| }, { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "ARRAY", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { |
| "availableLocales" : [ "...", "..." ], |
| "currency" : "...", |
| "currencyInstance" : { }, |
| "groupingUsed" : true, |
| "instance" : { }, |
| "integerInstance" : { }, |
| "maximumFractionDigits" : 12345, |
| "maximumIntegerDigits" : 12345, |
| "minimumFractionDigits" : 12345, |
| "minimumIntegerDigits" : 12345, |
| "numberInstance" : { }, |
| "parseIntegerOnly" : true, |
| "percentInstance" : { }, |
| "roundingMode" : "FLOOR" |
| }, |
| "timeInstance" : { }, |
| "timeZone" : { |
| "DSTSavings" : 12345, |
| "ID" : "...", |
| "availableIDs" : [ "...", "..." ], |
| "default" : { }, |
| "displayName" : "...", |
| "rawOffset" : 12345 |
| } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| } |
| }, |
| "description" : "On successful lookup of the the businessMetadata definition by it's name" |
| }, |
| "404" : { |
| "examples" : { |
| "application/json" : { |
| "attributeDefs" : [ { |
| "cardinality" : "SET", |
| "constraints" : [ { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| }, { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SET", |
| "constraints" : [ { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| }, { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "ENTITY", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { |
| "availableLocales" : [ "...", "..." ], |
| "currency" : "...", |
| "currencyInstance" : { }, |
| "groupingUsed" : true, |
| "instance" : { }, |
| "integerInstance" : { }, |
| "maximumFractionDigits" : 12345, |
| "maximumIntegerDigits" : 12345, |
| "minimumFractionDigits" : 12345, |
| "minimumIntegerDigits" : 12345, |
| "numberInstance" : { }, |
| "parseIntegerOnly" : true, |
| "percentInstance" : { }, |
| "roundingMode" : "DOWN" |
| }, |
| "timeInstance" : { }, |
| "timeZone" : { |
| "DSTSavings" : 12345, |
| "ID" : "...", |
| "availableIDs" : [ "...", "..." ], |
| "default" : { }, |
| "displayName" : "...", |
| "rawOffset" : 12345 |
| } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| } |
| }, |
| "description" : "On Failed lookup for the given name" |
| } |
| } |
| } |
| }, |
| "\/v2/types/classificationdef/guid/{guid}" : { |
| "get" : { |
| "tags" : [ "TypesREST" ], |
| "description" : "Get the classification definition for the given guid", |
| "operationId" : "getClassificationDefByGuid", |
| "produces" : [ "application/json" ], |
| "parameters" : [ |
| { |
| "name" : "guid", |
| "in" : "path", |
| "type" : "string", |
| "description" : "classification guid" |
| } |
| ], |
| "responses" : { |
| "200" : { |
| "schema" : { |
| "$ref" : "#/definitions/AtlasClassificationDef", |
| "description" : "On successful lookup of the the classification definition by it's guid" |
| }, |
| "examples" : { |
| "application/json" : { |
| "entityTypes" : [ "...", "..." ], |
| "subTypes" : [ "...", "..." ], |
| "superTypes" : [ "...", "..." ], |
| "attributeDefs" : [ { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| }, { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "LIST", |
| "constraints" : [ { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| }, { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "ENTITY", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { |
| "availableLocales" : [ "...", "..." ], |
| "currency" : "...", |
| "currencyInstance" : { }, |
| "groupingUsed" : true, |
| "instance" : { }, |
| "integerInstance" : { }, |
| "maximumFractionDigits" : 12345, |
| "maximumIntegerDigits" : 12345, |
| "minimumFractionDigits" : 12345, |
| "minimumIntegerDigits" : 12345, |
| "numberInstance" : { }, |
| "parseIntegerOnly" : true, |
| "percentInstance" : { }, |
| "roundingMode" : "UP" |
| }, |
| "timeInstance" : { }, |
| "timeZone" : { |
| "DSTSavings" : 12345, |
| "ID" : "...", |
| "availableIDs" : [ "...", "..." ], |
| "default" : { }, |
| "displayName" : "...", |
| "rawOffset" : 12345 |
| } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| } |
| }, |
| "description" : "On successful lookup of the the classification definition by it's guid" |
| }, |
| "404" : { |
| "examples" : { |
| "application/json" : { |
| "entityTypes" : [ "...", "..." ], |
| "subTypes" : [ "...", "..." ], |
| "superTypes" : [ "...", "..." ], |
| "attributeDefs" : [ { |
| "cardinality" : "LIST", |
| "constraints" : [ { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| }, { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "LIST", |
| "constraints" : [ { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| }, { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "PRIMITIVE", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { |
| "availableLocales" : [ "...", "..." ], |
| "currency" : "...", |
| "currencyInstance" : { }, |
| "groupingUsed" : true, |
| "instance" : { }, |
| "integerInstance" : { }, |
| "maximumFractionDigits" : 12345, |
| "maximumIntegerDigits" : 12345, |
| "minimumFractionDigits" : 12345, |
| "minimumIntegerDigits" : 12345, |
| "numberInstance" : { }, |
| "parseIntegerOnly" : true, |
| "percentInstance" : { }, |
| "roundingMode" : "FLOOR" |
| }, |
| "timeInstance" : { }, |
| "timeZone" : { |
| "DSTSavings" : 12345, |
| "ID" : "...", |
| "availableIDs" : [ "...", "..." ], |
| "default" : { }, |
| "displayName" : "...", |
| "rawOffset" : 12345 |
| } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| } |
| }, |
| "description" : "On Failed lookup for the given guid" |
| } |
| } |
| } |
| }, |
| "\/v2/types/classificationdef/name/{name}" : { |
| "get" : { |
| "tags" : [ "TypesREST" ], |
| "description" : "Get the classification definition by it's name (unique)", |
| "operationId" : "getClassificationDefByName", |
| "produces" : [ "application/json" ], |
| "parameters" : [ |
| { |
| "name" : "name", |
| "in" : "path", |
| "type" : "string", |
| "description" : "classification name" |
| } |
| ], |
| "responses" : { |
| "200" : { |
| "schema" : { |
| "$ref" : "#/definitions/AtlasClassificationDef", |
| "description" : "On successful lookup of the the classification definition by it's name" |
| }, |
| "examples" : { |
| "application/json" : { |
| "entityTypes" : [ "...", "..." ], |
| "subTypes" : [ "...", "..." ], |
| "superTypes" : [ "...", "..." ], |
| "attributeDefs" : [ { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| }, { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SET", |
| "constraints" : [ { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| }, { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "PRIMITIVE", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { |
| "availableLocales" : [ "...", "..." ], |
| "currency" : "...", |
| "currencyInstance" : { }, |
| "groupingUsed" : true, |
| "instance" : { }, |
| "integerInstance" : { }, |
| "maximumFractionDigits" : 12345, |
| "maximumIntegerDigits" : 12345, |
| "minimumFractionDigits" : 12345, |
| "minimumIntegerDigits" : 12345, |
| "numberInstance" : { }, |
| "parseIntegerOnly" : true, |
| "percentInstance" : { }, |
| "roundingMode" : "HALF_UP" |
| }, |
| "timeInstance" : { }, |
| "timeZone" : { |
| "DSTSavings" : 12345, |
| "ID" : "...", |
| "availableIDs" : [ "...", "..." ], |
| "default" : { }, |
| "displayName" : "...", |
| "rawOffset" : 12345 |
| } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| } |
| }, |
| "description" : "On successful lookup of the the classification definition by it's name" |
| }, |
| "404" : { |
| "examples" : { |
| "application/json" : { |
| "entityTypes" : [ "...", "..." ], |
| "subTypes" : [ "...", "..." ], |
| "superTypes" : [ "...", "..." ], |
| "attributeDefs" : [ { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| }, { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| }, { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "RELATIONSHIP", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { |
| "availableLocales" : [ "...", "..." ], |
| "currency" : "...", |
| "currencyInstance" : { }, |
| "groupingUsed" : true, |
| "instance" : { }, |
| "integerInstance" : { }, |
| "maximumFractionDigits" : 12345, |
| "maximumIntegerDigits" : 12345, |
| "minimumFractionDigits" : 12345, |
| "minimumIntegerDigits" : 12345, |
| "numberInstance" : { }, |
| "parseIntegerOnly" : true, |
| "percentInstance" : { }, |
| "roundingMode" : "UNNECESSARY" |
| }, |
| "timeInstance" : { }, |
| "timeZone" : { |
| "DSTSavings" : 12345, |
| "ID" : "...", |
| "availableIDs" : [ "...", "..." ], |
| "default" : { }, |
| "displayName" : "...", |
| "rawOffset" : 12345 |
| } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| } |
| }, |
| "description" : "On Failed lookup for the given name" |
| } |
| } |
| } |
| }, |
| "\/v2/types/entitydef/guid/{guid}" : { |
| "get" : { |
| "tags" : [ "TypesREST" ], |
| "description" : "Get the Entity definition for the given guid", |
| "operationId" : "getEntityDefByGuid", |
| "produces" : [ "application/json" ], |
| "parameters" : [ |
| { |
| "name" : "guid", |
| "in" : "path", |
| "type" : "string", |
| "description" : "entity guid" |
| } |
| ], |
| "responses" : { |
| "200" : { |
| "schema" : { |
| "$ref" : "#/definitions/AtlasEntityDef", |
| "description" : "On successful lookup of the the entity definition by it's guid" |
| }, |
| "examples" : { |
| "application/json" : { |
| "businessAttributeDefs" : { |
| "property1" : [ { |
| "cardinality" : "LIST", |
| "constraints" : [ { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| }, { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "LIST", |
| "constraints" : [ { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| }, { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "property2" : [ { |
| "cardinality" : "LIST", |
| "constraints" : [ { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| }, { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "LIST", |
| "constraints" : [ { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| }, { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ] |
| }, |
| "relationshipAttributeDefs" : [ { |
| "isLegacyAttribute" : true, |
| "relationshipTypeName" : "...", |
| "cardinality" : "LIST", |
| "constraints" : [ { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| }, { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "isLegacyAttribute" : true, |
| "relationshipTypeName" : "...", |
| "cardinality" : "LIST", |
| "constraints" : [ { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| }, { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "subTypes" : [ "...", "..." ], |
| "superTypes" : [ "...", "..." ], |
| "attributeDefs" : [ { |
| "cardinality" : "SET", |
| "constraints" : [ { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| }, { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| }, { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "MAP", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { |
| "availableLocales" : [ "...", "..." ], |
| "currency" : "...", |
| "currencyInstance" : { }, |
| "groupingUsed" : true, |
| "instance" : { }, |
| "integerInstance" : { }, |
| "maximumFractionDigits" : 12345, |
| "maximumIntegerDigits" : 12345, |
| "minimumFractionDigits" : 12345, |
| "minimumIntegerDigits" : 12345, |
| "numberInstance" : { }, |
| "parseIntegerOnly" : true, |
| "percentInstance" : { }, |
| "roundingMode" : "UP" |
| }, |
| "timeInstance" : { }, |
| "timeZone" : { |
| "DSTSavings" : 12345, |
| "ID" : "...", |
| "availableIDs" : [ "...", "..." ], |
| "default" : { }, |
| "displayName" : "...", |
| "rawOffset" : 12345 |
| } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| } |
| }, |
| "description" : "On successful lookup of the the entity definition by it's guid" |
| }, |
| "404" : { |
| "examples" : { |
| "application/json" : { |
| "businessAttributeDefs" : { |
| "property1" : [ { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| }, { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SET", |
| "constraints" : [ { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| }, { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "property2" : [ { |
| "cardinality" : "SET", |
| "constraints" : [ { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| }, { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| }, { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ] |
| }, |
| "relationshipAttributeDefs" : [ { |
| "isLegacyAttribute" : true, |
| "relationshipTypeName" : "...", |
| "cardinality" : "LIST", |
| "constraints" : [ { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| }, { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "isLegacyAttribute" : true, |
| "relationshipTypeName" : "...", |
| "cardinality" : "SET", |
| "constraints" : [ { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| }, { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "subTypes" : [ "...", "..." ], |
| "superTypes" : [ "...", "..." ], |
| "attributeDefs" : [ { |
| "cardinality" : "LIST", |
| "constraints" : [ { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| }, { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "LIST", |
| "constraints" : [ { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| }, { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "MAP", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { |
| "availableLocales" : [ "...", "..." ], |
| "currency" : "...", |
| "currencyInstance" : { }, |
| "groupingUsed" : true, |
| "instance" : { }, |
| "integerInstance" : { }, |
| "maximumFractionDigits" : 12345, |
| "maximumIntegerDigits" : 12345, |
| "minimumFractionDigits" : 12345, |
| "minimumIntegerDigits" : 12345, |
| "numberInstance" : { }, |
| "parseIntegerOnly" : true, |
| "percentInstance" : { }, |
| "roundingMode" : "HALF_UP" |
| }, |
| "timeInstance" : { }, |
| "timeZone" : { |
| "DSTSavings" : 12345, |
| "ID" : "...", |
| "availableIDs" : [ "...", "..." ], |
| "default" : { }, |
| "displayName" : "...", |
| "rawOffset" : 12345 |
| } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| } |
| }, |
| "description" : "On Failed lookup for the given guid" |
| } |
| } |
| } |
| }, |
| "\/v2/types/entitydef/name/{name}" : { |
| "get" : { |
| "tags" : [ "TypesREST" ], |
| "description" : "Get the entity definition by it's name (unique)", |
| "operationId" : "getEntityDefByName", |
| "produces" : [ "application/json" ], |
| "parameters" : [ |
| { |
| "name" : "name", |
| "in" : "path", |
| "type" : "string", |
| "description" : "entity name" |
| } |
| ], |
| "responses" : { |
| "200" : { |
| "schema" : { |
| "$ref" : "#/definitions/AtlasEntityDef", |
| "description" : "On successful lookup of the the entity definition by it's name" |
| }, |
| "examples" : { |
| "application/json" : { |
| "businessAttributeDefs" : { |
| "property1" : [ { |
| "cardinality" : "SET", |
| "constraints" : [ { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| }, { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "LIST", |
| "constraints" : [ { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| }, { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "property2" : [ { |
| "cardinality" : "LIST", |
| "constraints" : [ { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| }, { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SET", |
| "constraints" : [ { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| }, { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ] |
| }, |
| "relationshipAttributeDefs" : [ { |
| "isLegacyAttribute" : true, |
| "relationshipTypeName" : "...", |
| "cardinality" : "SET", |
| "constraints" : [ { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| }, { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "isLegacyAttribute" : true, |
| "relationshipTypeName" : "...", |
| "cardinality" : "SET", |
| "constraints" : [ { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| }, { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "subTypes" : [ "...", "..." ], |
| "superTypes" : [ "...", "..." ], |
| "attributeDefs" : [ { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| }, { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "LIST", |
| "constraints" : [ { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| }, { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "RELATIONSHIP", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { |
| "availableLocales" : [ "...", "..." ], |
| "currency" : "...", |
| "currencyInstance" : { }, |
| "groupingUsed" : true, |
| "instance" : { }, |
| "integerInstance" : { }, |
| "maximumFractionDigits" : 12345, |
| "maximumIntegerDigits" : 12345, |
| "minimumFractionDigits" : 12345, |
| "minimumIntegerDigits" : 12345, |
| "numberInstance" : { }, |
| "parseIntegerOnly" : true, |
| "percentInstance" : { }, |
| "roundingMode" : "UP" |
| }, |
| "timeInstance" : { }, |
| "timeZone" : { |
| "DSTSavings" : 12345, |
| "ID" : "...", |
| "availableIDs" : [ "...", "..." ], |
| "default" : { }, |
| "displayName" : "...", |
| "rawOffset" : 12345 |
| } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| } |
| }, |
| "description" : "On successful lookup of the the entity definition by it's name" |
| }, |
| "404" : { |
| "examples" : { |
| "application/json" : { |
| "businessAttributeDefs" : { |
| "property1" : [ { |
| "cardinality" : "SET", |
| "constraints" : [ { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| }, { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "LIST", |
| "constraints" : [ { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| }, { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "property2" : [ { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| }, { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "LIST", |
| "constraints" : [ { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| }, { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ] |
| }, |
| "relationshipAttributeDefs" : [ { |
| "isLegacyAttribute" : true, |
| "relationshipTypeName" : "...", |
| "cardinality" : "SINGLE", |
| "constraints" : [ { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| }, { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "isLegacyAttribute" : true, |
| "relationshipTypeName" : "...", |
| "cardinality" : "SET", |
| "constraints" : [ { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| }, { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "subTypes" : [ "...", "..." ], |
| "superTypes" : [ "...", "..." ], |
| "attributeDefs" : [ { |
| "cardinality" : "LIST", |
| "constraints" : [ { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| }, { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SET", |
| "constraints" : [ { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| }, { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "ENTITY", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { |
| "availableLocales" : [ "...", "..." ], |
| "currency" : "...", |
| "currencyInstance" : { }, |
| "groupingUsed" : true, |
| "instance" : { }, |
| "integerInstance" : { }, |
| "maximumFractionDigits" : 12345, |
| "maximumIntegerDigits" : 12345, |
| "minimumFractionDigits" : 12345, |
| "minimumIntegerDigits" : 12345, |
| "numberInstance" : { }, |
| "parseIntegerOnly" : true, |
| "percentInstance" : { }, |
| "roundingMode" : "CEILING" |
| }, |
| "timeInstance" : { }, |
| "timeZone" : { |
| "DSTSavings" : 12345, |
| "ID" : "...", |
| "availableIDs" : [ "...", "..." ], |
| "default" : { }, |
| "displayName" : "...", |
| "rawOffset" : 12345 |
| } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| } |
| }, |
| "description" : "On Failed lookup for the given name" |
| } |
| } |
| } |
| }, |
| "\/v2/types/enumdef/guid/{guid}" : { |
| "get" : { |
| "tags" : [ "TypesREST" ], |
| "description" : "Get the enum definition for the given guid", |
| "operationId" : "getEnumDefByGuid", |
| "produces" : [ "application/json" ], |
| "parameters" : [ |
| { |
| "name" : "guid", |
| "in" : "path", |
| "type" : "string", |
| "description" : "enum guid" |
| } |
| ], |
| "responses" : { |
| "200" : { |
| "schema" : { |
| "$ref" : "#/definitions/AtlasEnumDef", |
| "description" : "On successful lookup of the the enum definition by it's guid" |
| }, |
| "examples" : { |
| "application/json" : { |
| "defaultValue" : "...", |
| "elementDefs" : [ { |
| "description" : "...", |
| "ordinal" : 12345, |
| "value" : "..." |
| }, { |
| "description" : "...", |
| "ordinal" : 12345, |
| "value" : "..." |
| } ], |
| "category" : "ARRAY", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { |
| "availableLocales" : [ "...", "..." ], |
| "currency" : "...", |
| "currencyInstance" : { }, |
| "groupingUsed" : true, |
| "instance" : { }, |
| "integerInstance" : { }, |
| "maximumFractionDigits" : 12345, |
| "maximumIntegerDigits" : 12345, |
| "minimumFractionDigits" : 12345, |
| "minimumIntegerDigits" : 12345, |
| "numberInstance" : { }, |
| "parseIntegerOnly" : true, |
| "percentInstance" : { }, |
| "roundingMode" : "DOWN" |
| }, |
| "timeInstance" : { }, |
| "timeZone" : { |
| "DSTSavings" : 12345, |
| "ID" : "...", |
| "availableIDs" : [ "...", "..." ], |
| "default" : { }, |
| "displayName" : "...", |
| "rawOffset" : 12345 |
| } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| } |
| }, |
| "description" : "On successful lookup of the the enum definition by it's guid" |
| }, |
| "404" : { |
| "examples" : { |
| "application/json" : { |
| "defaultValue" : "...", |
| "elementDefs" : [ { |
| "description" : "...", |
| "ordinal" : 12345, |
| "value" : "..." |
| }, { |
| "description" : "...", |
| "ordinal" : 12345, |
| "value" : "..." |
| } ], |
| "category" : "PRIMITIVE", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { |
| "availableLocales" : [ "...", "..." ], |
| "currency" : "...", |
| "currencyInstance" : { }, |
| "groupingUsed" : true, |
| "instance" : { }, |
| "integerInstance" : { }, |
| "maximumFractionDigits" : 12345, |
| "maximumIntegerDigits" : 12345, |
| "minimumFractionDigits" : 12345, |
| "minimumIntegerDigits" : 12345, |
| "numberInstance" : { }, |
| "parseIntegerOnly" : true, |
| "percentInstance" : { }, |
| "roundingMode" : "CEILING" |
| }, |
| "timeInstance" : { }, |
| "timeZone" : { |
| "DSTSavings" : 12345, |
| "ID" : "...", |
| "availableIDs" : [ "...", "..." ], |
| "default" : { }, |
| "displayName" : "...", |
| "rawOffset" : 12345 |
| } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| } |
| }, |
| "description" : "On Failed lookup for the given guid" |
| } |
| } |
| } |
| }, |
| "\/v2/types/enumdef/name/{name}" : { |
| "get" : { |
| "tags" : [ "TypesREST" ], |
| "description" : "Get the enum definition by it's name (unique)", |
| "operationId" : "getEnumDefByName", |
| "produces" : [ "application/json" ], |
| "parameters" : [ |
| { |
| "name" : "name", |
| "in" : "path", |
| "type" : "string", |
| "description" : "enum name" |
| } |
| ], |
| "responses" : { |
| "200" : { |
| "schema" : { |
| "$ref" : "#/definitions/AtlasEnumDef", |
| "description" : "On successful lookup of the the enum definition by it's name" |
| }, |
| "examples" : { |
| "application/json" : { |
| "defaultValue" : "...", |
| "elementDefs" : [ { |
| "description" : "...", |
| "ordinal" : 12345, |
| "value" : "..." |
| }, { |
| "description" : "...", |
| "ordinal" : 12345, |
| "value" : "..." |
| } ], |
| "category" : "RELATIONSHIP", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { |
| "availableLocales" : [ "...", "..." ], |
| "currency" : "...", |
| "currencyInstance" : { }, |
| "groupingUsed" : true, |
| "instance" : { }, |
| "integerInstance" : { }, |
| "maximumFractionDigits" : 12345, |
| "maximumIntegerDigits" : 12345, |
| "minimumFractionDigits" : 12345, |
| "minimumIntegerDigits" : 12345, |
| "numberInstance" : { }, |
| "parseIntegerOnly" : true, |
| "percentInstance" : { }, |
| "roundingMode" : "HALF_UP" |
| }, |
| "timeInstance" : { }, |
| "timeZone" : { |
| "DSTSavings" : 12345, |
| "ID" : "...", |
| "availableIDs" : [ "...", "..." ], |
| "default" : { }, |
| "displayName" : "...", |
| "rawOffset" : 12345 |
| } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| } |
| }, |
| "description" : "On successful lookup of the the enum definition by it's name" |
| }, |
| "404" : { |
| "examples" : { |
| "application/json" : { |
| "defaultValue" : "...", |
| "elementDefs" : [ { |
| "description" : "...", |
| "ordinal" : 12345, |
| "value" : "..." |
| }, { |
| "description" : "...", |
| "ordinal" : 12345, |
| "value" : "..." |
| } ], |
| "category" : "CLASSIFICATION", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { |
| "availableLocales" : [ "...", "..." ], |
| "currency" : "...", |
| "currencyInstance" : { }, |
| "groupingUsed" : true, |
| "instance" : { }, |
| "integerInstance" : { }, |
| "maximumFractionDigits" : 12345, |
| "maximumIntegerDigits" : 12345, |
| "minimumFractionDigits" : 12345, |
| "minimumIntegerDigits" : 12345, |
| "numberInstance" : { }, |
| "parseIntegerOnly" : true, |
| "percentInstance" : { }, |
| "roundingMode" : "HALF_UP" |
| }, |
| "timeInstance" : { }, |
| "timeZone" : { |
| "DSTSavings" : 12345, |
| "ID" : "...", |
| "availableIDs" : [ "...", "..." ], |
| "default" : { }, |
| "displayName" : "...", |
| "rawOffset" : 12345 |
| } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| } |
| }, |
| "description" : "On Failed lookup for the given name" |
| } |
| } |
| } |
| }, |
| "\/v2/types/relationshipdef/guid/{guid}" : { |
| "get" : { |
| "tags" : [ "TypesREST" ], |
| "description" : "Get the relationship definition for the given guid", |
| "operationId" : "getRelationshipDefByGuid", |
| "produces" : [ "application/json" ], |
| "parameters" : [ |
| { |
| "name" : "guid", |
| "in" : "path", |
| "type" : "string", |
| "description" : "relationship guid" |
| } |
| ], |
| "responses" : { |
| "200" : { |
| "schema" : { |
| "$ref" : "#/definitions/AtlasRelationshipDef", |
| "description" : "On successful lookup of the the relationship definition by it's guid" |
| }, |
| "examples" : { |
| "application/json" : { |
| "endDef1" : { |
| "cardinality" : "SET", |
| "description" : "...", |
| "isContainer" : true, |
| "isLegacyAttribute" : true, |
| "name" : "...", |
| "type" : "..." |
| }, |
| "endDef2" : { |
| "cardinality" : "SET", |
| "description" : "...", |
| "isContainer" : true, |
| "isLegacyAttribute" : true, |
| "name" : "...", |
| "type" : "..." |
| }, |
| "propagateTags" : "ONE_TO_TWO", |
| "relationshipCategory" : "ASSOCIATION", |
| "relationshipLabel" : "...", |
| "attributeDefs" : [ { |
| "cardinality" : "LIST", |
| "constraints" : [ { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| }, { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "LIST", |
| "constraints" : [ { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| }, { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "OBJECT_ID_TYPE", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { |
| "availableLocales" : [ "...", "..." ], |
| "currency" : "...", |
| "currencyInstance" : { }, |
| "groupingUsed" : true, |
| "instance" : { }, |
| "integerInstance" : { }, |
| "maximumFractionDigits" : 12345, |
| "maximumIntegerDigits" : 12345, |
| "minimumFractionDigits" : 12345, |
| "minimumIntegerDigits" : 12345, |
| "numberInstance" : { }, |
| "parseIntegerOnly" : true, |
| "percentInstance" : { }, |
| "roundingMode" : "HALF_DOWN" |
| }, |
| "timeInstance" : { }, |
| "timeZone" : { |
| "DSTSavings" : 12345, |
| "ID" : "...", |
| "availableIDs" : [ "...", "..." ], |
| "default" : { }, |
| "displayName" : "...", |
| "rawOffset" : 12345 |
| } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| } |
| }, |
| "description" : "On successful lookup of the the relationship definition by it's guid" |
| }, |
| "404" : { |
| "examples" : { |
| "application/json" : { |
| "endDef1" : { |
| "cardinality" : "SINGLE", |
| "description" : "...", |
| "isContainer" : true, |
| "isLegacyAttribute" : true, |
| "name" : "...", |
| "type" : "..." |
| }, |
| "endDef2" : { |
| "cardinality" : "LIST", |
| "description" : "...", |
| "isContainer" : true, |
| "isLegacyAttribute" : true, |
| "name" : "...", |
| "type" : "..." |
| }, |
| "propagateTags" : "ONE_TO_TWO", |
| "relationshipCategory" : "AGGREGATION", |
| "relationshipLabel" : "...", |
| "attributeDefs" : [ { |
| "cardinality" : "LIST", |
| "constraints" : [ { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| }, { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SET", |
| "constraints" : [ { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| }, { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "ENTITY", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { |
| "availableLocales" : [ "...", "..." ], |
| "currency" : "...", |
| "currencyInstance" : { }, |
| "groupingUsed" : true, |
| "instance" : { }, |
| "integerInstance" : { }, |
| "maximumFractionDigits" : 12345, |
| "maximumIntegerDigits" : 12345, |
| "minimumFractionDigits" : 12345, |
| "minimumIntegerDigits" : 12345, |
| "numberInstance" : { }, |
| "parseIntegerOnly" : true, |
| "percentInstance" : { }, |
| "roundingMode" : "CEILING" |
| }, |
| "timeInstance" : { }, |
| "timeZone" : { |
| "DSTSavings" : 12345, |
| "ID" : "...", |
| "availableIDs" : [ "...", "..." ], |
| "default" : { }, |
| "displayName" : "...", |
| "rawOffset" : 12345 |
| } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| } |
| }, |
| "description" : "On Failed lookup for the given guid" |
| } |
| } |
| } |
| }, |
| "\/v2/types/relationshipdef/name/{name}" : { |
| "get" : { |
| "tags" : [ "TypesREST" ], |
| "description" : "Get the relationship definition by it's name (unique)", |
| "operationId" : "getRelationshipDefByName", |
| "produces" : [ "application/json" ], |
| "parameters" : [ |
| { |
| "name" : "name", |
| "in" : "path", |
| "type" : "string", |
| "description" : "relationship name" |
| } |
| ], |
| "responses" : { |
| "200" : { |
| "schema" : { |
| "$ref" : "#/definitions/AtlasRelationshipDef", |
| "description" : "On successful lookup of the the relationship definition by it's name" |
| }, |
| "examples" : { |
| "application/json" : { |
| "endDef1" : { |
| "cardinality" : "SINGLE", |
| "description" : "...", |
| "isContainer" : true, |
| "isLegacyAttribute" : true, |
| "name" : "...", |
| "type" : "..." |
| }, |
| "endDef2" : { |
| "cardinality" : "SET", |
| "description" : "...", |
| "isContainer" : true, |
| "isLegacyAttribute" : true, |
| "name" : "...", |
| "type" : "..." |
| }, |
| "propagateTags" : "NONE", |
| "relationshipCategory" : "AGGREGATION", |
| "relationshipLabel" : "...", |
| "attributeDefs" : [ { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| }, { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| }, { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "RELATIONSHIP", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { |
| "availableLocales" : [ "...", "..." ], |
| "currency" : "...", |
| "currencyInstance" : { }, |
| "groupingUsed" : true, |
| "instance" : { }, |
| "integerInstance" : { }, |
| "maximumFractionDigits" : 12345, |
| "maximumIntegerDigits" : 12345, |
| "minimumFractionDigits" : 12345, |
| "minimumIntegerDigits" : 12345, |
| "numberInstance" : { }, |
| "parseIntegerOnly" : true, |
| "percentInstance" : { }, |
| "roundingMode" : "UNNECESSARY" |
| }, |
| "timeInstance" : { }, |
| "timeZone" : { |
| "DSTSavings" : 12345, |
| "ID" : "...", |
| "availableIDs" : [ "...", "..." ], |
| "default" : { }, |
| "displayName" : "...", |
| "rawOffset" : 12345 |
| } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| } |
| }, |
| "description" : "On successful lookup of the the relationship definition by it's name" |
| }, |
| "404" : { |
| "examples" : { |
| "application/json" : { |
| "endDef1" : { |
| "cardinality" : "SET", |
| "description" : "...", |
| "isContainer" : true, |
| "isLegacyAttribute" : true, |
| "name" : "...", |
| "type" : "..." |
| }, |
| "endDef2" : { |
| "cardinality" : "LIST", |
| "description" : "...", |
| "isContainer" : true, |
| "isLegacyAttribute" : true, |
| "name" : "...", |
| "type" : "..." |
| }, |
| "propagateTags" : "TWO_TO_ONE", |
| "relationshipCategory" : "COMPOSITION", |
| "relationshipLabel" : "...", |
| "attributeDefs" : [ { |
| "cardinality" : "SET", |
| "constraints" : [ { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| }, { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| }, { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "ARRAY", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { |
| "availableLocales" : [ "...", "..." ], |
| "currency" : "...", |
| "currencyInstance" : { }, |
| "groupingUsed" : true, |
| "instance" : { }, |
| "integerInstance" : { }, |
| "maximumFractionDigits" : 12345, |
| "maximumIntegerDigits" : 12345, |
| "minimumFractionDigits" : 12345, |
| "minimumIntegerDigits" : 12345, |
| "numberInstance" : { }, |
| "parseIntegerOnly" : true, |
| "percentInstance" : { }, |
| "roundingMode" : "HALF_UP" |
| }, |
| "timeInstance" : { }, |
| "timeZone" : { |
| "DSTSavings" : 12345, |
| "ID" : "...", |
| "availableIDs" : [ "...", "..." ], |
| "default" : { }, |
| "displayName" : "...", |
| "rawOffset" : 12345 |
| } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| } |
| }, |
| "description" : "On Failed lookup for the given name" |
| } |
| } |
| } |
| }, |
| "\/v2/types/structdef/guid/{guid}" : { |
| "get" : { |
| "tags" : [ "TypesREST" ], |
| "description" : "Get the struct definition for the given guid", |
| "operationId" : "getStructDefByGuid", |
| "produces" : [ "application/json" ], |
| "parameters" : [ |
| { |
| "name" : "guid", |
| "in" : "path", |
| "type" : "string", |
| "description" : "struct guid" |
| } |
| ], |
| "responses" : { |
| "200" : { |
| "schema" : { |
| "$ref" : "#/definitions/AtlasStructDef", |
| "description" : "On successful lookup of the the struct definition by it's guid" |
| }, |
| "examples" : { |
| "application/json" : { |
| "attributeDefs" : [ { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| }, { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| }, { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "ENUM", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { |
| "availableLocales" : [ "...", "..." ], |
| "currency" : "...", |
| "currencyInstance" : { }, |
| "groupingUsed" : true, |
| "instance" : { }, |
| "integerInstance" : { }, |
| "maximumFractionDigits" : 12345, |
| "maximumIntegerDigits" : 12345, |
| "minimumFractionDigits" : 12345, |
| "minimumIntegerDigits" : 12345, |
| "numberInstance" : { }, |
| "parseIntegerOnly" : true, |
| "percentInstance" : { }, |
| "roundingMode" : "CEILING" |
| }, |
| "timeInstance" : { }, |
| "timeZone" : { |
| "DSTSavings" : 12345, |
| "ID" : "...", |
| "availableIDs" : [ "...", "..." ], |
| "default" : { }, |
| "displayName" : "...", |
| "rawOffset" : 12345 |
| } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| } |
| }, |
| "description" : "On successful lookup of the the struct definition by it's guid" |
| }, |
| "404" : { |
| "examples" : { |
| "application/json" : { |
| "attributeDefs" : [ { |
| "cardinality" : "LIST", |
| "constraints" : [ { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| }, { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "LIST", |
| "constraints" : [ { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| }, { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "OBJECT_ID_TYPE", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { |
| "availableLocales" : [ "...", "..." ], |
| "currency" : "...", |
| "currencyInstance" : { }, |
| "groupingUsed" : true, |
| "instance" : { }, |
| "integerInstance" : { }, |
| "maximumFractionDigits" : 12345, |
| "maximumIntegerDigits" : 12345, |
| "minimumFractionDigits" : 12345, |
| "minimumIntegerDigits" : 12345, |
| "numberInstance" : { }, |
| "parseIntegerOnly" : true, |
| "percentInstance" : { }, |
| "roundingMode" : "UNNECESSARY" |
| }, |
| "timeInstance" : { }, |
| "timeZone" : { |
| "DSTSavings" : 12345, |
| "ID" : "...", |
| "availableIDs" : [ "...", "..." ], |
| "default" : { }, |
| "displayName" : "...", |
| "rawOffset" : 12345 |
| } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| } |
| }, |
| "description" : "On Failed lookup for the given guid" |
| } |
| } |
| } |
| }, |
| "\/v2/types/structdef/name/{name}" : { |
| "get" : { |
| "tags" : [ "TypesREST" ], |
| "description" : "Get the struct definition by it's name (unique)", |
| "operationId" : "getStructDefByName", |
| "produces" : [ "application/json" ], |
| "parameters" : [ |
| { |
| "name" : "name", |
| "in" : "path", |
| "type" : "string", |
| "description" : "struct name" |
| } |
| ], |
| "responses" : { |
| "200" : { |
| "schema" : { |
| "$ref" : "#/definitions/AtlasStructDef", |
| "description" : "On successful lookup of the the struct definition by it's name" |
| }, |
| "examples" : { |
| "application/json" : { |
| "attributeDefs" : [ { |
| "cardinality" : "SET", |
| "constraints" : [ { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| }, { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| }, { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "OBJECT_ID_TYPE", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { |
| "availableLocales" : [ "...", "..." ], |
| "currency" : "...", |
| "currencyInstance" : { }, |
| "groupingUsed" : true, |
| "instance" : { }, |
| "integerInstance" : { }, |
| "maximumFractionDigits" : 12345, |
| "maximumIntegerDigits" : 12345, |
| "minimumFractionDigits" : 12345, |
| "minimumIntegerDigits" : 12345, |
| "numberInstance" : { }, |
| "parseIntegerOnly" : true, |
| "percentInstance" : { }, |
| "roundingMode" : "HALF_EVEN" |
| }, |
| "timeInstance" : { }, |
| "timeZone" : { |
| "DSTSavings" : 12345, |
| "ID" : "...", |
| "availableIDs" : [ "...", "..." ], |
| "default" : { }, |
| "displayName" : "...", |
| "rawOffset" : 12345 |
| } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| } |
| }, |
| "description" : "On successful lookup of the the struct definition by it's name" |
| }, |
| "404" : { |
| "examples" : { |
| "application/json" : { |
| "attributeDefs" : [ { |
| "cardinality" : "SET", |
| "constraints" : [ { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| }, { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| }, { |
| "params" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "type" : "..." |
| } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "ENUM", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { |
| "availableLocales" : [ "...", "..." ], |
| "currency" : "...", |
| "currencyInstance" : { }, |
| "groupingUsed" : true, |
| "instance" : { }, |
| "integerInstance" : { }, |
| "maximumFractionDigits" : 12345, |
| "maximumIntegerDigits" : 12345, |
| "minimumFractionDigits" : 12345, |
| "minimumIntegerDigits" : 12345, |
| "numberInstance" : { }, |
| "parseIntegerOnly" : true, |
| "percentInstance" : { }, |
| "roundingMode" : "UNNECESSARY" |
| }, |
| "timeInstance" : { }, |
| "timeZone" : { |
| "DSTSavings" : 12345, |
| "ID" : "...", |
| "availableIDs" : [ "...", "..." ], |
| "default" : { }, |
| "displayName" : "...", |
| "rawOffset" : 12345 |
| } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| } |
| }, |
| "description" : "On Failed lookup for the given name" |
| } |
| } |
| } |
| }, |
| "\/v2/types/typedef/guid/{guid}" : { |
| "get" : { |
| "tags" : [ "TypesREST" ], |
| "operationId" : "getTypeDefByGuid", |
| "produces" : [ "application/json" ], |
| "parameters" : [ |
| { |
| "name" : "guid", |
| "in" : "path", |
| "type" : "string", |
| "description" : "GUID of the type" |
| } |
| ], |
| "responses" : { |
| "200" : { |
| "schema" : { |
| "$ref" : "#/definitions/AtlasBaseTypeDef", |
| "description" : "Successful lookup" |
| }, |
| "examples" : { |
| "application/json" : { |
| "category" : "OBJECT_ID_TYPE", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { |
| "availableLocales" : [ "...", "..." ], |
| "currency" : "...", |
| "currencyInstance" : { }, |
| "groupingUsed" : true, |
| "instance" : { }, |
| "integerInstance" : { }, |
| "maximumFractionDigits" : 12345, |
| "maximumIntegerDigits" : 12345, |
| "minimumFractionDigits" : 12345, |
| "minimumIntegerDigits" : 12345, |
| "numberInstance" : { }, |
| "parseIntegerOnly" : true, |
| "percentInstance" : { }, |
| "roundingMode" : "UNNECESSARY" |
| }, |
| "timeInstance" : { }, |
| "timeZone" : { |
| "DSTSavings" : 12345, |
| "ID" : "...", |
| "availableIDs" : [ "...", "..." ], |
| "default" : { }, |
| "displayName" : "...", |
| "rawOffset" : 12345 |
| } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| } |
| }, |
| "description" : "Successful lookup" |
| }, |
| "404" : { |
| "examples" : { |
| "application/json" : { |
| "category" : "CLASSIFICATION", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { |
| "availableLocales" : [ "...", "..." ], |
| "currency" : "...", |
| "currencyInstance" : { }, |
| "groupingUsed" : true, |
| "instance" : { }, |
| "integerInstance" : { }, |
| "maximumFractionDigits" : 12345, |
| "maximumIntegerDigits" : 12345, |
| "minimumFractionDigits" : 12345, |
| "minimumIntegerDigits" : 12345, |
| "numberInstance" : { }, |
| "parseIntegerOnly" : true, |
| "percentInstance" : { }, |
| "roundingMode" : "UP" |
| }, |
| "timeInstance" : { }, |
| "timeZone" : { |
| "DSTSavings" : 12345, |
| "ID" : "...", |
| "availableIDs" : [ "...", "..." ], |
| "default" : { }, |
| "displayName" : "...", |
| "rawOffset" : 12345 |
| } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| } |
| }, |
| "description" : "Failed lookup" |
| } |
| } |
| } |
| }, |
| "\/v2/types/typedef/name/{name}" : { |
| "get" : { |
| "tags" : [ "TypesREST" ], |
| "description" : "Get type definition by it's name", |
| "operationId" : "getTypeDefByName", |
| "produces" : [ "application/json" ], |
| "parameters" : [ |
| { |
| "name" : "name", |
| "in" : "path", |
| "type" : "string", |
| "description" : "Type name" |
| } |
| ], |
| "responses" : { |
| "200" : { |
| "schema" : { |
| "$ref" : "#/definitions/AtlasBaseTypeDef", |
| "description" : "Successful lookup by name" |
| }, |
| "examples" : { |
| "application/json" : { |
| "category" : "STRUCT", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { |
| "availableLocales" : [ "...", "..." ], |
| "currency" : "...", |
| "currencyInstance" : { }, |
| "groupingUsed" : true, |
| "instance" : { }, |
| "integerInstance" : { }, |
| "maximumFractionDigits" : 12345, |
| "maximumIntegerDigits" : 12345, |
| "minimumFractionDigits" : 12345, |
| "minimumIntegerDigits" : 12345, |
| "numberInstance" : { }, |
| "parseIntegerOnly" : true, |
| "percentInstance" : { }, |
| "roundingMode" : "DOWN" |
| }, |
| "timeInstance" : { }, |
| "timeZone" : { |
| "DSTSavings" : 12345, |
| "ID" : "...", |
| "availableIDs" : [ "...", "..." ], |
| "default" : { }, |
| "displayName" : "...", |
| "rawOffset" : 12345 |
| } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| } |
| }, |
| "description" : "Successful lookup by name" |
| }, |
| "404" : { |
| "examples" : { |
| "application/json" : { |
| "category" : "OBJECT_ID_TYPE", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { |
| "availableLocales" : [ "...", "..." ], |
| "currency" : "...", |
| "currencyInstance" : { }, |
| "groupingUsed" : true, |
| "instance" : { }, |
| "integerInstance" : { }, |
| "maximumFractionDigits" : 12345, |
| "maximumIntegerDigits" : 12345, |
| "minimumFractionDigits" : 12345, |
| "minimumIntegerDigits" : 12345, |
| "numberInstance" : { }, |
| "parseIntegerOnly" : true, |
| "percentInstance" : { }, |
| "roundingMode" : "UP" |
| }, |
| "timeInstance" : { }, |
| "timeZone" : { |
| "DSTSavings" : 12345, |
| "ID" : "...", |
| "availableIDs" : [ "...", "..." ], |
| "default" : { }, |
| "displayName" : "...", |
| "rawOffset" : 12345 |
| } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| } |
| }, |
| "description" : "Failed lookup by name" |
| } |
| } |
| } |
| }, |
| "\/v2/types/typedef/name/{typeName}" : { |
| "delete" : { |
| "tags" : [ "TypesREST" ], |
| "description" : "Delete API for type identified by its name.", |
| "operationId" : "deleteAtlasTypeByName", |
| "parameters" : [ |
| { |
| "name" : "typeName", |
| "in" : "path", |
| "type" : "string", |
| "description" : "Name of the type to be deleted." |
| } |
| ], |
| "responses" : { |
| "204" : { |
| "description" : "On successful deletion of the requested type definitions" |
| }, |
| "400" : { |
| "description" : "On validation failure for any type definitions" |
| } |
| } |
| } |
| }, |
| "\/v2/types/typedefs" : { |
| "delete" : { |
| "tags" : [ "TypesREST" ], |
| "description" : "Bulk delete API for all types", |
| "operationId" : "deleteAtlasTypeDefs", |
| "consumes" : [ "application/json" ], |
| "parameters" : [ |
| { |
| "name" : "body", |
| "required" : false, |
| "in" : "body", |
| "schema" : { |
| "$ref" : "#/definitions/AtlasTypesDef", |
| "description" : "A composite object that captures all types to be deleted" |
| }, |
| "description" : "A composite object that captures all types to be deleted" |
| } |
| ], |
| "responses" : { |
| "204" : { |
| "description" : "On successful deletion of the requested type definitions" |
| }, |
| "400" : { |
| "description" : "On validation failure for any type definitions" |
| } |
| } |
| }, |
| "get" : { |
| "tags" : [ "TypesREST" ], |
| "description" : "Bulk retrieval API for retrieving all type definitions in Atlas", |
| "operationId" : "getAllTypeDefs", |
| "produces" : [ "application/json" ], |
| "parameters" : [ |
| ], |
| "responses" : { |
| "200" : { |
| "schema" : { |
| "$ref" : "#/definitions/AtlasTypesDef", |
| "description" : "AtlasTypesDef with type definitions matching the search criteria or else returns empty list of type definitions" |
| }, |
| "examples" : { |
| "application/json" : { |
| "businessMetadataDefs" : [ { |
| "attributeDefs" : [ { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "ARRAY", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| }, { |
| "attributeDefs" : [ { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "CLASSIFICATION", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| } ], |
| "classificationDefs" : [ { |
| "entityTypes" : [ "...", "..." ], |
| "subTypes" : [ "...", "..." ], |
| "superTypes" : [ "...", "..." ], |
| "attributeDefs" : [ { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "LIST", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "MAP", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| }, { |
| "entityTypes" : [ "...", "..." ], |
| "subTypes" : [ "...", "..." ], |
| "superTypes" : [ "...", "..." ], |
| "attributeDefs" : [ { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "LIST", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "ENUM", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| } ], |
| "entityDefs" : [ { |
| "businessAttributeDefs" : { |
| "property1" : [ { |
| "cardinality" : "LIST", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "LIST", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "property2" : [ { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "LIST", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ] |
| }, |
| "relationshipAttributeDefs" : [ { |
| "isLegacyAttribute" : true, |
| "relationshipTypeName" : "...", |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "isLegacyAttribute" : true, |
| "relationshipTypeName" : "...", |
| "cardinality" : "SINGLE", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "subTypes" : [ "...", "..." ], |
| "superTypes" : [ "...", "..." ], |
| "attributeDefs" : [ { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "LIST", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "ENTITY", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| }, { |
| "businessAttributeDefs" : { |
| "property1" : [ { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "LIST", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "property2" : [ { |
| "cardinality" : "LIST", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "LIST", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ] |
| }, |
| "relationshipAttributeDefs" : [ { |
| "isLegacyAttribute" : true, |
| "relationshipTypeName" : "...", |
| "cardinality" : "LIST", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "isLegacyAttribute" : true, |
| "relationshipTypeName" : "...", |
| "cardinality" : "LIST", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "subTypes" : [ "...", "..." ], |
| "superTypes" : [ "...", "..." ], |
| "attributeDefs" : [ { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "OBJECT_ID_TYPE", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| } ], |
| "enumDefs" : [ { |
| "defaultValue" : "...", |
| "elementDefs" : [ { |
| "description" : "...", |
| "ordinal" : 12345, |
| "value" : "..." |
| }, { |
| "description" : "...", |
| "ordinal" : 12345, |
| "value" : "..." |
| } ], |
| "category" : "ARRAY", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| }, { |
| "defaultValue" : "...", |
| "elementDefs" : [ { |
| "description" : "...", |
| "ordinal" : 12345, |
| "value" : "..." |
| }, { |
| "description" : "...", |
| "ordinal" : 12345, |
| "value" : "..." |
| } ], |
| "category" : "CLASSIFICATION", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| } ], |
| "relationshipDefs" : [ { |
| "endDef1" : { |
| "cardinality" : "SINGLE", |
| "description" : "...", |
| "isContainer" : true, |
| "isLegacyAttribute" : true, |
| "name" : "...", |
| "type" : "..." |
| }, |
| "endDef2" : { |
| "cardinality" : "SINGLE", |
| "description" : "...", |
| "isContainer" : true, |
| "isLegacyAttribute" : true, |
| "name" : "...", |
| "type" : "..." |
| }, |
| "propagateTags" : "TWO_TO_ONE", |
| "relationshipCategory" : "ASSOCIATION", |
| "relationshipLabel" : "...", |
| "attributeDefs" : [ { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "LIST", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "RELATIONSHIP", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| }, { |
| "endDef1" : { |
| "cardinality" : "SET", |
| "description" : "...", |
| "isContainer" : true, |
| "isLegacyAttribute" : true, |
| "name" : "...", |
| "type" : "..." |
| }, |
| "endDef2" : { |
| "cardinality" : "SET", |
| "description" : "...", |
| "isContainer" : true, |
| "isLegacyAttribute" : true, |
| "name" : "...", |
| "type" : "..." |
| }, |
| "propagateTags" : "BOTH", |
| "relationshipCategory" : "AGGREGATION", |
| "relationshipLabel" : "...", |
| "attributeDefs" : [ { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "RELATIONSHIP", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| } ], |
| "structDefs" : [ { |
| "attributeDefs" : [ { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "STRUCT", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| }, { |
| "attributeDefs" : [ { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "ARRAY", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| } ] |
| } |
| }, |
| "description" : "AtlasTypesDef with type definitions matching the search criteria or else returns empty list of type definitions" |
| } |
| } |
| }, |
| "post" : { |
| "tags" : [ "TypesREST" ], |
| "description" : "Bulk create APIs for all atlas type definitions, only new definitions will be created.\nAny changes to the existing definitions will be discarded", |
| "operationId" : "createAtlasTypeDefs", |
| "consumes" : [ "application/json" ], |
| "produces" : [ "application/json" ], |
| "parameters" : [ |
| { |
| "name" : "body", |
| "required" : false, |
| "in" : "body", |
| "schema" : { |
| "$ref" : "#/definitions/AtlasTypesDef", |
| "description" : "A composite wrapper object with corresponding lists of the type definition" |
| }, |
| "description" : "A composite wrapper object with corresponding lists of the type definition" |
| } |
| ], |
| "responses" : { |
| "200" : { |
| "schema" : { |
| "$ref" : "#/definitions/AtlasTypesDef", |
| "description" : "On successful update of requested type definitions" |
| }, |
| "examples" : { |
| "application/json" : { |
| "businessMetadataDefs" : [ { |
| "attributeDefs" : [ { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "LIST", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "STRUCT", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| }, { |
| "attributeDefs" : [ { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "LIST", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "STRUCT", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| } ], |
| "classificationDefs" : [ { |
| "entityTypes" : [ "...", "..." ], |
| "subTypes" : [ "...", "..." ], |
| "superTypes" : [ "...", "..." ], |
| "attributeDefs" : [ { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "ENUM", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| }, { |
| "entityTypes" : [ "...", "..." ], |
| "subTypes" : [ "...", "..." ], |
| "superTypes" : [ "...", "..." ], |
| "attributeDefs" : [ { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "CLASSIFICATION", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| } ], |
| "entityDefs" : [ { |
| "businessAttributeDefs" : { |
| "property1" : [ { |
| "cardinality" : "LIST", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "property2" : [ { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ] |
| }, |
| "relationshipAttributeDefs" : [ { |
| "isLegacyAttribute" : true, |
| "relationshipTypeName" : "...", |
| "cardinality" : "LIST", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "isLegacyAttribute" : true, |
| "relationshipTypeName" : "...", |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "subTypes" : [ "...", "..." ], |
| "superTypes" : [ "...", "..." ], |
| "attributeDefs" : [ { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "LIST", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "PRIMITIVE", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| }, { |
| "businessAttributeDefs" : { |
| "property1" : [ { |
| "cardinality" : "LIST", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "property2" : [ { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "LIST", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ] |
| }, |
| "relationshipAttributeDefs" : [ { |
| "isLegacyAttribute" : true, |
| "relationshipTypeName" : "...", |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "isLegacyAttribute" : true, |
| "relationshipTypeName" : "...", |
| "cardinality" : "LIST", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "subTypes" : [ "...", "..." ], |
| "superTypes" : [ "...", "..." ], |
| "attributeDefs" : [ { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "LIST", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "ARRAY", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| } ], |
| "enumDefs" : [ { |
| "defaultValue" : "...", |
| "elementDefs" : [ { |
| "description" : "...", |
| "ordinal" : 12345, |
| "value" : "..." |
| }, { |
| "description" : "...", |
| "ordinal" : 12345, |
| "value" : "..." |
| } ], |
| "category" : "ARRAY", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| }, { |
| "defaultValue" : "...", |
| "elementDefs" : [ { |
| "description" : "...", |
| "ordinal" : 12345, |
| "value" : "..." |
| }, { |
| "description" : "...", |
| "ordinal" : 12345, |
| "value" : "..." |
| } ], |
| "category" : "ENUM", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| } ], |
| "relationshipDefs" : [ { |
| "endDef1" : { |
| "cardinality" : "SINGLE", |
| "description" : "...", |
| "isContainer" : true, |
| "isLegacyAttribute" : true, |
| "name" : "...", |
| "type" : "..." |
| }, |
| "endDef2" : { |
| "cardinality" : "SET", |
| "description" : "...", |
| "isContainer" : true, |
| "isLegacyAttribute" : true, |
| "name" : "...", |
| "type" : "..." |
| }, |
| "propagateTags" : "ONE_TO_TWO", |
| "relationshipCategory" : "COMPOSITION", |
| "relationshipLabel" : "...", |
| "attributeDefs" : [ { |
| "cardinality" : "LIST", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "MAP", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| }, { |
| "endDef1" : { |
| "cardinality" : "LIST", |
| "description" : "...", |
| "isContainer" : true, |
| "isLegacyAttribute" : true, |
| "name" : "...", |
| "type" : "..." |
| }, |
| "endDef2" : { |
| "cardinality" : "LIST", |
| "description" : "...", |
| "isContainer" : true, |
| "isLegacyAttribute" : true, |
| "name" : "...", |
| "type" : "..." |
| }, |
| "propagateTags" : "TWO_TO_ONE", |
| "relationshipCategory" : "AGGREGATION", |
| "relationshipLabel" : "...", |
| "attributeDefs" : [ { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "ARRAY", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| } ], |
| "structDefs" : [ { |
| "attributeDefs" : [ { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "ARRAY", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| }, { |
| "attributeDefs" : [ { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "ENUM", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| } ] |
| } |
| }, |
| "description" : "On successful update of requested type definitions" |
| }, |
| "400" : { |
| "examples" : { |
| "application/json" : { |
| "businessMetadataDefs" : [ { |
| "attributeDefs" : [ { |
| "cardinality" : "LIST", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "STRUCT", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| }, { |
| "attributeDefs" : [ { |
| "cardinality" : "LIST", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "LIST", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "ENUM", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| } ], |
| "classificationDefs" : [ { |
| "entityTypes" : [ "...", "..." ], |
| "subTypes" : [ "...", "..." ], |
| "superTypes" : [ "...", "..." ], |
| "attributeDefs" : [ { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "ENUM", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| }, { |
| "entityTypes" : [ "...", "..." ], |
| "subTypes" : [ "...", "..." ], |
| "superTypes" : [ "...", "..." ], |
| "attributeDefs" : [ { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "LIST", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "ARRAY", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| } ], |
| "entityDefs" : [ { |
| "businessAttributeDefs" : { |
| "property1" : [ { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "property2" : [ { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ] |
| }, |
| "relationshipAttributeDefs" : [ { |
| "isLegacyAttribute" : true, |
| "relationshipTypeName" : "...", |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "isLegacyAttribute" : true, |
| "relationshipTypeName" : "...", |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "subTypes" : [ "...", "..." ], |
| "superTypes" : [ "...", "..." ], |
| "attributeDefs" : [ { |
| "cardinality" : "LIST", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "RELATIONSHIP", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| }, { |
| "businessAttributeDefs" : { |
| "property1" : [ { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "LIST", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "property2" : [ { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ] |
| }, |
| "relationshipAttributeDefs" : [ { |
| "isLegacyAttribute" : true, |
| "relationshipTypeName" : "...", |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "isLegacyAttribute" : true, |
| "relationshipTypeName" : "...", |
| "cardinality" : "LIST", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "subTypes" : [ "...", "..." ], |
| "superTypes" : [ "...", "..." ], |
| "attributeDefs" : [ { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "LIST", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "ENTITY", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| } ], |
| "enumDefs" : [ { |
| "defaultValue" : "...", |
| "elementDefs" : [ { |
| "description" : "...", |
| "ordinal" : 12345, |
| "value" : "..." |
| }, { |
| "description" : "...", |
| "ordinal" : 12345, |
| "value" : "..." |
| } ], |
| "category" : "PRIMITIVE", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| }, { |
| "defaultValue" : "...", |
| "elementDefs" : [ { |
| "description" : "...", |
| "ordinal" : 12345, |
| "value" : "..." |
| }, { |
| "description" : "...", |
| "ordinal" : 12345, |
| "value" : "..." |
| } ], |
| "category" : "CLASSIFICATION", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| } ], |
| "relationshipDefs" : [ { |
| "endDef1" : { |
| "cardinality" : "LIST", |
| "description" : "...", |
| "isContainer" : true, |
| "isLegacyAttribute" : true, |
| "name" : "...", |
| "type" : "..." |
| }, |
| "endDef2" : { |
| "cardinality" : "SINGLE", |
| "description" : "...", |
| "isContainer" : true, |
| "isLegacyAttribute" : true, |
| "name" : "...", |
| "type" : "..." |
| }, |
| "propagateTags" : "TWO_TO_ONE", |
| "relationshipCategory" : "COMPOSITION", |
| "relationshipLabel" : "...", |
| "attributeDefs" : [ { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "LIST", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "OBJECT_ID_TYPE", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| }, { |
| "endDef1" : { |
| "cardinality" : "SET", |
| "description" : "...", |
| "isContainer" : true, |
| "isLegacyAttribute" : true, |
| "name" : "...", |
| "type" : "..." |
| }, |
| "endDef2" : { |
| "cardinality" : "SINGLE", |
| "description" : "...", |
| "isContainer" : true, |
| "isLegacyAttribute" : true, |
| "name" : "...", |
| "type" : "..." |
| }, |
| "propagateTags" : "NONE", |
| "relationshipCategory" : "AGGREGATION", |
| "relationshipLabel" : "...", |
| "attributeDefs" : [ { |
| "cardinality" : "LIST", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "MAP", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| } ], |
| "structDefs" : [ { |
| "attributeDefs" : [ { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "ENUM", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| }, { |
| "attributeDefs" : [ { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "OBJECT_ID_TYPE", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| } ] |
| } |
| }, |
| "description" : "On validation failure for any type definitions" |
| } |
| } |
| }, |
| "put" : { |
| "tags" : [ "TypesREST" ], |
| "description" : "Bulk update API for all types, changes detected in the type definitions would be persisted", |
| "operationId" : "updateAtlasTypeDefs", |
| "consumes" : [ "application/json" ], |
| "produces" : [ "application/json" ], |
| "parameters" : [ |
| { |
| "name" : "body", |
| "required" : false, |
| "in" : "body", |
| "schema" : { |
| "$ref" : "#/definitions/AtlasTypesDef", |
| "description" : "A composite object that captures all type definition changes" |
| }, |
| "description" : "A composite object that captures all type definition changes" |
| } |
| ], |
| "responses" : { |
| "200" : { |
| "schema" : { |
| "$ref" : "#/definitions/AtlasTypesDef", |
| "description" : "On successful update of requested type definitions" |
| }, |
| "examples" : { |
| "application/json" : { |
| "businessMetadataDefs" : [ { |
| "attributeDefs" : [ { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "LIST", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "ENTITY", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| }, { |
| "attributeDefs" : [ { |
| "cardinality" : "LIST", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "RELATIONSHIP", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| } ], |
| "classificationDefs" : [ { |
| "entityTypes" : [ "...", "..." ], |
| "subTypes" : [ "...", "..." ], |
| "superTypes" : [ "...", "..." ], |
| "attributeDefs" : [ { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "BUSINESS_METADATA", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| }, { |
| "entityTypes" : [ "...", "..." ], |
| "subTypes" : [ "...", "..." ], |
| "superTypes" : [ "...", "..." ], |
| "attributeDefs" : [ { |
| "cardinality" : "LIST", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "ENUM", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| } ], |
| "entityDefs" : [ { |
| "businessAttributeDefs" : { |
| "property1" : [ { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "property2" : [ { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ] |
| }, |
| "relationshipAttributeDefs" : [ { |
| "isLegacyAttribute" : true, |
| "relationshipTypeName" : "...", |
| "cardinality" : "SINGLE", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "isLegacyAttribute" : true, |
| "relationshipTypeName" : "...", |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "subTypes" : [ "...", "..." ], |
| "superTypes" : [ "...", "..." ], |
| "attributeDefs" : [ { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "PRIMITIVE", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| }, { |
| "businessAttributeDefs" : { |
| "property1" : [ { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "property2" : [ { |
| "cardinality" : "LIST", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "LIST", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ] |
| }, |
| "relationshipAttributeDefs" : [ { |
| "isLegacyAttribute" : true, |
| "relationshipTypeName" : "...", |
| "cardinality" : "SINGLE", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "isLegacyAttribute" : true, |
| "relationshipTypeName" : "...", |
| "cardinality" : "SINGLE", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "subTypes" : [ "...", "..." ], |
| "superTypes" : [ "...", "..." ], |
| "attributeDefs" : [ { |
| "cardinality" : "LIST", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "LIST", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "ARRAY", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| } ], |
| "enumDefs" : [ { |
| "defaultValue" : "...", |
| "elementDefs" : [ { |
| "description" : "...", |
| "ordinal" : 12345, |
| "value" : "..." |
| }, { |
| "description" : "...", |
| "ordinal" : 12345, |
| "value" : "..." |
| } ], |
| "category" : "RELATIONSHIP", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| }, { |
| "defaultValue" : "...", |
| "elementDefs" : [ { |
| "description" : "...", |
| "ordinal" : 12345, |
| "value" : "..." |
| }, { |
| "description" : "...", |
| "ordinal" : 12345, |
| "value" : "..." |
| } ], |
| "category" : "PRIMITIVE", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| } ], |
| "relationshipDefs" : [ { |
| "endDef1" : { |
| "cardinality" : "LIST", |
| "description" : "...", |
| "isContainer" : true, |
| "isLegacyAttribute" : true, |
| "name" : "...", |
| "type" : "..." |
| }, |
| "endDef2" : { |
| "cardinality" : "LIST", |
| "description" : "...", |
| "isContainer" : true, |
| "isLegacyAttribute" : true, |
| "name" : "...", |
| "type" : "..." |
| }, |
| "propagateTags" : "ONE_TO_TWO", |
| "relationshipCategory" : "ASSOCIATION", |
| "relationshipLabel" : "...", |
| "attributeDefs" : [ { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "LIST", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "ARRAY", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| }, { |
| "endDef1" : { |
| "cardinality" : "SET", |
| "description" : "...", |
| "isContainer" : true, |
| "isLegacyAttribute" : true, |
| "name" : "...", |
| "type" : "..." |
| }, |
| "endDef2" : { |
| "cardinality" : "SINGLE", |
| "description" : "...", |
| "isContainer" : true, |
| "isLegacyAttribute" : true, |
| "name" : "...", |
| "type" : "..." |
| }, |
| "propagateTags" : "BOTH", |
| "relationshipCategory" : "COMPOSITION", |
| "relationshipLabel" : "...", |
| "attributeDefs" : [ { |
| "cardinality" : "LIST", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "STRUCT", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| } ], |
| "structDefs" : [ { |
| "attributeDefs" : [ { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "BUSINESS_METADATA", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| }, { |
| "attributeDefs" : [ { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "ENTITY", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| } ] |
| } |
| }, |
| "description" : "On successful update of requested type definitions" |
| }, |
| "400" : { |
| "examples" : { |
| "application/json" : { |
| "businessMetadataDefs" : [ { |
| "attributeDefs" : [ { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "LIST", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "CLASSIFICATION", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| }, { |
| "attributeDefs" : [ { |
| "cardinality" : "LIST", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "STRUCT", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| } ], |
| "classificationDefs" : [ { |
| "entityTypes" : [ "...", "..." ], |
| "subTypes" : [ "...", "..." ], |
| "superTypes" : [ "...", "..." ], |
| "attributeDefs" : [ { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "LIST", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "RELATIONSHIP", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| }, { |
| "entityTypes" : [ "...", "..." ], |
| "subTypes" : [ "...", "..." ], |
| "superTypes" : [ "...", "..." ], |
| "attributeDefs" : [ { |
| "cardinality" : "LIST", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "ENUM", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| } ], |
| "entityDefs" : [ { |
| "businessAttributeDefs" : { |
| "property1" : [ { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "LIST", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "property2" : [ { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ] |
| }, |
| "relationshipAttributeDefs" : [ { |
| "isLegacyAttribute" : true, |
| "relationshipTypeName" : "...", |
| "cardinality" : "SINGLE", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "isLegacyAttribute" : true, |
| "relationshipTypeName" : "...", |
| "cardinality" : "LIST", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "subTypes" : [ "...", "..." ], |
| "superTypes" : [ "...", "..." ], |
| "attributeDefs" : [ { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "MAP", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| }, { |
| "businessAttributeDefs" : { |
| "property1" : [ { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "property2" : [ { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "LIST", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ] |
| }, |
| "relationshipAttributeDefs" : [ { |
| "isLegacyAttribute" : true, |
| "relationshipTypeName" : "...", |
| "cardinality" : "LIST", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "isLegacyAttribute" : true, |
| "relationshipTypeName" : "...", |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "subTypes" : [ "...", "..." ], |
| "superTypes" : [ "...", "..." ], |
| "attributeDefs" : [ { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "ARRAY", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| } ], |
| "enumDefs" : [ { |
| "defaultValue" : "...", |
| "elementDefs" : [ { |
| "description" : "...", |
| "ordinal" : 12345, |
| "value" : "..." |
| }, { |
| "description" : "...", |
| "ordinal" : 12345, |
| "value" : "..." |
| } ], |
| "category" : "MAP", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| }, { |
| "defaultValue" : "...", |
| "elementDefs" : [ { |
| "description" : "...", |
| "ordinal" : 12345, |
| "value" : "..." |
| }, { |
| "description" : "...", |
| "ordinal" : 12345, |
| "value" : "..." |
| } ], |
| "category" : "ARRAY", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| } ], |
| "relationshipDefs" : [ { |
| "endDef1" : { |
| "cardinality" : "LIST", |
| "description" : "...", |
| "isContainer" : true, |
| "isLegacyAttribute" : true, |
| "name" : "...", |
| "type" : "..." |
| }, |
| "endDef2" : { |
| "cardinality" : "LIST", |
| "description" : "...", |
| "isContainer" : true, |
| "isLegacyAttribute" : true, |
| "name" : "...", |
| "type" : "..." |
| }, |
| "propagateTags" : "TWO_TO_ONE", |
| "relationshipCategory" : "AGGREGATION", |
| "relationshipLabel" : "...", |
| "attributeDefs" : [ { |
| "cardinality" : "LIST", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "PRIMITIVE", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| }, { |
| "endDef1" : { |
| "cardinality" : "SINGLE", |
| "description" : "...", |
| "isContainer" : true, |
| "isLegacyAttribute" : true, |
| "name" : "...", |
| "type" : "..." |
| }, |
| "endDef2" : { |
| "cardinality" : "SINGLE", |
| "description" : "...", |
| "isContainer" : true, |
| "isLegacyAttribute" : true, |
| "name" : "...", |
| "type" : "..." |
| }, |
| "propagateTags" : "ONE_TO_TWO", |
| "relationshipCategory" : "COMPOSITION", |
| "relationshipLabel" : "...", |
| "attributeDefs" : [ { |
| "cardinality" : "LIST", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "LIST", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "OBJECT_ID_TYPE", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| } ], |
| "structDefs" : [ { |
| "attributeDefs" : [ { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "SINGLE", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "ARRAY", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| }, { |
| "attributeDefs" : [ { |
| "cardinality" : "SET", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "STRING", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| }, { |
| "cardinality" : "LIST", |
| "constraints" : [ { }, { } ], |
| "defaultValue" : "...", |
| "description" : "...", |
| "displayName" : "...", |
| "includeInNotification" : true, |
| "indexType" : "DEFAULT", |
| "isIndexable" : true, |
| "isOptional" : true, |
| "isUnique" : true, |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "searchWeight" : 12345, |
| "typeName" : "...", |
| "valuesMaxCount" : 12345, |
| "valuesMinCount" : 12345 |
| } ], |
| "category" : "CLASSIFICATION", |
| "createTime" : 12345, |
| "createdBy" : "...", |
| "dateFormatter" : { |
| "availableLocales" : [ "...", "..." ], |
| "calendar" : 12345, |
| "dateInstance" : { }, |
| "dateTimeInstance" : { }, |
| "instance" : { }, |
| "lenient" : true, |
| "numberFormat" : { }, |
| "timeInstance" : { }, |
| "timeZone" : { } |
| }, |
| "description" : "...", |
| "guid" : "...", |
| "name" : "...", |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceType" : "...", |
| "typeVersion" : "...", |
| "updateTime" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345 |
| } ] |
| } |
| }, |
| "description" : "On validation failure for any type definitions" |
| } |
| } |
| } |
| }, |
| "\/v2/types/typedefs/headers" : { |
| "get" : { |
| "tags" : [ "TypesREST" ], |
| "description" : "Bulk retrieval API for all type definitions returned as a list of minimal information header", |
| "operationId" : "getTypeDefHeaders", |
| "produces" : [ "application/json" ], |
| "parameters" : [ |
| ], |
| "responses" : { |
| "200" : { |
| "schema" : { |
| "description" : "Returns a list of AtlasTypeDefHeader matching the search criteria\nor an empty list if no match.", |
| "type" : "array", |
| "items" : { |
| "$ref" : "#/definitions/AtlasTypeDefHeader" |
| } |
| }, |
| "examples" : { |
| "application/json" : [ { |
| "category" : "BUSINESS_METADATA", |
| "guid" : "...", |
| "name" : "...", |
| "serviceType" : "..." |
| } ] |
| }, |
| "description" : "Returns a list of AtlasTypeDefHeader matching the search criteria\nor an empty list if no match." |
| } |
| } |
| } |
| } |
| } |
| } |
