Click or drag to resize

PublishingSystemManagerServicesSavePubTarget Method
Saves a single Publishing Target with updated information

Namespace: IngeniuxCMService
Assembly: IngeniuxCMService (in IngeniuxCMService.dll) Version: 10.6.492
Syntax
Copy
public XHRServiceResponseGeneric<PublishingTargetSaveResult> SavePubTarget(
	PublishingTargetSaveInput data
)

Parameters

data  PublishingTargetSaveInput

The updated information on the Publishing Target and its underlying replication system

Example
Sample JSON input
JavaScript
Copy
{
    "data": {
        "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": true,
            "globalContentRoot": "",
            "homePageId": "x5",
            "iceEnabled": true,
            "iceFieldMarkupUpdateURL": "DssPreview/IGXDTICEUpdate",
            "includeFoldersInURL": false,
            "normalizeUrlSeparators": false,
            "page404Id": "",
            "pubFolder": "Live",
            "structuredUrlEnabled": true,
            "urlExtension": "xml",
            "urlSeparator": "-",
            "useExternalPreviewURL": true,
            "newEntry": false,
            "analyticsProvider": "Ingeniux.Analytics.Google.AnalyticsDataProvider, Ingeniux.Analytics",
            "analyticsEnabled": false
        },
        "members": ["UserGroup/1", "UserGroups/1"],
        "replication": {
            "doReplication": true,
            "simultaneousReplication": false,
            "targets": [{
                "type": "FileReplicationTarget",
                "ID": "bc24ec5353c9417590dbcc27ee56f005",
                "data": "{\"Disabled\":false,\"ID\":\"bc24ec5353c9417590dbcc27ee56f005\",\"Name\":\"File\",\"Description\":\"\",\"TargetLocation\":\"G:\\\\SyncTests\\\\file2\",\"CompareContent\":false,\"UseCommands\":false,\"PreReplicationCommand\":\"\",\"PreReplicationCommandTimeout\":10,\"PostReplicationCommand\":\"\",\"PostReplicationCommandTimeout\":10,\"UseImpersonation\":false,\"ImpersonateUserName\":\"\",\"ImpersonateUserDomain\":\"\",\"ImpersonatePassword\":\"\"}",
                "exemptLocations": [],
                "additionalLocations": [],
                "cleanupExemptLocations": []
            }]
        }
    }
}

Return Value

XHRServiceResponseGenericPublishingTargetSaveResult

Updated information of the Publishing Target after save, and list of all Publishing Targets

Example
Sample JSON return
JavaScript
Copy
{
    "code": 0,
    "error": null,
    "message": {
        "allowedTargets": [{
            "name": "Live",
            "id": "PublishingTargets\/1",
            "dynamicPublish": true,
            "previewUrl": "DssPreview\/IGXDynamicPreview",
            "rootPageId": "x2",
            "structuredUrlEnabled": true
        }, {
            "name": "Staging",
            "id": "PublishingTargets\/33",
            "dynamicPublish": true,
            "previewUrl": "DssPreview\/IGXDynamicPreview",
            "rootPageId": "x2",
            "structuredUrlEnabled": true
        }, {
            "name": "Staging 2",
            "id": "PublishingTargets\/34",
            "dynamicPublish": true,
            "previewUrl": "DssPreview\/IGXDynamicPreview",
            "rootPageId": "x2",
            "structuredUrlEnabled": true
        }],
        "info": {
            "name": "Live",
            "id": "PublishingTargets\/1",
            "rootPage": "x2",
            "rootPageName": "Site",
            "site": "",
            "transformOnPublish": false,
            "userAgent": "",
            "analytics": {
                "analyticsEnabled": false,
                "provider": null
            },
            "autoRedirectCanonicalURL": true,
            "baseUrl": "",
            "enableDynamicPublishing": true,
            "externalPreviewURL": "DssPreview\/IGXDynamicPreview",
            "forceLowerCaseURL": true,
            "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": ["{\"Disabled\":false,\"ID\":\"bc24ec5353c9417590dbcc27ee56f005\",\"Name\":\"File\",\"Description\":\"\",\"TargetLocation\":\"G:\\\\SyncTests\\\\file2\",\"UseCommands\":false,\"PreReplicationCommand\":\"\",\"PreReplicationCommandTimeout\":10,\"PostReplicationCommand\":\"\",\"PostReplicationCommandTimeout\":10,\"UseImpersonation\":false,\"ImpersonateUserName\":\"\",\"ImpersonateUserDomain\":\"\",\"ImpersonatePassword\":\"\",\"ReplicatorID\":\"Replicator_PublishingTargets_1\",\"Type\":\"Ingeniux.CMS.FileReplicationTarget\",\"typeFriendlyName\":\"Ingeniux.CMS.FileReplicationTarget\",\"PublishingTargetDirectory\":\"g:\\\\productdev\\\\dev_trunk\\\\cms_site\\\\app_data\\\\xml\\\\pub\\\\Live\",\"PublishingTargetID\":\"PublishingTargets\/1\",\"ExemptLocations\":[],\"AdditionalLocations\":[],\"CleanupExemptLocations\":[]}"]
        }
    }
}
Remarks

If Publishing Target doesn't exist, or Root Page doesn't exist, returns error status

If Structured URL is enabled, but Structured URL home page doesn't exist, returns error status

If Global Content Root Page id is not empty, but the Page doesn't exist, returns error status

See Also