\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
\nRelationshipDefs have 2 ends, each of which specify cardinality, an EntityDef type name and name and optionally\nwhether the end is a container.\n
\nRelationshipDefs can have AttributeDefs - though only primitive types are allowed.
\nRelationshipDefs have a relationshipCategory specifying the UML type of relationship required
\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
\nRelationshipDefs introduce new attributes to the entity instances. For example\n
\nEntityDef A might have attributes attr1,attr2,attr3
\nEntityDef B might have attributes attr4,attr5,attr6
\nRelationshipDef AtoB might define 2 ends
\n\n
\n end1: type A, name attr7\n end2: type B, name attr8\n\n
\nWhen an instance of EntityDef A is created, it will have attributes attr1,attr2,attr3,attr7
\nWhen an instance of EntityDef B is created, it will have attributes attr4,attr5,attr6,attr8\n
\nIn this way relationshipDefs can be authored separately from entityDefs and can inject relationship attributes into\nthe entity instances"
+ }
},
- "AtlasRelationshipEndDef": {
+ "AtlasGlossaryExtInfo": {
"type": "object",
+ "description": "The extended information of glossary.",
"properties": {
- "cardinality": {
- "$ref": "#/definitions/Cardinality"
- },
- "description": {
+ "guid": {
"type": "string",
- "description": "The description of the relationship end definition."
+ "description": "The GUID of the object."
},
- "isContainer": {
- "type": "boolean",
- "description": "Determines if it is container."
+ "classifications": {
+ "type": "array",
+ "description": "An array of classifications.",
+ "items": {
+ "$ref": "#/definitions/AtlasClassification"
+ },
+ "x-ms-identifiers": []
},
- "isLegacyAttribute": {
- "type": "boolean",
- "description": "Determines if it is a legacy attribute."
+ "longDescription": {
+ "type": "string",
+ "description": "The long version description."
},
"name": {
"type": "string",
- "description": "The name of the relationship end definition."
+ "description": "The name of the glossary object."
},
- "type": {
+ "qualifiedName": {
"type": "string",
- "description": "The type of the relationship end."
- }
- },
- "title": "AtlasRelationshipEndDef",
- "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."
- },
- "AtlasRelationshipAttributeDef": {
- "type": "object",
- "properties": {
- "isLegacyAttribute": {
- "type": "boolean",
- "description": "Determines if it is a legacy attribute."
+ "description": "The qualified name of the glossary object."
},
- "relationshipTypeName": {
+ "shortDescription": {
"type": "string",
- "description": "The name of the relationship type."
- }
- },
- "allOf": [
- {
- "$ref": "#/definitions/AtlasAttributeDef"
- }
- ],
- "title": "AtlasRelationshipEndDef",
- "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."
- },
- "AtlasRelationshipWithExtInfo": {
- "type": "object",
- "properties": {
- "referredEntities": {
- "type": "object",
- "description": "The referred entity header.",
- "additionalProperties": {
- "$ref": "#/definitions/AtlasEntityHeader"
- }
- },
- "relationship": {
- "$ref": "#/definitions/AtlasRelationship"
- }
- },
- "title": "AtlasRelationshipWithExtInfo",
- "description": "The relationship with extended information."
- },
- "AtlasStruct": {
- "type": "object",
- "properties": {
- "attributes": {
- "type": "object",
- "description": "The attributes of the struct.",
- "additionalProperties": {}
+ "description": "The short version of description."
},
- "typeName": {
+ "lastModifiedTS": {
"type": "string",
- "description": "The name of the type."
+ "description": "ETag for concurrency control."
},
- "lastModifiedTS": {
- "$ref": "#/definitions/LastModifiedTS"
- }
- },
- "title": "AtlasStruct",
- "description": "Captures details of struct contents. Not instantiated directly, used only via AtlasEntity, AtlasClassification."
- },
- "AtlasStructDef": {
- "type": "object",
- "title": "AtlasStructDef",
- "properties": {
- "attributeDefs": {
- "type": "array",
- "description": "An array of attribute definitions.",
- "items": {
- "$ref": "#/definitions/AtlasAttributeDef"
- }
- }
- },
- "allOf": [
- {
- "$ref": "#/definitions/AtlasBaseTypeDef"
- }
- ],
- "description": "class that captures details of a struct-type."
- },
- "AtlasTermAssignmentHeader": {
- "type": "object",
- "properties": {
- "confidence": {
+ "createTime": {
"type": "integer",
- "format": "int32",
- "description": "The confidence of the term assignment."
+ "format": "int64",
+ "description": "The created time of the record."
},
"createdBy": {
"type": "string",
"description": "The user who created the record."
},
- "description": {
- "type": "string",
- "description": "The description of the term assignment."
+ "updateTime": {
+ "type": "integer",
+ "format": "int64",
+ "description": "The update time of the record."
},
- "displayText": {
+ "updatedBy": {
"type": "string",
- "description": "The display text."
+ "description": "The user who updated the record."
},
- "expression": {
- "type": "string",
- "description": "The expression of the term assignment."
+ "categories": {
+ "type": "array",
+ "description": "An array of categories.",
+ "items": {
+ "$ref": "#/definitions/AtlasRelatedCategoryHeader"
+ },
+ "x-ms-identifiers": []
},
- "relationGuid": {
+ "language": {
"type": "string",
- "description": "The GUID of the relationship."
+ "description": "The language of the glossary."
},
- "status": {
- "$ref": "#/definitions/AtlasTermAssignmentStatus"
+ "terms": {
+ "type": "array",
+ "description": "An array of related term headers.",
+ "items": {
+ "$ref": "#/definitions/AtlasRelatedTermHeader"
+ },
+ "x-ms-identifiers": []
},
- "steward": {
+ "usage": {
"type": "string",
- "description": "The steward of the term."
+ "description": "The usage of the glossary."
},
- "termGuid": {
- "type": "string",
- "description": "The GUID of the term."
+ "categoryInfo": {
+ "type": "object",
+ "description": "The glossary category information.",
+ "additionalProperties": {
+ "$ref": "#/definitions/AtlasGlossaryCategory"
+ }
+ },
+ "termInfo": {
+ "type": "object",
+ "description": "The glossary term information.",
+ "additionalProperties": {
+ "$ref": "#/definitions/AtlasGlossaryTerm"
+ }
}
- },
- "title": "AtlasTermAssignmentHeader",
- "description": "The header for term assignment."
+ }
},
- "AtlasTermAssignmentStatus": {
- "type": "string",
- "title": "AtlasTermAssignmentStatus",
- "description": "The status of terms assignment.",
- "enum": [
- "DISCOVERED",
- "PROPOSED",
- "IMPORTED",
- "VALIDATED",
- "DEPRECATED",
- "OBSOLETE",
- "OTHER"
- ],
- "x-ms-enum": {
- "name": "AtlasTermAssignmentStatus",
- "modelAsString": true
- }
- },
- "AtlasTermCategorizationHeader": {
+ "AtlasGlossaryHeader": {
"type": "object",
+ "description": "The glossary header with basic information.",
"properties": {
- "categoryGuid": {
- "type": "string",
- "description": "The GUID of the category."
- },
- "description": {
- "type": "string",
- "description": "The description of the record."
- },
"displayText": {
"type": "string",
"description": "The display text."
},
+ "glossaryGuid": {
+ "type": "string",
+ "description": "The GUID of the glossary."
+ },
"relationGuid": {
"type": "string",
"description": "The GUID of the relationship."
- },
- "status": {
- "$ref": "#/definitions/AtlasTermRelationshipStatus"
}
- },
- "title": "AtlasTermCategorizationHeader",
- "description": "The basic information for term categorization."
- },
- "AtlasTermRelationshipStatus": {
- "type": "string",
- "title": "AtlasTermRelationshipStatus",
- "description": "The status of term relationship.",
- "enum": [
- "DRAFT",
- "ACTIVE",
- "DEPRECATED",
- "OBSOLETE",
- "OTHER"
- ],
- "x-ms-enum": {
- "name": "AtlasTermRelationshipStatus",
- "modelAsString": true
}
},
- "AtlasTypeDefHeader": {
+ "AtlasGlossaryTerm": {
"type": "object",
+ "description": "The glossary term.",
"properties": {
- "category": {
- "$ref": "#/definitions/TypeCategory"
- },
"guid": {
"type": "string",
- "description": "The GUID of the type definition."
+ "description": "The GUID of the object."
+ },
+ "classifications": {
+ "type": "array",
+ "description": "An array of classifications.",
+ "items": {
+ "$ref": "#/definitions/AtlasClassification"
+ },
+ "x-ms-identifiers": []
+ },
+ "longDescription": {
+ "type": "string",
+ "description": "The long version description."
},
"name": {
"type": "string",
- "description": "The name of the type definition."
- }
- },
- "title": "AtlasTypeDefHeader",
- "description": "The basic information of the type definition."
- },
- "AtlasTypesDef": {
- "type": "object",
- "properties": {
- "businessMetadataDefs": {
- "readOnly": false,
- "description": "businessMetadataDefs",
+ "description": "The name of the glossary object."
+ },
+ "qualifiedName": {
+ "type": "string",
+ "description": "The qualified name of the glossary object."
+ },
+ "shortDescription": {
+ "type": "string",
+ "description": "The short version of description."
+ },
+ "lastModifiedTS": {
+ "type": "string",
+ "description": "ETag for concurrency control."
+ },
+ "createTime": {
+ "type": "integer",
+ "format": "int64",
+ "description": "The created time of the record."
+ },
+ "createdBy": {
+ "type": "string",
+ "description": "The user who created the record."
+ },
+ "updateTime": {
+ "type": "integer",
+ "format": "int64",
+ "description": "The update time of the record."
+ },
+ "updatedBy": {
+ "type": "string",
+ "description": "The user who updated the record."
+ },
+ "abbreviation": {
+ "type": "string",
+ "description": "The abbreviation of the term."
+ },
+ "templateName": {
"type": "array",
- "items": {
- "$ref": "#/definitions/AtlasBusinessMetadataDef"
- }
+ "description": "The name of the template.",
+ "items": {}
},
- "classificationDefs": {
+ "anchor": {
+ "$ref": "#/definitions/AtlasGlossaryHeader",
+ "description": "The glossary header with basic information."
+ },
+ "antonyms": {
"type": "array",
- "description": "An array of classification definitions.",
+ "description": "An array of related term headers as antonyms.",
"items": {
- "$ref": "#/definitions/AtlasClassificationDef"
- }
+ "$ref": "#/definitions/AtlasRelatedTermHeader"
+ },
+ "x-ms-identifiers": []
},
- "entityDefs": {
+ "status": {
+ "$ref": "#/definitions/TermStatus",
+ "description": "Status of the AtlasGlossaryTerm"
+ },
+ "nickName": {
+ "type": "string",
+ "description": "The nick name of the term."
+ },
+ "hierarchyInfo": {
"type": "array",
- "description": "An array of entity definitions.",
+ "description": "The hierarchy information of the term.",
"items": {
- "$ref": "#/definitions/AtlasEntityDef"
- }
+ "$ref": "#/definitions/PurviewObjectId"
+ },
+ "x-ms-identifiers": []
},
- "enumDefs": {
+ "resources": {
"type": "array",
- "description": "An array of enum definitions.",
+ "description": "An array of resource link for term",
"items": {
- "$ref": "#/definitions/AtlasEnumDef"
+ "$ref": "#/definitions/ResourceLink"
+ },
+ "x-ms-identifiers": []
+ },
+ "contacts": {
+ "type": "object",
+ "description": "The dictionary of contacts for terms. Key could be Expert or Steward.",
+ "additionalProperties": {
+ "items": {
+ "$ref": "#/definitions/ContactInfo"
+ },
+ "type": "array"
}
},
- "relationshipDefs": {
- "type": "array",
- "description": "An array of relationship definitions.",
- "items": {
- "$ref": "#/definitions/AtlasRelationshipDef"
+ "attributes": {
+ "type": "object",
+ "description": "The custom attributes of the term, which is map \nASSOCIATION is a relationship with no containment. \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 independent.",
- "enum": [
- "ASSOCIATION",
- "AGGREGATION",
- "COMPOSITION"
- ],
- "x-ms-enum": {
- "name": "RelationshipCategory",
- "modelAsString": true
- }
- },
- "RoundingMode": {
- "type": "string",
- "title": "RoundingMode",
- "description": "The enum of rounding mode.",
- "enum": [
- "UP",
- "DOWN",
- "CEILING",
- "FLOOR",
- "HALF_UP",
- "HALF_DOWN",
- "HALF_EVEN",
- "UNNECESSARY"
- ],
- "x-ms-enum": {
- "name": "RoundingMode",
- "modelAsString": true
- }
- },
- "SortType": {
- "type": "string",
- "title": "SortType",
- "description": "to specify whether the result should be sorted? If yes, whether asc or desc.",
- "enum": [
- "NONE",
- "ASC",
- "DESC"
- ],
- "x-ms-enum": {
- "name": "SortType",
- "modelAsString": true
- }
- },
- "Status": {
- "type": "string",
- "title": "Status",
- "description": "Status of the entity - can be active or deleted. Deleted entities are not removed.",
- "enum": [
- "ACTIVE",
- "DELETED"
- ],
- "x-ms-enum": {
- "name": "Status",
- "modelAsString": true
- }
- },
- "Status_AtlasRelationship": {
- "type": "string",
- "title": "Status",
- "description": "The enum of relationship status.",
- "enum": [
- "ACTIVE",
- "DELETED"
- ],
- "x-ms-enum": {
- "name": "Status_AtlasRelationship",
- "modelAsString": true
}
},
- "TimeBoundary": {
+ "AtlasRelatedTermHeader": {
"type": "object",
+ "description": "The header of the related term.",
"properties": {
- "endTime": {
+ "description": {
"type": "string",
- "description": "The end of the time boundary."
+ "description": "The description of the related term."
},
- "startTime": {
+ "displayText": {
"type": "string",
- "description": "The start of the time boundary."
+ "description": "The display text."
},
- "timeZone": {
+ "expression": {
"type": "string",
- "description": "The timezone of the time boundary."
- }
- },
- "title": "TimeBoundary",
- "description": "Captures time-boundary details"
- },
- "TimeZone": {
- "type": "object",
- "properties": {
- "dstSavings": {
- "type": "integer",
- "format": "int32",
- "description": "The value of the daylight saving time."
+ "description": "The expression of the term."
},
- "id": {
+ "relationGuid": {
"type": "string",
- "description": "The ID of the timezone."
- },
- "availableIds": {
- "type": "array",
- "description": "An array of available IDs.",
- "items": {
- "type": "string"
- }
+ "description": "The GUID of the relationship."
},
- "default": {
- "$ref": "#/definitions/TimeZone"
+ "status": {
+ "$ref": "#/definitions/AtlasTermRelationshipStatus",
+ "description": "The status of term relationship."
},
- "displayName": {
+ "steward": {
"type": "string",
- "description": "The display name of the timezone."
+ "description": "The steward of the term."
},
- "rawOffset": {
- "type": "integer",
- "format": "int32",
- "description": "The raw offset of the timezone."
+ "termGuid": {
+ "type": "string",
+ "description": "The GUID of the term."
}
- },
- "title": "TimeZone",
- "description": "The timezone information."
- },
- "TypeCategory": {
- "type": "string",
- "title": "TypeCategory",
- "description": "The enum of type category.",
- "enum": [
- "PRIMITIVE",
- "OBJECT_ID_TYPE",
- "ENUM",
- "STRUCT",
- "CLASSIFICATION",
- "ENTITY",
- "ARRAY",
- "MAP",
- "RELATIONSHIP",
- "TERM_TEMPLATE"
- ],
- "x-ms-enum": {
- "name": "TypeCategory",
- "modelAsString": true
}
},
- "SuggestResult": {
- "type": "object",
- "properties": {
- "value": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/SuggestResultValue"
- }
- }
- },
- "title": "SuggestResult",
- "description": "The result item of the search suggest."
- },
- "SuggestResultValue": {
+ "AtlasRelationship": {
"type": "object",
+ "description": "Atlas relationship instance.",
"properties": {
- "@search.score": {
- "type": "number",
- "format": "float",
- "description": "The search score calculated by the search engine. The results are ordered by search score by default."
+ "attributes": {
+ "type": "object",
+ "description": "The attributes of the struct.",
+ "additionalProperties": {}
},
- "@search.text": {
+ "typeName": {
"type": "string",
- "description": "The target text that contains the keyword as prefix. The keyword is wrapped with emphasis mark."
+ "description": "The name of the type."
},
- "objectType": {
+ "lastModifiedTS": {
"type": "string",
- "description": "The object type of the record. Object type is the top-level property to distinguish whether a record is an asset or a term."
+ "description": "ETag for concurrency control."
},
"createTime": {
"type": "integer",
"format": "int64",
- "description": "The create time of the record. The Unix epoch format."
- },
- "updateTime": {
- "type": "integer",
- "format": "int64",
- "description": "The last update time of the record. The Unix epoch format."
+ "description": "The created time of the record."
},
- "id": {
+ "createdBy": {
"type": "string",
- "description": "The GUID of the record."
+ "description": "The user who created the record."
},
- "name": {
- "type": "string",
- "description": "The name of the record."
+ "end1": {
+ "$ref": "#/definitions/AtlasObjectId",
+ "description": "Reference to an object-instance of a type - like entity."
},
- "qualifiedName": {
- "type": "string",
- "description": "The qualified name of the record."
+ "end2": {
+ "$ref": "#/definitions/AtlasObjectId",
+ "description": "Reference to an object-instance of a type - like entity."
},
- "entityType": {
+ "guid": {
"type": "string",
- "description": "The type name of the asset."
+ "description": "The GUID of the relationship."
},
- "description": {
+ "homeId": {
"type": "string",
- "description": "The description of the asset."
+ "description": "The home ID of the relationship."
},
- "endorsement": {
+ "label": {
"type": "string",
- "description": "The endorsement of the asset."
+ "description": "The label of the relationship."
},
- "owner": {
- "type": "string",
- "description": "The owner of the record."
+ "provenanceType": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Used to record the provenance of an instance of an entity or relationship"
},
- "classification": {
- "type": "array",
- "description": "The classifications of the record.",
- "items": {
- "type": "string"
- }
+ "status": {
+ "$ref": "#/definitions/StatusAtlasRelationship",
+ "description": "The enum of relationship status."
},
- "label": {
- "type": "array",
- "description": "The labels of the asset.",
- "items": {
- "type": "string"
- }
- },
- "term": {
- "type": "array",
- "description": "The terms assigned to the asset.",
- "items": {
- "$ref": "#/definitions/TermSearchResultValue"
- }
- },
- "contact": {
- "type": "array",
- "description": "The contacts of the asset.",
- "items": {
- "$ref": "#/definitions/ContactSearchResultValue"
- }
- },
- "assetType": {
- "type": "array",
- "description": "The asset types of the asset.",
- "items": {
- "type": "string"
- }
- },
- "glossaryType": {
- "type": "string",
- "description": "The type name of the term. Could be AtlasGlossary, AtlasGlossaryTerm or AtlasGlossaryCategory."
- },
- "glossary": {
- "type": "string",
- "description": "The glossary name of the term."
- },
- "termStatus": {
- "type": "string",
- "description": "The status of the term."
- },
- "termTemplate": {
- "type": "array",
- "description": "The term template names used by the term.",
- "items": {
- "type": "string"
- }
- },
- "longDescription": {
- "type": "string",
- "description": "The definition of the term."
- }
- },
- "title": "SuggestResultValue",
- "description": "The value item of the search suggest."
- },
- "SearchResult": {
- "type": "object",
- "properties": {
- "@search.count": {
+ "updateTime": {
"type": "integer",
- "format": "int32",
- "description": "The total number of search results (not the number of documents in a single page)."
- },
- "@search.count.approximate": {
- "type": "boolean",
- "description": "'True' if the '@search.count' is an approximate value and vise versa."
+ "format": "int64",
+ "description": "The update time of the record."
},
- "continuationToken": {
+ "updatedBy": {
"type": "string",
- "description": "The token used to get next batch of data. Absent if there's no more data."
- },
- "@search.facets": {
- "$ref": "#/definitions/SearchFacetResultValue"
+ "description": "The user who updated the record."
},
- "value": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/SearchResultValue"
- }
+ "version": {
+ "type": "integer",
+ "format": "int64",
+ "description": "The version of the relationship."
}
- },
- "title": "SearchResult",
- "description": "The result of the search result."
+ }
},
- "SearchFacetResultValue": {
+ "AtlasRelationshipAttributeDef": {
"type": "object",
+ "description": "The relationshipEndDef represents an end of the relationship. The end of the\nrelationship is defined by a type, an\nattribute name, cardinality and whether\nit is the container end of the relationship.",
"properties": {
- "entityType": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/SearchFacetItemValue"
- }
+ "cardinality": {
+ "$ref": "#/definitions/CardinalityValue",
+ "description": "single-valued attribute or multi-valued attribute."
},
- "assetType": {
+ "constraints": {
"type": "array",
+ "description": "An array of constraints.",
"items": {
- "$ref": "#/definitions/SearchFacetItemValue"
- }
+ "$ref": "#/definitions/AtlasConstraintDef"
+ },
+ "x-ms-identifiers": []
},
- "classification": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/SearchFacetItemValue"
- }
+ "defaultValue": {
+ "type": "string",
+ "description": "The default value of the attribute."
},
- "term": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/SearchFacetItemValue"
- }
+ "description": {
+ "type": "string",
+ "description": "The description of the attribute."
},
- "contactId": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/SearchFacetItemValue"
- }
+ "includeInNotification": {
+ "type": "boolean",
+ "description": "Determines if it is included in notification."
},
- "contactType": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/SearchFacetItemValue"
- }
+ "isIndexable": {
+ "type": "boolean",
+ "description": "Determines if it is indexable."
},
- "label": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/SearchFacetItemValue"
- }
+ "isOptional": {
+ "type": "boolean",
+ "description": "Determines if it is optional."
},
- "glossaryType": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/SearchFacetItemValue"
- }
+ "isUnique": {
+ "type": "boolean",
+ "description": "Determines if it unique."
},
- "termStatus": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/SearchFacetItemValue"
- }
+ "name": {
+ "type": "string",
+ "description": "The name of the attribute."
},
- "termTemplate": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/SearchFacetItemValue"
+ "options": {
+ "type": "object",
+ "description": "The options for the attribute.",
+ "additionalProperties": {
+ "type": "string"
}
- }
- },
- "title": "Context",
- "description": "A facet list that consists of index fields assetType ,classification, contactId, and label. When the facet is specified in the request, the value of the facet is returned as an element of @search.facets."
- },
- "SearchFacetItemValue": {
- "type": "object",
- "properties": {
- "count": {
+ },
+ "typeName": {
+ "type": "string",
+ "description": "The name of the type."
+ },
+ "valuesMaxCount": {
"type": "integer",
"format": "int32",
- "description": "The count of the facet item."
+ "description": "The maximum count of the values."
},
- "value": {
- "type": "string",
- "description": "The name of the facet item."
- }
- },
- "title": "SearchFacetItemValue",
- "description": "The content of a search facet result item."
- },
- "SearchFacetItem": {
- "type": "object",
- "properties": {
- "count": {
+ "valuesMinCount": {
"type": "integer",
"format": "int32",
- "description": "The count of the facet item."
+ "description": "The minimum count of the values."
},
- "facet": {
- "type": "string",
- "description": "The name of the facet item."
+ "isLegacyAttribute": {
+ "type": "boolean",
+ "description": "Determines if it is a legacy attribute."
},
- "sort": {
- "type": "object"
+ "relationshipTypeName": {
+ "type": "string",
+ "description": "The name of the relationship type."
}
- },
- "title": "SearchFacetItemValue",
- "description": "The content of a search facet result item."
- },
- "SearchOrderItem": {
- "type": "object",
- "description": "See examples for the usage of search order."
+ }
},
- "SearchResultValue": {
+ "AtlasRelationshipDef": {
"type": "object",
+ "description": "AtlasRelationshipDef is a TypeDef that defines a relationship.\nAs with other typeDefs the AtlasRelationshipDef has a name. Once created the\nRelationshipDef has a guid.\nThe name and the guid are the 2 ways that the\nRelationshipDef is identified.\nRelationshipDefs have 2 ends, each of which\nspecify cardinality, an EntityDef type name and name and optionally\nwhether the\nend is a container.\nRelationshipDefs can have AttributeDefs - though only\nprimitive types are allowed. \nRelationshipDefs have a relationshipCategory\nspecifying the UML type of relationship required \nThe way EntityDefs and\nRelationshipDefs are intended to be used is that EntityDefs will define\nAttributeDefs these AttributeDefs\nwill not specify an EntityDef type name as\ntheir types.\nRelationshipDefs introduce new attributes to the entity\ninstances. For example\nEntityDef A might have attributes attr1,attr2,attr3\n\nEntityDef B might have attributes attr4,attr5,attr6 \nRelationshipDef\nAtoB might define 2 ends \n\nend1: type A, name attr7\nend2: type B, name attr8 \n\nWhen an instance of EntityDef A is created, it\nwill have attributes attr1,attr2,attr3,attr7 \nWhen an instance of EntityDef\nB is created, it will have attributes attr4,attr5,attr6,attr8\n\nIn this way\nrelationshipDefs can be authored separately from entityDefs and can inject\nrelationship attributes into\nthe entity instances",
"properties": {
- "@search.score": {
- "type": "number",
- "format": "float",
- "description": "The search score calculated by the search engine. The results are ordered by search score by default."
- },
- "@search.highlights": {
- "$ref": "#/definitions/SearchHighlights"
- },
- "objectType": {
- "type": "string",
- "description": "The object type of the record. Object type is the top-level property to distinguish whether a record is an asset or a term."
+ "category": {
+ "$ref": "#/definitions/TypeCategory",
+ "description": "The enum of type category."
},
"createTime": {
"type": "integer",
"format": "int64",
- "description": "The create time of the record. The Unix epoch format."
- },
- "updateTime": {
- "type": "integer",
- "format": "int64",
- "description": "The last update time of the record. The Unix epoch format."
- },
- "id": {
- "type": "string",
- "description": "The GUID of the record."
- },
- "name": {
- "type": "string",
- "description": "The name of the record."
+ "description": "The created time of the record."
},
- "qualifiedName": {
+ "createdBy": {
"type": "string",
- "description": "The qualified name of the record."
+ "description": "The user who created the record."
},
- "entityType": {
- "type": "string",
- "description": "The type name of the asset."
+ "dateFormatter": {
+ "$ref": "#/definitions/DateFormat",
+ "description": "The date format."
},
"description": {
"type": "string",
- "description": "The description of the asset."
+ "description": "The description of the type definition."
},
- "endorsement": {
+ "guid": {
"type": "string",
- "description": "The endorsement of the asset."
+ "description": "The GUID of the type definition."
},
- "owner": {
+ "name": {
"type": "string",
- "description": "The owner of the record."
+ "description": "The name of the type definition."
},
- "classification": {
- "type": "array",
- "description": "The classifications of the record.",
- "items": {
+ "options": {
+ "type": "object",
+ "description": "The options for the type definition.",
+ "additionalProperties": {
"type": "string"
}
},
- "label": {
- "type": "array",
- "description": "The labels of the asset.",
- "items": {
- "type": "string"
- }
- },
- "term": {
- "type": "array",
- "description": "The terms assigned to the asset.",
- "items": {
- "$ref": "#/definitions/TermSearchResultValue"
- }
+ "serviceType": {
+ "type": "string",
+ "description": "The service type."
},
- "contact": {
- "type": "array",
- "description": "The contacts of the asset.",
- "items": {
- "$ref": "#/definitions/ContactSearchResultValue"
- }
+ "typeVersion": {
+ "type": "string",
+ "description": "The version of the type."
},
- "assetType": {
- "type": "array",
- "description": "The asset types of the asset.",
- "items": {
- "type": "string"
- }
+ "updateTime": {
+ "type": "integer",
+ "format": "int64",
+ "description": "The update time of the record."
},
- "glossaryType": {
+ "updatedBy": {
"type": "string",
- "description": "The type name of the term. Could be AtlasGlossary, AtlasGlossaryTerm or AtlasGlossaryCategory."
+ "description": "The user who updated the record."
},
- "glossary": {
- "type": "string",
- "description": "The glossary name of the term."
+ "version": {
+ "type": "integer",
+ "format": "int64",
+ "description": "The version of the record."
},
- "termStatus": {
+ "lastModifiedTS": {
"type": "string",
- "description": "The status of the term."
+ "description": "ETag for concurrency control."
},
- "termTemplate": {
+ "attributeDefs": {
"type": "array",
- "description": "The term template names used by the term.",
+ "description": "An array of attribute definitions.",
"items": {
- "type": "string"
- }
+ "$ref": "#/definitions/AtlasAttributeDef"
+ },
+ "x-ms-identifiers": []
},
- "longDescription": {
+ "endDef1": {
+ "$ref": "#/definitions/AtlasRelationshipEndDef",
+ "description": "The relationshipEndDef represents an end of the relationship. The end of the\nrelationship is defined by a type, an\nattribute name, cardinality and whether\nit is the container end of the relationship."
+ },
+ "endDef2": {
+ "$ref": "#/definitions/AtlasRelationshipEndDef",
+ "description": "The relationshipEndDef represents an end of the relationship. The end of the\nrelationship is defined by a type, an\nattribute name, cardinality and whether\nit is the container end of the relationship."
+ },
+ "relationshipCategory": {
+ "$ref": "#/definitions/RelationshipCategory",
+ "description": "The Relationship category determines the style of relationship around\ncontainment and lifecycle.\nUML terminology is used for the values.\nASSOCIATION is a relationship with no containment. \nCOMPOSITION and AGGREGATION are containment relationships.\nThe difference being in the lifecycles of the container and its children. \nIn the COMPOSITION case, the children cannot exist without the container.\nFor AGGREGATION, the life cycles of the container and children are totally independent."
+ },
+ "relationshipLabel": {
"type": "string",
- "description": "The definition of the term."
+ "description": "The label of the relationship."
}
- },
- "title": "SearchResultValue",
- "description": "The value item of the search result."
+ }
},
- "SearchHighlights": {
+ "AtlasRelationshipEndDef": {
"type": "object",
- "description": "A highlight list that consists of index fields id ,qualifiedName, name, description, entityType. When the keyword appears in those fields, the value of the field, attached with emphasis mark, is returned as an element of @search.highlights.",
+ "description": "The relationshipEndDef represents an end of the relationship. The end of the\nrelationship is defined by a type, an\nattribute name, cardinality and whether\nit is the container end of the relationship.",
"properties": {
- "id": {
- "type": "array",
- "items": {
- "type": "string"
- }
+ "cardinality": {
+ "$ref": "#/definitions/CardinalityValue",
+ "description": "single-valued attribute or multi-valued attribute."
},
- "qualifiedName": {
- "type": "array",
- "items": {
- "type": "string"
- }
+ "description": {
+ "type": "string",
+ "description": "The description of the relationship end definition."
+ },
+ "isContainer": {
+ "type": "boolean",
+ "description": "Determines if it is container."
+ },
+ "isLegacyAttribute": {
+ "type": "boolean",
+ "description": "Determines if it is a legacy attribute."
},
"name": {
- "type": "array",
- "items": {
- "type": "string"
- }
+ "type": "string",
+ "description": "The name of the relationship end definition."
},
- "description": {
- "type": "array",
- "items": {
- "type": "string"
+ "type": {
+ "type": "string",
+ "description": "The type of the relationship end."
+ }
+ }
+ },
+ "AtlasRelationshipWithExtInfo": {
+ "type": "object",
+ "description": "The relationship with extended information.",
+ "properties": {
+ "referredEntities": {
+ "type": "object",
+ "description": "The referred entity header.",
+ "additionalProperties": {
+ "$ref": "#/definitions/AtlasEntityHeader"
}
},
- "entityType": {
- "type": "array",
- "items": {
- "type": "string"
- }
+ "relationship": {
+ "$ref": "#/definitions/AtlasRelationship",
+ "description": "Atlas relationship instance."
}
- },
- "title": "SearchHighlights"
+ }
},
- "TermSearchResultValue": {
+ "AtlasStruct": {
"type": "object",
+ "description": "Captures details of struct contents. Not instantiated directly, used only via\nAtlasEntity, AtlasClassification.",
"properties": {
- "name": {
- "type": "string",
- "description": "The name of the term."
+ "attributes": {
+ "type": "object",
+ "description": "The attributes of the struct.",
+ "additionalProperties": {}
},
- "glossaryName": {
+ "typeName": {
"type": "string",
- "description": "The name of the glossary which contains the term."
+ "description": "The name of the type."
},
- "guid": {
+ "lastModifiedTS": {
"type": "string",
- "description": "The GUID of the term."
+ "description": "ETag for concurrency control."
}
- },
- "title": "Context",
- "description": "The context."
+ }
},
- "ContactSearchResultValue": {
+ "AtlasStructDef": {
"type": "object",
+ "description": "class that captures details of a struct-type.",
"properties": {
- "id": {
- "type": "string",
- "description": "The GUID of the contact."
+ "category": {
+ "$ref": "#/definitions/TypeCategory",
+ "description": "The enum of type category."
},
- "info": {
+ "createTime": {
+ "type": "integer",
+ "format": "int64",
+ "description": "The created time of the record."
+ },
+ "createdBy": {
"type": "string",
- "description": "The description of the contact."
+ "description": "The user who created the record."
},
- "contactType": {
+ "dateFormatter": {
+ "$ref": "#/definitions/DateFormat",
+ "description": "The date format."
+ },
+ "description": {
"type": "string",
- "description": "The type of the contact. It can be Expert or Owner for an entity. It can be Expert or Steward for a glossary term."
- }
- },
- "title": "contact",
- "description": "The contact in the search and suggest result."
- },
- "AutoCompleteRequest": {
- "type": "object",
- "properties": {
- "keywords": {
+ "description": "The description of the type definition."
+ },
+ "guid": {
"type": "string",
- "description": "The keywords applied to all fields that support autocomplete operation. It must be at least 1 character, and no more than 100 characters."
+ "description": "The GUID of the type definition."
},
- "limit": {
- "type": "integer",
- "format": "int32",
- "description": "The number of autocomplete results we hope to return. The default value is 50. The value must be a number between 1 and 100."
+ "name": {
+ "type": "string",
+ "description": "The name of the type definition."
},
- "filter": {
+ "options": {
"type": "object",
- "description": "The filter for the autocomplete request."
- }
- },
- "title": "AutoCompleteRequest",
- "description": "The query of autocomplete request."
- },
- "AutoCompleteResult": {
- "type": "object",
- "properties": {
- "value": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/AutoCompleteResultValue"
+ "description": "The options for the type definition.",
+ "additionalProperties": {
+ "type": "string"
}
- }
- },
- "title": "AutoCompleteResult",
- "description": "The result of the autocomplete request."
- },
- "AutoCompleteResultValue": {
- "type": "object",
- "properties": {
- "text": {
- "type": "string",
- "description": "The completed term or phrase."
},
- "queryPlusText": {
+ "serviceType": {
"type": "string",
- "description": "The completed search query text."
- }
- },
- "title": "AutoCompleteResultValue",
- "description": "The value item of the autocomplete suggest."
- },
- "SearchRequest": {
- "type": "object",
- "properties": {
- "keywords": {
+ "description": "The service type."
+ },
+ "typeVersion": {
"type": "string",
- "description": "The keywords applied to all searchable fields."
+ "description": "The version of the type."
},
- "limit": {
+ "updateTime": {
"type": "integer",
- "format": "int32",
- "description": "The limit of the number of the search result. default value is 50; maximum value is 1000."
+ "format": "int64",
+ "description": "The update time of the record."
},
- "continuationToken": {
+ "updatedBy": {
"type": "string",
- "description": "The token used to get next batch of data. Default 'Null' to get the first batch, and will return new token in each response unless there's no more data."
+ "description": "The user who updated the record."
},
- "orderby": {
- "type": "array",
- "description": "The sort order of search results, can specify multiple fields.",
- "items": {
- "$ref": "#/definitions/SearchOrderItem"
- }
+ "version": {
+ "type": "integer",
+ "format": "int64",
+ "description": "The version of the record."
},
- "filter": {
- "type": "object",
- "description": "The filter for the search. See examples for the usage of supported filters."
+ "lastModifiedTS": {
+ "type": "string",
+ "description": "ETag for concurrency control."
},
- "facets": {
+ "attributeDefs": {
"type": "array",
+ "description": "An array of attribute definitions.",
"items": {
- "$ref": "#/definitions/SearchFacetItem"
- }
- },
- "taxonomySetting": {
- "type": "object",
- "properties": {
- "assetTypes": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "facet": {
- "$ref": "#/definitions/SearchFacetItem"
- }
- }
+ "$ref": "#/definitions/AtlasAttributeDef"
+ },
+ "x-ms-identifiers": []
}
- },
- "title": "SearchRequest",
- "description": "The search query of advanced search request."
+ }
},
- "SuggestRequest": {
+ "AtlasTermAssignmentHeader": {
"type": "object",
+ "description": "The header for term assignment.",
"properties": {
- "keywords": {
- "type": "string",
- "description": "The keywords applied to all fields that support suggest operation. It must be at least 1 character, and no more than 100 characters. In the index schema we defined a default suggester which lists all the supported fields and specifies a search mode."
- },
- "limit": {
+ "confidence": {
"type": "integer",
"format": "int32",
- "description": "The number of suggestions we hope to return. The default value is 5. The value must be a number between 1 and 100."
+ "description": "The confidence of the term assignment."
},
- "filter": {
- "type": "object",
- "description": "The filter for the search."
+ "createdBy": {
+ "type": "string",
+ "description": "The user who created the record."
+ },
+ "description": {
+ "type": "string",
+ "description": "The description of the term assignment."
+ },
+ "displayText": {
+ "type": "string",
+ "description": "The display text."
+ },
+ "expression": {
+ "type": "string",
+ "description": "The expression of the term assignment."
+ },
+ "relationGuid": {
+ "$ref": "#/definitions/Azure.Core.uuid",
+ "description": "The GUID of the relationship."
+ },
+ "status": {
+ "$ref": "#/definitions/AtlasTermAssignmentStatus",
+ "description": "The status of terms assignment."
+ },
+ "steward": {
+ "type": "string",
+ "description": "The steward of the term."
+ },
+ "termGuid": {
+ "$ref": "#/definitions/Azure.Core.uuid",
+ "description": "The GUID of the term."
}
- },
- "title": "SuggestRequest",
- "description": "The query of suggest request."
+ }
},
- "LastModifiedTS": {
+ "AtlasTermAssignmentStatus": {
"type": "string",
- "title": "lastModifiedTS",
- "description": "ETag for concurrency control."
+ "description": "Status for term assignment",
+ "enum": [
+ "DISCOVERED",
+ "PROPOSED",
+ "IMPORTED",
+ "VALIDATED",
+ "DEPRECATED",
+ "OBSOLETE",
+ "OTHER"
+ ],
+ "x-ms-enum": {
+ "name": "AtlasTermAssignmentStatus",
+ "modelAsString": true,
+ "values": [
+ {
+ "name": "Discovered",
+ "value": "DISCOVERED",
+ "description": "The status is discovered."
+ },
+ {
+ "name": "Proposed",
+ "value": "PROPOSED",
+ "description": "The status is proposed."
+ },
+ {
+ "name": "Imported",
+ "value": "IMPORTED",
+ "description": "The status is imported."
+ },
+ {
+ "name": "Validated",
+ "value": "VALIDATED",
+ "description": "The status is validated."
+ },
+ {
+ "name": "Deprecated",
+ "value": "DEPRECATED",
+ "description": "The status is deprecated."
+ },
+ {
+ "name": "Obsolete",
+ "value": "OBSOLETE",
+ "description": "The status is obsolete."
+ },
+ {
+ "name": "Other",
+ "value": "OTHER",
+ "description": "Other status."
+ }
+ ]
+ }
},
- "ErrorResponse": {
- "description": "An error response from the service",
+ "AtlasTermCategorizationHeader": {
"type": "object",
+ "description": "The basic information for term categorization.",
"properties": {
- "requestId": {
- "type": "string",
- "description": "The request ID."
+ "categoryGuid": {
+ "$ref": "#/definitions/Azure.Core.uuid",
+ "description": "The GUID of the category."
},
- "errorCode": {
+ "description": {
"type": "string",
- "description": "The error code."
+ "description": "The description of the record."
},
- "errorMessage": {
+ "displayText": {
"type": "string",
- "description": "The error message."
+ "description": "The display text."
+ },
+ "relationGuid": {
+ "$ref": "#/definitions/Azure.Core.uuid",
+ "description": "The GUID of the relationship."
+ },
+ "status": {
+ "$ref": "#/definitions/AtlasTermRelationshipStatus",
+ "description": "The status of term relationship."
}
}
},
- "RelatedCategoryHeaders": {
- "type": "object",
- "description": "An array of related categories.",
- "additionalProperties": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/AtlasRelatedCategoryHeader"
- }
+ "AtlasTermRelationshipStatus": {
+ "type": "string",
+ "description": "Status for atlas term relationship",
+ "enum": [
+ "DRAFT",
+ "ACTIVE",
+ "DEPRECATED",
+ "OBSOLETE",
+ "OTHER"
+ ],
+ "x-ms-enum": {
+ "name": "AtlasTermRelationshipStatus",
+ "modelAsString": true,
+ "values": [
+ {
+ "name": "Draft",
+ "value": "DRAFT",
+ "description": "draft"
+ },
+ {
+ "name": "Active",
+ "value": "ACTIVE",
+ "description": "active"
+ },
+ {
+ "name": "Deprecated",
+ "value": "DEPRECATED",
+ "description": "deprecated"
+ },
+ {
+ "name": "Obsolete",
+ "value": "OBSOLETE",
+ "description": "obsolete"
+ },
+ {
+ "name": "Other",
+ "value": "OTHER",
+ "description": "other"
+ }
+ ]
}
},
- "RelatedTermHeaders": {
+ "AtlasTypeDef": {
"type": "object",
- "description": "An array of related glossary terms for the given glossary or an empty list.",
- "additionalProperties": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/AtlasRelatedTermHeader"
+ "description": "The definitions of type.",
+ "properties": {
+ "category": {
+ "$ref": "#/definitions/TypeCategory",
+ "description": "The enum of type category."
+ },
+ "createTime": {
+ "type": "integer",
+ "format": "int64",
+ "description": "The created time of the record."
+ },
+ "createdBy": {
+ "type": "string",
+ "description": "The user who created the record."
+ },
+ "dateFormatter": {
+ "$ref": "#/definitions/DateFormat",
+ "description": "The date format."
+ },
+ "description": {
+ "type": "string",
+ "description": "The description of the type definition."
+ },
+ "guid": {
+ "type": "string",
+ "description": "The GUID of the type definition."
+ },
+ "name": {
+ "type": "string",
+ "description": "The name of the type definition."
+ },
+ "options": {
+ "type": "object",
+ "description": "The options for the type definition.",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "serviceType": {
+ "type": "string",
+ "description": "The service type."
+ },
+ "typeVersion": {
+ "type": "string",
+ "description": "The version of the type."
+ },
+ "updateTime": {
+ "type": "integer",
+ "format": "int64",
+ "description": "The update time of the record."
+ },
+ "updatedBy": {
+ "type": "string",
+ "description": "The user who updated the record."
+ },
+ "version": {
+ "type": "integer",
+ "format": "int64",
+ "description": "The version of the record."
+ },
+ "lastModifiedTS": {
+ "type": "string",
+ "description": "ETag for concurrency control."
+ },
+ "entityTypes": {
+ "type": "array",
+ "description": "Specifying a list of entityType names in the classificationDef, ensures that\nclassifications can\nonly be applied to those entityTypes.\n\nAny subtypes of the entity types inherit the restriction.\n\nAny classificationDef subtypes inherit the parents entityTypes restrictions.\n\nAny classificationDef subtypes can further restrict the parents entityTypes\nrestrictions by specifying a subset of the entityTypes.\n\nAn empty entityTypes list when there are no parent restrictions means there are no\nrestrictions.\n\nAn empty entityTypes list when there are parent\nrestrictions means that the subtype picks up the parents\nrestrictions.\n\nIf a list of entityTypes are supplied, where one inherits\nfrom another, this will be rejected. This should encourage cleaner\nclassificationsDefs.\n",
+ "items": {
+ "type": "string"
+ }
+ },
+ "subTypes": {
+ "type": "array",
+ "description": "An array of sub types.",
+ "items": {
+ "type": "string"
+ }
+ },
+ "superTypes": {
+ "type": "array",
+ "description": "An array of super types.",
+ "items": {
+ "type": "string"
+ }
+ },
+ "relationshipAttributeDefs": {
+ "type": "array",
+ "description": "An array of relationship attributes.",
+ "items": {
+ "$ref": "#/definitions/AtlasRelationshipAttributeDef"
+ },
+ "x-ms-identifiers": []
+ },
+ "defaultValue": {
+ "type": "string",
+ "description": "The default value."
+ },
+ "elementDefs": {
+ "type": "array",
+ "description": "An array of enum element definitions.",
+ "items": {
+ "$ref": "#/definitions/AtlasEnumElementDef"
+ },
+ "x-ms-identifiers": []
+ },
+ "endDef1": {
+ "$ref": "#/definitions/AtlasRelationshipEndDef",
+ "description": "The relationshipEndDef represents an end of the relationship. The end of the\nrelationship is defined by a type, an\nattribute name, cardinality and whether\nit is the container end of the relationship."
+ },
+ "endDef2": {
+ "$ref": "#/definitions/AtlasRelationshipEndDef",
+ "description": "The relationshipEndDef represents an end of the relationship. The end of the\nrelationship is defined by a type, an\nattribute name, cardinality and whether\nit is the container end of the relationship."
+ },
+ "relationshipCategory": {
+ "$ref": "#/definitions/RelationshipCategory",
+ "description": "The Relationship category determines the style of relationship around\ncontainment and lifecycle.\nUML terminology is used for the values.\n\nASSOCIATION is a relationship with no containment. \nCOMPOSITION and AGGREGATION are containment relationships.\n\nThe difference being in the lifecycles of the container and its children. \nIn the COMPOSITION case, the children cannot exist without the container. \nFor AGGREGATION, the life cycles of the container and children are totally independent."
+ },
+ "relationshipLabel": {
+ "type": "string",
+ "description": "The label of the relationship."
+ },
+ "attributeDefs": {
+ "type": "array",
+ "description": "An array of attribute definitions.",
+ "items": {
+ "$ref": "#/definitions/AtlasAttributeDef"
+ },
+ "x-ms-identifiers": []
}
}
},
- "BusinessMetadata": {
+ "AtlasTypeDefHeader": {
"type": "object",
- "additionalProperties": {
- "type": "object"
- },
- "description": "BusinessMetadata"
+ "description": "The basic information of the type definition.",
+ "properties": {
+ "category": {
+ "$ref": "#/definitions/TypeCategory",
+ "description": "The enum of type category."
+ },
+ "guid": {
+ "type": "string",
+ "description": "The GUID of the type definition."
+ },
+ "name": {
+ "type": "string",
+ "description": "The name of the type definition."
+ }
+ }
},
- "BusinessMetadataAttributes": {
+ "AtlasTypesDef": {
"type": "object",
- "additionalProperties": {
- "type": "object"
- },
- "description": "BusinessMetadataAttributes"
- }
- },
- "parameters": {
- "endpoint": {
- "name": "endpoint",
- "description": "The datamap endpoint of your Purview account. Example: https://{accountName}.purview.azure.com",
- "x-ms-parameter-location": "client",
- "required": true,
- "type": "string",
- "format": "url",
- "in": "path",
- "x-ms-skip-url-encoding": true
- },
- "guid": {
- "name": "guid",
- "description": "The globally unique identifier of the entity.",
- "in": "path",
- "required": true,
- "type": "string",
- "minLength": 1,
- "maxLength": 4096,
- "x-ms-parameter-location": "method"
- },
- "classificationName": {
- "name": "classificationName",
- "description": "The name of the classification.",
- "in": "path",
- "required": true,
- "type": "string",
- "minLength": 1,
- "maxLength": 4096,
- "x-ms-parameter-location": "method"
- },
- "typeName": {
- "name": "typeName",
- "description": "The name of the type.",
- "in": "path",
- "required": true,
- "type": "string",
- "minLength": 1,
- "maxLength": 4096,
- "x-ms-parameter-location": "method"
- },
- "categoryGuid": {
- "name": "categoryGuid",
- "description": "The globally unique identifier of the category.",
- "in": "path",
- "required": true,
- "type": "string",
- "minLength": 1,
- "maxLength": 4096,
- "x-ms-parameter-location": "method"
- },
- "limit": {
- "name": "limit",
- "description": "The page size - by default there is no paging.",
- "in": "query",
- "required": false,
- "type": "integer",
- "format": "int32",
- "x-ms-parameter-location": "method"
+ "description": "The definitions of types.",
+ "properties": {
+ "businessMetadataDefs": {
+ "type": "array",
+ "description": "businessMetadataDefs",
+ "items": {
+ "$ref": "#/definitions/AtlasBusinessMetadataDef"
+ },
+ "x-ms-identifiers": []
+ },
+ "classificationDefs": {
+ "type": "array",
+ "description": "An array of classification definitions.",
+ "items": {
+ "$ref": "#/definitions/AtlasClassificationDef"
+ },
+ "x-ms-identifiers": []
+ },
+ "entityDefs": {
+ "type": "array",
+ "description": "An array of entity definitions.",
+ "items": {
+ "$ref": "#/definitions/AtlasEntityDef"
+ },
+ "x-ms-identifiers": []
+ },
+ "enumDefs": {
+ "type": "array",
+ "description": "An array of enum definitions.",
+ "items": {
+ "$ref": "#/definitions/AtlasEnumDef"
+ },
+ "x-ms-identifiers": []
+ },
+ "relationshipDefs": {
+ "type": "array",
+ "description": "An array of relationship definitions.",
+ "items": {
+ "$ref": "#/definitions/AtlasRelationshipDef"
+ },
+ "x-ms-identifiers": []
+ },
+ "structDefs": {
+ "type": "array",
+ "description": "An array of struct definitions.",
+ "items": {
+ "$ref": "#/definitions/AtlasStructDef"
+ },
+ "x-ms-identifiers": []
+ },
+ "termTemplateDefs": {
+ "type": "array",
+ "description": "An array of term template definitions.",
+ "items": {
+ "$ref": "#/definitions/TermTemplateDef"
+ },
+ "x-ms-identifiers": []
+ }
+ }
},
- "offset": {
- "name": "offset",
- "description": "The offset for pagination purpose.",
- "in": "query",
- "required": false,
- "type": "integer",
- "format": "int32",
- "x-ms-parameter-location": "method"
+ "AutoCompleteOptions": {
+ "type": "object",
+ "description": "The payload of autocomplete request.",
+ "properties": {
+ "keywords": {
+ "type": "string",
+ "description": "The keywords applied to all fields that support autocomplete operation. It must\nbe at least 1 character, and no more than 100 characters."
+ },
+ "limit": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The number of autocomplete results we hope to return. The default value is 50.\nThe value must be a number between 1 and 100."
+ },
+ "filter": {
+ "description": "The filter for the autocomplete request."
+ }
+ }
},
- "sort": {
- "name": "sort",
- "description": "The sort order, ASC (default) or DESC.",
- "in": "query",
- "required": false,
- "type": "string",
- "default": "ASC",
- "x-ms-parameter-location": "method"
+ "AutoCompleteResult": {
+ "type": "object",
+ "description": "The result of the autocomplete request.",
+ "properties": {
+ "value": {
+ "type": "array",
+ "description": "The result value",
+ "items": {
+ "$ref": "#/definitions/AutoCompleteResultValue"
+ },
+ "x-ms-identifiers": []
+ }
+ }
},
- "termGuid": {
- "name": "termGuid",
- "in": "path",
- "description": "The globally unique identifier for glossary term.",
- "required": true,
- "type": "string",
- "minLength": 1,
- "maxLength": 4096,
- "x-ms-parameter-location": "method"
+ "AutoCompleteResultValue": {
+ "type": "object",
+ "description": "The value item of the autocomplete suggest.",
+ "properties": {
+ "text": {
+ "type": "string",
+ "description": "The completed term or phrase."
+ },
+ "queryPlusText": {
+ "type": "string",
+ "description": "The completed search query text."
+ }
+ }
},
- "fileId": {
- "name": "fileId",
- "in": "path",
- "description": "The globally unique identifier for file.",
- "required": true,
+ "Azure.Core.uuid": {
"type": "string",
- "minLength": 1,
- "maxLength": 4096,
- "x-ms-parameter-location": "method"
+ "format": "uuid",
+ "description": "Universally Unique Identifier"
},
- "glossaryGuid": {
- "name": "glossaryGuid",
- "in": "path",
- "description": "The globally unique identifier for glossary.",
- "required": true,
- "type": "string",
- "minLength": 1,
- "maxLength": 4096,
- "x-ms-parameter-location": "method"
+ "BulkImportResult": {
+ "type": "object",
+ "description": "Bulk import result",
+ "properties": {
+ "failedImportInfoList": {
+ "type": "array",
+ "description": "failed importInfoList",
+ "items": {
+ "$ref": "#/definitions/ImportInfo"
+ },
+ "x-ms-identifiers": []
+ },
+ "successImportInfoList": {
+ "type": "array",
+ "description": "successful importInfoList",
+ "items": {
+ "$ref": "#/definitions/ImportInfo"
+ },
+ "x-ms-identifiers": []
+ }
+ }
},
- "operationGuid": {
- "name": "operationGuid",
- "in": "path",
- "description": "The globally unique identifier for async operation job.",
- "required": true,
+ "CardinalityValue": {
"type": "string",
- "minLength": 1,
- "maxLength": 4096,
- "x-ms-parameter-location": "method"
+ "description": "Cardinality",
+ "enum": [
+ "SINGLE",
+ "LIST",
+ "SET"
+ ],
+ "x-ms-enum": {
+ "name": "CardinalityValue",
+ "modelAsString": true,
+ "values": [
+ {
+ "name": "Single",
+ "value": "SINGLE",
+ "description": "single"
+ },
+ {
+ "name": "List",
+ "value": "LIST",
+ "description": "list"
+ },
+ {
+ "name": "Set",
+ "value": "SET",
+ "description": "set"
+ }
+ ]
+ }
},
- "glossaryName": {
- "name": "glossaryName",
- "in": "path",
- "description": "The name of the glossary.",
- "required": true,
- "type": "string",
- "minLength": 1,
- "maxLength": 4096,
- "x-ms-parameter-location": "method"
+ "ClassificationAssociateOptions": {
+ "type": "object",
+ "description": "The request payload for classification association.",
+ "properties": {
+ "classification": {
+ "$ref": "#/definitions/AtlasClassification",
+ "description": "An instance of a classification; it doesn't have an identity, this object\nexists only when associated with an entity."
+ },
+ "entityGuids": {
+ "type": "array",
+ "description": "The GUID of the entity.",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
},
- "searchLimit": {
- "name": "limit",
- "description": "Limits the result set to only include the specified number of entries.",
- "in": "query",
- "required": false,
- "type": "integer",
- "format": "int32",
- "x-ms-parameter-location": "method"
+ "ContactInfo": {
+ "type": "object",
+ "description": "ContactInfo",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "Azure Active Directory object Id."
+ },
+ "info": {
+ "type": "string",
+ "description": "additional information to describe this contact."
+ }
+ }
},
- "searchKeyword": {
- "name": "keyword",
- "description": "The keyword to get auto complete.",
- "in": "query",
- "required": true,
- "type": "string",
- "x-ms-parameter-location": "method"
+ "ContactSearchResultValue": {
+ "type": "object",
+ "description": "The contact in the search and suggest result.",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "The GUID of the contact."
+ },
+ "info": {
+ "type": "string",
+ "description": "The description of the contact."
+ },
+ "contactType": {
+ "type": "string",
+ "description": "The type of the contact. It can be Expert or Owner for an entity. It can be\nExpert or Steward for a glossary term."
+ }
+ }
},
- "depth": {
- "name": "depth",
- "description": "The number of hops for lineage.",
- "in": "query",
- "required": false,
- "type": "integer",
- "default": 3,
- "format": "int32",
- "x-ms-parameter-location": "method"
- },
- "direction": {
- "name": "direction",
- "description": "The direction of the lineage, which could be INPUT, OUTPUT or BOTH.",
- "in": "query",
- "required": true,
+ "DateFormat": {
+ "type": "object",
+ "description": "The date format.",
+ "properties": {
+ "availableLocales": {
+ "type": "array",
+ "description": "An array of available locales.",
+ "items": {
+ "type": "string"
+ }
+ },
+ "calendar": {
+ "type": "number",
+ "format": "float",
+ "description": "Calendar"
+ },
+ "dateInstance": {
+ "$ref": "#/definitions/DateFormat",
+ "description": "The date format."
+ },
+ "dateTimeInstance": {
+ "$ref": "#/definitions/DateFormat",
+ "description": "The date format."
+ },
+ "instance": {
+ "$ref": "#/definitions/DateFormat",
+ "description": "The date format."
+ },
+ "lenient": {
+ "type": "boolean",
+ "description": "Determines the leniency of the date format."
+ },
+ "numberFormat": {
+ "$ref": "#/definitions/NumberFormat",
+ "description": "The number format."
+ },
+ "timeInstance": {
+ "$ref": "#/definitions/DateFormat",
+ "description": "The date format."
+ },
+ "timeZone": {
+ "$ref": "#/definitions/TimeZone",
+ "description": "The timezone information."
+ }
+ }
+ },
+ "EntityMutationResult": {
+ "type": "object",
+ "description": "The mutation response result of entity.",
+ "properties": {
+ "guidAssignments": {
+ "type": "object",
+ "description": "A map of GUID assignments with entities.",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "mutatedEntities": {
+ "type": "object",
+ "description": "The entity headers of mutated entities.",
+ "additionalProperties": {
+ "items": {
+ "$ref": "#/definitions/AtlasEntityHeader"
+ },
+ "type": "array",
+ "x-ms-identifiers": []
+ }
+ },
+ "partialUpdatedEntities": {
+ "type": "array",
+ "description": "An array of entity headers that partially updated.",
+ "items": {
+ "$ref": "#/definitions/AtlasEntityHeader"
+ },
+ "x-ms-identifiers": []
+ }
+ }
+ },
+ "EntityStatus": {
"type": "string",
+ "description": "Status - can be active or deleted",
"enum": [
- "BOTH",
- "INPUT",
- "OUTPUT"
+ "ACTIVE",
+ "DELETED"
],
"x-ms-enum": {
- "name": "direction",
- "modelAsString": true
- },
- "x-ms-parameter-location": "method"
+ "name": "EntityStatus",
+ "modelAsString": true,
+ "values": [
+ {
+ "name": "Active",
+ "value": "ACTIVE",
+ "description": "The status is active."
+ },
+ {
+ "name": "Deleted",
+ "value": "DELETED",
+ "description": "The status is deleted."
+ }
+ ]
+ }
},
- "extendedInfo": {
- "name": "extendedInfo",
- "description": "Limits whether includes extended information.",
- "in": "query",
- "required": false,
- "type": "boolean",
- "x-ms-parameter-location": "method"
+ "ImportInfo": {
+ "type": "object",
+ "description": "ImportInfo",
+ "properties": {
+ "childObjectName": {
+ "type": "string",
+ "description": "childObjectName"
+ },
+ "importStatus": {
+ "$ref": "#/definitions/ImportStatus",
+ "description": "importStatus"
+ },
+ "parentObjectName": {
+ "type": "string",
+ "description": "parentObjectName"
+ },
+ "remarks": {
+ "type": "string",
+ "description": "remarks"
+ }
+ }
},
- "relationshipGuid": {
- "name": "guid",
- "description": "The globally unique identifier of the relationship.",
- "in": "path",
- "required": true,
+ "ImportStatus": {
"type": "string",
- "minLength": 1,
- "maxLength": 4096,
- "x-ms-parameter-location": "method"
+ "description": "Status for import",
+ "enum": [
+ "SUCCESS",
+ "FAILED"
+ ],
+ "x-ms-enum": {
+ "name": "ImportStatus",
+ "modelAsString": true,
+ "values": [
+ {
+ "name": "Success",
+ "value": "SUCCESS",
+ "description": "Success"
+ },
+ {
+ "name": "Failed",
+ "value": "FAILED",
+ "description": "Failed"
+ }
+ ]
+ }
},
- "classificationDefGuid": {
- "name": "guid",
- "description": "The globally unique identifier of the classification.",
- "in": "path",
- "required": true,
+ "LineageDirection": {
"type": "string",
- "minLength": 1,
- "maxLength": 4096,
- "x-ms-parameter-location": "method"
+ "description": "Lineage direction",
+ "enum": [
+ "INPUT",
+ "OUTPUT",
+ "BOTH"
+ ],
+ "x-ms-enum": {
+ "name": "LineageDirection",
+ "modelAsString": true,
+ "values": [
+ {
+ "name": "Input",
+ "value": "INPUT",
+ "description": "input"
+ },
+ {
+ "name": "Output",
+ "value": "OUTPUT",
+ "description": "output"
+ },
+ {
+ "name": "Both",
+ "value": "BOTH",
+ "description": "both"
+ }
+ ]
+ }
},
- "classificationDefName": {
- "name": "name",
- "description": "The name of the classification.",
- "in": "path",
- "required": true,
- "type": "string",
- "minLength": 1,
- "maxLength": 4096,
- "x-ms-parameter-location": "method"
+ "LineageRelation": {
+ "type": "object",
+ "description": "The lineage relation with GUID of the from and to entity.",
+ "properties": {
+ "fromEntityId": {
+ "type": "string",
+ "description": "The GUID of from-entity."
+ },
+ "relationshipId": {
+ "type": "string",
+ "description": "The GUID of relationship."
+ },
+ "toEntityId": {
+ "type": "string",
+ "description": "The GUID of to-entity."
+ }
+ }
},
- "entityDefGuid": {
- "name": "guid",
- "description": "The globally unique identifier of the entity.",
- "in": "path",
- "required": true,
- "type": "string",
- "minLength": 1,
- "maxLength": 4096,
- "x-ms-parameter-location": "method"
+ "MoveEntitiesOptions": {
+ "type": "object",
+ "description": "MoveEntitiesOptions",
+ "properties": {
+ "entityGuids": {
+ "type": "array",
+ "description": "An array of entity guids to be moved to target collection.",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
},
- "entityDefName": {
- "name": "name",
- "description": "The name of the entity.",
- "in": "path",
- "required": true,
- "type": "string",
- "minLength": 1,
- "maxLength": 4096,
- "x-ms-parameter-location": "method"
+ "NumberFormat": {
+ "type": "object",
+ "description": "The number format.",
+ "properties": {
+ "availableLocales": {
+ "type": "array",
+ "description": "The number format.",
+ "items": {
+ "type": "string"
+ }
+ },
+ "currency": {
+ "type": "string",
+ "description": "The currency."
+ },
+ "currencyInstance": {
+ "$ref": "#/definitions/NumberFormat",
+ "description": "The number format."
+ },
+ "groupingUsed": {
+ "type": "boolean",
+ "description": "Determines if grouping is used."
+ },
+ "instance": {
+ "$ref": "#/definitions/NumberFormat",
+ "description": "The number format."
+ },
+ "integerInstance": {
+ "$ref": "#/definitions/NumberFormat",
+ "description": "The number format."
+ },
+ "maximumFractionDigits": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The maximum of fraction digits."
+ },
+ "maximumIntegerDigits": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The maximum of integer digits."
+ },
+ "minimumFractionDigits": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The minimum of fraction digits."
+ },
+ "minimumIntegerDigits": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The minimum of integer digits."
+ },
+ "numberInstance": {
+ "$ref": "#/definitions/NumberFormat",
+ "description": "The number format."
+ },
+ "parseIntegerOnly": {
+ "type": "boolean",
+ "description": "Determines if only integer is parsed."
+ },
+ "percentInstance": {
+ "$ref": "#/definitions/NumberFormat",
+ "description": "The number format."
+ },
+ "roundingMode": {
+ "$ref": "#/definitions/RoundingMode",
+ "description": "The enum of rounding mode."
+ }
+ }
},
- "termTemplateDefGuid": {
- "name": "guid",
- "description": "The globally unique identifier of the term template.",
- "in": "path",
- "required": true,
- "type": "string",
- "minLength": 1,
- "maxLength": 4096,
- "x-ms-parameter-location": "method"
+ "ParentRelation": {
+ "type": "object",
+ "description": "The lineage parents relation with GUID of the parent entity and to child entity.",
+ "properties": {
+ "childEntityId": {
+ "type": "string",
+ "description": "The GUID of child entity."
+ },
+ "relationshipId": {
+ "type": "string",
+ "description": "The GUID of relationship."
+ },
+ "parentEntityId": {
+ "type": "string",
+ "description": "The GUID of parent entity."
+ }
+ }
},
- "termTemplateDefName": {
- "name": "name",
- "description": "The name of the term template.",
- "in": "path",
- "required": true,
- "type": "string",
- "minLength": 1,
- "maxLength": 4096,
- "x-ms-parameter-location": "method"
+ "PurviewObjectId": {
+ "type": "object",
+ "description": "PurviewObjectId",
+ "properties": {
+ "guid": {
+ "type": "string",
+ "description": "The GUID of the object."
+ },
+ "typeName": {
+ "type": "string",
+ "description": "The name of the type."
+ },
+ "uniqueAttributes": {
+ "type": "object",
+ "description": "The unique attributes of the object.",
+ "additionalProperties": {}
+ },
+ "name": {
+ "type": "string",
+ "description": "Name"
+ },
+ "displayText": {
+ "type": "string",
+ "description": "Display text"
+ },
+ "itemPath": {
+ "type": "string",
+ "description": "Item path"
+ },
+ "resourceId": {
+ "type": "string",
+ "description": "Resource Id"
+ },
+ "properties": {
+ "type": "object",
+ "description": "Dictionary of \n
",
+ "description": "An array of related term headers.",
"items": {
- "type": "string"
- }
+ "$ref": "#/definitions/AtlasRelatedTermHeader"
+ },
+ "x-ms-identifiers": []
},
- "subTypes": {
+ "examples": {
"type": "array",
- "description": "An array of sub types.",
+ "description": "An array of examples.",
"items": {
"type": "string"
}
},
- "superTypes": {
+ "isA": {
"type": "array",
- "description": "An array of super types.",
+ "description": "An array of related term headers indicating the is-a relationship.",
"items": {
- "type": "string"
- }
+ "$ref": "#/definitions/AtlasRelatedTermHeader"
+ },
+ "x-ms-identifiers": []
},
- "relationshipAttributeDefs": {
+ "preferredTerms": {
"type": "array",
- "description": "An array of relationship attributes.",
+ "description": "An array of preferred related term headers.",
"items": {
- "$ref": "#/definitions/AtlasRelationshipAttributeDef"
- }
+ "$ref": "#/definitions/AtlasRelatedTermHeader"
+ },
+ "x-ms-identifiers": []
},
- "defaultValue": {
- "type": "string",
- "description": "The default value."
+ "preferredToTerms": {
+ "type": "array",
+ "description": "An array of related term headers that are preferred to.",
+ "items": {
+ "$ref": "#/definitions/AtlasRelatedTermHeader"
+ },
+ "x-ms-identifiers": []
},
- "elementDefs": {
+ "replacedBy": {
"type": "array",
- "description": "An array of enum element definitions.",
+ "description": "An array of related term headers that are replaced by.",
"items": {
- "$ref": "#/definitions/AtlasEnumElementDef"
- }
+ "$ref": "#/definitions/AtlasRelatedTermHeader"
+ },
+ "x-ms-identifiers": []
},
- "endDef1": {
- "$ref": "#/definitions/AtlasRelationshipEndDef"
+ "replacementTerms": {
+ "type": "array",
+ "description": "An array of related term headers for replacement.",
+ "items": {
+ "$ref": "#/definitions/AtlasRelatedTermHeader"
+ },
+ "x-ms-identifiers": []
},
- "endDef2": {
- "$ref": "#/definitions/AtlasRelationshipEndDef"
+ "seeAlso": {
+ "type": "array",
+ "description": "An array of related term headers for see also.",
+ "items": {
+ "$ref": "#/definitions/AtlasRelatedTermHeader"
+ },
+ "x-ms-identifiers": []
},
- "relationshipCategory": {
- "$ref": "#/definitions/RelationshipCategory"
+ "synonyms": {
+ "type": "array",
+ "description": "An array of related term headers as synonyms.",
+ "items": {
+ "$ref": "#/definitions/AtlasRelatedTermHeader"
+ },
+ "x-ms-identifiers": []
},
- "relationshipLabel": {
- "type": "string",
- "description": "The label of the relationship."
+ "translatedTerms": {
+ "type": "array",
+ "description": "An array of translated related term headers.",
+ "items": {
+ "$ref": "#/definitions/AtlasRelatedTermHeader"
+ },
+ "x-ms-identifiers": []
},
- "attributeDefs": {
+ "translationTerms": {
"type": "array",
- "description": "An array of attribute definitions.",
+ "description": "An array of related term headers for translation.",
"items": {
- "$ref": "#/definitions/AtlasAttributeDef"
- }
- }
- },
- "title": "AtlasExtraTypeDef",
- "description": "Extra properties for a type."
- },
- "AtlasTypeDef": {
- "type": "object",
- "allOf": [
- {
- "$ref": "#/definitions/AtlasBaseTypeDef"
- },
- {
- "$ref": "#/definitions/AtlasExtraTypeDef"
- }
- ],
- "title": "AtlasTypeDef",
- "description": "The definitions of type."
- },
- "ImportInfo": {
- "type": "object",
- "title": "ImportInfo",
- "properties": {
- "childObjectName": {
- "readOnly": false,
- "description": "childObjectName",
- "type": "string"
- },
- "importStatus": {
- "readOnly": false,
- "$ref": "#/definitions/ImportStatus",
- "description": "importStatus"
- },
- "parentObjectName": {
- "readOnly": false,
- "description": "parentObjectName",
- "type": "string"
+ "$ref": "#/definitions/AtlasRelatedTermHeader"
+ },
+ "x-ms-identifiers": []
},
- "remarks": {
- "readOnly": false,
- "description": "remarks",
- "type": "string"
- }
- },
- "example": {
- "childObjectName": "...",
- "importStatus": "SUCCESS",
- "parentObjectName": "...",
- "remarks": "..."
- },
- "description": "ImportInfo"
- },
- "ImportStatus": {
- "type": "string",
- "title": "ImportStatus",
- "enum": [
- "SUCCESS",
- "FAILED"
- ],
- "description": "ImportStatus",
- "x-ms-enum": {
- "name": "importStatus",
- "modelAsString": true
- }
- },
- "BulkImportResponse": {
- "type": "object",
- "title": "BulkImportResponse",
- "properties": {
- "failedImportInfoList": {
- "readOnly": false,
- "description": "failed importInfoList",
- "type": "array",
- "items": {
- "$ref": "#/definitions/ImportInfo"
- }
+ "usage": {
+ "type": "string",
+ "description": "The usage of the term."
},
- "successImportInfoList": {
- "readOnly": false,
- "description": "successful importInfoList",
+ "validValues": {
"type": "array",
+ "description": "An array of related term headers as valid values.",
"items": {
- "$ref": "#/definitions/ImportInfo"
- }
- }
- },
- "example": {
- "failedImportInfoList": [
- {
- "childObjectName": "...",
- "importStatus": "SUCCESS",
- "parentObjectName": "...",
- "remarks": "..."
- },
- {
- "childObjectName": "...",
- "importStatus": "SUCCESS",
- "parentObjectName": "...",
- "remarks": "..."
- }
- ],
- "successImportInfoList": [
- {
- "childObjectName": "...",
- "importStatus": "FAILED",
- "parentObjectName": "...",
- "remarks": "..."
+ "$ref": "#/definitions/AtlasRelatedTermHeader"
},
- {
- "childObjectName": "...",
- "importStatus": "FAILED",
- "parentObjectName": "...",
- "remarks": "..."
- }
- ]
- },
- "description": "example"
- },
- "Cardinality": {
- "type": "string",
- "title": "Cardinality",
- "description": "single-valued attribute or multi-valued attribute.",
- "enum": [
- "SINGLE",
- "LIST",
- "SET"
- ],
- "x-ms-enum": {
- "name": "Cardinality",
- "modelAsString": true
- }
- },
- "ClassificationAssociateRequest": {
- "type": "object",
- "properties": {
- "classification": {
- "$ref": "#/definitions/AtlasClassification"
+ "x-ms-identifiers": []
},
- "entityGuids": {
- "type": "array",
- "description": "The GUID of the entity.",
- "items": {
- "type": "string"
- }
- }
- },
- "title": "ClassificationAssociateRequest",
- "description": "The request for classification association."
- },
- "MoveEntitiesRequest": {
- "type": "object",
- "properties": {
- "entityGuids": {
+ "validValuesFor": {
"type": "array",
- "description": "An array of entity guids to be moved to target collection.",
+ "description": "An array of related term headers as valid values for other records.",
"items": {
- "type": "string"
- }
+ "$ref": "#/definitions/AtlasRelatedTermHeader"
+ },
+ "x-ms-identifiers": []
}
}
},
- "DateFormat": {
+ "AtlasLineageInfo": {
"type": "object",
- "title": "DateFormat",
+ "description": "The lineage information.",
"properties": {
- "availableLocales": {
- "type": "array",
- "description": "An array of available locales.",
- "items": {
- "type": "string"
- }
- },
- "calendar": {
- "type": "number"
- },
- "dateInstance": {
- "$ref": "#/definitions/DateFormat"
- },
- "dateTimeInstance": {
- "$ref": "#/definitions/DateFormat"
- },
- "instance": {
- "$ref": "#/definitions/DateFormat"
- },
- "lenient": {
- "type": "boolean",
- "description": "Determines the leniency of the date format."
- },
- "numberFormat": {
- "$ref": "#/definitions/NumberFormat"
- },
- "timeInstance": {
- "$ref": "#/definitions/DateFormat"
+ "baseEntityGuid": {
+ "type": "string",
+ "description": "The GUID of the base entity."
},
- "timeZone": {
- "$ref": "#/definitions/TimeZone"
- }
- },
- "description": "The date format."
- },
- "EntityMutationResponse": {
- "type": "object",
- "properties": {
- "guidAssignments": {
+ "guidEntityMap": {
"type": "object",
- "description": "A map of GUID assignments with entities.",
+ "description": "The GUID entity map.",
"additionalProperties": {
- "type": "string"
+ "$ref": "#/definitions/AtlasEntityHeader"
}
},
- "mutatedEntities": {
+ "widthCounts": {
"type": "object",
- "description": "The entity headers of mutated entities.",
+ "description": "The entity count in specific direction.",
"additionalProperties": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/AtlasEntityHeader"
- }
+ "additionalProperties": {},
+ "type": "object"
}
},
- "partialUpdatedEntities": {
+ "lineageDepth": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The depth of lineage."
+ },
+ "lineageWidth": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The width of lineage."
+ },
+ "childrenCount": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The number of children node."
+ },
+ "lineageDirection": {
+ "$ref": "#/definitions/LineageDirection",
+ "description": "The enum of lineage direction."
+ },
+ "parentRelations": {
"type": "array",
- "description": "An array of entity headers that partially updated.",
+ "description": "An array of parentRelations relations.",
"items": {
- "$ref": "#/definitions/AtlasEntityHeader"
- }
+ "$ref": "#/definitions/ParentRelation"
+ },
+ "x-ms-identifiers": []
+ },
+ "relations": {
+ "type": "array",
+ "description": "An array of lineage relations.",
+ "items": {
+ "$ref": "#/definitions/LineageRelation"
+ },
+ "x-ms-identifiers": []
}
- },
- "title": "EntityMutationResponse",
- "description": "The mutation response of entity."
- },
- "LineageDirection": {
- "type": "string",
- "title": "LineageDirection",
- "description": "The enum of lineage direction.",
- "enum": [
- "INPUT",
- "OUTPUT",
- "BOTH"
- ],
- "x-ms-enum": {
- "name": "LineageDirection",
- "modelAsString": true
}
},
- "LineageRelation": {
+ "AtlasObjectId": {
"type": "object",
+ "description": "Reference to an object-instance of a type - like entity.",
"properties": {
- "fromEntityId": {
+ "guid": {
"type": "string",
- "description": "The GUID of from-entity."
+ "description": "The GUID of the object."
},
- "relationshipId": {
+ "typeName": {
"type": "string",
- "description": "The GUID of relationship."
+ "description": "The name of the type."
},
- "toEntityId": {
- "type": "string",
- "description": "The GUID of to-entity."
+ "uniqueAttributes": {
+ "type": "object",
+ "description": "The unique attributes of the object.",
+ "additionalProperties": {}
}
- },
- "title": "LineageRelation",
- "description": "The lineage relation with GUID of the from and to entity."
+ }
},
- "ParentRelation": {
+ "AtlasRelatedCategoryHeader": {
"type": "object",
+ "description": "The header of the related category.",
"properties": {
- "childEntityId": {
+ "categoryGuid": {
"type": "string",
- "description": "The GUID of child entity."
+ "description": "The GUID of the category."
},
- "relationshipId": {
+ "description": {
"type": "string",
- "description": "The GUID of relationship."
+ "description": "The description of the category header."
},
- "parentEntityId": {
+ "displayText": {
"type": "string",
- "description": "The GUID of parent entity."
+ "description": "The display text."
+ },
+ "parentCategoryGuid": {
+ "type": "string",
+ "description": "The GUID of the parent category."
+ },
+ "relationGuid": {
+ "type": "string",
+ "description": "The GUID of the relationship."
}
- },
- "title": "ParentRelation",
- "description": "The lineage parents relation with GUID of the parent entity and to child entity."
+ }
},
- "NumberFormat": {
+ "AtlasRelatedObjectId": {
"type": "object",
- "title": "NumberFormat",
+ "description": "Reference to an object-instance of AtlasEntity type used in relationship\nattribute values",
"properties": {
- "availableLocales": {
- "type": "array",
- "description": "The number format.",
- "items": {
- "type": "string"
- }
+ "guid": {
+ "type": "string",
+ "description": "The GUID of the object."
},
- "currency": {
+ "typeName": {
"type": "string",
- "description": "The currency."
+ "description": "The name of the type."
},
- "currencyInstance": {
- "$ref": "#/definitions/NumberFormat"
+ "uniqueAttributes": {
+ "type": "object",
+ "description": "The unique attributes of the object.",
+ "additionalProperties": {}
},
- "groupingUsed": {
- "type": "boolean",
- "description": "Determines if grouping is used."
+ "displayText": {
+ "type": "string",
+ "description": "The display text."
},
- "instance": {
- "$ref": "#/definitions/NumberFormat"
- },
- "integerInstance": {
- "$ref": "#/definitions/NumberFormat"
- },
- "maximumFractionDigits": {
- "type": "integer",
- "format": "int32",
- "description": "The maximum of fraction digits."
- },
- "maximumIntegerDigits": {
- "type": "integer",
- "format": "int32",
- "description": "The maximum of integer digits."
- },
- "minimumFractionDigits": {
- "type": "integer",
- "format": "int32",
- "description": "The minimum of fraction digits."
- },
- "minimumIntegerDigits": {
- "type": "integer",
- "format": "int32",
- "description": "The minimum of integer digits."
- },
- "numberInstance": {
- "$ref": "#/definitions/NumberFormat"
- },
- "parseIntegerOnly": {
- "type": "boolean",
- "description": "Determines if only integer is parsed."
- },
- "percentInstance": {
- "$ref": "#/definitions/NumberFormat"
- },
- "roundingMode": {
- "$ref": "#/definitions/RoundingMode"
- }
- },
- "description": "The number format."
- },
- "TermGuid": {
- "type": "string",
- "title": "termGuid",
- "description": "The globally unique identifier for glossary term."
- },
- "PList": {
- "type": "object",
- "properties": {
- "list": {
- "type": "array",
- "description": "An array of objects.",
- "items": {
- "type": "object",
- "properties": {}
- }
- },
- "pageSize": {
- "type": "integer",
- "format": "int32",
- "description": "The size of the page."
+ "entityStatus": {
+ "$ref": "#/definitions/EntityStatus",
+ "description": "Status of the entity - can be active or deleted. Deleted entities are not\nremoved."
},
- "sortBy": {
+ "relationshipType": {
"type": "string",
- "description": "The sorted by field."
+ "description": "Relationship type"
},
- "sortType": {
- "$ref": "#/definitions/SortType"
+ "relationshipAttributes": {
+ "$ref": "#/definitions/AtlasStruct",
+ "description": "Captures details of struct contents. Not instantiated directly, used only via\nAtlasEntity, AtlasClassification."
},
- "startIndex": {
- "type": "integer",
- "format": "int64",
- "description": "The start index of the page."
+ "relationshipGuid": {
+ "$ref": "#/definitions/Azure.Core.uuid",
+ "description": "The GUID of the relationship."
},
- "totalCount": {
- "type": "integer",
- "format": "int64",
- "description": "The total count of items."
+ "relationshipStatus": {
+ "$ref": "#/definitions/StatusAtlasRelationship",
+ "description": "The enum of relationship status."
}
- },
- "title": "PList",
- "description": "Paginated-list, for returning search results."
- },
- "RelationshipCategory": {
- "type": "string",
- "title": "RelationshipCategory",
- "description": "The Relationship category determines the style of relationship around containment and lifecycle.\nUML terminology is used for the values.\n
\nCOMPOSITION and AGGREGATION are containment relationships.\n