AtlasSearchResult Data Type

Properties
name data type constraints description
approximateCount number required
attributes AttributeSearchResult  
classification string  
entities array of AtlasEntityHeader  
fullTextResult array of AtlasFullTextResult  
nextMarker string  
queryText string  
queryType AtlasQueryType  
referredEntities map of AtlasEntityHeader  
relations array of AtlasRelationshipHeader  
searchParameters SearchParameters  
type string  

Example

{
  "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" : "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" : "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" : "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" : "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" : "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" : "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" : "DISCOVERED",
        "steward" : "...",
        "termGuid" : "..."
      } ],
      "status" : "PURGED",
      "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" : "ONE_TO_TWO",
    "status" : "ACTIVE",
    "attributes" : {
      "property1" : { },
      "property2" : { }
    },
    "typeName" : "..."
  } ],
  "searchParameters" : {
    "attributes" : [ "...", "..." ],
    "classification" : "...",
    "entityFilters" : {
      "attributeName" : "...",
      "attributeValue" : "...",
      "condition" : "AND",
      "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" : "IS_NULL"
    },
    "relationshipName" : "...",
    "sortBy" : "...",
    "sortOrder" : "ASCENDING",
    "tagFilters" : {
      "attributeName" : "...",
      "attributeValue" : "...",
      "condition" : "AND",
      "criterion" : [ { }, { } ],
      "operator" : "CONTAINS_ALL"
    },
    "termName" : "...",
    "typeName" : "..."
  },
  "type" : "..."
}