Content raw event attributes

Raw events in the context of content events are JSON objects with attributes.

Notation and examples

The dot notation indicates nested fields. For example, source.type means the type field within the source JSON object.

Contents, activities, documents, and comments

Table 1. Common attributes of content raw events
Event part	Description	Optional or required	Type
business-events-envelope-version	The event format version.	Required	The `"1.0.1"` string
business-events-extension-version	The extension and the version of extension that defines the event format.	Required	The `"content/1.0.0"` string
id	The event identifier. This parameter is a 128-bit GUID.	Required	String
timestamp	The timestamp of this event.	Required	A string that contains an ISO8601 date in this format: yyyy-mm-ddThh:mm:ss.nnn+\|-hh:mm.
category	The category of this event.	Required	String Always: `content:Document`
type	The type of the event.	Required	String - One of: `content:CREATION` or `content:UPDATE` or `content:GETCONTENT` or `content:DELETION`

Table 2. System attributes of content raw events
Event part	Description	Optional or required	Type
system	Information about the system that generated the event.	Required	JSON object
system.id	The identifier of the CPE object store that generated this event. This parameter is a 128-bit GUID.	Required	String
system.content	CPE-specific information about the system.	Required	JSON object
system.content.name	The CPE objectstore name.	Required	String
system.content.host	The CPE hostname, or ip address.	Required	String
system.content.domain	The CPE domain name.	Required	String
system.content.domain-id	The identifier of the CPE domain. This parameter is a 128-bit GUID.	Optional	String

Table 3. Context attributes of content raw events
Event part	Description	Optional or required	Type
context	The correlation information.	Required	JSON object
context.trace-id	The trace identifier.	Required	String
context.span-id	The span identifier.	Required	String

Table 4. Source attributes of content raw events
Event part	Description	Optional or required	Type
source	Information about the source that generated this event.	Required	JSON object
source.id	The identifier of the object that generated this event. This parameter is a 128-bit GUID.	Required	String
source.type	The type of source that generated this event.	Required	String Always: `content:Document`

Table 5. User attributes of content raw events
Event part	Description	Optional or required	Type
user	Information about the user who acted on the event.	Required	JSON object
user.name	The display name of the user who acted on the event, typically the Creator field on the event.	Required	String
user.id	The identifier of the user who acted on the event, typically the Creator field on the event.	Required	String

Table 6. Data attributes of content raw events
Event part	Description	Optional or required	Type
data	The business data.	Optional	JSON object
data.content	Content-specific information about document data. Includes system and custom properties from the document.	Optional	JSON object
data.content.Owner	The security owner assigned to the object.	Optional	String
data.content.IsInExceptionState	Specifies whether the lifecycle state of this document is in an exception state or not.	Optional	Boolean - One of: `true` or `false`
data.content.DateCreated	The date and time the object is created.	Optional	A string that contains an ISO8601 date in this format: yyyy-mm-ddThh:mm:ss.nnn+\|-hh:mm
data.content.ClassDescription	The description of the document class from which this object is instantiated.	Optional	String
data.content.Creator	The name of the user assigned as the creator of the object.	Optional	String
data.content.CmIsMarkedForDeletion	Indicates whether the object is marked (flagged) for deletion.	Optional	Boolean - One of: `true` or `false`
data.content.DateCheckedIn	The date and time that this document is checked in.	Optional	A string that contains an ISO8601 date in this format: yyyy-mm-ddThh:mm:ss.nnn+\|-hh:mm
data.content.VersionStatus	Specifies a VersionStatus constant that indicates the current version status of this document version.	Optional	Number - One of: `1` (RELEASED), `2` (IN_PROCESS), `3` (RESERVATION), `4` (SUPERSEDED)
data.content.DateLastModified	Indicates the date and time the object was last modified.	Optional	A string that contains an ISO8601 date in this format: yyyy-mm-ddThh:mm:ss.nnn+\|-hh:mm
data.content.Name	The name for this object.	Optional	String
data.content.IsFrozenVersion	Specifies whether this document version is a frozen version or not.	Optional	Boolean - One of: `true` or `false`
data.content.MinorVersionNumber	The minor version number of this document version.	Optional	Number
data.content.DocumentTitle	The title of document object.	Optional	String
data.content.LastModifier	The name of the user who last modified this object.	Optional	String
data.content.IsCurrentVersion	Specifies whether this document version is the current (latest) version object of a document's version series or not.	Optional	Boolean - One of: `true` or `false`
data.content.CompoundDocumentState	The setting that determines whether a document can be a parent component in a compound document.	Optional	Number - One of: `0` (COMPOUND_DOCUMENT), `1` (STANDARD_DOCUMENT)
data.content.IsVersioningEnabled	Specifies whether you can create a new version of this object or not.	Optional	Boolean - One of: `true` or `false`
data.content.MajorVersionNumber	The major version number of this document version.	Optional	Number
data.content.ClassificationStatus	Specifies a DocClassificationStatus constant that indicates the auto-classification status for this document.	Optional	Number - One of: `0` (CLASSIFICATION_COMPLETE), `1` (CLASSIFICATION_FAILED), `2` (CLASSIFICATION_PENDING), `3` (NOT_CLASSIFIED)
data.content.IsReserved	Specifies whether a user has reserved the right to check in the next version following this version or not.	Optional	Boolean - One of: `true` or `false`
data.content.VersionSeries	The identifier of the version series for the source object. This parameter is a 128-bit GUID.	Optional	String
data.content.Id	A 128-bit GUID that is assigned to this Content Platform Engine object when the object is created.	Optional	String
data.content.ReservationType	A ReservationType constant that specifies the type of this document reservation (collaborative or exclusive) or whether its reservation type is the same as the default objectstore setting.	Optional	Number - One of: `0` (OBJECT_STORE_DEFAULT), `16` (COLLABORATIVE), `32` (EXCLUSIVE)