diff --git a/docs/actions/events/entity-change-event.md b/docs/actions/events/entity-change-event.md index 27277a97ad..4a7264c20b 100644 --- a/docs/actions/events/entity-change-event.md +++ b/docs/actions/events/entity-change-event.md @@ -219,6 +219,73 @@ This event is emitted when an existing owner has been removed from an entity on } ``` +### Add Structured Property Event + +This event is emitted when a Structured Property has been added to an entity on DataHub. + +#### Sample Event +```json +{ + "entityUrn": "urn:li:dataset:abc", + "entityType": "dataset", + "category": "STRUCTURED_PROPERTY", + "operation": "ADD", + "modifier": "urn:li:structuredProperty:prop1", + "parameters": { + "propertyUrn": "urn:li:structuredProperty:prop1", + "propertyValues": "[\"value1\"]" + }, + "version": 0, + "auditStamp": { + "actor": "urn:li:corpuser:jdoe", + "time": 1649953100653 + } +} +``` + +### Remove Structured Property Event + +This event is emitted when a Structured Property has been removed from an entity on DataHub. + +#### Sample Event +```json +{ + "entityUrn": "urn:li:dataset:abc", + "entityType": "dataset", + "category": "STRUCTURED_PROPERTY", + "operation": "REMOVE", + "modifier": "urn:li:structuredProperty:prop1", + "version": 0, + "auditStamp": { + "actor": "urn:li:corpuser:jdoe", + "time": 1649953100653 + } +} +``` + +### Modify Structured Property Event + +This event is emitted when a Structured Property's values have been modified on an entity in DataHub. + +#### Sample Event +```json +{ + "entityUrn": "urn:li:dataset:abc", + "entityType": "dataset", + "category": "STRUCTURED_PROPERTY", + "operation": "MODIFY", + "modifier": "urn:li:structuredProperty:prop1", + "parameters": { + "propertyUrn": "urn:li:structuredProperty:prop1", + "propertyValues": "[\"value1\",\"value2\"]" + }, + "version": 0, + "auditStamp": { + "actor": "urn:li:corpuser:jdoe", + "time": 1649953100653 + } +} +``` ### Modify Deprecation Event @@ -349,4 +416,4 @@ This event is emitted when a new entity has been hard-deleted on DataHub. "time": 1649953100653 } } -``` \ No newline at end of file +```