post https://developer.interactgo.com/api/page/composer
This endpoint allows the user to create and publish a build page.
In order to publish a page, the authenticated user must have at least published author permission to the Top Section id and each of the categories specified.
Use the following payload as the body:
{
"Transition": {
"State": "published",
"Message": "version message",
"sendnotifications": false, // Optional - if NotificationRecipients should be notified of page creation
"NotificationMessage": "Notification Message goes here" // Optional - message to sent to recipients
},
"Page": {
"ContentType" : "html", // content type can be one of these three: "html" / "link" / "upload"
"TopSectionIds": [3061],
"AuthorId": 342,
"PublishAsId": null,
"AssetId": 250237,
"Title": "test Page",
"Summary": "jk page summary ",
"Content": {
"Html":"<p>Content < things > here.<span class=\"mentionhighlight\" ///contenteditable=\"false\" data-personid=\"281\" ////data-type=\"Person\" href=\"#\">James Harris</span><span> </span></p>"
},
"CategoryIds": [3090],
"Features": {
"DefaultToFullWidth": false,
"AllowComments": false,
"IsKeyPage": false,
"Recommends": {
"Show": true,
"MaxContentAge": 7
}
},
"Audience": {
"RelatedContent": [
{
"Id": 1392,
"Title": "UK Office",
"ReverseLink": true
},
{
"Id": 1393,
"Title": "UK News",
"ReverseLink": false
}
],
"NotificationRecipients": [
{
"Id": 265,
"Name": null,
"Type": "Person",
"IsPerson": true
},
{
"Id": 266,
"Name": null,
"Type": "Person",
"IsPerson": true
}
]
},
"ComposerAttachments": {
"Files": [
{
"Title": "jon-asleeb-unsplash.jpg",
"Path": "/Utilities/Uploads/Handler/Uploader.ashx?area=composer&filename=jon-asleeb-unsplash.jpg&fileguid=3f6528e2-8d7f-48ec-8cea-26f1d6f5055e",
"Target": "_blank",
"GoStraightToTarget": false,
"FileGuid": "3f6528e2-8d7f-48ec-8cea-26f1d6f5055e",
"FileSize": 2086413,
"Extension": ".jpg"
}
]
},
"PubStartDate":"2021-08-05T11:10:46.3486271Z",
"PubEndDate":"2022-08-12T11:10:46.3486271Z",
"ReviewDate":"2031-08-12T11:10:46.3486271Z",
"TagIds": [],
"Keywords": ["Postman"],
"Blocks":{}
}
}
{
"Transition": {
"State": "published",
"Message": "version message",
"sendnotifications": true, // if NotificationRecipients should be notified of page creation
"NotificationMessage": "Notification Message goes here" // Optional - message to sent to recipients
},
"Page": {
"ContentType" : "link", // content type can be one of these three: "html" / "link" / "upload"
"TopSectionIds": [3061],
"AuthorId": 342,
"PublishAsId": null,
"AssetId": 250237,
"Title": "test Page",
"Summary": "jk page summary ",
"Content": {
"Link": {
"Title": "title of link from api",
"Address": "https://www.bbc.co.uk",
"Target": "_self",
"GoStraightToTarget": true
}
},
"CategoryIds": [3090],
"Features": {
"DefaultToFullWidth": false,
"AllowComments": false,
"IsKeyPage": false,
"Recommends": {
"Show": true,
"MaxContentAge": 7
}
},
"Audience": {
"RelatedContent": [
{
"Id": 1392,
"Title": "UK Office",
"ReverseLink": true
},
{
"Id": 1393,
"Title": "UK News",
"ReverseLink": false
}
],
"NotificationRecipients": [
{
"Id": 265,
"Name": null,
"Type": "Person",
"IsPerson": true
},
{
"Id": 266,
"Name": null,
"Type": "Person",
"IsPerson": true
}
]
"ComposerAttachments": {
"Links": [
{
"Title": "ManualLink",
"Path": http://www.google.co.uk,
"Target": "_blank",
"GoStraightToTarget": false,
"FileGuid": "",
"FileSize": 0,
"Extension": null
}
]
}
},
"ComposerAttachments": {
"Files": [
{
"Title": "ManualLink,
"Path": "https://google.com",
"Target": "_blank",
"GoStraightToTarget": false,
"FileGuid": "",
"FileSize": 0,
"Extension": null
}
]
},
"PubStartDate":"2021-08-05T11:10:46.3486271Z",
"PubEndDate":"2022-08-12T11:10:46.3486271Z",
"ReviewDate":"2031-08-12T11:10:46.3486271Z",
"TagIds": [],
"Keywords": ["Postman"]
}
}
{
"Transition": {
"State": "published",
"Message": "version message",
"sendnotifications": true, // if NotificationRecipients should be notified of page creation
"NotificationMessage": "Notification Message goes here" // Optional - message to sent to recipients
},
"Page": {
"ContentType" : "upload", // content type can be one of these three: "html" / "link" / "upload"
"TopSectionIds": [3061],
"AuthorId": 342,
"PublishAsId": null,
"AssetId": 250237,
"Title": "Regression - upload page 11/08 ",
"Summary": "jk page summary ",
"Content": {
"Upload": {
"FileGuid": "6bd1d124-1037-42bf-9c0f-748ad73e3377",
"Title": "BMP IMAGES.jpg",
"FileSize":61957,
"Extension": ".jpg",
"Address": "/Utilities/Uploads/Handler/Uploader.ashx?area=composer&filename=BMP IMAGES.jpg&fileguid=6bd1d124-1037-42bf-9c0f-748ad73e3377",
"DisableDownload": false,
"GoStraightToTarget": false
}
},
"CategoryIds": [3090],
"Features": {
"DefaultToFullWidth": false,
"AllowComments": false,
"IsKeyPage": false,
"Recommends": {
"Show": true,
"MaxContentAge": 7
}
},
"Audience": {
"RelatedContent": [
{
"Id": 1392,
"Title": "UK Office",
"ReverseLink": true
},
{
"Id": 1393,
"Title": "UK News",
"ReverseLink": false
}
],
"NotificationRecipients": [
{
"Id": 265,
"Name": null,
"Type": "Person",
"IsPerson": true
},
{
"Id": 266,
"Name": null,
"Type": "Person",
"IsPerson": true
}
]
},
"ComposerAttachments": {
"Files": [
{
"Title": "jon-asleeb-unsplash.jpg",
"Path": "/Utilities/Uploads/Handler/Uploader.ashx?area=composer&filename=jon-asleeb-unsplash.jpg&fileguid=3f6528e2-8d7f-48ec-8cea-26f1d6f5055e",
"Target": "_blank",
"GoStraightToTarget": false,
"FileGuid": "3f6528e2-8d7f-48ec-8cea-26f1d6f5055e",
"FileSize": 2086413,
"Extension": ".jpg"
}
]
},
"PubStartDate":"2021-08-05T11:10:46.3486271Z",
"PubEndDate":"2022-08-12T11:10:46.3486271Z",
"ReviewDate":"2031-08-12T11:10:46.3486271Z",
"TagIds": [],
"Keywords": ["Postman"]
}
}
{
"Transition": {
"Message": "string",
"State": "string",
"UserIds": [
0
],
"ResendMentions": true,
"SendNotifications": true,
"NotificationMessage": "string"
},
"Page": {
"AuthorId": 0,
"PublishAsId": 0,
"CategoryIds": [
0
],
"TagIds": [
0
],
"Keywords": [
"string"
],
"ComposerAttachment": {
"AttachmentId": 0,
"Title": "string",
"UploadTitle": "string",
"Url": "string",
"Path": "string",
"PathUpload": "string",
"PathLink": "string",
"Target": "string",
"GoStraightToTarget": true,
"FileGuid": "string",
"FileSize": 0,
"Extension": "string",
"IconClass": "string",
"TitleWithSize": "string",
"BinaryData": "string",
"TypeId": 0,
"ObjectTypeId": "Content",
"ObjectId": 0,
"Version": 0,
"Main": true,
"Index": "string",
"TargetOptions": [
{
"Disabled": true,
"Group": {
"Disabled": true,
"Name": "string"
},
"Selected": true,
"Text": "string",
"Value": "string"
}
]
},
"ComposerAttachments": {
"Links": [
{
"AttachmentId": 0,
"Title": "string",
"UploadTitle": "string",
"Url": "string",
"Path": "string",
"PathUpload": "string",
"PathLink": "string",
"Target": "string",
"GoStraightToTarget": true,
"FileGuid": "string",
"FileSize": 0,
"Extension": "string",
"IconClass": "string",
"TitleWithSize": "string",
"BinaryData": "string",
"TypeId": 0,
"ObjectTypeId": "Content",
"ObjectId": 0,
"Version": 0,
"Main": true,
"Index": "string",
"TargetOptions": [
{
"Disabled": true,
"Group": {
"Disabled": true,
"Name": "string"
},
"Selected": true,
"Text": "string",
"Value": "string"
}
]
}
],
"Files": [
{
"AttachmentId": 0,
"Title": "string",
"UploadTitle": "string",
"Url": "string",
"Path": "string",
"PathUpload": "string",
"PathLink": "string",
"Target": "string",
"GoStraightToTarget": true,
"FileGuid": "string",
"FileSize": 0,
"Extension": "string",
"IconClass": "string",
"TitleWithSize": "string",
"BinaryData": "string",
"TypeId": 0,
"ObjectTypeId": "Content",
"ObjectId": 0,
"Version": 0,
"Main": true,
"Index": "string",
"TargetOptions": [
{
"Disabled": true,
"Group": {
"Disabled": true,
"Name": "string"
},
"Selected": true,
"Text": "string",
"Value": "string"
}
]
}
]
},
"TopSectionIds": [
0
],
"AssetId": 0,
"ContentType": "string",
"Title": "string",
"Summary": "string",
"Content": {
"Html": "string",
"Link": {
"Title": "string",
"Address": "string",
"Target": "string",
"GoStraightToTarget": true,
"FileGuid": "string",
"FileSize": 0,
"Extension": "string",
"DisableDownload": true
},
"Upload": {
"Title": "string",
"Address": "string",
"Target": "string",
"GoStraightToTarget": true,
"FileGuid": "string",
"FileSize": 0,
"Extension": "string",
"DisableDownload": true
}
},
"Features": {
"DefaultToFullWidth": true,
"AllowComments": true,
"IsKeyPage": true,
"Recommends": {
"Show": true,
"MaxContentAge": 0
},
"IsMandatoryRead": true
},
"Audience": {
"RelatedContent": [ // RELEATED CONTENT - ID of page / document, title of link / page to appear and whether it reverse links or not
{
"Id": 0,
"Title": "string",
"ReverseLink": true
}
],
"NotificationRecipients": [ // TARGETED AUDIENCE - the Id is either personId or organisationId depending on IsPerson or not
{
"Id": 0,
"Name": "string",
"Type": "string",
"IsPerson": true
}
]
},
"PubStartDate": "2021-08-12T10:15:29.688Z",
"PubEndDate": "2021-08-12T10:15:29.688Z",
"ReviewDate": "2021-08-12T10:15:29.688Z",
"JsonData": "string",
"ConfidentialityId": 0,
"ClassificationId": 0,
"BestBets": [
"string"
],
"Translations": {
"originalLanguageId": 0,
"translations": [
{
"languageId": 0,
"title": "string",
"summary": "string",
"body": "string"
}
]
}
}
}