REST interface for data discovery using dsl or full text search
Retrieve data for the specified attribute search query
| name | type | description | constraints |
|---|---|---|---|
| attrName | query | Attribute name | |
| attrValuePrefix | query | Attibute value to search on | |
| limit | query | limit the result set to only include the specified number of entries | required |
| offset | query | start offset of the result set (useful for pagination) | required |
| typeName | query | limit the result to only entities of specified type or its sub-types |
| code | condition |
|---|---|
| 200 | On successful FullText lookup with some results, might return an empty list if execution succeeded without any results |
| 400 | Invalid wildcard or query parameters |
| media type | data type | description |
|---|---|---|
| application/json | AtlasSearchResult (JSON) | Search results |
| application/json | AtlasSearchResult (JSON) |
GET /v2/search/attribute
Content-Type: application/json
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: 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" : "IMPORTED",
"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" : "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" : "..."
} ],
"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" : "ATTRIBUTE",
"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" : "PROPOSED",
"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" : "DEPRECATED",
"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" : "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" : "STARTS_WITH"
},
"excludeDeletedEntities" : true,
"excludeHeaderAttributes" : true,
"includeClassificationAttributes" : true,
"includeSubClassifications" : true,
"includeSubTypes" : true,
"limit" : 12345,
"marker" : "...",
"offset" : 12345,
"query" : "...",
"relationshipFilters" : {
"attributeName" : "...",
"attributeValue" : "...",
"condition" : "AND",
"criterion" : [ { }, { } ],
"operator" : "STARTS_WITH"
},
"relationshipName" : "...",
"sortBy" : "...",
"sortOrder" : "ASCENDING",
"tagFilters" : {
"attributeName" : "...",
"attributeValue" : "...",
"condition" : "OR",
"criterion" : [ { }, { } ],
"operator" : "ENDS_WITH"
},
"termName" : "...",
"typeName" : "..."
},
"type" : "..."
}
Retrieve data for the specified fulltext query
| name | type | description | constraints |
|---|---|---|---|
| classification | query | limit the result to only entities tagged with the given classification or or its sub-types | |
| excludeDeletedEntities | query | required | |
| limit | query | limit the result set to only include the specified number of entries | required |
| marker | query | ||
| offset | query | start offset of the result set (useful for pagination) | required |
| query | query | Fulltext query | |
| sortBy | query | ||
| sortOrder | query | "ASCENDING" or "DESCENDING" | |
| typeName | query | limit the result to only entities of specified type or its sub-types |
| code | condition |
|---|---|
| 200 | On successful FullText lookup with some results, might return an empty list if execution succeeded without any results |
| 400 | Invalid fulltext or query parameters |
| media type | data type | description |
|---|---|---|
| application/json | AtlasSearchResult (JSON) | Search results |
| application/json | AtlasSearchResult (JSON) |
GET /v2/search/basic
Content-Type: application/json
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: 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" : "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" : "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" : "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" : "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" : "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" : "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" : "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" : "..."
}
},
"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" : "TWO_TO_ONE",
"status" : "ACTIVE",
"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" : "CONTAINS"
},
"relationshipName" : "...",
"sortBy" : "...",
"sortOrder" : "ASCENDING",
"tagFilters" : {
"attributeName" : "...",
"attributeValue" : "...",
"condition" : "AND",
"criterion" : [ { }, { } ],
"operator" : "IS_NULL"
},
"termName" : "...",
"typeName" : "..."
},
"type" : "..."
}
Attribute based search for entities satisfying the search parameters
| media type | data type | description |
|---|---|---|
| application/json | SearchParameters (JSON) | Search parameters |
| application/json | SearchParameters (JSON) |
| code | condition |
|---|---|
| 200 | On successful search |
| 400 | Tag/Entity doesn't exist or Tag/entity filter is present without tag/type name |
| media type | data type | description |
|---|---|---|
| application/json | AtlasSearchResult (JSON) | Atlas search result |
| application/json | AtlasSearchResult (JSON) |
POST /v2/search/basic
Content-Type: application/json
Accept: application/json
{
"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" : "AND",
"criterion" : [ { }, { } ],
"operator" : "NOT_CONTAINS"
},
"relationshipName" : "...",
"sortBy" : "...",
"sortOrder" : "DESCENDING",
"tagFilters" : {
"attributeName" : "...",
"attributeValue" : "...",
"condition" : "AND",
"criterion" : [ { }, { } ],
"operator" : "IS_NULL"
},
"termName" : "...",
"typeName" : "..."
}
HTTP/1.1 200 OK
Content-Type: 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" : "PROPOSED",
"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" : "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" : "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" : "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" : "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" : "VALIDATED",
"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" : "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" : "BOTH",
"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" : "IS_NULL"
},
"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" : "AND",
"criterion" : [ { }, { } ],
"operator" : "LTE"
},
"termName" : "...",
"typeName" : "..."
},
"type" : "..."
}
Retrieve data for the specified DSL
| name | type | description | constraints |
|---|---|---|---|
| classification | query | limit the result to only entities tagged with the given classification or or its sub-types | |
| limit | query | limit the result set to only include the specified number of entries | required |
| offset | query | start offset of the result set (useful for pagination) | required |
| query | query | DSL query | |
| typeName | query | limit the result to only entities of specified type or its sub-types |
| code | condition |
|---|---|
| 200 | On successful DSL execution with some results, might return an empty list if execution succeeded without any results |
| 400 | Invalid DSL or query parameters |
| media type | data type | description |
|---|---|---|
| application/json | AtlasSearchResult (JSON) | Search results |
| application/json | AtlasSearchResult (JSON) |
GET /v2/search/dsl
Content-Type: application/json
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: 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" : "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" : "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" : "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" : "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" : "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" : "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" : "ACTIVE",
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
}
},
"relations" : [ {
"end1" : {
"guid" : "...",
"typeName" : "...",
"uniqueAttributes" : {
"property1" : { },
"property2" : { }
}
},
"end2" : {
"guid" : "...",
"typeName" : "...",
"uniqueAttributes" : {
"property1" : { },
"property2" : { }
}
},
"guid" : "...",
"label" : "...",
"propagateTags" : "BOTH",
"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" : "AND",
"criterion" : [ { }, { } ],
"operator" : "TIME_RANGE"
},
"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" : "CONTAINS_ANY"
},
"termName" : "...",
"typeName" : "..."
},
"type" : "..."
}
Retrieve data for the specified fulltext query
| name | type | description | constraints |
|---|---|---|---|
| excludeDeletedEntities | query | required | |
| limit | query | limit the result set to only include the specified number of entries | required |
| offset | query | start offset of the result set (useful for pagination) | required |
| query | query | Fulltext query |
| code | condition |
|---|---|
| 200 | On successful FullText lookup with some results, might return an empty list if execution succeeded without any results |
| 400 | Invalid fulltext or query parameters |
| media type | data type | description |
|---|---|---|
| application/json | AtlasSearchResult (JSON) | Search results |
| application/json | AtlasSearchResult (JSON) |
GET /v2/search/fulltext
Content-Type: application/json
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: 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" : "DISCOVERED",
"steward" : "...",
"termGuid" : "..."
} ],
"status" : "DELETED",
"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" : "OBSOLETE",
"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" : "ACTIVE",
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
},
"score" : 12345.0
} ],
"nextMarker" : "...",
"queryText" : "...",
"queryType" : "RELATIONSHIP",
"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" : "VALIDATED",
"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" : "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" : "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" : "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" : "GT"
},
"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" : "DESCENDING",
"tagFilters" : {
"attributeName" : "...",
"attributeValue" : "...",
"condition" : "OR",
"criterion" : [ { }, { } ],
"operator" : "IN"
},
"termName" : "...",
"typeName" : "..."
},
"type" : "..."
}
Attribute based search for entities satisfying the search parameters
| name | type | description | constraints |
|---|---|---|---|
| excludeDeletedEntities | query | required | |
| limit | query | required | |
| offset | query | required | |
| query | query | ||
| sortBy | query | ||
| sortOrder | query | "ASCENDING" or "DESCENDING" | |
| typeName | query |
| code | condition |
|---|---|
| 200 | On successful search |
| 400 | Tag/Entity doesn't exist or Tag/entity filter is present without tag/type name |
| media type | data type | description |
|---|---|---|
| application/json | AtlasQuickSearchResult (JSON) | Atlas search result |
| application/json | AtlasQuickSearchResult (JSON) |
GET /v2/search/quick
Content-Type: application/json
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: 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" : "ATTRIBUTE",
"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" : "ACTIVE",
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
}
},
"relations" : [ {
"end1" : { },
"end2" : { },
"guid" : "...",
"label" : "...",
"propagateTags" : "NONE",
"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" : "..."
}
}
Attribute based search for entities satisfying the search parameters
| media type | data type |
|---|---|
| application/json | QuickSearchParameters (JSON) |
| application/json | QuickSearchParameters (JSON) |
| code | condition |
|---|---|
| 200 | On successful search |
| 400 | Entity/attribute doesn't exist or entity filter is present without type name |
| media type | data type | description |
|---|---|---|
| application/json | AtlasQuickSearchResult (JSON) | Atlas search result |
| application/json | AtlasQuickSearchResult (JSON) |
POST /v2/search/quick
Content-Type: application/json
Accept: application/json
{
"attributes" : [ "...", "..." ],
"entityFilters" : {
"attributeName" : "...",
"attributeValue" : "...",
"condition" : "AND",
"criterion" : [ { }, { } ],
"operator" : "GTE"
},
"excludeDeletedEntities" : true,
"excludeHeaderAttributes" : true,
"includeSubTypes" : true,
"limit" : 12345,
"offset" : 12345,
"query" : "...",
"sortBy" : "...",
"sortOrder" : "ASCENDING",
"typeName" : "..."
}
HTTP/1.1 200 OK
Content-Type: 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" : "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" : "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" : "NONE",
"status" : "DELETED",
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
}, {
"end1" : { },
"end2" : { },
"guid" : "...",
"label" : "...",
"propagateTags" : "TWO_TO_ONE",
"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" : "..."
}
}
Relationship search to search for relations(edges)
| name | type | description | constraints |
|---|---|---|---|
| limit | query | limit the result set to only include the specified number of entries | required |
| marker | query | ||
| offset | query | start offset of the result set (useful for pagination) | required |
| relationshipName | query | AtlasRelationshipType name | |
| sortBy | query | sort the result using this attribute name, default value is 'name' | |
| sortOrder | query | sorting order | "ASCENDING" or "DESCENDING" |
| code | condition |
|---|---|
| 200 | On successful search |
| media type | data type | description |
|---|---|---|
| application/json | AtlasSearchResult (JSON) | Atlas search result |
| application/json | AtlasSearchResult (JSON) |
GET /v2/search/relations
Content-Type: application/json
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: 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" : "PROPOSED",
"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" : "PROPOSED",
"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" : "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" : "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" : "DEPRECATED",
"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" : "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" : "OBSOLETE",
"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" : "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" : "IN"
},
"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" : "ASCENDING",
"tagFilters" : {
"attributeName" : "...",
"attributeValue" : "...",
"condition" : "AND",
"criterion" : [ { }, { } ],
"operator" : "NEQ"
},
"termName" : "...",
"typeName" : "..."
},
"type" : "..."
}
Relationship search to search for relations(edges)
| media type | data type | description |
|---|---|---|
| application/json | RelationshipSearchParameters (JSON) | RelationshipSearchParameters |
| application/json | RelationshipSearchParameters (JSON) |
| code | condition |
|---|---|
| 200 | On successful search |
| media type | data type | description |
|---|---|---|
| application/json | AtlasSearchResult (JSON) | Atlas search result |
| application/json | AtlasSearchResult (JSON) |
POST /v2/search/relations
Content-Type: application/json
Accept: application/json
{
"includeSubTypes" : true,
"limit" : 12345,
"marker" : "...",
"offset" : 12345,
"relationshipFilters" : {
"attributeName" : "...",
"attributeValue" : "...",
"condition" : "OR",
"criterion" : [ { }, { } ],
"operator" : "CONTAINS"
},
"relationshipName" : "...",
"sortBy" : "...",
"sortOrder" : "ASCENDING"
}
HTTP/1.1 200 OK
Content-Type: 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" : "DEPRECATED",
"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" : "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" : "DEPRECATED",
"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" : "DELETED",
"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" : "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" : "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" : "IMPORTED",
"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" : "TWO_TO_ONE",
"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" : "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" : "GTE"
},
"relationshipName" : "...",
"sortBy" : "...",
"sortOrder" : "DESCENDING",
"tagFilters" : {
"attributeName" : "...",
"attributeValue" : "...",
"condition" : "AND",
"criterion" : [ { }, { } ],
"operator" : "LT"
},
"termName" : "...",
"typeName" : "..."
},
"type" : "..."
}
Relationship search to search for related entities satisfying the search parameters
| name | type | description | constraints | multivalued |
|---|---|---|---|---|
| attributes | query | set of attributes in search result. | yes | |
| excludeDeletedEntities | query | required | no | |
| getApproximateCount | query | required | no | |
| guid | query | Attribute name | no | |
| includeClassificationAttributes | query | required | no | |
| limit | query | limit the result set to only include the specified number of entries | required | no |
| offset | query | start offset of the result set (useful for pagination) | required | no |
| relation | query | relationName | no | |
| sortBy | query | sort the result using this attribute name, default value is 'name' | no | |
| sortOrder | query | sorting order | "ASCENDING" or "DESCENDING" | no |
| code | condition |
|---|---|
| 200 | On successful search |
| 400 | guid is not a valid entity type or attributeName is not a valid relationship attribute |
| media type | data type | description |
|---|---|---|
| application/json | AtlasSearchResult (JSON) | Atlas search result |
| application/json | AtlasSearchResult (JSON) |
GET /v2/search/relationship
Content-Type: application/json
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: 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" : "OTHER",
"steward" : "...",
"termGuid" : "..."
}, {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "DEPRECATED",
"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" : "VALIDATED",
"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" : "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" : "ATTRIBUTE",
"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" : "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" : "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" : "..."
}
},
"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" : "ONE_TO_TWO",
"status" : "ACTIVE",
"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" : "AND",
"criterion" : [ { }, { } ],
"operator" : "IS_NULL"
},
"relationshipName" : "...",
"sortBy" : "...",
"sortOrder" : "ASCENDING",
"tagFilters" : {
"attributeName" : "...",
"attributeValue" : "...",
"condition" : "AND",
"criterion" : [ { }, { } ],
"operator" : "NOT_CONTAINS"
},
"termName" : "...",
"typeName" : "..."
},
"type" : "..."
}
| name | type | description |
|---|---|---|
| user | query | User for whom the search is retrieved |
| media type | data type | description |
|---|---|---|
| application/json | array of AtlasUserSavedSearch (JSON) | list of all saved searches for given user |
| application/json | array of AtlasUserSavedSearch (JSON) |
GET /v2/search/saved
Content-Type: application/json
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
[ {
"name" : "...",
"ownerName" : "...",
"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" : "OR",
"criterion" : [ { }, { } ],
"operator" : "NOT_EMPTY"
},
"relationshipName" : "...",
"sortBy" : "...",
"sortOrder" : "ASCENDING",
"tagFilters" : {
"attributeName" : "...",
"attributeValue" : "...",
"condition" : "OR",
"criterion" : [ { }, { } ],
"operator" : "LTE"
},
"termName" : "...",
"typeName" : "..."
},
"searchType" : "BASIC_RELATIONSHIP",
"uiParameters" : "...",
"guid" : "..."
} ]
| media type | data type |
|---|---|
| application/json | AtlasUserSavedSearch (JSON) |
| application/json | AtlasUserSavedSearch (JSON) |
| media type | data type | description |
|---|---|---|
| application/json | AtlasUserSavedSearch (JSON) | the saved search-object |
| application/json | AtlasUserSavedSearch (JSON) |
POST /v2/search/saved
Content-Type: application/json
Accept: 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" : "NOT_CONTAINS"
},
"relationshipName" : "...",
"sortBy" : "...",
"sortOrder" : "ASCENDING",
"tagFilters" : {
"attributeName" : "...",
"attributeValue" : "...",
"condition" : "AND",
"criterion" : [ { }, { } ],
"operator" : "IN"
},
"termName" : "...",
"typeName" : "..."
},
"searchType" : "ADVANCED",
"uiParameters" : "...",
"guid" : "..."
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"name" : "...",
"ownerName" : "...",
"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" : "TIME_RANGE"
},
"relationshipName" : "...",
"sortBy" : "...",
"sortOrder" : "ASCENDING",
"tagFilters" : {
"attributeName" : "...",
"attributeValue" : "...",
"condition" : "AND",
"criterion" : [ { }, { } ],
"operator" : "IS_NULL"
},
"termName" : "...",
"typeName" : "..."
},
"searchType" : "BASIC_RELATIONSHIP",
"uiParameters" : "...",
"guid" : "..."
}
| media type | data type |
|---|---|
| application/json | AtlasUserSavedSearch (JSON) |
| application/json | AtlasUserSavedSearch (JSON) |
| media type | data type | description |
|---|---|---|
| application/json | AtlasUserSavedSearch (JSON) | the updated search-object |
| application/json | AtlasUserSavedSearch (JSON) |
PUT /v2/search/saved
Content-Type: application/json
Accept: application/json
{
"name" : "...",
"ownerName" : "...",
"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" : "CONTAINS_ALL"
},
"relationshipName" : "...",
"sortBy" : "...",
"sortOrder" : "DESCENDING",
"tagFilters" : {
"attributeName" : "...",
"attributeValue" : "...",
"condition" : "OR",
"criterion" : [ { }, { } ],
"operator" : "GT"
},
"termName" : "...",
"typeName" : "..."
},
"searchType" : "ADVANCED",
"uiParameters" : "...",
"guid" : "..."
}
HTTP/1.1 204 No Content
Content-Type: application/json
{
"name" : "...",
"ownerName" : "...",
"searchParameters" : {
"attributes" : [ "...", "..." ],
"classification" : "...",
"entityFilters" : {
"attributeName" : "...",
"attributeValue" : "...",
"condition" : "AND",
"criterion" : [ { }, { } ],
"operator" : "NEQ"
},
"excludeDeletedEntities" : true,
"excludeHeaderAttributes" : true,
"includeClassificationAttributes" : true,
"includeSubClassifications" : true,
"includeSubTypes" : true,
"limit" : 12345,
"marker" : "...",
"offset" : 12345,
"query" : "...",
"relationshipFilters" : {
"attributeName" : "...",
"attributeValue" : "...",
"condition" : "OR",
"criterion" : [ { }, { } ],
"operator" : "STARTS_WITH"
},
"relationshipName" : "...",
"sortBy" : "...",
"sortOrder" : "ASCENDING",
"tagFilters" : {
"attributeName" : "...",
"attributeValue" : "...",
"condition" : "AND",
"criterion" : [ { }, { } ],
"operator" : "CONTAINS_ALL"
},
"termName" : "...",
"typeName" : "..."
},
"searchType" : "BASIC_RELATIONSHIP",
"uiParameters" : "...",
"guid" : "..."
}
| name | type | description |
|---|---|---|
| fieldName | query | |
| prefixString | query |
| media type | data type | description |
|---|---|---|
| application/json | AtlasSuggestionsResult (JSON) | |
| application/json | AtlasSuggestionsResult (JSON) |
GET /v2/search/suggestions
Content-Type: application/json
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"fieldName" : "...",
"prefixString" : "...",
"suggestions" : [ "...", "..." ]
}
| media type | data type | description |
|---|---|---|
| application/json | AtlasSearchResultDownloadStatus (JSON) | |
| application/json | AtlasSearchResultDownloadStatus (JSON) |
GET /v2/search/download/status
Content-Type: application/json
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"searchDownloadRecords" : [ {
"createdBy" : "...",
"createdTime" : 12345,
"fileName" : "...",
"startTime" : 12345,
"status" : "PENDING"
}, {
"createdBy" : "...",
"createdTime" : 12345,
"fileName" : "...",
"startTime" : 12345,
"status" : "COMPLETE"
} ]
}
| name | type | description |
|---|---|---|
| filename | path |
| media type | data type | description |
|---|---|---|
| application/octet-stream | object |
GET /v2/search/download/{filename}
Content-Type: application/json
Accept: application/octet-stream
...
HTTP/1.1 200 OK
Content-Type: application/octet-stream
...
| name | type | description |
|---|---|---|
| guid | path | Name of the saved search |
DELETE /v2/search/saved/{guid}
Content-Type: application/json
...
HTTP/1.1 204 No Content
| name | type | description |
|---|---|---|
| name | path | Name of the saved search |
| user | query | User for whom the search is retrieved |
| media type | data type | description |
|---|---|---|
| application/json | AtlasUserSavedSearch (JSON) | |
| application/json | AtlasUserSavedSearch (JSON) |
GET /v2/search/saved/{name}
Content-Type: application/json
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"name" : "...",
"ownerName" : "...",
"searchParameters" : {
"attributes" : [ "...", "..." ],
"classification" : "...",
"entityFilters" : {
"attributeName" : "...",
"attributeValue" : "...",
"condition" : "AND",
"criterion" : [ { }, { } ],
"operator" : "NEQ"
},
"excludeDeletedEntities" : true,
"excludeHeaderAttributes" : true,
"includeClassificationAttributes" : true,
"includeSubClassifications" : true,
"includeSubTypes" : true,
"limit" : 12345,
"marker" : "...",
"offset" : 12345,
"query" : "...",
"relationshipFilters" : {
"attributeName" : "...",
"attributeValue" : "...",
"condition" : "OR",
"criterion" : [ { }, { } ],
"operator" : "TIME_RANGE"
},
"relationshipName" : "...",
"sortBy" : "...",
"sortOrder" : "ASCENDING",
"tagFilters" : {
"attributeName" : "...",
"attributeValue" : "...",
"condition" : "OR",
"criterion" : [ { }, { } ],
"operator" : "CONTAINS_ANY"
},
"termName" : "...",
"typeName" : "..."
},
"searchType" : "BASIC_RELATIONSHIP",
"uiParameters" : "...",
"guid" : "..."
}
| media type | data type |
|---|---|
| application/json | map of object (JSON) |
| application/json | map of object (JSON) |
POST /v2/search/basic/download/create_file
Content-Type: application/json
...
HTTP/1.1 201 Created
| media type | data type |
|---|---|
| application/json | map of object (JSON) |
| application/json | map of object (JSON) |
POST /v2/search/dsl/download/create_file
Content-Type: application/json
...
HTTP/1.1 201 Created
Attribute based search for entities satisfying the search parameters
| name | type | description |
|---|---|---|
| name | path | name of saved-search |
| user | query | saved-search owner |
| media type | data type | description |
|---|---|---|
| application/json | AtlasSearchResult (JSON) | Atlas search result |
| application/json | AtlasSearchResult (JSON) |
GET /v2/search/saved/execute/{name}
Content-Type: application/json
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: 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" : "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" : "DEPRECATED",
"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" : "BASIC",
"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" : "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" : "PROPOSED",
"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" : "TWO_TO_ONE",
"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" : "PURGED",
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
} ],
"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" : "AND",
"criterion" : [ { }, { } ],
"operator" : "NOT_NULL"
},
"relationshipName" : "...",
"sortBy" : "...",
"sortOrder" : "ASCENDING",
"tagFilters" : {
"attributeName" : "...",
"attributeValue" : "...",
"condition" : "AND",
"criterion" : [ { }, { } ],
"operator" : "STARTS_WITH"
},
"termName" : "...",
"typeName" : "..."
},
"type" : "..."
}
Attribute based search for entities satisfying the search parameters
| name | type | description |
|---|---|---|
| guid | path | Guid identifying saved search |
| media type | data type | description |
|---|---|---|
| application/json | AtlasSearchResult (JSON) | Atlas search result |
| application/json | AtlasSearchResult (JSON) |
GET /v2/search/saved/execute/guid/{guid}
Content-Type: application/json
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: 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" : "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" : "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" : "DELETED",
"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" : "ATTRIBUTE",
"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" : "DEPRECATED",
"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" : "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" : "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" : "ACTIVE",
"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" : "TIME_RANGE"
},
"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" : "DESCENDING",
"tagFilters" : {
"attributeName" : "...",
"attributeValue" : "...",
"condition" : "OR",
"criterion" : [ { }, { } ],
"operator" : "STARTS_WITH"
},
"termName" : "...",
"typeName" : "..."
},
"type" : "..."
}