PublishingSystemManagerServices.ListPubProfiles Method

PublishingSystemManagerServicesListPubProfiles Method

Ingeniux CMS Web Services API

Retrieves the list of Publishing Profiles. Publishing Profiles are collection of Publishing Target that fit certain criteria. The purpose of Publishing Profiles is easy Publishing Targets selection during Publish submission.

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

Syntax

C++

Copy

public XHRServiceResponseGeneric<PublishingProfilesListData> ListPubProfiles()

Public Function ListPubProfiles As XHRServiceResponseGeneric(Of PublishingProfilesListData)

public:
virtual XHRServiceResponseGeneric<PublishingProfilesListData^>^ ListPubProfiles() sealed

abstract ListPubProfiles : unit -> XHRServiceResponseGeneric<PublishingProfilesListData> 
override ListPubProfiles : unit -> XHRServiceResponseGeneric<PublishingProfilesListData>

Return Value

Type: XHRServiceResponseGenericPublishingProfilesListData

Object contains Array of Publishing Profile 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
        }],
        "pubProfiles": [{
            "name": "Staging",
            "id": "PublishingProfiles\/1",
            "targetsCount": 2
        }, {
            "name": "Live",
            "id": "PublishingProfiles\/2",
            "targetsCount": 1
        }]
    }
}

Reference

PublishingSystemManagerServices Class

IngeniuxCMService Namespace