Content time series event attributes
The timeseries format flattens the JSON code of the content event so
that it is easier to use by data science tools.
Notation and examples
The dot notation indicates nested fields. For example, data.DateCreated
means the DateCreated field within the data JSON object.
Contents, activities, documents, and comments
| Event part | Description | Optional or required | Type |
|---|---|---|---|
| domainId | The identifier of the CPE domain. This parameter is a 128-bit GUID. | Optional | String |
| version | The time series format version. | Required | String |
| id | The event identifier that is a 128-bit GUID. | Required | String |
| timestamp | The time stamp of this event. | Required | A string that contains an ISO8601 date in this format: yyyy-mm-ddThh:mm:ss.nnn+|-hh:mm |
| type | The type of the event. | Required | String - One of: CREATION or UPDATE or GETCONTENT or DELETION |
| objectStoreId | The identifier of the CPE objectstore that generated this event. This parameter is a 128-bit GUID. | Required | String |
| objectStoreName | The CPE objectstore name. | Required | String |
| domainName | The CPE domain name. | Optional | String |
| trace-id | The trace identifier. | Required if the trace-id and span-id values are set in the raw event context. | String |
| span-id | The span identifier. | Required if the trace-id and span-id values are set in the raw event context. | String |
| sourceId | The identifier of the object that generated this event. This parameter is a 128-bit GUID. | Required | String |
| performerId | The identifier of the user who acted on the event, typically the Creator field on the event. | Required | String |
| performerName | The display name of the user who acted on the event, typically the Creator field on the event. | Required | String |
| data | The business data. Includes system and custom properties from the document. | Required | JSON object |
| data.Owner | The security owner that is assigned to the object. | Optional | String |
| data.IsInExceptionState | Specifies whether the lifecycle state of this document is in an exception state or not. | Optional | Boolean - One of: true or false |
| data.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.ClassDescription | The description of the document class from which this object is instantiated. | Optional | String |
| data.Creator | The name of the user that is assigned as the creator of the object. | Optional | String |
| data.CmIsMarkedForDeletion | Indicates whether the object is marked (flagged) for deletion. | Optional | Boolean - One of: true or false |
| data.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.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.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.Name | The name for this object. | Optional | String |
| data.IsFrozenVersion | Specifies whether this document version is a frozen version or not. | Optional | Boolean - One of: true or false |
| data.MinorVersionNumber | The minor version number of this document version. | Optional | Number |
| data.DocumentTitle | The title of document object. | Optional | String |
| data.LastModifier | The name of the user who last modified this object. | Optional | String |
| data.IsCurrentVersion | Specifies whether this document version is the current (most recent) version object of a document's version series or not. | Optional | Boolean - One of: true or false |
| data.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.IsVersioningEnabled | Specifies whether you can create a new version of this object or not. | Optional | Boolean - One of: true or false |
| data.MajorVersionNumber | The major version number of this document version. | Optional | Number |
| data.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.IsReserved | Specifies whether a user reserved the right to check in the next version after this version or not. | Optional | Boolean - One of: true or false |
| data.VersionSeries | The identifier of the version series for the source object. This parameter is a 128-bit GUID. | Optional | String |
| data.Id | A 128-bit GUID that is assigned to this Content Platform Engine object when the object is created. | Optional | String |