MarkForPublishServicesGetPublishingSystemObjects Method

Ingeniux CMS Web Services API

Retrieves either list of Publishing Targets a given page is marked for; Or list of Publishing Profiles that contains marked Publishing Targets in each profile.

Namespace:  IngeniuxCMService
Assembly:  IngeniuxCMService (in IngeniuxCMService.dll) Version: 10.3.70
Syntax

public XHRServiceResponseGeneric<ProfileListResult> GetPublishingSystemObjects(
	GetProfilesListingInput data
)

Parameters

data
Type: GetProfilesListingInput

The information of whether to return Publishing Profiles or Publishing Targets, and which page we are pulling information for.

Examples

Sample JSON input - get publishing profiles
JavaScript
{
        "url": "",
        "handleAs": "json-comment-optional",
        "content": {
            "start": 0,
            "count": 100,
            "sort": "label"
        },
        "method": "getPublishingProfiles",
        "pageId": "x11"
}
Examples

Sample JSON input - get publishing targets
JavaScript
{
        "url": "",
        "handleAs": "json-comment-optional",
        "content": {
            "start": 0,
            "count": 100,
            "sort": "name"
        },
        "method": "getPublishingTargets",
        "pageId": "x11"
}

Return Value

Type: XHRServiceResponseGenericProfileListResult

The list of Publishing Target that the given page is marked on;

Or the list of all Publishing Profile, each contains the Publishing Targets that belong to it, and marked on given page

Examples

Sample JSON return - get publishing profiles
JavaScript
{
    "code": 0,
    "error": null,
    "message": {
        "identifier": "id",
        "items": [{
            "name": "Live",
            "id": "PublishingProfiles\/2",
            "label": "Live (1)",
            "targets": [{
                "name": "Live",
                "id": "PublishingTargets\/1"
            }],
            "targetsCount": 1
        }, {
            "name": "Staging",
            "id": "PublishingProfiles\/1",
            "label": "Staging (2)",
            "targets": [{
                "name": "Staging",
                "id": "PublishingTargets\/33"
            }],
            "targetsCount": 2
        }, {
            "name": "",
            "id": "custom",
            "label": "-- Custom picks of Publishing Targets --",
            "targets": [],
            "targetsCount": 0
        }],
        "label": "name",
        "numRows": 3
    }
}
Remarks

Note that for each profile, "targets" and "targetsCount" may not match, since "targetsCount" is count of all publishing targets in profile, "targets" will only list publishing targets the page is marked on.
Examples

Sample JSON return - get publishing targets (marked for given page)
JavaScript
{
    "code": 0,
    "error": null,
    "message": {
        "identifier": "id",
        "items": [{
            "name": "Live",
            "id": "PublishingTargets\/1"
        }, {
            "name": "Staging",
            "id": "PublishingTargets\/33"
        }],
        "label": "name",
        "numRows": 2
    }
}
Remarks

On Ingeniux CMS Client, this method is called to for selection of Publishing Target to check a Page in for.
See Also

Reference