Document comment time series formats

Document comment time series for Case events are timeSeries JSON objects with attributes, as described in the table and shown in the example.

Table 1. Document comment time series
Attribute Description Optional or required Type
type The type of the event Required The "document-comment" string constant
state The state of the activity event Required The Creation string constant
comment-id The identifier of the comment Required String
comment-text The text of the comment Required String
comment-version The version number of the comment Required String
document-comment-current-version-id The identifier of current version of comment Required String
document-comment-version-series The identifier of version series of comment Required String
document-name The display name of document to which the comment belongs Required String

Example of a document comment time series

{
    "id": "{90BB7E67-0000-C62D-8A1E-C746392794AB}",
    "offset": 34664,
    "partition": 0,
    "timestamp": "2018-12-05T14:18:01.354Z",
    "icm-system-id": "{8D0692D0-4E55-46B2-ABAE-307C88A97089}",
    "content-engine-server": "localhost",
    "emitter-logical-unique-id": "icpTest",
    "object-store-display-name": "tos",
    "object-store-symbolic-name": "tos",
    "object-store-id": "{8D0692D0-4E55-46B2-ABAE-307C88A97089}",
    "p8-domain-name": "myP8Domain",
    "p8-domain-id": "{99370115-636B-4267-B2CE-96471CB4B141}",
    "type": "document-comment",
    "case-instance-id": "{80187E67-0000-CB13-817C-6D0C37132747}",
    "case-instance-name": "000000560001",
    "state": "Creation",
    "comment-id": "{90BB7E67-0000-C016-820F-3EB7D0D37615}",
    "comment-text": "Comment on a document",
    "comment-version": "1544019481354",
    "document-comment-current-version-id": "{D0367E67-0000-C212-BC7A-F896F8F027AD}",
    "document-comment-version-series": "{E0367E67-0000-C616-B474-8A8697F150A8}",
    "parent-instance-id": "{D0367E67-0000-C212-BC7A-F896F8F027AD}",
    "document-name": "sample doc",
    "audit-sequence": 18811,
    "case-folder-id": "{80187E67-0000-CB13-817C-6D0C37132747}",
    "source-class-id": "{72E7C255-F962-43C8-9A08-6184713A298A}",
    "source-class-display-name": "Version Series Comment",
    "case-type-name": "CCDM_CaseST",
    "case-type-display-name": "CaseST",
    "solution-name": "Credit Card Dispute Management",
    "version": "1.0.1",
    "category": "icm",
    "user": "deadmin"
}