Cli-microsoft365: Enhancement: Extend `spo page get` json output to include all returned properties

Created on 23 Jul 2020 · 2Comments · Source: pnp/cli-microsoft365

The spo page get command currently returns the same properties in text and json output modes.

For example,

commentsDisabled: true
layoutType      : Article
numControls     : 5
numSections     : 4
title           : Sample Copy

```json
{
"commentsDisabled": true,
"numSections": 4,
"numControls": 5,
"title": "Sample Copy",
"layoutType": "Article"
}

When running the command in `--verbose` mode we can see that the request returns the full json payload from the API.

```json
{
  "ListItemAllFields": {
    "CommentsDisabled": true,
    "FileSystemObjectType": 0,
    "Id": 20,
    "ServerRedirectedEmbedUri": null,
    "ServerRedirectedEmbedUrl": "",
    "ContentTypeId": "0x0101009D1CB255DA76424F860D91F20E6C411800B48E644782EA5040882EADEE2AC838FF",
    "ComplianceAssetId": null,
    "WikiField": null,
    "Title": "Sample Copy",
    "ClientSideApplicationId": "b6917cb1-93a0-4b97-a84d-7cf49975d4ec",
    "PageLayoutType": "Article",
    "CanvasContent1": "<div><div data-sp-canvascontrol=\"\" data-sp-canvasdataversion=\"1.0\" data-sp-controldata=\"&#123;&quot;controlType&quot;&#58;4,&quot;id&quot;&#58;&quot;1212fc8d-dd6b-408a-8d5d-9f1cc787efbb&quot;,&quot;position&quot;&#58;&#123;&quot;controlIndex&quot;&#58;2,&quot;sectionIndex&quot;&#58;1,&quot;sectionFactor&quot;&#58;12,&quot;zoneIndex&quot;&#58;1,&quot;layoutIndex&quot;&#58;1&#125;,&quot;addedFromPersistedData&quot;&#58;true,&quot;emphasis&quot;&#58;&#123;&#125;&#125;\"><div data-sp-rte=\"\"><p>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque odio sem, finibus quis libero congue, accumsan faucibus justo. Etiam mattis metus leo, ac iaculis dui molestie nec. Cras sodales felis a nunc scelerisque, vel laoreet eros mollis. Aliquam consequat mi sit amet cursus aliquam. Sed faucibus metus sed metus vehicula feugiat. Orci varius natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Aliquam non fermentum eros. Nam at eros urna. Morbi eget porta enim, maximus malesuada velit. Maecenas rhoncus in erat vel feugiat. Mauris vitae vehicula purus. Mauris molestie metus ac leo aliquet luctus.<br></p></div></div><div data-sp-canvascontrol=\"\" data-sp-canvasdataversion=\"1.0\" data-sp-controldata=\"&#123;&quot;controlType&quot;&#58;4,&quot;id&quot;&#58;&quot;a12c3f3e-ba0f-4681-b196-733c53612700&quot;,&quot;position&quot;&#58;&#123;&quot;zoneIndex&quot;&#58;2,&quot;sectionIndex&quot;&#58;1,&quot;controlIndex&quot;&#58;0.5,&quot;sectionFactor&quot;&#58;12,&quot;layoutIndex&quot;&#58;1&#125;,&quot;emphasis&quot;&#58;&#123;&quot;zoneEmphasis&quot;&#58;1&#125;&#125;\"><div data-sp-rte=\"\"><p>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque odio sem, finibus quis libero congue, accumsan faucibus justo. Etiam mattis metus leo, ac iaculis dui molestie nec. Cras sodales felis a nunc scelerisque, vel laoreet eros mollis. Aliquam consequat mi sit amet cursus aliquam. Sed faucibus metus sed metus vehicula feugiat. Orci varius natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Aliquam non fermentum eros. Nam at eros urna. Morbi eget porta enim, maximus malesuada velit. Maecenas rhoncus in erat vel feugiat. Mauris vitae vehicula purus. Mauris molestie metus ac leo aliquet luctus.<br></p></div></div><div data-sp-canvascontrol=\"\" data-sp-canvasdataversion=\"1.0\" data-sp-controldata=\"&#123;&quot;controlType&quot;&#58;3,&quot;id&quot;&#58;&quot;f1f82b6e-81a7-4ac4-a598-a6f61252ca99&quot;,&quot;position&quot;&#58;&#123;&quot;zoneIndex&quot;&#58;2,&quot;sectionIndex&quot;&#58;1,&quot;controlIndex&quot;&#58;1,&quot;sectionFactor&quot;&#58;12,&quot;layoutIndex&quot;&#58;1&#125;,&quot;webPartId&quot;&#58;&quot;490d7c76-1824-45b2-9de3-676421c997fa&quot;,&quot;emphasis&quot;&#58;&#123;&quot;zoneEmphasis&quot;&#58;1&#125;,&quot;reservedHeight&quot;&#58;326,&quot;reservedWidth&quot;&#58;1180,&quot;addedFromPersistedData&quot;&#58;true&#125;\"><div data-sp-webpart=\"\" data-sp-webpartdataversion=\"1.2\" data-sp-webpartdata=\"&#123;&quot;id&quot;&#58;&quot;490d7c76-1824-45b2-9de3-676421c997fa&quot;,&quot;instanceId&quot;&#58;&quot;f1f82b6e-81a7-4ac4-a598-a6f61252ca99&quot;,&quot;title&quot;&#58;&quot;Embed&quot;,&quot;description&quot;&#58;&quot;Embed content from other sites such as Sway, YouTube, Vimeo, and more&quot;,&quot;serverProcessedContent&quot;&#58;&#123;&quot;htmlStrings&quot;&#58;&#123;&#125;,&quot;searchablePlainTexts&quot;&#58;&#123;&#125;,&quot;imageSources&quot;&#58;&#123;&#125;,&quot;links&quot;&#58;&#123;&#125;&#125;,&quot;dataVersion&quot;&#58;&quot;1.2&quot;,&quot;properties&quot;&#58;&#123;&quot;embedCode&quot;&#58;&quot;&quot;,&quot;cachedEmbedCode&quot;&#58;&quot;&quot;,&quot;shouldScaleWidth&quot;&#58;true,&quot;tempState&quot;&#58;&#123;&#125;,&quot;thumbnailUrl&quot;&#58;&quot;&quot;&#125;&#125;\"><div data-sp-componentid=\"\">490d7c76-1824-45b2-9de3-676421c997fa</div><div data-sp-htmlproperties=\"\"></div></div></div><div data-sp-canvascontrol=\"\" data-sp-canvasdataversion=\"1.0\" data-sp-controldata=\"&#123;&quot;controlType&quot;&#58;4,&quot;id&quot;&#58;&quot;5e9a75cf-f71e-40b7-860e-ead4eb7eac9d&quot;,&quot;position&quot;&#58;&#123;&quot;zoneIndex&quot;&#58;3,&quot;sectionIndex&quot;&#58;1,&quot;controlIndex&quot;&#58;1,&quot;sectionFactor&quot;&#58;6,&quot;layoutIndex&quot;&#58;1&#125;,&quot;emphasis&quot;&#58;&#123;&#125;&#125;\"><div data-sp-rte=\"\"><p>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque odio sem, finibus quis libero congue, accumsan faucibus justo. Etiam mattis metus leo, ac iaculis dui molestie nec. Cras sodales felis a nunc scelerisque, vel laoreet eros mollis. Aliquam consequat mi sit amet cursus aliquam. Sed faucibus metus sed metus vehicula feugiat. Orci varius natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Aliquam non fermentum eros. Nam at eros urna. Morbi eget porta enim, maximus malesuada velit. Maecenas rhoncus in erat vel feugiat. Mauris vitae vehicula purus. Mauris molestie metus ac leo aliquet luctus.<br></p></div></div><div data-sp-canvascontrol=\"\" data-sp-canvasdataversion=\"1.0\" data-sp-controldata=\"&#123;&quot;controlType&quot;&#58;4,&quot;id&quot;&#58;&quot;ffee2749-adb7-4afc-a2a2-b5850c66773e&quot;,&quot;position&quot;&#58;&#123;&quot;zoneIndex&quot;&#58;3,&quot;sectionIndex&quot;&#58;2,&quot;controlIndex&quot;&#58;1,&quot;sectionFactor&quot;&#58;6,&quot;layoutIndex&quot;&#58;1&#125;,&quot;emphasis&quot;&#58;&#123;&#125;&#125;\"><div data-sp-rte=\"\"><p>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque odio sem, finibus quis libero congue, accumsan faucibus justo. Etiam mattis metus leo, ac iaculis dui molestie nec. Cras sodales felis a nunc scelerisque, vel laoreet eros mollis. Aliquam consequat mi sit amet cursus aliquam. Sed faucibus metus sed metus vehicula feugiat. Orci varius natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Aliquam non fermentum eros. Nam at eros urna. Morbi eget porta enim, maximus malesuada velit. Maecenas rhoncus in erat vel feugiat. Mauris vitae vehicula purus. Mauris molestie metus ac leo aliquet luctus.<br></p></div></div><div data-sp-canvascontrol=\"\" data-sp-canvasdataversion=\"1.0\" data-sp-controldata=\"&#123;&quot;controlType&quot;&#58;0,&quot;pageSettingsSlice&quot;&#58;&#123;&quot;isDefaultDescription&quot;&#58;true,&quot;isDefaultThumbnail&quot;&#58;true&#125;&#125;\"></div></div>",
    "BannerImageUrl": {
      "Description": "/_layouts/15/images/sitepagethumbnail.png",
      "Url": "https://cpsglobaldev.sharepoint.com/_layouts/15/images/sitepagethumbnail.png"
    },
    "Description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque odio sem, finibus quis libero congue, accumsan faucibus justo. Etiam mattis metus leo, ac iaculis dui molestie nec. Cras sodales felis a nunc scelerisque, vel laoreet eros mollis.…",
    "PromotedState": 0,
    "FirstPublishedDate": null,
    "LayoutWebpartsContent": "<div><div data-sp-canvascontrol=\"\" data-sp-canvasdataversion=\"1.4\" data-sp-controldata=\"&#123;&quot;id&quot;&#58;&quot;cbe7b0a9-3504-44dd-a3a3-0e5cacd07788&quot;,&quot;instanceId&quot;&#58;&quot;cbe7b0a9-3504-44dd-a3a3-0e5cacd07788&quot;,&quot;title&quot;&#58;&quot;\\n      Title area\\n    &quot;,&quot;description&quot;&#58;&quot;\\n      Title area description\\n    &quot;,&quot;serverProcessedContent&quot;&#58;&#123;&quot;htmlStrings&quot;&#58;&#123;&#125;,&quot;searchablePlainTexts&quot;&#58;&#123;&#125;,&quot;imageSources&quot;&#58;&#123;&quot;imageSource&quot;&#58;&quot;/_LAYOUTS/IMAGES/SLEEKTEMPLATEIMAGETILE.JPG&quot;&#125;,&quot;links&quot;&#58;&#123;&#125;,&quot;customMetadata&quot;&#58;&#123;&quot;imageSource&quot;&#58;&#123;&#125;&#125;&#125;,&quot;dataVersion&quot;&#58;&quot;1.4&quot;,&quot;properties&quot;&#58;&#123;&quot;imageSourceType&quot;&#58;2,&quot;title&quot;&#58;&quot;Sample Copy&quot;,&quot;textAlignment&quot;&#58;&quot;Left&quot;,&quot;showPublishDate&quot;&#58;true,&quot;authors&quot;&#58;[],&quot;showTopicHeader&quot;&#58;false,&quot;authorByline&quot;&#58;[],&quot;layoutType&quot;&#58;&quot;NoImage&quot;,&quot;topicHeader&quot;&#58;&quot;&quot;&#125;,&quot;reservedHeight&quot;&#58;155&#125;\"></div></div>",
    "OData__AuthorBylineId": null,
    "_AuthorBylineStringId": null,
    "OData__TopicHeader": null,
    "OData__SPSitePageFlags": null,
    "OData__OriginalSourceUrl": null,
    "OData__OriginalSourceSiteId": null,
    "OData__OriginalSourceWebId": null,
    "OData__OriginalSourceListId": null,
    "OData__OriginalSourceItemId": null,
    "ID": 20,
    "Created": "2020-07-23T14:18:14",
    "AuthorId": 9,
    "Modified": "2020-07-23T14:19:15",
    "EditorId": 9,
    "OData__CopySource": null,
    "CheckoutUserId": null,
    "OData__UIVersionString": "1.0",
    "GUID": "793e5c3b-1eeb-49ff-a64c-1e165bdfc6ca"
  },
  "CheckInComment": "",
  "CheckOutType": 2,
  "ContentTag": "{2DA71DF5-9587-4456-AA92-EE3F9CA5676A},14,11",
  "CustomizedPageStatus": 0,
  "ETag": "\"{2DA71DF5-9587-4456-AA92-EE3F9CA5676A},14\"",
  "Exists": true,
  "IrmEnabled": false,
  "Length": "11547",
  "Level": 1,
  "LinkingUri": null,
  "LinkingUrl": "",
  "MajorVersion": 1,
  "MinorVersion": 0,
  "Name": "Sample-Copy.aspx",
  "ServerRelativeUrl": "/teams/GTSandpit/SitePages/Sample-Copy.aspx",
  "TimeCreated": "2020-07-23T13:18:14Z",
  "TimeLastModified": "2020-07-23T13:19:16Z",
  "Title": "Sample Copy",
  "UIVersion": 512,
  "UIVersionLabel": "1.0",
  "UniqueId": "2da71df5-9587-4456-aa92-ee3f9ca5676a"
}

It would be beneficial to return these properties to the console in json output for scripting scenarios, such as obtaining the value of the CanvasContent1 property containing the contents of the page.

enhancement good first issue work in progress

Source