Documentation

/content/{id}/portlets [GET]

ThoughtFarmer REST API Method: /content/{id}/portlets/{culture} [GET]

Retrieves raw portlet data for a given content page.

URL:
http://yourserver.com/api/content/{id}/portlets/{culture}

Response Formats:
JSON, XML

HTTP Method(s):
GET

Requires Authentication:
true, user making call must pass a valid token parameter and must be able to view the content being requested

Parameters:

Parameter Type Description
id int Required. The content id of the page
token string Required. A valid token authentication parameter
culture string Language to use for content (authenticating user's default language used if not provided)
Response Status Codes:
200 - Success
404 - Content or portlet data not found

Example request
GET http://yourserver.com/api/content/{id}/portlets
{
    "core": {
        "contentId": 550,
        "treePath": [
            1,
            25,
            763
        ],
        "pageType": 1
    },
    "intranetStatistics": null,
    "pageTitle": {
        "key": "en",
        "text": "New York Flood Relief",
        "isoLanguage": "en"
    },
    "tags": {
        "canEdit": true,
        "tags": [
            {
                "tagId": 18,
                "name": "page",
                "url": "/browse/?tags=18"
            },
            {
                "tagId": 265,
                "name": "Relief",
                "url": "/browse/?tags=265"
            }
        ]
    },
    "likePageButton": {
        "likeType": 1,
        "uniqueId": 550,
        "totalLikes": 0,
        "isLiked": false
    },
    "followPageButton": {
        "isFollowing": true,
        "totalFollowing": 3,
        "contentId": 550
    },
    "emailPageButton": {
        "showEmailPageBtn": true,
        "pageTitle": "New York Flood Relief"
    },
    "exportPageButton": {
        "canBeExported": true,
        "wordUrl": "/word/page/?contentId=550&culture=en",
        "pdfUrl": "/pdf/page/?contentId=550&culture=en",
        "excelUrl": "?contentId=550&culture=en",
        "showExportPdf": true,
        "showExportWord": true,
        "showExportExcel": false
    },
    "bookmarkButton": {
        "isBookmarked": true,
        "canBeBookmarked": true,
        "contentId": 550,
        "bookmarkId": 1180,
        "totalBookmarkCount": 1,
        "followPageButtonModel": null
    },
    "translatePageButton": ":( Unable to find the card 'TranslatePageButton' :( :S",
    "toggleCultureButton": {
        "languages": [
            {
                "twoLetterIsoLanguageName": "en",
                "nativeName": "English",
                "url": "/content/en/550"
            }
        ],
        "culture": "en"
    },
    "pageHeaderBranding": {
        "image": null,
        "startColor": "#269896",
        "endColor": "#092F2F"
    },
    "contentBanner": {
        "isPrivate": false,
        "isArchived": false,
        "isFuture": false,
        "isInheritedArchived": false
    },
    "versionHistory": {
        "contentId": 550,
        "version": 2,
        "canEdit": true
    },
    "recentActivity": {
        "enabled": true
    },
    "pageSecurity": ":( Unable to find the card 'PageSecurity' :( :S",
    "contentOwner": {
        "owner": {
            "lastName": "Redpath",
            "userName": "sredpath",
            "largeImageUrl": "/profileimage/43012370000/10/72x72/True/0/P1290356.JPG",
            "smallImageUrl": "/profileimage/43012370000/10/44x44/True/0/P1290356.JPG",
            "userId": 7,
            "contentId": 24,
            "fullName": "Sara Redpath",
            "jobTitle": "Sales Coordinator",
            "email": "sara@thoughtfarmer.com",
            "url": "/content/24",
            "imageUrl": "/profileimage/43012370000/10/24x24/True/0/P1290356.JPG",
            "mediumImageUrl": "/profileimage/43012370000/10/48x48/True/0/P1290356.JPG",
            "isAdministrator": true,
            "isActive": true,
            "firstName": "Sara"
        },
        "canEdit": true
    },
    "publishedDate": {
        "iso8601": "2013-02-07T14:14:18Z",
        "ticks": 634958432585000000,
        "local": "2013-02-07T09:14:18.5"
    },
    "updatedDate": {
        "iso8601": "2015-11-24T21:56:25Z",
        "ticks": 635839989853030000,
        "local": "2015-11-24T16:56:25.303"
    },
    "pageViews": ":( Unable to find the card 'PageViews' :( :S",
    "editPageButton": {
        "url": "/content/edit/en/550",
        "label": "Edit",
        "isRepeatingCalendarEvent": false,
        "repeatingCalendarEventEditUrl": ""
    },
    "addPageButton": {
        "url": "/content/add/550",
        "label": "Add",
        "isRepeatingCalendarEvent": false,
        "repeatingCalendarEventEditUrl": null
    },
    "deletePageButton": {
        "url": "/content/delete/550",
        "label": "Delete",
        "isRepeatingCalendarEvent": false,
        "repeatingCalendarEventOccurance": ""
    },
    "archivePageButton": {
        "url": "#",
        "label": "Archive",
        "archiving": true,
        "isRepeatingCalendarEvent": false
    },
    "movePageButton": {
        "url": "#",
        "label": "Move",
        "isRepeatingCalendarEvent": false,
        "repeatingCalendarEventEditUrl": null
    },
    "duplicatePageButton": {
        "url": "/content/add/763/duplicate/550",
        "label": "Duplicate",
        "isRepeatingCalendarEvent": false,
        "repeatingCalendarEventEditUrl": null
    },
    "reorderNavigationButton": {
        "url": "#",
        "label": "Reorder navigation",
        "isRepeatingCalendarEvent": false,
        "repeatingCalendarEventEditUrl": null
    },
    "securitySettingsButton": {
        "url": "#",
        "label": "Security",
        "isRepeatingCalendarEvent": false,
        "repeatingCalendarEventEditUrl": null
    },
    "superNav": {
        "currentRoot": {
            "contentId": 550,
            "title": "New York Flood Relief",
            "url": "/content/550",
            "pageType": 1,
            "hasChildren": true,
            "target": "",
            "canEdit": true,
            "isPrivate": false,
            "isArchived": false,
            "isNew": false,
            "isUpdated": false,
            "isFuture": false,
            "datePublished": null,
            "isActive": true
        },
        "ancestors": [
            {
                "contentId": 1,
                "title": "Home",
                "url": "/",
                "pageType": 0,
                "hasChildren": true,
                "target": null,
                "canEdit": false,
                "isPrivate": false,
                "isArchived": false,
                "isNew": false,
                "isUpdated": false,
                "isFuture": false,
                "datePublished": null,
                "isActive": true
            },
            {
                "contentId": 25,
                "title": "Departments & Locations",
                "url": "/content/25",
                "pageType": 0,
                "hasChildren": true,
                "target": null,
                "canEdit": false,
                "isPrivate": false,
                "isArchived": false,
                "isNew": false,
                "isUpdated": false,
                "isFuture": false,
                "datePublished": null,
                "isActive": true
            },
            {
                "contentId": 763,
                "title": "Committees and Groups",
                "url": "/content/763",
                "pageType": 0,
                "hasChildren": true,
                "target": null,
                "canEdit": false,
                "isPrivate": false,
                "isArchived": false,
                "isNew": false,
                "isUpdated": false,
                "isFuture": false,
                "datePublished": null,
                "isActive": true
            }
        ],
        "children": [
            {
                "contentId": 4149,
                "title": "Rwar",
                "url": "/content/1073",
                "pageType": 3,
                "hasChildren": false,
                "target": "",
                "canEdit": true,
                "isPrivate": false,
                "isArchived": false,
                "isNew": false,
                "isUpdated": false,
                "isFuture": false,
                "datePublished": null,
                "isActive": true
            },
            {
                "contentId": 581,
                "title": "flood",
                "url": "/content/581",
                "pageType": 8,
                "hasChildren": false,
                "target": "",
                "canEdit": true,
                "isPrivate": false,
                "isArchived": false,
                "isNew": false,
                "isUpdated": false,
                "isFuture": false,
                "datePublished": null,
                "isActive": true
            },
            {
                "contentId": 572,
                "title": "Status Updates",
                "url": "/content/572",
                "pageType": 8,
                "hasChildren": false,
                "target": "",
                "canEdit": true,
                "isPrivate": false,
                "isArchived": false,
                "isNew": false,
                "isUpdated": false,
                "isFuture": false,
                "datePublished": null,
                "isActive": true
            },
            {
                "contentId": 555,
                "title": "Flood Photos",
                "url": "/content/555",
                "pageType": 7,
                "hasChildren": false,
                "target": "",
                "canEdit": true,
                "isPrivate": false,
                "isArchived": false,
                "isNew": false,
                "isUpdated": false,
                "isFuture": false,
                "datePublished": null,
                "isActive": true
            },
            {
                "contentId": 554,
                "title": "Flood Q&A",
                "url": "/content/554",
                "pageType": 9,
                "hasChildren": false,
                "target": "",
                "canEdit": true,
                "isPrivate": false,
                "isArchived": false,
                "isNew": false,
                "isUpdated": false,
                "isFuture": false,
                "datePublished": null,
                "isActive": true
            },
            {
                "contentId": 551,
                "title": "Flood Relief Calendar",
                "url": "/content/551",
                "pageType": 6,
                "hasChildren": false,
                "target": "",
                "canEdit": true,
                "isPrivate": false,
                "isArchived": false,
                "isNew": false,
                "isUpdated": false,
                "isFuture": false,
                "datePublished": null,
                "isActive": true
            }
        ],
        "hideOnHomepage": false
    },
    "cultureInfoWarningMessage": null,
    "ownerLocked": null,
    "crossSiteRequestForgeryToken": {
        "value": ":"
    },
    "returnToLink": null,
    "rssLinks": {
        "links": [
            {
                "url": "/content/550/rss/activity",
                "title": "ThoughtFarmer Intranet - Recent activities under New York Flood Relief"
            }
        ]
    },
    "urlCacheTokens": {
        "localizationUrlCacheToken": "8.0.1_962699845789",
        "configUrlCacheToken": "8.0.1_186627834952",
        "themeUrlCacheToken": "dev_635915044526917481"
    },
    "globalCustomPortlet": {
        "portlets": []
    },
    "pageBody": {
        "key": "en",
        "htmlContent": "This is our page to organize flood relief in the area our brances serve. If you have any ideas, please share them here and help us do some good!\r\n",
        "isoLanguage": "en"
    },
    "comments": {
        "list": [],
        "allowComments": true,
        "commentsSortDescending": "false",
        "contentId": 550,
        "showVersionMessages": false
    },
    "pageStructure": "PageStructureA",
    "pageLayoutPortlets": [
        {
            "layoutPortletId": 71,
            "portlet": "PageBody",
            "pageStructureLane": "Center",
            "sortOrder": 1
        },
        {
            "layoutPortletId": 72,
            "portlet": "DocumentLibrary",
            "pageStructureLane": "Center",
            "sortOrder": 2
        },
        {
            "layoutPortletId": 73,
            "portlet": "Comments",
            "pageStructureLane": "Center",
            "sortOrder": 3
        }
    ]
}