Stage summary event formats

Stage summary events are JSON objects that result from the aggregation of time series.

Table 1. Stage summary attributes
Attribute	Description	Optional or required	Type
case-folder-id	The identifier of the case folder to which the case stage belongs	Required	String
category	The category of the event	Required	The `icm` string constant
case-instance-id	The identifier of the case instance to which the case stage belongs	Required	String
case-instance-name	The name of the case instance to which the case stage belongs	Required	String
stage-id	The identifier of the case stage	Required	String
stage-name	The name of the case stage	Required	String
stage-type-display-name	The display name of the case stage	Required	String
stage-start-time	Indicates the latest time when the stage was started	Optional	Date
stage-restart-time	The timestamp when the stage was started last time.	Optional	A string that contains an ISO8601 date
stage-due-date	Indicates the time when the stage is expected to complete	Optional	Date
stage-total-run-time	Indicates the total number of minutes already spent in this stage	Optional	Number
stage-current-onhold-time	Indicates the number of minutes the stage was put on hold recently	Optional	Number
stage-restart-count	Indicates the number of time the stage is started	Required	Number
type	The type of the case stage summary	Required	The task string constant
state	The state of the case stage, based on the latest aggregated event	Required	A string constant. Possible values: Active, Completed
case-type-name	The name of the case type to which the case stage belongs	Required	String
case-type-display-name	The display name of the case type to which the case stage belongs	Required	String
source-class-id	The identifier of the source class of the case stage	Required	String
source-class-display-name	The display name of the source class of the case stage	Required	String
solution-name	The name of the solution to which the case stage belongs	Required	String
timestamp	The timestamp of the last aggregated event to produce this summary	Required	A string that contains an ISO8601 date
version	The version number of the case stage summary	Required	String
start-time	The time at which the case stage started	Required	A string that contains an ISO8601 date
start-time-quarter	The year quarter that contains the start-time value	Required	Number
end-time	The time at which the last case activity event was received	Required	A string that contains an ISO8601 date
end-time-quarter	The year quarter that contains the end-time value	Required	Number
user	Last modified or updated user	Required	String
duration-seconds	The case stage duration, in seconds. Present if the difference between the start-time value and end-time value can be computed.	Optional	Number

Example of a stage summary


{
    "case-folder-id": "{C030C970-0000-C11D-B2D6-B3147223A7E3}",
    "category": "icm",
    "case-instance-id": "{C030C970-0000-C11D-B2D6-B3147223A7E3}",
    "case-instance-name": "000000120001",
    "stage-id": "{C030C970-0100-C98E-BDF6-57CDB216C862}",
    "stage-name": "Stage2",
    "stage-type-display-name": "Stage",
    "type": "stage",
    "state": "Complete",
    "case-type-name": "SOL1_CT1",
    "case-type-display-name": "CT1",
    "stage-due-date": "2020-03-13T11:45:57.306Z",
    "start-time": "2020-03-11T11:32:57.306Z",
    "end-time": "2020-03-11T12:02:43.257Z",
    "stage-total-run-time": 16,
    "stage-restart-count": 1,
    "source-class-id": "{FAC305A7-5264-41CD-B3CF-14383172EC1D}",
    "source-class-display-name": "Stage",
    "solution-name": "My Solution",
    "timestamp": "2020-03-11T12:02:43.257Z",
    "user": "intgpeadmin",
    "version": "1.0.2",
    "icm-system-id": "{3279D638-31FA-466B-98BC-D9425EC4AFA3}",
    "content-engine-server": "syncope1.fyre.ibm.com",
    "emitter-logical-unique-id": "unittest",
    "object-store-display-name": "TOS",
    "object-store-symbolic-name": "TOS",
    "object-store-id": "{3279D638-31FA-466B-98BC-D9425EC4AFA3}",
    "p8-domain-name": "CPE",
    "p8-domain-id": "{EE3082AC-31C2-44F2-9809-EB752869C23F}",
    "duration-seconds": 16
  }