PageCreationRulesAdminServices.GetRule Method

PageCreationRulesAdminServicesGetRule Method

Ingeniux CMS Web Services API

Retrieves a single Page Creation Rule via its unique Id, providing full details of the Rule.

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

Syntax

C++

Copy

public XHRServiceResponseGeneric<PageCreationRuleEditorData> GetRule(
	GetSingleItemParam data
)

Public Function GetRule ( 
	data As GetSingleItemParam
) As XHRServiceResponseGeneric(Of PageCreationRuleEditorData)

public:
virtual XHRServiceResponseGeneric<PageCreationRuleEditorData^>^ GetRule(
	GetSingleItemParam^ data
) sealed

abstract GetRule : 
        data : GetSingleItemParam -> XHRServiceResponseGeneric<PageCreationRuleEditorData> 
override GetRule : 
        data : GetSingleItemParam -> XHRServiceResponseGeneric<PageCreationRuleEditorData>

Parameters

data

Type: GetSingleItemParam

Object containing the unique Id of Page Creation Rule to retrieve

Examples

Sample JSON intpu

JavaScript

Copy

{
    "data": {
        "itemId": "PageCreationRules/1"
    }
}

Return Value

Type: XHRServiceResponseGenericPageCreationRuleEditorData

Full details of the Page Creation Rule

Examples

Sample JSON return

JavaScript

Copy

{
    "code": 0,
    "error": null,
    "message": {
        "info": {
            "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": "",
            "groups": [{
                "name": "Administrators",
                "id": "UserGroup\/1"
            }, {
                "name": "Authors",
                "id": "UserGroups\/1"
            }],
            "users": []
        },
        "parents": [{
            "name": "Listing",
            "id": "x112",
            "accessible": true,
            "icon": 99,
            "parentOnly": false,
            "path": "Site\/Listing"
        }]
    }
}

Remarks

If Page Creation Rule with given Id doesn't exit, returns error status

Reference

PageCreationRulesAdminServices Class

IngeniuxCMService Namespace