PublishingSystemManagerServicesAdministrativeReplicate Method

Performs a replication directly on a Publishing Target without publishing.

Namespace: IngeniuxCMService
Assembly: IngeniuxCMService (in IngeniuxCMService.dll) Version: 10.6.492

Syntax

public XHRServiceResponseGeneric<AdminReplicationResult> AdministrativeReplicate(
	string pubTargetId,
	bool clean
)

Public Function AdministrativeReplicate ( 
	pubTargetId As String,
	clean As Boolean
) As XHRServiceResponseGeneric(Of AdminReplicationResult)

public:
virtual XHRServiceResponseGeneric<AdminReplicationResult^>^ AdministrativeReplicate(
	String^ pubTargetId, 
	bool clean
) sealed

abstract AdministrativeReplicate : 
        pubTargetId : string * 
        clean : bool -> XHRServiceResponseGeneric<AdminReplicationResult> 
override AdministrativeReplicate : 
        pubTargetId : string * 
        clean : bool -> XHRServiceResponseGeneric<AdminReplicationResult>

Parameters

pubTargetId String: Id of the Publishing Target
clean Boolean: Whether to perform a replication that will clean up files not no longer exists in the Publishing Folder

Return Value

XHRServiceResponseGenericAdminReplicationResult

Object containing instructions of the administrative replication

Example

Sample JSON return

JavaScript

Copy

{
    "code": 0,
    "error": null,
    "message": {
        "clean": false,
        "pubTargetId": "PublishingTargets\/1"
    }
}

Remarks

If Publishing Target doesn't exist, returns error status

If Publishing Target's replication function is not enabled, returns error status

This opertaion will return a response right away, the actual replication will be performed in the background and may take some time to finish

Reference

PublishingSystemManagerServices Class

IngeniuxCMService Namespace