SiteTreeServices.GetPageProperties Method

SiteTreeServicesGetPageProperties Method

Ingeniux CMS Web Services API

Retrieves Properties of a single Page node, which includes collection of meta data of the Page.

Namespace: IngeniuxCMService
Assembly: IngeniuxCMService (in IngeniuxCMService.dll) Version: 9.0.565.0 (9.0.565)

Syntax

C++

Copy

public XHRServiceResponseGeneric<PageProperties> GetPageProperties(
	string pageId,
	string pubTarget,
	bool fullDetails = false
)

Public Function GetPageProperties ( 
	pageId As String,
	pubTarget As String,
	Optional fullDetails As Boolean = false
) As XHRServiceResponseGeneric(Of PageProperties)

public:
virtual XHRServiceResponseGeneric<PageProperties^>^ GetPageProperties(
	String^ pageId, 
	String^ pubTarget, 
	bool fullDetails = false
) sealed

abstract GetPageProperties : 
        pageId : string * 
        pubTarget : string * 
        ?fullDetails : bool 
(* Defaults:
        let _fullDetails = defaultArg fullDetails false
*)
-> XHRServiceResponseGeneric<PageProperties> 
override GetPageProperties : 
        pageId : string * 
        pubTarget : string * 
        ?fullDetails : bool 
(* Defaults:
        let _fullDetails = defaultArg fullDetails false
*)
-> XHRServiceResponseGeneric<PageProperties>

Parameters

pageId: Type: SystemString
Id of the Page
pubTarget: Type: SystemString
Id of the current Publishing Target, optional
fullDetails (Optional): Type: SystemBoolean
[Missing <param name="fullDetails"/> documentation for "M:IngeniuxCMService.SiteTreeServices.GetPageProperties(System.String,System.String,System.Boolean)"]

Return Value

Type: XHRServiceResponseGenericPageProperties

Properties of the Page node

Examples

Sample JSON return

JavaScript

Copy

{
    "code": 0,
    "error": null,
    "message": {
        "name": "dbquery",
        "allowedCategoryRoots": [],
        "ancestors": ["x1", "x2"],
        "assignedGroup": null,
        "assignedUser": null,
        "canClaimPage": false,
        "canTranslate": false,
        "checkedOut": false,
        "error": null,
        "icon": 4,
        "isAssignedToOtherUser": false,
        "isEditable": false,
        "isInWorkflow": false,
        "justRecycled": false,
        "languageRootId": "",
        "lingualMaps": {
            "clones": [],
            "master": null
        },
        "locale": "",
        "localeInherited": true,
        "markedForPublish": true,
        "markedForPublishAny": true,
        "markedForPublishPropagated": false,
        "nextPageId": null,
        "nextPageIndex": 0,
        "noDnd": false,
        "numChildPages": 0,
        "pageId": "x99",
        "parentId": null,
        "pendingMasterVersion": 0,
        "referenceProps": {
            "created": "20140109T22:46:19",
            "createdBy": "INGENIUX\\awang",
            "endDate": "00010101T00:00:00",
            "lastModified": "20140127T18:17:05",
            "lastModifiedBy": "User\/INGENIUX___awang",
            "publishAs": "",
            "startDate": "00010101T00:00:00"
        },
        "remoteServer": "",
        "schemaFriendlyName": null,
        "schemaName": "DbQuery",
        "schemaOnLatestVersion": false,
        "securityLevel": 2,
        "userCanCopyPage": true,
        "workflow": null
    }
}

Remarks

If Page doesn't exist, returns error status

Reference

SiteTreeServices Class

IngeniuxCMService Namespace