PublishingSystemManagerServicesGetPubTarget Method

Ingeniux CMS Web Services API

Retrieves information of a single Publishing Target by its unique Id

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

public XHRServiceResponseGeneric<PublishingTargetEditorData> GetPubTarget(
	PublishingSystemItemGetParam data
)

Parameters

data
Type: PublishingSystemItemGetParam

Object containing unique Id of the Publishing Target

Examples

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

Return Value

Type: XHRServiceResponseGenericPublishingTargetEditorData

Object containing the information of Publishing Target, the information of its replication system, and collection of User Groups

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": "Live",
            "id": "PublishingTargets\/1",
            "rootPage": "x2",
            "rootPageName": "Site",
            "site": "",
            "transformOnPublish": false,
            "userAgent": "",
            "analytics": {
                "analyticsEnabled": false,
                "provider": "Ingeniux.Analytics.Google.AnalyticsDataProvider, Ingeniux.Analytics"
            },
            "autoRedirectCanonicalURL": true,
            "baseUrl": "",
            "enableDynamicPublishing": true,
            "externalPreviewURL": "DssPreview\/IGXDynamicPreview",
            "forceLowerCaseURL": false,
            "globalContentRoot": "",
            "homePageId": "x5",
            "iceEnabled": true,
            "iceFieldMarkupUpdateURL": "DssPreview\/IGXDTICEUpdate",
            "includeFoldersInURL": false,
            "normalizeUrlSeparators": false,
            "page404Id": "",
            "pubFolder": "Live",
            "structuredUrlEnabled": true,
            "urlExtension": "xml",
            "urlSeparator": "-",
            "useExternalPreviewURL": true
        },
        "replication": {
            "doReplication": true,
            "simultaneousReplication": false,
            "targetTypes": [{
                "name": "File Replication Target",
                "type": "FileReplicationTarget"
            }, {
                "name": "Secure FTP Replication Target",
                "type": "SFTPReplicationTarget"
            }, {
                "name": "FTP\/SSL Replication Target",
                "type": "FTPSReplicationTarget"
            }, {
                "name": "FTP Replication Target",
                "type": "FTPReplicationTarget"
            }],
            "targets": ["{\"TargetLocation\":\"G:\\\\SyncTests\\\\file2\",\"UseImpersonation\":false,\"ImpersonateUserName\":\"\",\"ImpersonateUserDomain\":\"\",\"ImpersonatePassword\":\"\",\"ID\":\"bc24ec5353c9417590dbcc27ee56f005\",\"Name\":\"File\",\"Disabled\":false,\"ReplicatorID\":\"Replicator_PublishingTargets_1\",\"Type\":\"Ingeniux.CMS.FileReplicationTarget\",\"typeFriendlyName\":\"Ingeniux.CMS.FileReplicationTarget\",\"Description\":\"\",\"PublishingTargetDirectory\":\"g:\\\\productdev\\\\dev_trunk\\\\cms_site\\\\app_data\\\\xml\\\\pub\\\\Live\",\"PublishingTargetID\":\"PublishingTargets\/1\",\"UseCommands\":false,\"PreReplicationCommand\":\"\",\"PostReplicationCommand\":\"\",\"PreReplicationCommandTimeout\":10,\"PostReplicationCommandTimeout\":10,\"ExemptLocations\":[],\"AdditionalLocations\":[],\"CleanupExemptLocations\":[]}"]
        }
    }
}
Remarks

If Publishing Target doesn't exist, returns error status

See Also

Reference