Document time series formats

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

Table 1. Document time series
Attribute Description Optional or required Type
type The type of the event Required The "document" string constant
state The state of the document event Required A string constant.

Possible values: Creation, Modification, FileIn, FileOut, Deletion.

document-name The display name of the document Required String
document-current-version-id The identifier of the current version of the document Required String
document-current-version-series-id The identifier of the current version series of the document Required String
parent-instance-id The identifier of the case with which this document is associated Required String
parent-instance-name The display name of the case with which this document is associated Required String
data The business data. Present only if case properties are audited. Optional JSON object

Examples of a document time series

{
    "id": "{E0367E67-0100-CA06-9CE9-6AC5A904A1AC}",
    "offset": 13465,
    "partition": 1,
    "timestamp": "2018-12-05T11:53:06.954Z",
    "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",
    "case-instance-id": "{80187E67-0000-CB13-817C-6D0C37132747}",
    "case-instance-name": "000000560001",
    "state": "FileIn",
    "document-name": "sample doc",
    "document-current-version-id": "{D0367E67-0000-C212-BC7A-F896F8F027AD}",
    "document-version-series-id": "{E0367E67-0000-C616-B474-8A8697F150A8}",
    "parent-instance-id": "{80187E67-0000-CB13-817C-6D0C37132747}",
    "parent-instance-name": "000000560001",
    "document-folder-name": "000000560001",
    "audit-sequence": 18810,
    "case-folder-id": "{80187E67-0000-CB13-817C-6D0C37132747}",
    "source-class-id": "{01A3A8C2-7AEC-11D1-A31B-0020AF9FBB1C}",
    "source-class-display-name": "Document",
    "case-type-name": "CCDM_CaseST",
    "case-type-display-name": "CaseST",
    "solution-name": "Credit Card Dispute Management",
    "version": "1.0.1",
    "category": "icm",
    "user": "deadmin",
    "data": {
        "DocumentTitle": "sample doc"
    }
}