PublishingSystemManagerServices.ListPubTargets Method

PublishingSystemManagerServicesListPubTargets Method

Ingeniux CMS Web Services API

Retrieves the collection of Publishing Targets and User Groups basic information

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

Syntax

C++

Copy

public XHRServiceResponseGeneric<PublishingTargetsListData> ListPubTargets()

Public Function ListPubTargets As XHRServiceResponseGeneric(Of PublishingTargetsListData)

public:
virtual XHRServiceResponseGeneric<PublishingTargetsListData^>^ ListPubTargets() sealed

abstract ListPubTargets : unit -> XHRServiceResponseGeneric<PublishingTargetsListData> 
override ListPubTargets : unit -> XHRServiceResponseGeneric<PublishingTargetsListData>

Return Value

Type: XHRServiceResponseGenericPublishingTargetsListData

Object contains Array of Publishing Target basic information, and array of User Groups basic information

Examples

Sample JSON return

JavaScript

Copy

{
    "code": 0,
    "error": null,
    "message": {
        "groups": [{
            "name": "Administrators",
            "groupId": "UserGroup\/1",
            "usersCount": 2
        }, {
            "name": "Authors",
            "groupId": "UserGroups\/1",
            "usersCount": 1
        }],
        "pubTargets": [{
            "name": "Live",
            "id": "PublishingTargets\/1",
            "rootPage": "x2",
            "rootPageName": "Site",
            "site": "",
            "transformOnPublish": false,
            "userAgent": ""
        }, {
            "name": "Staging",
            "id": "PublishingTargets\/33",
            "rootPage": "x2",
            "rootPageName": "Site",
            "site": "",
            "transformOnPublish": false,
            "userAgent": ""
        }, {
            "name": "Staging 2",
            "id": "PublishingTargets\/34",
            "rootPage": "x2",
            "rootPageName": "Site",
            "site": "",
            "transformOnPublish": false,
            "userAgent": ""
        }]
    }
}

Reference

PublishingSystemManagerServices Class

IngeniuxCMService Namespace