When an article is created, edited or deleted the following data is populated. Articles are regularly saved before they are publish to prevent loss of work. As a result there may be many automatic create and update events raised by the system before the point of publication. If you are interested in the separate publish event see the below 5.2.3 section.
|
Article Template |
{ "id": <int>, "title": <int>, "summary": <string>, "tag":<string>, "articleTypeId": <int>, "priorityId": <int>, "createdAt": <string ISO 8601 Date>, "createdByPersonId":<int>, "modifiedAt": <string ISO 8601 Date>, "modifiedByPersonId":<int>, "isPublished": <bool>, "visibleToEveryone": <bool>, "hideMainImageDetail": <bool>, "contentSettings": <contentSettings see 8.0>, "notificationSettings" : <notificationSettings see 8.0>, "engagement": { "numberOfComments": <int>, "numberOfLikes": <int> }, "articleTags": [], "isDeleted": false } |
Json Schema (for use with MS Power Automate)
{
"type": "object",
"properties": {
"subjectType": {
"type": "string"
},
"changeType": {
"type": "string"
},
"subjectFrontEndUrl": {
"type": "string"
},
"timeStamp": {
"type": "string"
},
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"title": {
"type": "string"
},
"summary": {
"type": "string"
},
"tag": {
"type": "string"
},
"articleTypeId": {
"type": "integer"
},
"priorityId": {
"type": "integer"
},
"createdAt": {
"type": "string"
},
"createdByPerson": {
"type": "object",
"properties": {
"PersonId": {
"type": "integer"
},
"FirstName": {
"type": "string"
},
"FamilyName": {
"type": "string"
},
"Email": {
"type": "string"
}
}
},
"modifiedAt": {
"type": "string"
},
"modifiedByPerson": {
"type": "object",
"properties": {
"PersonId": {
"type": "integer"
},
"FirstName": {
"type": "string"
},
"FamilyName": {
"type": "string"
},
"Email": {
"type": "string"
}
}
},
"pinDurationHours": {
"type": "integer"
},
"isPublished": {
"type": "boolean"
},
"publishedAt": {
"type": "string"
},
"scheduledPublishTime": {
"type": "string"
},
"visibleToEveryone": {
"type": "boolean"
},
"mainImageId": {
"type": "integer"
},
"hideMainImageDetail": {
"type": "boolean"
},
"publishedAsPersonId": {
"type": "integer"
},
"channelId": {
"type": "integer"
},
"channelTitle": {
"type": "string"
},
"feedId": {
"type": "integer"
},
"feedTitle": {
"type": "string"
},
"contentSettings": {
"type": "object",
"properties": {
"allowLikes": {
"type": "boolean"
},
"allowComments": {
"type": "boolean"
},
"allowImagesInComments": {
"type": "boolean"
}
}
},
"notificationSettings": {
"type": "object",
"properties": {
"push": {
"type": "boolean"
},
"sms": {
"type": "boolean"
},
"email": {
"type": "boolean"
},
"microsoftTeams": {
"type": "boolean"
},
"inApp": {
"type": "boolean"
}
}
},
"approvalDetails": {
"type": "object",
"properties": {
"requiresApproval": {
"type": "boolean"
},
"approved": {
"type": "boolean"
},
"approvedByPersonId": {
"type": "integer"
},
"approvedAt": {
"type": "string"
},
"approverPersonIds": {
"type": "array",
"items": {
"type": "integer"
}
}
}
},
"engagement": {
"type": "object",
"properties": {
"numberOfReads": {
"type": "integer"
},
"numberOfComments": {
"type": "integer"
},
"numberOfLikes": {
"type": "integer"
}
}
},
"releatedItems": {
"type": "object",
"properties": {
"surveyId": {
"type": "integer"
},
"taskGroupId": {
"type": "integer"
},
"worksheetId": {
"type": "integer"
}
}
},
"articleTags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"articleId": {
"type": "integer"
},
"tagId": {
"type": "integer"
},
"tag": {
"type": "string"
},
"tagDescription": {
"type": "string"
},
"relatedObjectId": {
"type": "integer"
},
"relatedObjectType": {
"type": "string"
},
"isDeleted": {
"type": "boolean"
}
},
"required": [
"id",
"articleId",
"tagId",
"tag",
"tagDescription",
"relatedObjectId",
"relatedObjectType",
"isDeleted"
]
}
},
"isDeleted": {
"type": "boolean"
}
}
},
"differences": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string"
},
"oldValue": {
"type": "string"
},
"newValue": {
"type": "string"
}
},
"required": [
"path",
"oldValue",
"newValue"
]
}
}
}
}
5.2.3 Article Publish JSON Event Schema
{
"definitions": {
"ArticlePublishDto": {
"type": [
"object",
"null"
],
"properties": {
"Id": {
"type": "integer"
},
"Title": {
"type": [
"string",
"null"
]
},
"Summary": {
"type": [
"string",
"null"
]
},
"Tag": {
"type": [
"string",
"null"
]
},
"PriorityName": {
"type": [
"string",
"null"
]
},
"CreatedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"CreatedByPerson": {
"$ref": "#/definitions/PersonSummaryDto"
},
"ModifiedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"ModifiedByPerson": {
"$ref": "#/definitions/PersonSummaryDto"
},
"PublishedDate": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"AudienceDto": {
"$ref": "#/definitions/AudienceDto"
},
"ArticleContent": {
"type": [
"string",
"null"
]
},
"ArticleContentText": {
"type": [
"string",
"null"
]
},
"MainImageId": {
"type": [
"integer",
"null"
]
}
}
},
"ArticleTagDto": {
"type": [
"object",
"null"
],
"properties": {
"Tag": {
"type": [
"string",
"null"
]
},
"Id": {
"type": "integer"
}
}
},
"AudienceDto": {
"type": [
"object",
"null"
],
"properties": {
"Everyone": {
"type": [
"boolean",
"null"
]
},
"Persons": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/definitions/ArticleTagDto"
}
},
"Sites": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/definitions/ArticleTagDto"
}
},
"Departments": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/definitions/ArticleTagDto"
}
},
"Groups": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/definitions/ArticleTagDto"
}
}
}
},
"Difference": {
"type": [
"object",
"null"
],
"properties": {
"path": {
"type": [
"string",
"null"
]
},
"oldValue": {
"type": [
"string",
"null"
]
},
"newValue": {
"type": [
"string",
"null"
]
}
}
},
"PersonSummaryDto": {
"type": [
"object",
"null"
],
"properties": {
"PersonId": {
"type": "integer"
},
"FirstName": {
"type": [
"string",
"null"
]
},
"FamilyName": {
"type": [
"string",
"null"
]
},
"Email": {
"type": [
"string",
"null"
]
}
}
}
},
"type": "object",
"properties": {
"subjectType": {
"type": [
"string",
"null"
]
},
"changeType": {
"type": [
"string",
"null"
]
},
"subjectFrontEndUrl": {
"type": [
"string",
"null"
]
},
"timeStamp": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"data": {
"$ref": "#/definitions/ArticlePublishDto"
},
"differences": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/definitions/Difference"
}
}
}
}