REST for a single entity
Create new entity or update existing entity in Atlas. Existing entity is matched using its unique guid if supplied or by its unique attributes eg: qualifiedName
| media type | data type |
|---|---|
| application/json | AtlasEntityWithExtInfo (JSON) |
| application/json | AtlasEntityWithExtInfo (JSON) |
| media type | data type | description |
|---|---|---|
| application/json | EntityMutationResponse (JSON) | EntityMutationResponse |
| application/json | EntityMutationResponse (JSON) |
POST /v2/entity
Content-Type: application/json
Accept: application/json
{
"entity" : {
"businessAttributes" : {
"property1" : { },
"property2" : { }
},
"classifications" : [ {
"entityGuid" : "...",
"entityStatus" : "ACTIVE",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ { }, { } ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
}, {
"entityGuid" : "...",
"entityStatus" : "ACTIVE",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ { }, { } ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
} ],
"createTime" : 12345,
"createdBy" : "...",
"customAttributes" : {
"property1" : "...",
"property2" : "..."
},
"guid" : "...",
"homeId" : "...",
"isIncomplete" : true,
"labels" : [ "...", "..." ],
"meanings" : [ {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "DISCOVERED",
"steward" : "...",
"termGuid" : "..."
}, {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "OBSOLETE",
"steward" : "...",
"termGuid" : "..."
} ],
"pendingTasks" : [ "...", "..." ],
"provenanceType" : 12345,
"proxy" : true,
"relationshipAttributes" : {
"property1" : { },
"property2" : { }
},
"status" : "DELETED",
"updateTime" : 12345,
"updatedBy" : "...",
"version" : 12345,
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
},
"referredEntities" : {
"property1" : {
"businessAttributes" : {
"property1" : { },
"property2" : { }
},
"classifications" : [ {
"entityGuid" : "...",
"entityStatus" : "PURGED",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ { }, { } ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
}, {
"entityGuid" : "...",
"entityStatus" : "PURGED",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ { }, { } ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
} ],
"createTime" : 12345,
"createdBy" : "...",
"customAttributes" : {
"property1" : "...",
"property2" : "..."
},
"guid" : "...",
"homeId" : "...",
"isIncomplete" : true,
"labels" : [ "...", "..." ],
"meanings" : [ {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "OBSOLETE",
"steward" : "...",
"termGuid" : "..."
}, {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "IMPORTED",
"steward" : "...",
"termGuid" : "..."
} ],
"pendingTasks" : [ "...", "..." ],
"provenanceType" : 12345,
"proxy" : true,
"relationshipAttributes" : {
"property1" : { },
"property2" : { }
},
"status" : "DELETED",
"updateTime" : 12345,
"updatedBy" : "...",
"version" : 12345,
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
},
"property2" : {
"businessAttributes" : {
"property1" : { },
"property2" : { }
},
"classifications" : [ {
"entityGuid" : "...",
"entityStatus" : "PURGED",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ { }, { } ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
}, {
"entityGuid" : "...",
"entityStatus" : "PURGED",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ { }, { } ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
} ],
"createTime" : 12345,
"createdBy" : "...",
"customAttributes" : {
"property1" : "...",
"property2" : "..."
},
"guid" : "...",
"homeId" : "...",
"isIncomplete" : true,
"labels" : [ "...", "..." ],
"meanings" : [ {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "DEPRECATED",
"steward" : "...",
"termGuid" : "..."
}, {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "IMPORTED",
"steward" : "...",
"termGuid" : "..."
} ],
"pendingTasks" : [ "...", "..." ],
"provenanceType" : 12345,
"proxy" : true,
"relationshipAttributes" : {
"property1" : { },
"property2" : { }
},
"status" : "PURGED",
"updateTime" : 12345,
"updatedBy" : "...",
"version" : 12345,
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
}
}
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"guidAssignments" : {
"property1" : "...",
"property2" : "..."
},
"mutatedEntities" : {
"property1" : [ {
"classificationNames" : [ "...", "..." ],
"classifications" : [ {
"entityGuid" : "...",
"entityStatus" : "ACTIVE",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ { }, { } ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
}, {
"entityGuid" : "...",
"entityStatus" : "PURGED",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ { }, { } ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
} ],
"displayText" : "...",
"guid" : "...",
"isIncomplete" : true,
"labels" : [ "...", "..." ],
"meaningNames" : [ "...", "..." ],
"meanings" : [ {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "VALIDATED",
"steward" : "...",
"termGuid" : "..."
}, {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "OTHER",
"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" : "IMPORTED",
"steward" : "...",
"termGuid" : "..."
}, {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "VALIDATED",
"steward" : "...",
"termGuid" : "..."
} ],
"status" : "ACTIVE",
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
} ],
"property2" : [ {
"classificationNames" : [ "...", "..." ],
"classifications" : [ {
"entityGuid" : "...",
"entityStatus" : "ACTIVE",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ { }, { } ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
}, {
"entityGuid" : "...",
"entityStatus" : "PURGED",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ { }, { } ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
} ],
"displayText" : "...",
"guid" : "...",
"isIncomplete" : true,
"labels" : [ "...", "..." ],
"meaningNames" : [ "...", "..." ],
"meanings" : [ {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "DEPRECATED",
"steward" : "...",
"termGuid" : "..."
}, {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "DISCOVERED",
"steward" : "...",
"termGuid" : "..."
} ],
"status" : "PURGED",
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
}, {
"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" : "..."
} ]
},
"partialUpdatedEntities" : [ {
"classificationNames" : [ "...", "..." ],
"classifications" : [ {
"entityGuid" : "...",
"entityStatus" : "DELETED",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ { }, { } ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
}, {
"entityGuid" : "...",
"entityStatus" : "ACTIVE",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ { }, { } ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
} ],
"displayText" : "...",
"guid" : "...",
"isIncomplete" : true,
"labels" : [ "...", "..." ],
"meaningNames" : [ "...", "..." ],
"meanings" : [ {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "IMPORTED",
"steward" : "...",
"termGuid" : "..."
}, {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "OBSOLETE",
"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" : "IMPORTED",
"steward" : "...",
"termGuid" : "..."
}, {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "PROPOSED",
"steward" : "...",
"termGuid" : "..."
} ],
"status" : "PURGED",
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
} ]
}
Bulk API to delete list of entities identified by its GUIDs
| name | type | description | multivalued |
|---|---|---|---|
| guid | query | yes |
| media type | data type | description |
|---|---|---|
| application/json | EntityMutationResponse (JSON) | |
| application/json | EntityMutationResponse (JSON) |
DELETE /v2/entity/bulk
Content-Type: application/json
Accept: application/json
...
HTTP/1.1 204 No Content
Content-Type: application/json
{
"guidAssignments" : {
"property1" : "...",
"property2" : "..."
},
"mutatedEntities" : {
"property1" : [ {
"classificationNames" : [ "...", "..." ],
"classifications" : [ {
"entityGuid" : "...",
"entityStatus" : "PURGED",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ { }, { } ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
}, {
"entityGuid" : "...",
"entityStatus" : "DELETED",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ { }, { } ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
} ],
"displayText" : "...",
"guid" : "...",
"isIncomplete" : true,
"labels" : [ "...", "..." ],
"meaningNames" : [ "...", "..." ],
"meanings" : [ {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "IMPORTED",
"steward" : "...",
"termGuid" : "..."
}, {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "PROPOSED",
"steward" : "...",
"termGuid" : "..."
} ],
"status" : "DELETED",
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
}, {
"classificationNames" : [ "...", "..." ],
"classifications" : [ {
"entityGuid" : "...",
"entityStatus" : "ACTIVE",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ { }, { } ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
}, {
"entityGuid" : "...",
"entityStatus" : "DELETED",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ { }, { } ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
} ],
"displayText" : "...",
"guid" : "...",
"isIncomplete" : true,
"labels" : [ "...", "..." ],
"meaningNames" : [ "...", "..." ],
"meanings" : [ {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "DEPRECATED",
"steward" : "...",
"termGuid" : "..."
}, {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "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" : "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" : "ACTIVE",
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
}, {
"classificationNames" : [ "...", "..." ],
"classifications" : [ {
"entityGuid" : "...",
"entityStatus" : "PURGED",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ { }, { } ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
}, {
"entityGuid" : "...",
"entityStatus" : "DELETED",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ { }, { } ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
} ],
"displayText" : "...",
"guid" : "...",
"isIncomplete" : true,
"labels" : [ "...", "..." ],
"meaningNames" : [ "...", "..." ],
"meanings" : [ {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "OTHER",
"steward" : "...",
"termGuid" : "..."
}, {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "IMPORTED",
"steward" : "...",
"termGuid" : "..."
} ],
"status" : "ACTIVE",
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
} ]
},
"partialUpdatedEntities" : [ {
"classificationNames" : [ "...", "..." ],
"classifications" : [ {
"entityGuid" : "...",
"entityStatus" : "DELETED",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ { }, { } ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
}, {
"entityGuid" : "...",
"entityStatus" : "PURGED",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ { }, { } ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
} ],
"displayText" : "...",
"guid" : "...",
"isIncomplete" : true,
"labels" : [ "...", "..." ],
"meaningNames" : [ "...", "..." ],
"meanings" : [ {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "PROPOSED",
"steward" : "...",
"termGuid" : "..."
}, {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "OBSOLETE",
"steward" : "...",
"termGuid" : "..."
} ],
"status" : "ACTIVE",
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
}, {
"classificationNames" : [ "...", "..." ],
"classifications" : [ {
"entityGuid" : "...",
"entityStatus" : "DELETED",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ { }, { } ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
}, {
"entityGuid" : "...",
"entityStatus" : "ACTIVE",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ { }, { } ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
} ],
"displayText" : "...",
"guid" : "...",
"isIncomplete" : true,
"labels" : [ "...", "..." ],
"meaningNames" : [ "...", "..." ],
"meanings" : [ {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "VALIDATED",
"steward" : "...",
"termGuid" : "..."
}, {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "OTHER",
"steward" : "...",
"termGuid" : "..."
} ],
"status" : "PURGED",
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
} ]
}
Bulk API to retrieve list of entities identified by its GUIDs.
| name | type | description | default | constraints | multivalued |
|---|---|---|---|---|---|
| guid | query | yes | |||
| ignoreRelationships | query | false | boolean | no | |
| minExtInfo | query | false | boolean | no |
| media type | data type | description |
|---|---|---|
| application/json | AtlasEntitiesWithExtInfo (JSON) | |
| application/json | AtlasEntitiesWithExtInfo (JSON) |
GET /v2/entity/bulk
Content-Type: application/json
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"entities" : [ {
"businessAttributes" : {
"property1" : { },
"property2" : { }
},
"classifications" : [ {
"entityGuid" : "...",
"entityStatus" : "DELETED",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ { }, { } ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
}, {
"entityGuid" : "...",
"entityStatus" : "ACTIVE",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ { }, { } ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
} ],
"createTime" : 12345,
"createdBy" : "...",
"customAttributes" : {
"property1" : "...",
"property2" : "..."
},
"guid" : "...",
"homeId" : "...",
"isIncomplete" : true,
"labels" : [ "...", "..." ],
"meanings" : [ {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "PROPOSED",
"steward" : "...",
"termGuid" : "..."
}, {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "VALIDATED",
"steward" : "...",
"termGuid" : "..."
} ],
"pendingTasks" : [ "...", "..." ],
"provenanceType" : 12345,
"proxy" : true,
"relationshipAttributes" : {
"property1" : { },
"property2" : { }
},
"status" : "DELETED",
"updateTime" : 12345,
"updatedBy" : "...",
"version" : 12345,
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
}, {
"businessAttributes" : {
"property1" : { },
"property2" : { }
},
"classifications" : [ {
"entityGuid" : "...",
"entityStatus" : "PURGED",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ { }, { } ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
}, {
"entityGuid" : "...",
"entityStatus" : "PURGED",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ { }, { } ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
} ],
"createTime" : 12345,
"createdBy" : "...",
"customAttributes" : {
"property1" : "...",
"property2" : "..."
},
"guid" : "...",
"homeId" : "...",
"isIncomplete" : true,
"labels" : [ "...", "..." ],
"meanings" : [ {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "IMPORTED",
"steward" : "...",
"termGuid" : "..."
}, {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "DISCOVERED",
"steward" : "...",
"termGuid" : "..."
} ],
"pendingTasks" : [ "...", "..." ],
"provenanceType" : 12345,
"proxy" : true,
"relationshipAttributes" : {
"property1" : { },
"property2" : { }
},
"status" : "PURGED",
"updateTime" : 12345,
"updatedBy" : "...",
"version" : 12345,
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
} ],
"referredEntities" : {
"property1" : {
"businessAttributes" : {
"property1" : { },
"property2" : { }
},
"classifications" : [ {
"entityGuid" : "...",
"entityStatus" : "PURGED",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ { }, { } ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
}, {
"entityGuid" : "...",
"entityStatus" : "ACTIVE",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ { }, { } ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
} ],
"createTime" : 12345,
"createdBy" : "...",
"customAttributes" : {
"property1" : "...",
"property2" : "..."
},
"guid" : "...",
"homeId" : "...",
"isIncomplete" : true,
"labels" : [ "...", "..." ],
"meanings" : [ {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "IMPORTED",
"steward" : "...",
"termGuid" : "..."
}, {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "VALIDATED",
"steward" : "...",
"termGuid" : "..."
} ],
"pendingTasks" : [ "...", "..." ],
"provenanceType" : 12345,
"proxy" : true,
"relationshipAttributes" : {
"property1" : { },
"property2" : { }
},
"status" : "PURGED",
"updateTime" : 12345,
"updatedBy" : "...",
"version" : 12345,
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
},
"property2" : {
"businessAttributes" : {
"property1" : { },
"property2" : { }
},
"classifications" : [ {
"entityGuid" : "...",
"entityStatus" : "ACTIVE",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ { }, { } ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
}, {
"entityGuid" : "...",
"entityStatus" : "PURGED",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ { }, { } ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
} ],
"createTime" : 12345,
"createdBy" : "...",
"customAttributes" : {
"property1" : "...",
"property2" : "..."
},
"guid" : "...",
"homeId" : "...",
"isIncomplete" : true,
"labels" : [ "...", "..." ],
"meanings" : [ {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "DEPRECATED",
"steward" : "...",
"termGuid" : "..."
}, {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "VALIDATED",
"steward" : "...",
"termGuid" : "..."
} ],
"pendingTasks" : [ "...", "..." ],
"provenanceType" : 12345,
"proxy" : true,
"relationshipAttributes" : {
"property1" : { },
"property2" : { }
},
"status" : "DELETED",
"updateTime" : 12345,
"updatedBy" : "...",
"version" : 12345,
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
}
}
}
Bulk API to create new entities or updates existing entities in Atlas. Existing entity is matched using its unique guid if supplied or by its unique attributes eg: qualifiedName
| media type | data type |
|---|---|
| application/json | AtlasEntitiesWithExtInfo (JSON) |
| application/json | AtlasEntitiesWithExtInfo (JSON) |
| media type | data type | description |
|---|---|---|
| application/json | EntityMutationResponse (JSON) | |
| application/json | EntityMutationResponse (JSON) |
POST /v2/entity/bulk
Content-Type: application/json
Accept: application/json
{
"entities" : [ {
"businessAttributes" : {
"property1" : { },
"property2" : { }
},
"classifications" : [ {
"entityGuid" : "...",
"entityStatus" : "DELETED",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ { }, { } ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
}, {
"entityGuid" : "...",
"entityStatus" : "DELETED",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ { }, { } ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
} ],
"createTime" : 12345,
"createdBy" : "...",
"customAttributes" : {
"property1" : "...",
"property2" : "..."
},
"guid" : "...",
"homeId" : "...",
"isIncomplete" : true,
"labels" : [ "...", "..." ],
"meanings" : [ {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "VALIDATED",
"steward" : "...",
"termGuid" : "..."
}, {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "PROPOSED",
"steward" : "...",
"termGuid" : "..."
} ],
"pendingTasks" : [ "...", "..." ],
"provenanceType" : 12345,
"proxy" : true,
"relationshipAttributes" : {
"property1" : { },
"property2" : { }
},
"status" : "PURGED",
"updateTime" : 12345,
"updatedBy" : "...",
"version" : 12345,
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
}, {
"businessAttributes" : {
"property1" : { },
"property2" : { }
},
"classifications" : [ {
"entityGuid" : "...",
"entityStatus" : "DELETED",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ { }, { } ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
}, {
"entityGuid" : "...",
"entityStatus" : "PURGED",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ { }, { } ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
} ],
"createTime" : 12345,
"createdBy" : "...",
"customAttributes" : {
"property1" : "...",
"property2" : "..."
},
"guid" : "...",
"homeId" : "...",
"isIncomplete" : true,
"labels" : [ "...", "..." ],
"meanings" : [ {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "DEPRECATED",
"steward" : "...",
"termGuid" : "..."
}, {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "DEPRECATED",
"steward" : "...",
"termGuid" : "..."
} ],
"pendingTasks" : [ "...", "..." ],
"provenanceType" : 12345,
"proxy" : true,
"relationshipAttributes" : {
"property1" : { },
"property2" : { }
},
"status" : "ACTIVE",
"updateTime" : 12345,
"updatedBy" : "...",
"version" : 12345,
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
} ],
"referredEntities" : {
"property1" : {
"businessAttributes" : {
"property1" : { },
"property2" : { }
},
"classifications" : [ {
"entityGuid" : "...",
"entityStatus" : "PURGED",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ { }, { } ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
}, {
"entityGuid" : "...",
"entityStatus" : "DELETED",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ { }, { } ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
} ],
"createTime" : 12345,
"createdBy" : "...",
"customAttributes" : {
"property1" : "...",
"property2" : "..."
},
"guid" : "...",
"homeId" : "...",
"isIncomplete" : true,
"labels" : [ "...", "..." ],
"meanings" : [ {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "IMPORTED",
"steward" : "...",
"termGuid" : "..."
}, {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "PROPOSED",
"steward" : "...",
"termGuid" : "..."
} ],
"pendingTasks" : [ "...", "..." ],
"provenanceType" : 12345,
"proxy" : true,
"relationshipAttributes" : {
"property1" : { },
"property2" : { }
},
"status" : "DELETED",
"updateTime" : 12345,
"updatedBy" : "...",
"version" : 12345,
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
},
"property2" : {
"businessAttributes" : {
"property1" : { },
"property2" : { }
},
"classifications" : [ {
"entityGuid" : "...",
"entityStatus" : "PURGED",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ { }, { } ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
}, {
"entityGuid" : "...",
"entityStatus" : "ACTIVE",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ { }, { } ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
} ],
"createTime" : 12345,
"createdBy" : "...",
"customAttributes" : {
"property1" : "...",
"property2" : "..."
},
"guid" : "...",
"homeId" : "...",
"isIncomplete" : true,
"labels" : [ "...", "..." ],
"meanings" : [ {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "OBSOLETE",
"steward" : "...",
"termGuid" : "..."
}, {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "DEPRECATED",
"steward" : "...",
"termGuid" : "..."
} ],
"pendingTasks" : [ "...", "..." ],
"provenanceType" : 12345,
"proxy" : true,
"relationshipAttributes" : {
"property1" : { },
"property2" : { }
},
"status" : "ACTIVE",
"updateTime" : 12345,
"updatedBy" : "...",
"version" : 12345,
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
}
}
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"guidAssignments" : {
"property1" : "...",
"property2" : "..."
},
"mutatedEntities" : {
"property1" : [ {
"classificationNames" : [ "...", "..." ],
"classifications" : [ {
"entityGuid" : "...",
"entityStatus" : "ACTIVE",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ { }, { } ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
}, {
"entityGuid" : "...",
"entityStatus" : "DELETED",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ { }, { } ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
} ],
"displayText" : "...",
"guid" : "...",
"isIncomplete" : true,
"labels" : [ "...", "..." ],
"meaningNames" : [ "...", "..." ],
"meanings" : [ {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "OBSOLETE",
"steward" : "...",
"termGuid" : "..."
}, {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "OBSOLETE",
"steward" : "...",
"termGuid" : "..."
} ],
"status" : "ACTIVE",
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
}, {
"classificationNames" : [ "...", "..." ],
"classifications" : [ {
"entityGuid" : "...",
"entityStatus" : "ACTIVE",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ { }, { } ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
}, {
"entityGuid" : "...",
"entityStatus" : "PURGED",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ { }, { } ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
} ],
"displayText" : "...",
"guid" : "...",
"isIncomplete" : true,
"labels" : [ "...", "..." ],
"meaningNames" : [ "...", "..." ],
"meanings" : [ {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "DISCOVERED",
"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" : "ACTIVE",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ { }, { } ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
}, {
"entityGuid" : "...",
"entityStatus" : "PURGED",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ { }, { } ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
} ],
"displayText" : "...",
"guid" : "...",
"isIncomplete" : true,
"labels" : [ "...", "..." ],
"meaningNames" : [ "...", "..." ],
"meanings" : [ {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "DEPRECATED",
"steward" : "...",
"termGuid" : "..."
}, {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "DEPRECATED",
"steward" : "...",
"termGuid" : "..."
} ],
"status" : "ACTIVE",
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
}, {
"classificationNames" : [ "...", "..." ],
"classifications" : [ {
"entityGuid" : "...",
"entityStatus" : "PURGED",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ { }, { } ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
}, {
"entityGuid" : "...",
"entityStatus" : "PURGED",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ { }, { } ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
} ],
"displayText" : "...",
"guid" : "...",
"isIncomplete" : true,
"labels" : [ "...", "..." ],
"meaningNames" : [ "...", "..." ],
"meanings" : [ {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "OBSOLETE",
"steward" : "...",
"termGuid" : "..."
}, {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "DISCOVERED",
"steward" : "...",
"termGuid" : "..."
} ],
"status" : "DELETED",
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
} ]
},
"partialUpdatedEntities" : [ {
"classificationNames" : [ "...", "..." ],
"classifications" : [ {
"entityGuid" : "...",
"entityStatus" : "DELETED",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ { }, { } ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
}, {
"entityGuid" : "...",
"entityStatus" : "PURGED",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ { }, { } ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
} ],
"displayText" : "...",
"guid" : "...",
"isIncomplete" : true,
"labels" : [ "...", "..." ],
"meaningNames" : [ "...", "..." ],
"meanings" : [ {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "DISCOVERED",
"steward" : "...",
"termGuid" : "..."
}, {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "PROPOSED",
"steward" : "...",
"termGuid" : "..."
} ],
"status" : "ACTIVE",
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
}, {
"classificationNames" : [ "...", "..." ],
"classifications" : [ {
"entityGuid" : "...",
"entityStatus" : "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" : "OTHER",
"steward" : "...",
"termGuid" : "..."
} ],
"status" : "PURGED",
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
} ]
}
Bulk API to associate a tag to multiple entities. Option 1: List of GUIDs to associate a tag Option 2: Typename and list of uniq attributes for entities to associate a tag Option 3: List of GUIDs and Typename with list of uniq attributes for entities to associate a tag
| media type | data type |
|---|---|
| application/json | ClassificationAssociateRequest (JSON) |
| application/json | ClassificationAssociateRequest (JSON) |
POST /v2/entity/bulk/classification
Content-Type: application/json
{
"classification" : {
"entityGuid" : "...",
"entityStatus" : "DELETED",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ {
"endTime" : "...",
"startTime" : "...",
"timeZone" : "..."
}, {
"endTime" : "...",
"startTime" : "...",
"timeZone" : "..."
} ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
},
"entitiesUniqueAttributes" : [ {
"property1" : { },
"property2" : { }
}, {
"property1" : { },
"property2" : { }
} ],
"entityGuids" : [ "...", "..." ],
"entityTypeName" : "..."
}
HTTP/1.1 201 Created
| name | type | description | constraints |
|---|---|---|---|
| tagUpdateStartTime | query | required |
| media type | data type | description |
|---|---|---|
| application/json | AtlasEntityHeaders (JSON) |
GET /v2/entity/bulk/headers
Content-Type: application/json
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"guidHeaderMap" : {
"property1" : {
"classificationNames" : [ "...", "..." ],
"classifications" : [ {
"entityGuid" : "...",
"entityStatus" : "ACTIVE",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ { }, { } ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
}, {
"entityGuid" : "...",
"entityStatus" : "PURGED",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ { }, { } ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
} ],
"displayText" : "...",
"guid" : "...",
"isIncomplete" : true,
"labels" : [ "...", "..." ],
"meaningNames" : [ "...", "..." ],
"meanings" : [ {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "OBSOLETE",
"steward" : "...",
"termGuid" : "..."
}, {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "PROPOSED",
"steward" : "...",
"termGuid" : "..."
} ],
"status" : "DELETED",
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
},
"property2" : {
"classificationNames" : [ "...", "..." ],
"classifications" : [ {
"entityGuid" : "...",
"entityStatus" : "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" : "..."
}
}
}
| media type | data type |
|---|---|
| application/json | AtlasEntityHeaders (JSON) |
| media type | data type | description |
|---|---|---|
| application/json | string (JSON) |
POST /v2/entity/bulk/setClassifications
Content-Type: application/json
Accept: application/json
{
"guidHeaderMap" : {
"property1" : {
"classificationNames" : [ "...", "..." ],
"classifications" : [ {
"entityGuid" : "...",
"entityStatus" : "DELETED",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ { }, { } ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
}, {
"entityGuid" : "...",
"entityStatus" : "DELETED",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ { }, { } ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
} ],
"displayText" : "...",
"guid" : "...",
"isIncomplete" : true,
"labels" : [ "...", "..." ],
"meaningNames" : [ "...", "..." ],
"meanings" : [ {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "DEPRECATED",
"steward" : "...",
"termGuid" : "..."
}, {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "IMPORTED",
"steward" : "...",
"termGuid" : "..."
} ],
"status" : "DELETED",
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
},
"property2" : {
"classificationNames" : [ "...", "..." ],
"classifications" : [ {
"entityGuid" : "...",
"entityStatus" : "PURGED",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ { }, { } ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
}, {
"entityGuid" : "...",
"entityStatus" : "PURGED",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ { }, { } ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
} ],
"displayText" : "...",
"guid" : "...",
"isIncomplete" : true,
"labels" : [ "...", "..." ],
"meaningNames" : [ "...", "..." ],
"meanings" : [ {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "PROPOSED",
"steward" : "...",
"termGuid" : "..."
}, {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "PROPOSED",
"steward" : "...",
"termGuid" : "..."
} ],
"status" : "DELETED",
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
}
}
}
HTTP/1.1 201 Created
Content-Type: application/json
...
Upload the file for creating Business Metadata in BULK
| name | type | description |
|---|---|---|
| fileDetail | formdata | FormDataContentDisposition metadata of file |
| uploadedInputStream | formdata | InputStream of file |
| media type | data type |
|---|---|
| multipart/form-data | (custom) |
| code | condition |
|---|---|
| 200 | If Business Metadata creation was successful |
| 400 | If Business Metadata definition has invalid or missing information |
| 409 | If Business Metadata already exists (duplicate qualifiedName) |
| media type | data type | description |
|---|---|---|
| application/json | BulkImportResponse (JSON) | |
| application/json | BulkImportResponse (JSON) |
POST /v2/entity/businessmetadata/import
Content-Type: multipart/form-data
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"failedImportInfoList" : [ {
"childObjectName" : "...",
"importStatus" : "SUCCESS",
"parentObjectName" : "...",
"remarks" : "..."
}, {
"childObjectName" : "...",
"importStatus" : "SUCCESS",
"parentObjectName" : "...",
"remarks" : "..."
} ],
"successImportInfoList" : [ {
"childObjectName" : "...",
"importStatus" : "FAILED",
"parentObjectName" : "...",
"remarks" : "..."
}, {
"childObjectName" : "...",
"importStatus" : "FAILED",
"parentObjectName" : "...",
"remarks" : "..."
} ]
}
Delete an entity identified by its GUID.
| name | type | description |
|---|---|---|
| guid | path | GUID for the entity |
| media type | data type | description |
|---|---|---|
| application/json | EntityMutationResponse (JSON) | EntityMutationResponse |
| application/json | EntityMutationResponse (JSON) |
DELETE /v2/entity/guid/{guid}
Content-Type: application/json
Accept: application/json
...
HTTP/1.1 204 No Content
Content-Type: application/json
{
"guidAssignments" : {
"property1" : "...",
"property2" : "..."
},
"mutatedEntities" : {
"property1" : [ {
"classificationNames" : [ "...", "..." ],
"classifications" : [ {
"entityGuid" : "...",
"entityStatus" : "ACTIVE",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ { }, { } ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
}, {
"entityGuid" : "...",
"entityStatus" : "PURGED",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ { }, { } ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
} ],
"displayText" : "...",
"guid" : "...",
"isIncomplete" : true,
"labels" : [ "...", "..." ],
"meaningNames" : [ "...", "..." ],
"meanings" : [ {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "OTHER",
"steward" : "...",
"termGuid" : "..."
}, {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "DEPRECATED",
"steward" : "...",
"termGuid" : "..."
} ],
"status" : "DELETED",
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
}, {
"classificationNames" : [ "...", "..." ],
"classifications" : [ {
"entityGuid" : "...",
"entityStatus" : "PURGED",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ { }, { } ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
}, {
"entityGuid" : "...",
"entityStatus" : "PURGED",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ { }, { } ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
} ],
"displayText" : "...",
"guid" : "...",
"isIncomplete" : true,
"labels" : [ "...", "..." ],
"meaningNames" : [ "...", "..." ],
"meanings" : [ {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "OTHER",
"steward" : "...",
"termGuid" : "..."
}, {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "OTHER",
"steward" : "...",
"termGuid" : "..."
} ],
"status" : "PURGED",
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
} ],
"property2" : [ {
"classificationNames" : [ "...", "..." ],
"classifications" : [ {
"entityGuid" : "...",
"entityStatus" : "ACTIVE",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ { }, { } ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
}, {
"entityGuid" : "...",
"entityStatus" : "PURGED",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ { }, { } ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
} ],
"displayText" : "...",
"guid" : "...",
"isIncomplete" : true,
"labels" : [ "...", "..." ],
"meaningNames" : [ "...", "..." ],
"meanings" : [ {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "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" : "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" : "OTHER",
"steward" : "...",
"termGuid" : "..."
} ],
"status" : "DELETED",
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
} ]
},
"partialUpdatedEntities" : [ {
"classificationNames" : [ "...", "..." ],
"classifications" : [ {
"entityGuid" : "...",
"entityStatus" : "PURGED",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ { }, { } ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
}, {
"entityGuid" : "...",
"entityStatus" : "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" : "PURGED",
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
}, {
"classificationNames" : [ "...", "..." ],
"classifications" : [ {
"entityGuid" : "...",
"entityStatus" : "PURGED",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ { }, { } ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
}, {
"entityGuid" : "...",
"entityStatus" : "DELETED",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ { }, { } ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
} ],
"displayText" : "...",
"guid" : "...",
"isIncomplete" : true,
"labels" : [ "...", "..." ],
"meaningNames" : [ "...", "..." ],
"meanings" : [ {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "DEPRECATED",
"steward" : "...",
"termGuid" : "..."
}, {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "OTHER",
"steward" : "...",
"termGuid" : "..."
} ],
"status" : "DELETED",
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
} ]
}
Fetch complete definition of an entity given its GUID.
| name | type | description | default | constraints |
|---|---|---|---|---|
| guid | path | GUID for the entity | ||
| ignoreRelationships | query | false | boolean | |
| minExtInfo | query | false | boolean |
| media type | data type | description |
|---|---|---|
| application/json | AtlasEntityWithExtInfo (JSON) | AtlasEntity |
| application/json | AtlasEntityWithExtInfo (JSON) |
GET /v2/entity/guid/{guid}
Content-Type: application/json
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"entity" : {
"businessAttributes" : {
"property1" : { },
"property2" : { }
},
"classifications" : [ {
"entityGuid" : "...",
"entityStatus" : "ACTIVE",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ { }, { } ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
}, {
"entityGuid" : "...",
"entityStatus" : "PURGED",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ { }, { } ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
} ],
"createTime" : 12345,
"createdBy" : "...",
"customAttributes" : {
"property1" : "...",
"property2" : "..."
},
"guid" : "...",
"homeId" : "...",
"isIncomplete" : true,
"labels" : [ "...", "..." ],
"meanings" : [ {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "DEPRECATED",
"steward" : "...",
"termGuid" : "..."
}, {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "DEPRECATED",
"steward" : "...",
"termGuid" : "..."
} ],
"pendingTasks" : [ "...", "..." ],
"provenanceType" : 12345,
"proxy" : true,
"relationshipAttributes" : {
"property1" : { },
"property2" : { }
},
"status" : "PURGED",
"updateTime" : 12345,
"updatedBy" : "...",
"version" : 12345,
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
},
"referredEntities" : {
"property1" : {
"businessAttributes" : {
"property1" : { },
"property2" : { }
},
"classifications" : [ {
"entityGuid" : "...",
"entityStatus" : "PURGED",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ { }, { } ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
}, {
"entityGuid" : "...",
"entityStatus" : "DELETED",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ { }, { } ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
} ],
"createTime" : 12345,
"createdBy" : "...",
"customAttributes" : {
"property1" : "...",
"property2" : "..."
},
"guid" : "...",
"homeId" : "...",
"isIncomplete" : true,
"labels" : [ "...", "..." ],
"meanings" : [ {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "OBSOLETE",
"steward" : "...",
"termGuid" : "..."
}, {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "OTHER",
"steward" : "...",
"termGuid" : "..."
} ],
"pendingTasks" : [ "...", "..." ],
"provenanceType" : 12345,
"proxy" : true,
"relationshipAttributes" : {
"property1" : { },
"property2" : { }
},
"status" : "PURGED",
"updateTime" : 12345,
"updatedBy" : "...",
"version" : 12345,
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
},
"property2" : {
"businessAttributes" : {
"property1" : { },
"property2" : { }
},
"classifications" : [ {
"entityGuid" : "...",
"entityStatus" : "DELETED",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ { }, { } ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
}, {
"entityGuid" : "...",
"entityStatus" : "DELETED",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ { }, { } ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
} ],
"createTime" : 12345,
"createdBy" : "...",
"customAttributes" : {
"property1" : "...",
"property2" : "..."
},
"guid" : "...",
"homeId" : "...",
"isIncomplete" : true,
"labels" : [ "...", "..." ],
"meanings" : [ {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "DISCOVERED",
"steward" : "...",
"termGuid" : "..."
}, {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "DISCOVERED",
"steward" : "...",
"termGuid" : "..."
} ],
"pendingTasks" : [ "...", "..." ],
"provenanceType" : 12345,
"proxy" : true,
"relationshipAttributes" : {
"property1" : { },
"property2" : { }
},
"status" : "DELETED",
"updateTime" : 12345,
"updatedBy" : "...",
"version" : 12345,
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
}
}
}
Entity Partial Update - Add/Update entity attribute identified by its GUID. Supports only uprimitive attribute type and entity references. does not support updation of complex types like arrays, maps Null updates are not possible
| name | type | description |
|---|---|---|
| guid | path | |
| name | query |
| media type | data type |
|---|---|
| application/json | object (JSON) |
| application/json | object (JSON) |
| media type | data type | description |
|---|---|---|
| application/json | EntityMutationResponse (JSON) | |
| application/json | EntityMutationResponse (JSON) |
PUT /v2/entity/guid/{guid}
Content-Type: application/json
Accept: application/json
...
HTTP/1.1 204 No Content
Content-Type: application/json
{
"guidAssignments" : {
"property1" : "...",
"property2" : "..."
},
"mutatedEntities" : {
"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" : "DEPRECATED",
"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" : "DELETED",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ { }, { } ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
}, {
"entityGuid" : "...",
"entityStatus" : "ACTIVE",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ { }, { } ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
} ],
"displayText" : "...",
"guid" : "...",
"isIncomplete" : true,
"labels" : [ "...", "..." ],
"meaningNames" : [ "...", "..." ],
"meanings" : [ {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "PROPOSED",
"steward" : "...",
"termGuid" : "..."
}, {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "PROPOSED",
"steward" : "...",
"termGuid" : "..."
} ],
"status" : "PURGED",
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
} ],
"property2" : [ {
"classificationNames" : [ "...", "..." ],
"classifications" : [ {
"entityGuid" : "...",
"entityStatus" : "PURGED",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ { }, { } ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
}, {
"entityGuid" : "...",
"entityStatus" : "ACTIVE",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ { }, { } ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
} ],
"displayText" : "...",
"guid" : "...",
"isIncomplete" : true,
"labels" : [ "...", "..." ],
"meaningNames" : [ "...", "..." ],
"meanings" : [ {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "VALIDATED",
"steward" : "...",
"termGuid" : "..."
}, {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "DISCOVERED",
"steward" : "...",
"termGuid" : "..."
} ],
"status" : "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" : "OBSOLETE",
"steward" : "...",
"termGuid" : "..."
}, {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "OTHER",
"steward" : "...",
"termGuid" : "..."
} ],
"status" : "DELETED",
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
} ]
},
"partialUpdatedEntities" : [ {
"classificationNames" : [ "...", "..." ],
"classifications" : [ {
"entityGuid" : "...",
"entityStatus" : "DELETED",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ { }, { } ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
}, {
"entityGuid" : "...",
"entityStatus" : "DELETED",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ { }, { } ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
} ],
"displayText" : "...",
"guid" : "...",
"isIncomplete" : true,
"labels" : [ "...", "..." ],
"meaningNames" : [ "...", "..." ],
"meanings" : [ {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "OTHER",
"steward" : "...",
"termGuid" : "..."
}, {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "OTHER",
"steward" : "...",
"termGuid" : "..."
} ],
"status" : "DELETED",
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
}, {
"classificationNames" : [ "...", "..." ],
"classifications" : [ {
"entityGuid" : "...",
"entityStatus" : "PURGED",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ { }, { } ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
}, {
"entityGuid" : "...",
"entityStatus" : "PURGED",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ { }, { } ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
} ],
"displayText" : "...",
"guid" : "...",
"isIncomplete" : true,
"labels" : [ "...", "..." ],
"meaningNames" : [ "...", "..." ],
"meanings" : [ {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "OTHER",
"steward" : "...",
"termGuid" : "..."
}, {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "IMPORTED",
"steward" : "...",
"termGuid" : "..."
} ],
"status" : "DELETED",
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
} ]
}
| name | type | description | default | constraints |
|---|---|---|---|---|
| guid | path | |||
| auditAction | query | "BUSINESS_ATTRIBUTE_UPDATE" or "CLASSIFICATION_ADD" or "CLASSIFICATION_DELETE" or "CLASSIFICATION_UPDATE" or "CUSTOM_ATTRIBUTE_UPDATE" or "ENTITY_CREATE" or "ENTITY_DELETE" or "ENTITY_IMPORT_CREATE" or "ENTITY_IMPORT_DELETE" or "ENTITY_IMPORT_UPDATE" or "ENTITY_PURGE" or "ENTITY_UPDATE" or "LABEL_ADD" or "LABEL_DELETE" or "PROPAGATED_CLASSIFICATION_ADD" or "PROPAGATED_CLASSIFICATION_DELETE" or "PROPAGATED_CLASSIFICATION_UPDATE" or "TERM_ADD" or "TERM_DELETE" | ||
| count | query | 100 | short | |
| offset | query | -1 | int | |
| sortBy | query | |||
| sortOrder | query | |||
| startKey | query |
| media type | data type | description |
|---|---|---|
| application/json | array of EntityAuditEventV2 (JSON) | |
| application/json | array of EntityAuditEventV2 (JSON) |
GET /v2/entity/{guid}/audit
Content-Type: application/json
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
[ {
"action" : "LABEL_DELETE",
"details" : "...",
"entity" : {
"businessAttributes" : {
"property1" : { },
"property2" : { }
},
"classifications" : [ {
"entityGuid" : "...",
"entityStatus" : "PURGED",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ { }, { } ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
}, {
"entityGuid" : "...",
"entityStatus" : "ACTIVE",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ { }, { } ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
} ],
"createTime" : 12345,
"createdBy" : "...",
"customAttributes" : {
"property1" : "...",
"property2" : "..."
},
"guid" : "...",
"homeId" : "...",
"isIncomplete" : true,
"labels" : [ "...", "..." ],
"meanings" : [ {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "OBSOLETE",
"steward" : "...",
"termGuid" : "..."
}, {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "PROPOSED",
"steward" : "...",
"termGuid" : "..."
} ],
"pendingTasks" : [ "...", "..." ],
"provenanceType" : 12345,
"proxy" : true,
"relationshipAttributes" : {
"property1" : { },
"property2" : { }
},
"status" : "ACTIVE",
"updateTime" : 12345,
"updatedBy" : "...",
"version" : 12345,
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
},
"entityId" : "...",
"eventKey" : "...",
"timestamp" : 12345,
"type" : "ENTITY_AUDIT_V2",
"user" : "..."
} ]
Get the sample Template for uploading/creating bulk BusinessMetaData
| code | condition |
|---|---|
| 400 | If the provided fileType is not supported |
| media type | data type | description |
|---|---|---|
| application/octet-stream | object | Template File |
GET /v2/entity/businessmetadata/import/template
Content-Type: application/json
Accept: application/octet-stream
...
HTTP/1.1 200 OK
Content-Type: application/octet-stream
...
| name | type | description |
|---|---|---|
| guid | path |
| media type | data type |
|---|---|
| application/json | map of object (JSON) |
DELETE /v2/entity/guid/{guid}/businessmetadata
Content-Type: application/json
...
HTTP/1.1 204 No Content
| name | type | description | default | constraints |
|---|---|---|---|---|
| guid | path | |||
| isOverwrite | query | false | boolean |
| media type | data type |
|---|---|
| application/json | map of object (JSON) |
POST /v2/entity/guid/{guid}/businessmetadata
Content-Type: application/json
...
HTTP/1.1 201 Created
Gets the list of classifications for a given entity represented by a guid.
| name | type | description |
|---|---|---|
| guid | path | globally unique identifier for the entity |
| media type | data type | description |
|---|---|---|
| application/json | AtlasClassifications (JSON) | a list of classifications for the given entity guid |
| application/json | AtlasClassifications (JSON) |
GET /v2/entity/guid/{guid}/classifications
Content-Type: application/json
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"list" : [ { }, { } ],
"pageSize" : 12345,
"sortBy" : "...",
"sortType" : "ASC",
"startIndex" : 12345,
"totalCount" : 12345
}
Adds classifications to an existing entity represented by a guid.
| name | type | description |
|---|---|---|
| guid | path | globally unique identifier for the entity |
| media type | data type |
|---|---|
| application/json | array of AtlasClassification (JSON) |
| application/json | array of AtlasClassification (JSON) |
POST /v2/entity/guid/{guid}/classifications
Content-Type: application/json
[ {
"entityGuid" : "...",
"entityStatus" : "DELETED",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ {
"endTime" : "...",
"startTime" : "...",
"timeZone" : "..."
}, {
"endTime" : "...",
"startTime" : "...",
"timeZone" : "..."
} ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
} ]
HTTP/1.1 201 Created
Updates classifications to an existing entity represented by a guid.
| name | type | description |
|---|---|---|
| guid | path | globally unique identifier for the entity |
| media type | data type |
|---|---|
| application/json | array of AtlasClassification (JSON) |
| application/json | array of AtlasClassification (JSON) |
PUT /v2/entity/guid/{guid}/classifications
Content-Type: application/json
[ {
"entityGuid" : "...",
"entityStatus" : "PURGED",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ {
"endTime" : "...",
"startTime" : "...",
"timeZone" : "..."
}, {
"endTime" : "...",
"startTime" : "...",
"timeZone" : "..."
} ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
} ]
HTTP/1.1 204 No Content
Get entity header given its GUID.
| name | type | description |
|---|---|---|
| guid | path | GUID for the entity |
| media type | data type | description |
|---|---|---|
| application/json | AtlasEntityHeader (JSON) | AtlasEntity |
| application/json | AtlasEntityHeader (JSON) |
GET /v2/entity/guid/{guid}/header
Content-Type: application/json
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"classificationNames" : [ "...", "..." ],
"classifications" : [ {
"entityGuid" : "...",
"entityStatus" : "DELETED",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ {
"endTime" : "...",
"startTime" : "...",
"timeZone" : "..."
}, {
"endTime" : "...",
"startTime" : "...",
"timeZone" : "..."
} ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
}, {
"entityGuid" : "...",
"entityStatus" : "PURGED",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ {
"endTime" : "...",
"startTime" : "...",
"timeZone" : "..."
}, {
"endTime" : "...",
"startTime" : "...",
"timeZone" : "..."
} ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
} ],
"displayText" : "...",
"guid" : "...",
"isIncomplete" : true,
"labels" : [ "...", "..." ],
"meaningNames" : [ "...", "..." ],
"meanings" : [ {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "PROPOSED",
"steward" : "...",
"termGuid" : "..."
}, {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "DISCOVERED",
"steward" : "...",
"termGuid" : "..."
} ],
"status" : "DELETED",
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
}
delete given labels to a given entity
| name | type | description |
|---|---|---|
| guid | path | - Unique entity identifier |
| media type | data type |
|---|---|
| application/json | array of string (JSON) |
DELETE /v2/entity/guid/{guid}/labels
Content-Type: application/json
...
HTTP/1.1 204 No Content
Set labels to a given entity
| name | type | description |
|---|---|---|
| guid | path | - Unique entity identifier |
| media type | data type | description |
|---|---|---|
| application/json | array of string (JSON) | - set of labels to be set to the entity |
POST /v2/entity/guid/{guid}/labels
Content-Type: application/json
...
HTTP/1.1 201 Created
add given labels to a given entity
| name | type | description |
|---|---|---|
| guid | path | - Unique entity identifier |
| media type | data type |
|---|---|
| application/json | array of string (JSON) |
PUT /v2/entity/guid/{guid}/labels
Content-Type: application/json
...
HTTP/1.1 204 No Content
Delete an entity identified by its type and unique attributes.
In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format
attr:
| name | type | description |
|---|---|---|
| typeName | path | - entity type to be deleted |
| media type | data type | description |
|---|---|---|
| application/json | EntityMutationResponse (JSON) | EntityMutationResponse |
| application/json | EntityMutationResponse (JSON) |
DELETE /v2/entity/uniqueAttribute/type/{typeName}
Content-Type: application/json
Accept: application/json
...
HTTP/1.1 204 No Content
Content-Type: application/json
{
"guidAssignments" : {
"property1" : "...",
"property2" : "..."
},
"mutatedEntities" : {
"property1" : [ {
"classificationNames" : [ "...", "..." ],
"classifications" : [ {
"entityGuid" : "...",
"entityStatus" : "DELETED",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ { }, { } ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
}, {
"entityGuid" : "...",
"entityStatus" : "ACTIVE",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ { }, { } ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
} ],
"displayText" : "...",
"guid" : "...",
"isIncomplete" : true,
"labels" : [ "...", "..." ],
"meaningNames" : [ "...", "..." ],
"meanings" : [ {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "OBSOLETE",
"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" : "DELETED",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ { }, { } ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
}, {
"entityGuid" : "...",
"entityStatus" : "PURGED",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ { }, { } ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
} ],
"displayText" : "...",
"guid" : "...",
"isIncomplete" : true,
"labels" : [ "...", "..." ],
"meaningNames" : [ "...", "..." ],
"meanings" : [ {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "IMPORTED",
"steward" : "...",
"termGuid" : "..."
}, {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "PROPOSED",
"steward" : "...",
"termGuid" : "..."
} ],
"status" : "PURGED",
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
} ],
"property2" : [ {
"classificationNames" : [ "...", "..." ],
"classifications" : [ {
"entityGuid" : "...",
"entityStatus" : "PURGED",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ { }, { } ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
}, {
"entityGuid" : "...",
"entityStatus" : "DELETED",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ { }, { } ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
} ],
"displayText" : "...",
"guid" : "...",
"isIncomplete" : true,
"labels" : [ "...", "..." ],
"meaningNames" : [ "...", "..." ],
"meanings" : [ {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "OTHER",
"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" : "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" : "DEPRECATED",
"steward" : "...",
"termGuid" : "..."
} ],
"status" : "PURGED",
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
} ]
},
"partialUpdatedEntities" : [ {
"classificationNames" : [ "...", "..." ],
"classifications" : [ {
"entityGuid" : "...",
"entityStatus" : "PURGED",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ { }, { } ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
}, {
"entityGuid" : "...",
"entityStatus" : "PURGED",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ { }, { } ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
} ],
"displayText" : "...",
"guid" : "...",
"isIncomplete" : true,
"labels" : [ "...", "..." ],
"meaningNames" : [ "...", "..." ],
"meanings" : [ {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "DEPRECATED",
"steward" : "...",
"termGuid" : "..."
}, {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "OBSOLETE",
"steward" : "...",
"termGuid" : "..."
} ],
"status" : "DELETED",
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
}, {
"classificationNames" : [ "...", "..." ],
"classifications" : [ {
"entityGuid" : "...",
"entityStatus" : "PURGED",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ { }, { } ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
}, {
"entityGuid" : "...",
"entityStatus" : "ACTIVE",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ { }, { } ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
} ],
"displayText" : "...",
"guid" : "...",
"isIncomplete" : true,
"labels" : [ "...", "..." ],
"meaningNames" : [ "...", "..." ],
"meanings" : [ {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "PROPOSED",
"steward" : "...",
"termGuid" : "..."
}, {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "OBSOLETE",
"steward" : "...",
"termGuid" : "..."
} ],
"status" : "DELETED",
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
} ]
}
Fetch complete definition of an entity given its type and unique attribute.
In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format
attr:
| name | type | description | default | constraints |
|---|---|---|---|---|
| typeName | path | |||
| ignoreRelationships | query | false | boolean | |
| minExtInfo | query | false | boolean |
| media type | data type | description |
|---|---|---|
| application/json | AtlasEntityWithExtInfo (JSON) | AtlasEntityWithExtInfo |
| application/json | AtlasEntityWithExtInfo (JSON) |
GET /v2/entity/uniqueAttribute/type/{typeName}
Content-Type: application/json
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"entity" : {
"businessAttributes" : {
"property1" : { },
"property2" : { }
},
"classifications" : [ {
"entityGuid" : "...",
"entityStatus" : "ACTIVE",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ { }, { } ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
}, {
"entityGuid" : "...",
"entityStatus" : "PURGED",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ { }, { } ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
} ],
"createTime" : 12345,
"createdBy" : "...",
"customAttributes" : {
"property1" : "...",
"property2" : "..."
},
"guid" : "...",
"homeId" : "...",
"isIncomplete" : true,
"labels" : [ "...", "..." ],
"meanings" : [ {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "OBSOLETE",
"steward" : "...",
"termGuid" : "..."
}, {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "PROPOSED",
"steward" : "...",
"termGuid" : "..."
} ],
"pendingTasks" : [ "...", "..." ],
"provenanceType" : 12345,
"proxy" : true,
"relationshipAttributes" : {
"property1" : { },
"property2" : { }
},
"status" : "DELETED",
"updateTime" : 12345,
"updatedBy" : "...",
"version" : 12345,
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
},
"referredEntities" : {
"property1" : {
"businessAttributes" : {
"property1" : { },
"property2" : { }
},
"classifications" : [ {
"entityGuid" : "...",
"entityStatus" : "PURGED",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ { }, { } ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
}, {
"entityGuid" : "...",
"entityStatus" : "PURGED",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ { }, { } ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
} ],
"createTime" : 12345,
"createdBy" : "...",
"customAttributes" : {
"property1" : "...",
"property2" : "..."
},
"guid" : "...",
"homeId" : "...",
"isIncomplete" : true,
"labels" : [ "...", "..." ],
"meanings" : [ {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "PROPOSED",
"steward" : "...",
"termGuid" : "..."
}, {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "VALIDATED",
"steward" : "...",
"termGuid" : "..."
} ],
"pendingTasks" : [ "...", "..." ],
"provenanceType" : 12345,
"proxy" : true,
"relationshipAttributes" : {
"property1" : { },
"property2" : { }
},
"status" : "DELETED",
"updateTime" : 12345,
"updatedBy" : "...",
"version" : 12345,
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
},
"property2" : {
"businessAttributes" : {
"property1" : { },
"property2" : { }
},
"classifications" : [ {
"entityGuid" : "...",
"entityStatus" : "ACTIVE",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ { }, { } ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
}, {
"entityGuid" : "...",
"entityStatus" : "PURGED",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ { }, { } ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
} ],
"createTime" : 12345,
"createdBy" : "...",
"customAttributes" : {
"property1" : "...",
"property2" : "..."
},
"guid" : "...",
"homeId" : "...",
"isIncomplete" : true,
"labels" : [ "...", "..." ],
"meanings" : [ {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "VALIDATED",
"steward" : "...",
"termGuid" : "..."
}, {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "PROPOSED",
"steward" : "...",
"termGuid" : "..."
} ],
"pendingTasks" : [ "...", "..." ],
"provenanceType" : 12345,
"proxy" : true,
"relationshipAttributes" : {
"property1" : { },
"property2" : { }
},
"status" : "DELETED",
"updateTime" : 12345,
"updatedBy" : "...",
"version" : 12345,
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
}
}
}
Entity Partial Update - Allows a subset of attributes to be updated on
an entity which is identified by its type and unique attribute eg: Referenceable.qualifiedName.
Null updates are not possible
In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format
attr:
| name | type | description |
|---|---|---|
| typeName | path |
| media type | data type |
|---|---|
| application/json | AtlasEntityWithExtInfo (JSON) |
| application/json | AtlasEntityWithExtInfo (JSON) |
| media type | data type | description |
|---|---|---|
| application/json | EntityMutationResponse (JSON) | |
| application/json | EntityMutationResponse (JSON) |
PUT /v2/entity/uniqueAttribute/type/{typeName}
Content-Type: application/json
Accept: application/json
{
"entity" : {
"businessAttributes" : {
"property1" : { },
"property2" : { }
},
"classifications" : [ {
"entityGuid" : "...",
"entityStatus" : "ACTIVE",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ { }, { } ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
}, {
"entityGuid" : "...",
"entityStatus" : "PURGED",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ { }, { } ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
} ],
"createTime" : 12345,
"createdBy" : "...",
"customAttributes" : {
"property1" : "...",
"property2" : "..."
},
"guid" : "...",
"homeId" : "...",
"isIncomplete" : true,
"labels" : [ "...", "..." ],
"meanings" : [ {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "PROPOSED",
"steward" : "...",
"termGuid" : "..."
}, {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "DEPRECATED",
"steward" : "...",
"termGuid" : "..."
} ],
"pendingTasks" : [ "...", "..." ],
"provenanceType" : 12345,
"proxy" : true,
"relationshipAttributes" : {
"property1" : { },
"property2" : { }
},
"status" : "DELETED",
"updateTime" : 12345,
"updatedBy" : "...",
"version" : 12345,
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
},
"referredEntities" : {
"property1" : {
"businessAttributes" : {
"property1" : { },
"property2" : { }
},
"classifications" : [ {
"entityGuid" : "...",
"entityStatus" : "PURGED",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ { }, { } ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
}, {
"entityGuid" : "...",
"entityStatus" : "PURGED",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ { }, { } ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
} ],
"createTime" : 12345,
"createdBy" : "...",
"customAttributes" : {
"property1" : "...",
"property2" : "..."
},
"guid" : "...",
"homeId" : "...",
"isIncomplete" : true,
"labels" : [ "...", "..." ],
"meanings" : [ {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "OTHER",
"steward" : "...",
"termGuid" : "..."
}, {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "DEPRECATED",
"steward" : "...",
"termGuid" : "..."
} ],
"pendingTasks" : [ "...", "..." ],
"provenanceType" : 12345,
"proxy" : true,
"relationshipAttributes" : {
"property1" : { },
"property2" : { }
},
"status" : "ACTIVE",
"updateTime" : 12345,
"updatedBy" : "...",
"version" : 12345,
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
},
"property2" : {
"businessAttributes" : {
"property1" : { },
"property2" : { }
},
"classifications" : [ {
"entityGuid" : "...",
"entityStatus" : "PURGED",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ { }, { } ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
}, {
"entityGuid" : "...",
"entityStatus" : "DELETED",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ { }, { } ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
} ],
"createTime" : 12345,
"createdBy" : "...",
"customAttributes" : {
"property1" : "...",
"property2" : "..."
},
"guid" : "...",
"homeId" : "...",
"isIncomplete" : true,
"labels" : [ "...", "..." ],
"meanings" : [ {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "OBSOLETE",
"steward" : "...",
"termGuid" : "..."
}, {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "DISCOVERED",
"steward" : "...",
"termGuid" : "..."
} ],
"pendingTasks" : [ "...", "..." ],
"provenanceType" : 12345,
"proxy" : true,
"relationshipAttributes" : {
"property1" : { },
"property2" : { }
},
"status" : "PURGED",
"updateTime" : 12345,
"updatedBy" : "...",
"version" : 12345,
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
}
}
}
HTTP/1.1 204 No Content
Content-Type: application/json
{
"guidAssignments" : {
"property1" : "...",
"property2" : "..."
},
"mutatedEntities" : {
"property1" : [ {
"classificationNames" : [ "...", "..." ],
"classifications" : [ {
"entityGuid" : "...",
"entityStatus" : "ACTIVE",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ { }, { } ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
}, {
"entityGuid" : "...",
"entityStatus" : "PURGED",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ { }, { } ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
} ],
"displayText" : "...",
"guid" : "...",
"isIncomplete" : true,
"labels" : [ "...", "..." ],
"meaningNames" : [ "...", "..." ],
"meanings" : [ {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "IMPORTED",
"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" : "OTHER",
"steward" : "...",
"termGuid" : "..."
}, {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "OBSOLETE",
"steward" : "...",
"termGuid" : "..."
} ],
"status" : "DELETED",
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
} ],
"property2" : [ {
"classificationNames" : [ "...", "..." ],
"classifications" : [ {
"entityGuid" : "...",
"entityStatus" : "PURGED",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ { }, { } ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
}, {
"entityGuid" : "...",
"entityStatus" : "DELETED",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ { }, { } ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
} ],
"displayText" : "...",
"guid" : "...",
"isIncomplete" : true,
"labels" : [ "...", "..." ],
"meaningNames" : [ "...", "..." ],
"meanings" : [ {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "VALIDATED",
"steward" : "...",
"termGuid" : "..."
}, {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "VALIDATED",
"steward" : "...",
"termGuid" : "..."
} ],
"status" : "ACTIVE",
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
}, {
"classificationNames" : [ "...", "..." ],
"classifications" : [ {
"entityGuid" : "...",
"entityStatus" : "DELETED",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ { }, { } ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
}, {
"entityGuid" : "...",
"entityStatus" : "DELETED",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ { }, { } ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
} ],
"displayText" : "...",
"guid" : "...",
"isIncomplete" : true,
"labels" : [ "...", "..." ],
"meaningNames" : [ "...", "..." ],
"meanings" : [ {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "OTHER",
"steward" : "...",
"termGuid" : "..."
}, {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "OTHER",
"steward" : "...",
"termGuid" : "..."
} ],
"status" : "DELETED",
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
} ]
},
"partialUpdatedEntities" : [ {
"classificationNames" : [ "...", "..." ],
"classifications" : [ {
"entityGuid" : "...",
"entityStatus" : "ACTIVE",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ { }, { } ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
}, {
"entityGuid" : "...",
"entityStatus" : "PURGED",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ { }, { } ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
} ],
"displayText" : "...",
"guid" : "...",
"isIncomplete" : true,
"labels" : [ "...", "..." ],
"meaningNames" : [ "...", "..." ],
"meanings" : [ {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "VALIDATED",
"steward" : "...",
"termGuid" : "..."
}, {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "VALIDATED",
"steward" : "...",
"termGuid" : "..."
} ],
"status" : "ACTIVE",
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
}, {
"classificationNames" : [ "...", "..." ],
"classifications" : [ {
"entityGuid" : "...",
"entityStatus" : "DELETED",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ { }, { } ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
}, {
"entityGuid" : "...",
"entityStatus" : "PURGED",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ { }, { } ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
} ],
"displayText" : "...",
"guid" : "...",
"isIncomplete" : true,
"labels" : [ "...", "..." ],
"meaningNames" : [ "...", "..." ],
"meanings" : [ {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "DEPRECATED",
"steward" : "...",
"termGuid" : "..."
}, {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "DEPRECATED",
"steward" : "...",
"termGuid" : "..."
} ],
"status" : "PURGED",
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
} ]
}
Bulk API to retrieve list of entities identified by its unique attributes.
In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format
typeName=
| name | type | description | default | constraints |
|---|---|---|---|---|
| typeName | path | |||
| ignoreRelationships | query | false | boolean | |
| minExtInfo | query | false | boolean |
| media type | data type | description |
|---|---|---|
| application/json | AtlasEntitiesWithExtInfo (JSON) | AtlasEntitiesWithExtInfo |
| application/json | AtlasEntitiesWithExtInfo (JSON) |
GET /v2/entity/bulk/uniqueAttribute/type/{typeName}
Content-Type: application/json
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"entities" : [ {
"businessAttributes" : {
"property1" : { },
"property2" : { }
},
"classifications" : [ {
"entityGuid" : "...",
"entityStatus" : "ACTIVE",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ { }, { } ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
}, {
"entityGuid" : "...",
"entityStatus" : "ACTIVE",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ { }, { } ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
} ],
"createTime" : 12345,
"createdBy" : "...",
"customAttributes" : {
"property1" : "...",
"property2" : "..."
},
"guid" : "...",
"homeId" : "...",
"isIncomplete" : true,
"labels" : [ "...", "..." ],
"meanings" : [ {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "DEPRECATED",
"steward" : "...",
"termGuid" : "..."
}, {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "DISCOVERED",
"steward" : "...",
"termGuid" : "..."
} ],
"pendingTasks" : [ "...", "..." ],
"provenanceType" : 12345,
"proxy" : true,
"relationshipAttributes" : {
"property1" : { },
"property2" : { }
},
"status" : "ACTIVE",
"updateTime" : 12345,
"updatedBy" : "...",
"version" : 12345,
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
}, {
"businessAttributes" : {
"property1" : { },
"property2" : { }
},
"classifications" : [ {
"entityGuid" : "...",
"entityStatus" : "PURGED",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ { }, { } ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
}, {
"entityGuid" : "...",
"entityStatus" : "PURGED",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ { }, { } ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
} ],
"createTime" : 12345,
"createdBy" : "...",
"customAttributes" : {
"property1" : "...",
"property2" : "..."
},
"guid" : "...",
"homeId" : "...",
"isIncomplete" : true,
"labels" : [ "...", "..." ],
"meanings" : [ {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "PROPOSED",
"steward" : "...",
"termGuid" : "..."
}, {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "OTHER",
"steward" : "...",
"termGuid" : "..."
} ],
"pendingTasks" : [ "...", "..." ],
"provenanceType" : 12345,
"proxy" : true,
"relationshipAttributes" : {
"property1" : { },
"property2" : { }
},
"status" : "DELETED",
"updateTime" : 12345,
"updatedBy" : "...",
"version" : 12345,
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
} ],
"referredEntities" : {
"property1" : {
"businessAttributes" : {
"property1" : { },
"property2" : { }
},
"classifications" : [ {
"entityGuid" : "...",
"entityStatus" : "DELETED",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ { }, { } ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
}, {
"entityGuid" : "...",
"entityStatus" : "ACTIVE",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ { }, { } ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
} ],
"createTime" : 12345,
"createdBy" : "...",
"customAttributes" : {
"property1" : "...",
"property2" : "..."
},
"guid" : "...",
"homeId" : "...",
"isIncomplete" : true,
"labels" : [ "...", "..." ],
"meanings" : [ {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "IMPORTED",
"steward" : "...",
"termGuid" : "..."
}, {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "DISCOVERED",
"steward" : "...",
"termGuid" : "..."
} ],
"pendingTasks" : [ "...", "..." ],
"provenanceType" : 12345,
"proxy" : true,
"relationshipAttributes" : {
"property1" : { },
"property2" : { }
},
"status" : "PURGED",
"updateTime" : 12345,
"updatedBy" : "...",
"version" : 12345,
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
},
"property2" : {
"businessAttributes" : {
"property1" : { },
"property2" : { }
},
"classifications" : [ {
"entityGuid" : "...",
"entityStatus" : "PURGED",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ { }, { } ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
}, {
"entityGuid" : "...",
"entityStatus" : "PURGED",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ { }, { } ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
} ],
"createTime" : 12345,
"createdBy" : "...",
"customAttributes" : {
"property1" : "...",
"property2" : "..."
},
"guid" : "...",
"homeId" : "...",
"isIncomplete" : true,
"labels" : [ "...", "..." ],
"meanings" : [ {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "PROPOSED",
"steward" : "...",
"termGuid" : "..."
}, {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "IMPORTED",
"steward" : "...",
"termGuid" : "..."
} ],
"pendingTasks" : [ "...", "..." ],
"provenanceType" : 12345,
"proxy" : true,
"relationshipAttributes" : {
"property1" : { },
"property2" : { }
},
"status" : "ACTIVE",
"updateTime" : 12345,
"updatedBy" : "...",
"version" : 12345,
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
}
}
}
| name | type | description |
|---|---|---|
| bmName | path | |
| guid | path |
| media type | data type |
|---|---|
| application/json | map of object (JSON) |
DELETE /v2/entity/guid/{guid}/businessmetadata/{bmName}
Content-Type: application/json
...
HTTP/1.1 204 No Content
| name | type | description |
|---|---|---|
| bmName | path | |
| guid | path |
| media type | data type |
|---|---|
| application/json | map of object (JSON) |
POST /v2/entity/guid/{guid}/businessmetadata/{bmName}
Content-Type: application/json
...
HTTP/1.1 201 Created
Deletes a given classification from an existing entity represented by a guid.
| name | type | description |
|---|---|---|
| classificationName | path | name of the classifcation |
| guid | path | globally unique identifier for the entity |
| associatedEntityGuid | query |
DELETE /v2/entity/guid/{guid}/classification/{classificationName}
Content-Type: application/json
...
HTTP/1.1 204 No Content
Gets the list of classifications for a given entity represented by a guid.
| name | type | description |
|---|---|---|
| classificationName | path | |
| guid | path | globally unique identifier for the entity |
| media type | data type | description |
|---|---|---|
| application/json | AtlasClassification (JSON) | classification for the given entity guid |
| application/json | AtlasClassification (JSON) |
GET /v2/entity/guid/{guid}/classification/{classificationName}
Content-Type: application/json
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"entityGuid" : "...",
"entityStatus" : "PURGED",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ {
"endTime" : "...",
"startTime" : "...",
"timeZone" : "..."
}, {
"endTime" : "...",
"startTime" : "...",
"timeZone" : "..."
} ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
}
Adds classification to the entity identified by its type and unique attributes.
| name | type | description |
|---|---|---|
| typeName | path |
| media type | data type |
|---|---|
| application/json | array of AtlasClassification (JSON) |
| application/json | array of AtlasClassification (JSON) |
POST /v2/entity/uniqueAttribute/type/{typeName}/classifications
Content-Type: application/json
[ {
"entityGuid" : "...",
"entityStatus" : "ACTIVE",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ {
"endTime" : "...",
"startTime" : "...",
"timeZone" : "..."
}, {
"endTime" : "...",
"startTime" : "...",
"timeZone" : "..."
} ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
} ]
HTTP/1.1 201 Created
Updates classification on an entity identified by its type and unique attributes.
| name | type | description |
|---|---|---|
| typeName | path |
| media type | data type |
|---|---|
| application/json | array of AtlasClassification (JSON) |
| application/json | array of AtlasClassification (JSON) |
PUT /v2/entity/uniqueAttribute/type/{typeName}/classifications
Content-Type: application/json
[ {
"entityGuid" : "...",
"entityStatus" : "DELETED",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ {
"endTime" : "...",
"startTime" : "...",
"timeZone" : "..."
}, {
"endTime" : "...",
"startTime" : "...",
"timeZone" : "..."
} ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
} ]
HTTP/1.1 204 No Content
Fetch AtlasEntityHeader given its type and unique attribute.
In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format
attr:
| name | type | description |
|---|---|---|
| typeName | path |
| media type | data type | description |
|---|---|---|
| application/json | AtlasEntityHeader (JSON) | AtlasEntityHeader |
| application/json | AtlasEntityHeader (JSON) |
GET /v2/entity/uniqueAttribute/type/{typeName}/header
Content-Type: application/json
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"classificationNames" : [ "...", "..." ],
"classifications" : [ {
"entityGuid" : "...",
"entityStatus" : "ACTIVE",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ {
"endTime" : "...",
"startTime" : "...",
"timeZone" : "..."
}, {
"endTime" : "...",
"startTime" : "...",
"timeZone" : "..."
} ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
}, {
"entityGuid" : "...",
"entityStatus" : "PURGED",
"propagate" : true,
"removePropagationsOnEntityDelete" : true,
"validityPeriods" : [ {
"endTime" : "...",
"startTime" : "...",
"timeZone" : "..."
}, {
"endTime" : "...",
"startTime" : "...",
"timeZone" : "..."
} ],
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
} ],
"displayText" : "...",
"guid" : "...",
"isIncomplete" : true,
"labels" : [ "...", "..." ],
"meaningNames" : [ "...", "..." ],
"meanings" : [ {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "OTHER",
"steward" : "...",
"termGuid" : "..."
}, {
"confidence" : 12345,
"createdBy" : "...",
"description" : "...",
"displayText" : "...",
"expression" : "...",
"qualifiedName" : "...",
"relationGuid" : "...",
"source" : "...",
"status" : "DISCOVERED",
"steward" : "...",
"termGuid" : "..."
} ],
"status" : "DELETED",
"attributes" : {
"property1" : { },
"property2" : { }
},
"typeName" : "..."
}
| name | type | description |
|---|---|---|
| typeName | path |
| media type | data type |
|---|---|
| application/json | array of string (JSON) |
| application/json | array of string (JSON) |
DELETE /v2/entity/uniqueAttribute/type/{typeName}/labels
Content-Type: application/json
...
HTTP/1.1 204 No Content
| name | type | description |
|---|---|---|
| typeName | path |
| media type | data type |
|---|---|
| application/json | array of string (JSON) |
| application/json | array of string (JSON) |
POST /v2/entity/uniqueAttribute/type/{typeName}/labels
Content-Type: application/json
...
HTTP/1.1 201 Created
| name | type | description |
|---|---|---|
| typeName | path |
| media type | data type |
|---|---|
| application/json | array of string (JSON) |
| application/json | array of string (JSON) |
PUT /v2/entity/uniqueAttribute/type/{typeName}/labels
Content-Type: application/json
...
HTTP/1.1 204 No Content
Deletes a given classification from an entity identified by its type and unique attributes.
| name | type | description |
|---|---|---|
| classificationName | path | name of the classification |
| typeName | path |
DELETE /v2/entity/uniqueAttribute/type/{typeName}/classification/{classificationName}
Content-Type: application/json
...
HTTP/1.1 204 No Content