PublishingSystemManagerServicesGetPubProfile Method

Ingeniux CMS Web Services API

Retrieves information of a single Publishing Profile by its unique Id

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

public XHRServiceResponseGeneric<PublishingProfileEditorData> GetPubProfile(
	PublishingSystemItemGetParam data
)

Parameters

data
Type: PublishingSystemItemGetParam

Object containing Publishing Profile's unique Id

Examples

Sample JSON input
JavaScript
{
    "data": {
        "itemId": "PublishingProfiles/1"
    }
}

Return Value

Type: XHRServiceResponseGenericPublishingProfileEditorData

Object containing detailed information of the Publishing Profile, and colleciton of User Groups basic information

Examples

Sample JSON return
JavaScript
{
    "code": 0,
    "error": null,
    "message": {
        "accessibleGroups": [{
            "name": "Administrators",
            "groupId": "UserGroup\/1",
            "usersCount": 2
        }, {
            "name": "Authors",
            "groupId": "UserGroups\/1",
            "usersCount": 1
        }],
        "info": {
            "name": "Staging",
            "id": "PublishingProfiles\/1",
            "targetsCount": 2,
            "excludeTargets": [["PublishingTargets\/33", "PublishingTargets\/34"], ["PublishingTargets\/1"]],
            "pubTargets": [{
                "name": "Staging",
                "id": "PublishingTargets\/33"
            }, {
                "name": "Staging 2",
                "id": "PublishingTargets\/34"
            }]
        }
    }
}
Remarks

If Publishing Profile doesn't exist, returns error status

See Also

Reference