PageCreationRulesAdminServices.List Method

PageCreationRulesAdminServicesList Method

Ingeniux CMS Web Services API

Retrieves the list of extended information entries of Page Creation Rules, and collection of Workflow Definition basic information entries.

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

Syntax

C++

Copy

public XHRServiceResponseGeneric<PageCreationRulesListingData> List()

Public Function List As XHRServiceResponseGeneric(Of PageCreationRulesListingData)

public:
virtual XHRServiceResponseGeneric<PageCreationRulesListingData^>^ List() sealed

abstract List : unit -> XHRServiceResponseGeneric<PageCreationRulesListingData> 
override List : unit -> XHRServiceResponseGeneric<PageCreationRulesListingData>

Return Value

Type: XHRServiceResponseGenericPageCreationRulesListingData

The object contains collection of Page Creation Rules and Workflow Definitions

Examples

Sample JSON return

JavaScript

Copy

{
    "code": 0,
    "error": null,
    "message": {
        "rules": [{
            "name": "Image",
            "id": "PageCreationRules\/1",
            "englishName": null,
            "groupsCount": 2,
            "isDefault": false,
            "workflowEnglishName": null,
            "workflowName": "",
            "autoSelectParent": true,
            "isSchemaComponent": true,
            "parentsCount": 1,
            "schema": "Image File",
            "schemaEnglishName": "Image File",
            "stylesheet": "~default~",
            "usersCount": 0,
            "workflowId": ""
        }],
        "workflowChoices": [{
            "name": "--No Workflow--",
            "id": "",
            "allowedGroup": null,
            "allowedUsers": null
        }]
    }
}

Remarks

The returned workflow definition information are choices to use create deciding whether to have Pages created via a Page Creation Rule to be put into a Workflow.

Reference

PageCreationRulesAdminServices Class

IngeniuxCMService Namespace