356 lines
9.3 KiB
JSON
356 lines
9.3 KiB
JSON
/**
|
|
Feed item should have following fields:
|
|
|
|
id (mandatory) - unique id of feed item (String)
|
|
createDate (mandatory) - timestamp (for ex. 1391090625388), creation time of the update item
|
|
|
|
Feed item usually has information about it's author (system-generated items may not have it):
|
|
|
|
author: {
|
|
userId (mandatory)- user login id (String)
|
|
firstName (mandatory) - first name (String)
|
|
lastName (mandatory) - last name (String)
|
|
thumbnail (optional) - Base64 encoded image (String)
|
|
thumbnailMime (optional) - mime type for thumbnail image (String, for ex. "image/jpeg")
|
|
}
|
|
|
|
Update feed items may be of different types:
|
|
|
|
type (mandatory):
|
|
"comment" - user-created note
|
|
"system" - system-created update
|
|
|
|
Feed item should have information about related domain object:
|
|
|
|
relatedObject: {
|
|
"id": item unique id (String)
|
|
"displayId": item display id (String)
|
|
"title" item title (String)
|
|
"type": item type ("incident", "workorder", "knowledge", "request", "asset", "task", "smart-record", "profile")
|
|
}
|
|
|
|
System updates should have additional data about change event:
|
|
Detailed info on format:
|
|
http://confluence.bmc.com:8080/display/Galileo/Ticket+Timeline#TicketTimeline-JSONformatsystemevents
|
|
|
|
"event" (mandatory for "system" items) : {
|
|
"messageId": message unique id (String, for ex. "48927"),
|
|
"eventType": event type (String, for ex. "assignment-change"),
|
|
"labelTemplate": template for label with placeholders (String, for ex. "Assigned To: {0} by {1}"),
|
|
"entities": array with entities, this info will be used to fill placeholders in label template
|
|
[
|
|
{"type": "person", "displayValue": "Jesse Pinkman", "entityId": "jpinkman"},
|
|
{"type": "person", "displayValue": "Allen Allbrook", "entityId": "Allen"}
|
|
]
|
|
}
|
|
|
|
User-created notes should have additional data about the note:
|
|
|
|
"note" (mandatory for "comment" items): {
|
|
"commentId" : id of an item in AR system
|
|
"message": body of a comment (String)
|
|
"attachmentCount" : amount of attachments (Integer, for ex. 2),
|
|
"commentCount" : amount of comments belonging to this note (Integer, for ex. 3),
|
|
"likeCount": amount of likes (Integer)
|
|
"shareData" : information on shared post, format to be discussed
|
|
}
|
|
|
|
|
|
*/
|
|
|
|
[
|
|
// Update Item (Ticket expiring soon)
|
|
{
|
|
"id": "UPD_FEED_000",
|
|
"type": "system",
|
|
"createDate": 1391090625388,
|
|
"relatedObject": {
|
|
"id": "INC_001",
|
|
"displayId": "INC12123",
|
|
"title": "Unable to connect to VPN",
|
|
"type": "incident"
|
|
},
|
|
"event": {
|
|
"messageId": "48927",
|
|
"eventType": "sla-change",
|
|
"labelTemplate": "{0} Left: {1} for {2}"),
|
|
"entities": [
|
|
{"type": "text", "displayValue": "30m"},
|
|
{"type": "workorder", "displayValue": "WO0000000000125", "entityId": "WO0000000000125"},
|
|
{"type": "person", "displayValue": "Allen Allbrook", "entityId": "Allen"}
|
|
]
|
|
}
|
|
},
|
|
// Update Item (Ticket normal)
|
|
{
|
|
"id": "UPD_FEED_011",
|
|
"type": "system",
|
|
"createDate": 1391090625388,
|
|
"relatedObject": {
|
|
"id": "INC_001123",
|
|
"displayId": "INC12123",
|
|
"title": "Unable to connect to service",
|
|
"type": "incident"
|
|
},
|
|
"event": {
|
|
"messageId": "48927",
|
|
"eventType": "ticket-create",
|
|
"labelTemplate": "Submitted by {0}",
|
|
"entities": [
|
|
{"type": "person", "displayValue": "Walter White", "entityId": "wwhite"}
|
|
]
|
|
}
|
|
},
|
|
// Update Item (New Comment)
|
|
{
|
|
"id": "UPD_FEED_001",
|
|
"type": "comment",
|
|
"createDate": 1391090625388,
|
|
"relatedObject": {
|
|
"id": "INC_001",
|
|
"displayId": "INC12123",
|
|
"title": "Wireless connection failure",
|
|
"type": "incident"
|
|
},
|
|
"author": {
|
|
"id": "USR_001",
|
|
"loginId": "jpinkman",
|
|
"firstName": "Jesse",
|
|
"lastName": "Pinkman",
|
|
"thumbnail": "base64 encoded"
|
|
},
|
|
"note" : {
|
|
"message": "Hey Gus - I looked into that issue with the wireless cart in Unit 34. Walt was making some changes in the lab, accidentally hit the reset button while he was doing a sandwich."
|
|
"attachmentCount" : 0,
|
|
"commentCount" : 0,
|
|
"likeCount": 0,
|
|
"shareData" : {}
|
|
}
|
|
},
|
|
// Update Item (Ticket Update)
|
|
{
|
|
"id": "UPD_FEED_002",
|
|
"type": "system",
|
|
"createDate": 1391090615388,
|
|
"relatedObject": {
|
|
"id": "INC_001",
|
|
"displayId": "INC12123",
|
|
"title": "Wireless connection failure",
|
|
"type": "incident"
|
|
},
|
|
"event": {
|
|
"messageId": "48927",
|
|
"eventType": "status-change",
|
|
"labelTemplate": "Status Marked: {0} by {1}",
|
|
"entities": [
|
|
{"type": "status", "displayValue": "Assigned", "entityId": "assigned" },
|
|
{"type": "person", "displayValue": "Allen Allbrook", "entityId": "Allen"}
|
|
]
|
|
}
|
|
|
|
},
|
|
// Update Item (Priority Update)
|
|
{
|
|
"id": "UPD_FEED_0021",
|
|
"type": "system",
|
|
"createDate": 1391090615388,
|
|
"relatedObject": {
|
|
"id": "INC_001",
|
|
"displayId": "INC12123",
|
|
"title": "Wireless connection failure",
|
|
"type": "incident"
|
|
},
|
|
"event": {
|
|
"messageId": "48927",
|
|
"eventType": "priority-change",
|
|
"labelTemplate": "Priority Marked: {0} by {1}",
|
|
"entities": [
|
|
{"type": "status", "displayValue": "High", "entityId": "high" },
|
|
{"type": "person", "displayValue": "Walter White", "entityId": "wwhite"}
|
|
]
|
|
}
|
|
},
|
|
// Update Item (Assignment Update)
|
|
{
|
|
"id": "UPD_FEED_00221",
|
|
"type": "system",
|
|
"createDate": 1391090615388,
|
|
"relatedObject": {
|
|
"id": "INC_001",
|
|
"displayId": "INC12123",
|
|
"title": "Wireless connection failure",
|
|
"type": "incident"
|
|
},
|
|
"event": {
|
|
"messageId": "48925",
|
|
"eventType": "assignment-change",
|
|
"labelTemplate": "Assigned To: {0} by {1}",
|
|
"entities": [
|
|
{"type": "person", "displayValue": "Jesse Pinkman", "entityId": "jpinkman"},
|
|
{"type": "person", "displayValue": "Allen Allbrook", "entityId": "Allen"}
|
|
]
|
|
}
|
|
},
|
|
// Update Item (Knowledge Article Update)
|
|
{
|
|
"id": "UPD_FEED_003",
|
|
"type": "system",
|
|
"createDate": 1391090615388,
|
|
"relatedObject": {
|
|
"id": "KB_001",
|
|
"displayId": "KB12323",
|
|
"title": "Common VPN Issues",
|
|
"type": "knowledge"
|
|
},
|
|
"event": {
|
|
"messageId": "48935",
|
|
"eventType": "generic-update",
|
|
"labelTemplate": "Edited by {0}",
|
|
"entities": [
|
|
{"type": "person", "displayValue": "Allen Allbrook", "entityId": "Allen"}
|
|
]
|
|
}
|
|
},
|
|
// Update Item (Incident Status Update)
|
|
{
|
|
"id": "UPD_FEED_004",
|
|
"type": "system"
|
|
"createDate": 1391090615388,
|
|
"relatedObject": {
|
|
"id": "INC_001",
|
|
"displayId": "INC12123",
|
|
"title": "Wireless connection failure",
|
|
"type": "incident"
|
|
},
|
|
"event": {
|
|
"messageId": "48927",
|
|
"eventType": "status-change",
|
|
"labelTemplate": "Status Marked: {0} by {1}",
|
|
"entities": [
|
|
{"type": "status", "displayValue": "Resolved", "entityId": "resolved" },
|
|
{"type": "person", "displayValue": "Walter White", "entityId": "wwhite"}
|
|
]
|
|
}
|
|
},
|
|
// Update Item (Asset Update)
|
|
{
|
|
"id": "UPD_FEED_005",
|
|
"type": "system"
|
|
"createDate": 1391090615388,
|
|
"relatedObject": {
|
|
"id": "ASSET_001",
|
|
"displayId": "A1233212",
|
|
"title": "Dell Laptop 209012",
|
|
"type": "asset"
|
|
},
|
|
"event": {
|
|
"messageId": "48935",
|
|
"eventType": "generic-update",
|
|
"labelTemplate": "Updated by {0}",
|
|
"entities": [
|
|
{"type": "person", "displayValue": "Allen Allbrook", "entityId": "Allen"}
|
|
]
|
|
}
|
|
},
|
|
// Update Item (Work Order)
|
|
{
|
|
"id": "UPD_FEED_006",
|
|
"type": "system",
|
|
"createDate": 1391090615388,
|
|
"relatedObject": {
|
|
"id": "WO_1233123",
|
|
"displayId": "WO1233123",
|
|
"title": "Sun Server CPU Upgrade",
|
|
"type": "workorder"
|
|
},
|
|
"event": {
|
|
"messageId": "48945",
|
|
"eventType": "generic-update",
|
|
"labelTemplate": "Submitted by {0}",
|
|
"entities": [
|
|
{"type": "person", "displayValue": "Walter White", "entityId": "wwhite"}
|
|
]
|
|
}
|
|
},
|
|
// Update Item (Service Request)
|
|
{
|
|
"id": "UPD_FEED_007",
|
|
"type": "system"
|
|
"createDate": 1391090615388,
|
|
"relatedObject": {
|
|
"id": "SRQ_1231231",
|
|
"displayId": "SRQ1231231",
|
|
"title": "Server Upgrades",
|
|
"type": "request"
|
|
},
|
|
"event": {
|
|
"messageId": "48945",
|
|
"eventType": "generic-update",
|
|
"labelTemplate": "Submitted by {0}",
|
|
"entities": [
|
|
{"type": "person", "displayValue": "Walter White", "entityId": "wwhite"}
|
|
]
|
|
}
|
|
},
|
|
// Update Item (Profile)
|
|
{
|
|
"id": "UPD_FEED_008",
|
|
"type": "system"
|
|
"createDate": 1391090615388,
|
|
"relatedObject": {
|
|
"id": "TSK_1231231",
|
|
"displayId": "TSK1231231",
|
|
"title": "Run Defrag / Diagnostics",
|
|
"type": "task"
|
|
},
|
|
"event": {
|
|
"messageId": "48945",
|
|
"eventType": "generic-update",
|
|
"labelTemplate": "Submitted by {0}",
|
|
"entities": [
|
|
{"type": "person", "displayValue": "Walter White", "entityId": "wwhite"}
|
|
]
|
|
}
|
|
},
|
|
// Update Item (Smart Record)
|
|
{
|
|
"id": "UPD_FEED_009",
|
|
"type": "system",
|
|
"createDate": 1391090615388,
|
|
"relatedObject": {
|
|
"id": "SMR_1231231",
|
|
"displayId": "SMR1231231",
|
|
"title": "Wireless Failure",
|
|
"type": "smart-record"
|
|
},
|
|
"event": {
|
|
"messageId": "48945",
|
|
"eventType": "generic-update",
|
|
"labelTemplate": "Submitted by {0}",
|
|
"entities": [
|
|
{"type": "person", "displayValue": "Walter White", "entityId": "wwhite"}
|
|
]
|
|
}
|
|
},
|
|
// Update Item (Profile)
|
|
{
|
|
"id": "UPD_FEED_010",
|
|
"type": "system",
|
|
"subType": "generic-update",
|
|
"createDate": 1391090615388,
|
|
"relatedObject": {
|
|
"id": "PRO_1231231",
|
|
"displayId": "PRO1231231",
|
|
"title": "Gus Fring",
|
|
"type": "profile"
|
|
},
|
|
"event": {
|
|
"messageId": "48945",
|
|
"eventType": "generic-update",
|
|
"labelTemplate": "Submitted by {0}",
|
|
"entities": [
|
|
{"type": "person", "displayValue": "Walter White", "entityId": "wwhite"}
|
|
]
|
|
}
|
|
}
|
|
] |